@ogcio/building-blocks-sdk 0.0.24 → 0.0.26

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.
@@ -2226,6 +2226,140 @@
2226
2226
  }
2227
2227
  }
2228
2228
  },
2229
+ "/api/v1/requests/allActive": {
2230
+ "get": {
2231
+ "tags": [
2232
+ "PaymentRequests"
2233
+ ],
2234
+ "responses": {
2235
+ "200": {
2236
+ "description": "Default Response",
2237
+ "content": {
2238
+ "application/json": {
2239
+ "schema": {
2240
+ "type": "object",
2241
+ "properties": {
2242
+ "data": {
2243
+ "type": "array",
2244
+ "items": {
2245
+ "type": "object",
2246
+ "properties": {
2247
+ "paymentRequestId": {
2248
+ "type": "string"
2249
+ },
2250
+ "title": {
2251
+ "type": "string"
2252
+ },
2253
+ "description": {
2254
+ "type": "string"
2255
+ },
2256
+ "amount": {
2257
+ "type": "number"
2258
+ },
2259
+ "allowAmountOverride": {
2260
+ "type": "boolean"
2261
+ },
2262
+ "createdAt": {
2263
+ "type": "string"
2264
+ }
2265
+ },
2266
+ "required": [
2267
+ "paymentRequestId",
2268
+ "title",
2269
+ "allowAmountOverride",
2270
+ "createdAt"
2271
+ ]
2272
+ }
2273
+ },
2274
+ "metadata": {
2275
+ "type": "object",
2276
+ "properties": {
2277
+ "links": {
2278
+ "description": "Object containing the links to the related endpoints",
2279
+ "type": "object",
2280
+ "properties": {
2281
+ "self": {
2282
+ "type": "object",
2283
+ "properties": {
2284
+ "href": {
2285
+ "description": "URL pointing to the request itself",
2286
+ "type": "string"
2287
+ }
2288
+ }
2289
+ },
2290
+ "next": {
2291
+ "type": "object",
2292
+ "properties": {
2293
+ "href": {
2294
+ "description": "URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted",
2295
+ "type": "string"
2296
+ }
2297
+ }
2298
+ },
2299
+ "prev": {
2300
+ "type": "object",
2301
+ "properties": {
2302
+ "href": {
2303
+ "description": "URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted",
2304
+ "type": "string"
2305
+ }
2306
+ }
2307
+ },
2308
+ "first": {
2309
+ "type": "object",
2310
+ "properties": {
2311
+ "href": {
2312
+ "description": "URL pointing to the first page of results in a paginated response",
2313
+ "type": "string"
2314
+ }
2315
+ }
2316
+ },
2317
+ "last": {
2318
+ "type": "object",
2319
+ "properties": {
2320
+ "href": {
2321
+ "description": "URL pointing to the first page of results in a paginated response",
2322
+ "type": "string"
2323
+ }
2324
+ }
2325
+ },
2326
+ "pages": {
2327
+ "description": "It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2'",
2328
+ "type": "object",
2329
+ "additionalProperties": {
2330
+ "type": "object",
2331
+ "properties": {
2332
+ "href": {
2333
+ "type": "string"
2334
+ }
2335
+ }
2336
+ }
2337
+ }
2338
+ },
2339
+ "required": [
2340
+ "self",
2341
+ "first",
2342
+ "last",
2343
+ "pages"
2344
+ ]
2345
+ },
2346
+ "totalCount": {
2347
+ "description": "Number representing the total number of available items",
2348
+ "type": "number"
2349
+ }
2350
+ }
2351
+ }
2352
+ },
2353
+ "required": [
2354
+ "data"
2355
+ ]
2356
+ }
2357
+ }
2358
+ }
2359
+ }
2360
+ }
2361
+ }
2362
+ },
2229
2363
  "/api/v1/requests/{requestId}": {
2230
2364
  "get": {
2231
2365
  "tags": [
@@ -3918,6 +4052,505 @@
3918
4052
  }
3919
4053
  }
3920
4054
  },
4055
+ "/api/v1/transactions/by-external-id/{extPaymentId}": {
4056
+ "get": {
4057
+ "tags": [
4058
+ "Transactions"
4059
+ ],
4060
+ "parameters": [
4061
+ {
4062
+ "schema": {
4063
+ "type": "string"
4064
+ },
4065
+ "in": "path",
4066
+ "name": "extPaymentId",
4067
+ "required": true
4068
+ }
4069
+ ],
4070
+ "responses": {
4071
+ "200": {
4072
+ "description": "Default Response",
4073
+ "content": {
4074
+ "application/json": {
4075
+ "schema": {
4076
+ "type": "object",
4077
+ "properties": {
4078
+ "data": {
4079
+ "type": "object",
4080
+ "properties": {
4081
+ "transactionId": {
4082
+ "type": "string"
4083
+ },
4084
+ "status": {
4085
+ "anyOf": [
4086
+ {
4087
+ "type": "string",
4088
+ "enum": [
4089
+ "initiated"
4090
+ ]
4091
+ },
4092
+ {
4093
+ "type": "string",
4094
+ "enum": [
4095
+ "pending"
4096
+ ]
4097
+ },
4098
+ {
4099
+ "type": "string",
4100
+ "enum": [
4101
+ "succeeded"
4102
+ ]
4103
+ },
4104
+ {
4105
+ "type": "string",
4106
+ "enum": [
4107
+ "cancelled"
4108
+ ]
4109
+ },
4110
+ {
4111
+ "type": "string",
4112
+ "enum": [
4113
+ "failed"
4114
+ ]
4115
+ }
4116
+ ]
4117
+ },
4118
+ "amount": {
4119
+ "minimum": 1,
4120
+ "maximum": 1000000,
4121
+ "type": "number"
4122
+ },
4123
+ "extPaymentId": {
4124
+ "allOf": [
4125
+ {
4126
+ "type": "string"
4127
+ },
4128
+ {
4129
+ "type": "string"
4130
+ }
4131
+ ]
4132
+ },
4133
+ "paymentProviderId": {
4134
+ "type": "string"
4135
+ },
4136
+ "updatedAt": {
4137
+ "type": "string"
4138
+ },
4139
+ "title": {
4140
+ "type": "string"
4141
+ },
4142
+ "userId": {
4143
+ "type": "string"
4144
+ },
4145
+ "metadata": {
4146
+ "type": "object",
4147
+ "properties": {
4148
+ "name": {
4149
+ "type": "string"
4150
+ },
4151
+ "email": {
4152
+ "type": "string"
4153
+ },
4154
+ "runId": {
4155
+ "type": "string"
4156
+ },
4157
+ "journeyId": {
4158
+ "type": "string"
4159
+ },
4160
+ "journeyTitle": {
4161
+ "type": "string"
4162
+ }
4163
+ },
4164
+ "required": [
4165
+ "name",
4166
+ "email"
4167
+ ]
4168
+ },
4169
+ "description": {
4170
+ "type": "string"
4171
+ },
4172
+ "providerName": {
4173
+ "type": "string"
4174
+ },
4175
+ "providerType": {
4176
+ "type": "string"
4177
+ },
4178
+ "paymentRequestId": {
4179
+ "type": "string"
4180
+ }
4181
+ },
4182
+ "required": [
4183
+ "transactionId",
4184
+ "status",
4185
+ "amount",
4186
+ "extPaymentId",
4187
+ "paymentProviderId",
4188
+ "updatedAt",
4189
+ "title",
4190
+ "userId",
4191
+ "metadata",
4192
+ "description",
4193
+ "providerName",
4194
+ "providerType",
4195
+ "paymentRequestId"
4196
+ ]
4197
+ },
4198
+ "metadata": {
4199
+ "type": "object",
4200
+ "properties": {
4201
+ "links": {
4202
+ "description": "Object containing the links to the related endpoints",
4203
+ "type": "object",
4204
+ "properties": {
4205
+ "self": {
4206
+ "type": "object",
4207
+ "properties": {
4208
+ "href": {
4209
+ "description": "URL pointing to the request itself",
4210
+ "type": "string"
4211
+ }
4212
+ }
4213
+ },
4214
+ "next": {
4215
+ "type": "object",
4216
+ "properties": {
4217
+ "href": {
4218
+ "description": "URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted",
4219
+ "type": "string"
4220
+ }
4221
+ }
4222
+ },
4223
+ "prev": {
4224
+ "type": "object",
4225
+ "properties": {
4226
+ "href": {
4227
+ "description": "URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted",
4228
+ "type": "string"
4229
+ }
4230
+ }
4231
+ },
4232
+ "first": {
4233
+ "type": "object",
4234
+ "properties": {
4235
+ "href": {
4236
+ "description": "URL pointing to the first page of results in a paginated response",
4237
+ "type": "string"
4238
+ }
4239
+ }
4240
+ },
4241
+ "last": {
4242
+ "type": "object",
4243
+ "properties": {
4244
+ "href": {
4245
+ "description": "URL pointing to the first page of results in a paginated response",
4246
+ "type": "string"
4247
+ }
4248
+ }
4249
+ },
4250
+ "pages": {
4251
+ "description": "It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2'",
4252
+ "type": "object",
4253
+ "additionalProperties": {
4254
+ "type": "object",
4255
+ "properties": {
4256
+ "href": {
4257
+ "type": "string"
4258
+ }
4259
+ }
4260
+ }
4261
+ }
4262
+ },
4263
+ "required": [
4264
+ "self",
4265
+ "first",
4266
+ "last",
4267
+ "pages"
4268
+ ]
4269
+ },
4270
+ "totalCount": {
4271
+ "description": "Number representing the total number of available items",
4272
+ "type": "number"
4273
+ }
4274
+ }
4275
+ }
4276
+ },
4277
+ "required": [
4278
+ "data"
4279
+ ]
4280
+ }
4281
+ }
4282
+ }
4283
+ },
4284
+ "404": {
4285
+ "description": "Default Response",
4286
+ "content": {
4287
+ "application/json": {
4288
+ "schema": {
4289
+ "type": "object",
4290
+ "properties": {
4291
+ "code": {
4292
+ "type": "string"
4293
+ },
4294
+ "detail": {
4295
+ "type": "string"
4296
+ },
4297
+ "requestId": {
4298
+ "type": "string"
4299
+ },
4300
+ "name": {
4301
+ "type": "string"
4302
+ },
4303
+ "validation": {},
4304
+ "validationContext": {
4305
+ "type": "string"
4306
+ }
4307
+ },
4308
+ "required": [
4309
+ "code",
4310
+ "detail",
4311
+ "requestId",
4312
+ "name"
4313
+ ]
4314
+ }
4315
+ }
4316
+ }
4317
+ }
4318
+ }
4319
+ },
4320
+ "patch": {
4321
+ "tags": [
4322
+ "Transactions"
4323
+ ],
4324
+ "requestBody": {
4325
+ "content": {
4326
+ "application/json": {
4327
+ "schema": {
4328
+ "type": "object",
4329
+ "properties": {
4330
+ "status": {
4331
+ "anyOf": [
4332
+ {
4333
+ "type": "string",
4334
+ "enum": [
4335
+ "initiated"
4336
+ ]
4337
+ },
4338
+ {
4339
+ "type": "string",
4340
+ "enum": [
4341
+ "pending"
4342
+ ]
4343
+ },
4344
+ {
4345
+ "type": "string",
4346
+ "enum": [
4347
+ "succeeded"
4348
+ ]
4349
+ },
4350
+ {
4351
+ "type": "string",
4352
+ "enum": [
4353
+ "cancelled"
4354
+ ]
4355
+ },
4356
+ {
4357
+ "type": "string",
4358
+ "enum": [
4359
+ "failed"
4360
+ ]
4361
+ }
4362
+ ]
4363
+ }
4364
+ },
4365
+ "required": [
4366
+ "status"
4367
+ ]
4368
+ }
4369
+ }
4370
+ },
4371
+ "required": true
4372
+ },
4373
+ "parameters": [
4374
+ {
4375
+ "schema": {
4376
+ "type": "string"
4377
+ },
4378
+ "in": "path",
4379
+ "name": "extPaymentId",
4380
+ "required": true
4381
+ }
4382
+ ],
4383
+ "responses": {
4384
+ "200": {
4385
+ "description": "Default Response",
4386
+ "content": {
4387
+ "application/json": {
4388
+ "schema": {
4389
+ "type": "object",
4390
+ "properties": {
4391
+ "data": {
4392
+ "type": "object",
4393
+ "properties": {
4394
+ "transactionId": {
4395
+ "type": "string"
4396
+ },
4397
+ "paymentRequestId": {
4398
+ "type": "string"
4399
+ },
4400
+ "metadata": {
4401
+ "type": "object",
4402
+ "properties": {
4403
+ "name": {
4404
+ "type": "string"
4405
+ },
4406
+ "email": {
4407
+ "type": "string"
4408
+ },
4409
+ "runId": {
4410
+ "type": "string"
4411
+ },
4412
+ "journeyId": {
4413
+ "type": "string"
4414
+ },
4415
+ "journeyTitle": {
4416
+ "type": "string"
4417
+ }
4418
+ },
4419
+ "required": [
4420
+ "name",
4421
+ "email"
4422
+ ]
4423
+ }
4424
+ },
4425
+ "required": [
4426
+ "transactionId",
4427
+ "paymentRequestId",
4428
+ "metadata"
4429
+ ]
4430
+ },
4431
+ "metadata": {
4432
+ "type": "object",
4433
+ "properties": {
4434
+ "links": {
4435
+ "description": "Object containing the links to the related endpoints",
4436
+ "type": "object",
4437
+ "properties": {
4438
+ "self": {
4439
+ "type": "object",
4440
+ "properties": {
4441
+ "href": {
4442
+ "description": "URL pointing to the request itself",
4443
+ "type": "string"
4444
+ }
4445
+ }
4446
+ },
4447
+ "next": {
4448
+ "type": "object",
4449
+ "properties": {
4450
+ "href": {
4451
+ "description": "URL pointing to the next page of results in a paginated response. If there are no more results, this field may be omitted",
4452
+ "type": "string"
4453
+ }
4454
+ }
4455
+ },
4456
+ "prev": {
4457
+ "type": "object",
4458
+ "properties": {
4459
+ "href": {
4460
+ "description": "URL pointing to the previous page of results in a paginated response. If there are no more results, this field may be omitted",
4461
+ "type": "string"
4462
+ }
4463
+ }
4464
+ },
4465
+ "first": {
4466
+ "type": "object",
4467
+ "properties": {
4468
+ "href": {
4469
+ "description": "URL pointing to the first page of results in a paginated response",
4470
+ "type": "string"
4471
+ }
4472
+ }
4473
+ },
4474
+ "last": {
4475
+ "type": "object",
4476
+ "properties": {
4477
+ "href": {
4478
+ "description": "URL pointing to the first page of results in a paginated response",
4479
+ "type": "string"
4480
+ }
4481
+ }
4482
+ },
4483
+ "pages": {
4484
+ "description": "It may contain a list of other useful URLs, e.g. one entry for page:'page 1', 'page 2'",
4485
+ "type": "object",
4486
+ "additionalProperties": {
4487
+ "type": "object",
4488
+ "properties": {
4489
+ "href": {
4490
+ "type": "string"
4491
+ }
4492
+ }
4493
+ }
4494
+ }
4495
+ },
4496
+ "required": [
4497
+ "self",
4498
+ "first",
4499
+ "last",
4500
+ "pages"
4501
+ ]
4502
+ },
4503
+ "totalCount": {
4504
+ "description": "Number representing the total number of available items",
4505
+ "type": "number"
4506
+ }
4507
+ }
4508
+ }
4509
+ },
4510
+ "required": [
4511
+ "data"
4512
+ ]
4513
+ }
4514
+ }
4515
+ }
4516
+ },
4517
+ "500": {
4518
+ "description": "Default Response",
4519
+ "content": {
4520
+ "application/json": {
4521
+ "schema": {
4522
+ "type": "object",
4523
+ "properties": {
4524
+ "code": {
4525
+ "type": "string"
4526
+ },
4527
+ "detail": {
4528
+ "type": "string"
4529
+ },
4530
+ "requestId": {
4531
+ "type": "string"
4532
+ },
4533
+ "name": {
4534
+ "type": "string"
4535
+ },
4536
+ "validation": {},
4537
+ "validationContext": {
4538
+ "type": "string"
4539
+ }
4540
+ },
4541
+ "required": [
4542
+ "code",
4543
+ "detail",
4544
+ "requestId",
4545
+ "name"
4546
+ ]
4547
+ }
4548
+ }
4549
+ }
4550
+ }
4551
+ }
4552
+ }
4553
+ },
3921
4554
  "/api/v1/transactions/": {
3922
4555
  "get": {
3923
4556
  "tags": [