budgea_client 2.0.0 → 2.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (88) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/README.md +17 -0
  4. data/Rakefile +1 -5
  5. data/budgea_openapi.json +748 -63
  6. data/docs/Account.md +2 -0
  7. data/docs/AdministrationApi.md +497 -4
  8. data/docs/AuthenticationApi.md +2 -0
  9. data/docs/BanksApi.md +165 -48
  10. data/docs/ConnectionsApi.md +14 -12
  11. data/docs/Connector.md +2 -0
  12. data/docs/DocumentsApi.md +26 -26
  13. data/docs/InlineResponse20013.md +1 -1
  14. data/docs/InlineResponse20014.md +1 -1
  15. data/docs/InlineResponse20015.md +1 -1
  16. data/docs/InlineResponse20016.md +1 -1
  17. data/docs/InlineResponse20017.md +1 -1
  18. data/docs/InlineResponse20018.md +1 -1
  19. data/docs/InlineResponse20019.md +1 -1
  20. data/docs/InlineResponse20020.md +1 -1
  21. data/docs/InlineResponse20021.md +1 -1
  22. data/docs/InlineResponse20022.md +1 -1
  23. data/docs/InlineResponse20023.md +1 -1
  24. data/docs/InlineResponse20024.md +1 -1
  25. data/docs/InlineResponse20025.md +1 -1
  26. data/docs/InlineResponse20026.md +1 -1
  27. data/docs/InlineResponse20027.md +1 -1
  28. data/docs/InlineResponse20028.md +1 -1
  29. data/docs/InlineResponse20029.md +1 -1
  30. data/docs/InlineResponse20030.md +1 -1
  31. data/docs/InlineResponse20031.md +1 -1
  32. data/docs/InlineResponse20032.md +1 -1
  33. data/docs/InlineResponse20033.md +1 -1
  34. data/docs/InlineResponse20034.md +1 -1
  35. data/docs/InlineResponse20035.md +1 -1
  36. data/docs/InlineResponse20036.md +1 -1
  37. data/docs/PFMApi.md +10 -10
  38. data/docs/ProvidersApi.md +38 -38
  39. data/docs/TermsApi.md +4 -4
  40. data/docs/Transaction.md +1 -1
  41. data/docs/TransfersApi.md +43 -25
  42. data/docs/UsersManagementApi.md +4 -4
  43. data/docs/WealthApi.md +18 -18
  44. data/docs/Webhook.md +2 -0
  45. data/lib/budgea_client/api/administration_api.rb +506 -6
  46. data/lib/budgea_client/api/authentication_api.rb +3 -0
  47. data/lib/budgea_client/api/banks_api.rb +183 -72
  48. data/lib/budgea_client/api/connections_api.rb +21 -18
  49. data/lib/budgea_client/api/documents_api.rb +39 -39
  50. data/lib/budgea_client/api/pfm_api.rb +15 -15
  51. data/lib/budgea_client/api/providers_api.rb +57 -57
  52. data/lib/budgea_client/api/terms_api.rb +6 -6
  53. data/lib/budgea_client/api/transfers_api.rb +63 -36
  54. data/lib/budgea_client/api/users_management_api.rb +6 -6
  55. data/lib/budgea_client/api/wealth_api.rb +27 -27
  56. data/lib/budgea_client/models/account.rb +24 -4
  57. data/lib/budgea_client/models/connector.rb +26 -1
  58. data/lib/budgea_client/models/inline_response_200_13.rb +11 -11
  59. data/lib/budgea_client/models/inline_response_200_14.rb +11 -11
  60. data/lib/budgea_client/models/inline_response_200_15.rb +11 -11
  61. data/lib/budgea_client/models/inline_response_200_16.rb +11 -11
  62. data/lib/budgea_client/models/inline_response_200_17.rb +11 -11
  63. data/lib/budgea_client/models/inline_response_200_18.rb +11 -11
  64. data/lib/budgea_client/models/inline_response_200_19.rb +11 -11
  65. data/lib/budgea_client/models/inline_response_200_20.rb +11 -11
  66. data/lib/budgea_client/models/inline_response_200_21.rb +11 -11
  67. data/lib/budgea_client/models/inline_response_200_22.rb +11 -11
  68. data/lib/budgea_client/models/inline_response_200_23.rb +11 -11
  69. data/lib/budgea_client/models/inline_response_200_24.rb +11 -11
  70. data/lib/budgea_client/models/inline_response_200_25.rb +11 -11
  71. data/lib/budgea_client/models/inline_response_200_26.rb +11 -11
  72. data/lib/budgea_client/models/inline_response_200_27.rb +11 -11
  73. data/lib/budgea_client/models/inline_response_200_28.rb +11 -11
  74. data/lib/budgea_client/models/inline_response_200_29.rb +11 -11
  75. data/lib/budgea_client/models/inline_response_200_30.rb +11 -11
  76. data/lib/budgea_client/models/inline_response_200_31.rb +11 -11
  77. data/lib/budgea_client/models/inline_response_200_32.rb +11 -11
  78. data/lib/budgea_client/models/inline_response_200_33.rb +11 -11
  79. data/lib/budgea_client/models/inline_response_200_34.rb +11 -11
  80. data/lib/budgea_client/models/inline_response_200_35.rb +11 -11
  81. data/lib/budgea_client/models/inline_response_200_36.rb +11 -11
  82. data/lib/budgea_client/models/transaction.rb +11 -18
  83. data/lib/budgea_client/models/webhook.rb +24 -4
  84. data/lib/budgea_client/version.rb +1 -1
  85. data/lib/budgea_client.rb +7 -0
  86. data/original_budgea_openapi.json +771 -142
  87. data/pkg/budgea_client-2.0.1.gem +0 -0
  88. metadata +4 -3
data/budgea_openapi.json CHANGED
@@ -869,6 +869,13 @@
869
869
  "name": "type",
870
870
  "description": "to target a specific account type which will be"
871
871
  },
872
+ {
873
+ "required": false,
874
+ "in": "query",
875
+ "type": "integer",
876
+ "name": "occurrences",
877
+ "description": "require at least N accounts of the targeted"
878
+ },
872
879
  {
873
880
  "required": false,
874
881
  "type": "string",
@@ -1047,6 +1054,63 @@
1047
1054
  "summary": "Get all categories"
1048
1055
  }
1049
1056
  },
1057
+ "/categories/keywords": {
1058
+ "post": {
1059
+ "responses": {
1060
+ "200": {
1061
+ "description": "Successful POST on Keyword resource",
1062
+ "schema": {
1063
+ "$ref": "#/definitions/Keyword"
1064
+ }
1065
+ }
1066
+ },
1067
+ "tags": [
1068
+ "Banks"
1069
+ ],
1070
+ "description": "If the keyword already exists the keyword is not added. Used for the categorization of transactions.<br><br>Form params: - id_category (integer): a reference towards the category associated with the keyword - keyword (string): the searched keyword - income (bool): 1 if the associated category represents an income else 0 - priority (integer): sets the priority for the keyword, used when categorizing<br><br>",
1071
+ "parameters": [
1072
+ {
1073
+ "required": false,
1074
+ "type": "string",
1075
+ "name": "expand",
1076
+ "in": "query"
1077
+ }
1078
+ ],
1079
+ "summary": "Add a new keyword associated with a category in the database."
1080
+ }
1081
+ },
1082
+ "/categories/keywords/{id_keyword}": {
1083
+ "delete": {
1084
+ "responses": {
1085
+ "200": {
1086
+ "description": "Successful DELETE on Keyword resource",
1087
+ "schema": {
1088
+ "$ref": "#/definitions/Keyword"
1089
+ }
1090
+ }
1091
+ },
1092
+ "tags": [
1093
+ "Banks"
1094
+ ],
1095
+ "description": "",
1096
+ "parameters": [
1097
+ {
1098
+ "required": true,
1099
+ "in": "path",
1100
+ "type": "integer",
1101
+ "name": "id_keyword",
1102
+ "description": ""
1103
+ },
1104
+ {
1105
+ "required": false,
1106
+ "type": "string",
1107
+ "name": "expand",
1108
+ "in": "query"
1109
+ }
1110
+ ],
1111
+ "summary": "Delete a particular key-value pair on a transaction."
1112
+ }
1113
+ },
1050
1114
  "/categorize": {
1051
1115
  "post": {
1052
1116
  "responses": {
@@ -1522,6 +1586,72 @@
1522
1586
  "summary": "Set a configuration value on the API."
1523
1587
  }
1524
1588
  },
1589
+ "/config/logs": {
1590
+ "get": {
1591
+ "responses": {
1592
+ "200": {
1593
+ "description": "configlogs",
1594
+ "schema": {
1595
+ "required": [
1596
+ "configlogs"
1597
+ ],
1598
+ "type": "object",
1599
+ "properties": {
1600
+ "configlogs": {
1601
+ "items": {
1602
+ "$ref": "#/definitions/ConfigLog"
1603
+ },
1604
+ "type": "array"
1605
+ }
1606
+ }
1607
+ }
1608
+ }
1609
+ },
1610
+ "tags": [
1611
+ "Administration"
1612
+ ],
1613
+ "description": "<br><br>",
1614
+ "parameters": [
1615
+ {
1616
+ "required": false,
1617
+ "in": "query",
1618
+ "type": "string",
1619
+ "name": "search",
1620
+ "description": "limit the results to keys matching the given value"
1621
+ },
1622
+ {
1623
+ "required": false,
1624
+ "in": "query",
1625
+ "type": "string",
1626
+ "name": "type",
1627
+ "description": "type of change done on the configuration"
1628
+ },
1629
+ {
1630
+ "name": "min_date",
1631
+ "format": "date",
1632
+ "required": false,
1633
+ "in": "query",
1634
+ "type": "string",
1635
+ "description": "minimal date of the change"
1636
+ },
1637
+ {
1638
+ "name": "max_date",
1639
+ "format": "date",
1640
+ "required": false,
1641
+ "in": "query",
1642
+ "type": "string",
1643
+ "description": "maximum date of the change"
1644
+ },
1645
+ {
1646
+ "required": false,
1647
+ "type": "string",
1648
+ "name": "expand",
1649
+ "in": "query"
1650
+ }
1651
+ ],
1652
+ "summary": "Get configuration change history of the API."
1653
+ }
1654
+ },
1525
1655
  "/connections": {
1526
1656
  "get": {
1527
1657
  "responses": {
@@ -1614,13 +1744,6 @@
1614
1744
  ],
1615
1745
  "description": "Send a request to add a new connector<br><br>",
1616
1746
  "parameters": [
1617
- {
1618
- "required": false,
1619
- "in": "formData",
1620
- "type": "string",
1621
- "name": "api",
1622
- "description": "Name of the API"
1623
- },
1624
1747
  {
1625
1748
  "required": true,
1626
1749
  "in": "formData",
@@ -4223,6 +4346,60 @@
4223
4346
  "type": "string",
4224
4347
  "name": "expand",
4225
4348
  "in": "query"
4349
+ },
4350
+ {
4351
+ "required": false,
4352
+ "type": "string",
4353
+ "name": "category",
4354
+ "in": "query"
4355
+ },
4356
+ {
4357
+ "required": false,
4358
+ "type": "string",
4359
+ "name": "bank_name",
4360
+ "in": "query"
4361
+ },
4362
+ {
4363
+ "required": false,
4364
+ "type": "string",
4365
+ "name": "deleted",
4366
+ "in": "query"
4367
+ },
4368
+ {
4369
+ "required": false,
4370
+ "type": "string",
4371
+ "name": "bic",
4372
+ "in": "query"
4373
+ },
4374
+ {
4375
+ "required": false,
4376
+ "type": "string",
4377
+ "name": "label",
4378
+ "in": "query"
4379
+ },
4380
+ {
4381
+ "required": false,
4382
+ "type": "string",
4383
+ "name": "state",
4384
+ "in": "query"
4385
+ },
4386
+ {
4387
+ "required": false,
4388
+ "type": "string",
4389
+ "name": "iban",
4390
+ "in": "query"
4391
+ },
4392
+ {
4393
+ "required": false,
4394
+ "type": "string",
4395
+ "name": "error",
4396
+ "in": "query"
4397
+ },
4398
+ {
4399
+ "required": false,
4400
+ "type": "string",
4401
+ "name": "id",
4402
+ "in": "query"
4226
4403
  }
4227
4404
  ],
4228
4405
  "summary": "Returns the list of recipients."
@@ -7297,6 +7474,13 @@
7297
7474
  "name": "id_connector",
7298
7475
  "description": "ID of the connector"
7299
7476
  },
7477
+ {
7478
+ "required": false,
7479
+ "in": "formData",
7480
+ "type": "string",
7481
+ "name": "connector_uuid",
7482
+ "description": "optional uuid of the connector (replaces id_connector)"
7483
+ },
7300
7484
  {
7301
7485
  "required": false,
7302
7486
  "in": "formData",
@@ -20238,6 +20422,13 @@
20238
20422
  "name": "id_connector",
20239
20423
  "description": "ID of the connector"
20240
20424
  },
20425
+ {
20426
+ "required": false,
20427
+ "in": "formData",
20428
+ "type": "string",
20429
+ "name": "connector_uuid",
20430
+ "description": "Optional unique ID of the connector (replaces id_connector)"
20431
+ },
20241
20432
  {
20242
20433
  "required": false,
20243
20434
  "in": "formData",
@@ -20340,6 +20531,13 @@
20340
20531
  "name": "id_service",
20341
20532
  "description": "The service ID to associate with the webhook"
20342
20533
  },
20534
+ {
20535
+ "required": false,
20536
+ "in": "formData",
20537
+ "type": "string",
20538
+ "name": "id_auth",
20539
+ "description": "The webhook authentication process to use (its ID or its name)"
20540
+ },
20343
20541
  {
20344
20542
  "name": "url",
20345
20543
  "format": "float",
@@ -20395,13 +20593,24 @@
20395
20593
  "summary": "Deletes all webhooks"
20396
20594
  }
20397
20595
  },
20398
- "/webhooks/{id_webhook}": {
20399
- "post": {
20596
+ "/webhooks/auth": {
20597
+ "get": {
20400
20598
  "responses": {
20401
20599
  "200": {
20402
- "description": "Successful POST on Webhook resource",
20600
+ "description": "authproviders",
20403
20601
  "schema": {
20404
- "$ref": "#/definitions/Webhook"
20602
+ "required": [
20603
+ "authproviders"
20604
+ ],
20605
+ "type": "object",
20606
+ "properties": {
20607
+ "authproviders": {
20608
+ "items": {
20609
+ "$ref": "#/definitions/AuthProvider"
20610
+ },
20611
+ "type": "array"
20612
+ }
20613
+ }
20405
20614
  }
20406
20615
  }
20407
20616
  },
@@ -20410,48 +20619,49 @@
20410
20619
  ],
20411
20620
  "description": "",
20412
20621
  "parameters": [
20413
- {
20414
- "required": true,
20415
- "in": "path",
20416
- "type": "integer",
20417
- "name": "id_webhook",
20418
- "description": ""
20419
- },
20420
20622
  {
20421
20623
  "required": false,
20422
- "in": "formData",
20423
20624
  "type": "string",
20424
- "name": "deleted",
20425
- "description": "a date to delete the webhook or 'null' to enable it"
20426
- },
20427
- {
20428
- "required": false,
20429
- "in": "formData",
20430
- "type": "integer",
20431
- "name": "id_user",
20432
- "description": "The user ID to associate with the webhook"
20433
- },
20625
+ "name": "expand",
20626
+ "in": "query"
20627
+ }
20628
+ ],
20629
+ "summary": "Get webhooks authentication types"
20630
+ },
20631
+ "post": {
20632
+ "responses": {
20633
+ "200": {
20634
+ "description": "Successful POST on AuthProvider resource",
20635
+ "schema": {
20636
+ "$ref": "#/definitions/AuthProvider"
20637
+ }
20638
+ }
20639
+ },
20640
+ "tags": [
20641
+ "Administration"
20642
+ ],
20643
+ "description": "",
20644
+ "parameters": [
20434
20645
  {
20435
- "required": false,
20646
+ "required": true,
20436
20647
  "in": "formData",
20437
20648
  "type": "integer",
20438
- "name": "id_service",
20439
- "description": "The service ID to associate with the webhook"
20649
+ "name": "type",
20650
+ "description": "The type of the authentication process (oauth, certificate, token, etc...)"
20440
20651
  },
20441
20652
  {
20442
- "name": "url",
20443
- "format": "float",
20444
- "required": false,
20653
+ "required": true,
20445
20654
  "in": "formData",
20446
- "type": "number",
20447
- "description": "The webhook callback url"
20655
+ "type": "string",
20656
+ "name": "name",
20657
+ "description": "The name of the authentication process to differentiate"
20448
20658
  },
20449
20659
  {
20450
20660
  "required": false,
20451
20661
  "in": "formData",
20452
20662
  "type": "string",
20453
- "name": "event",
20454
- "description": "The webhook event"
20663
+ "name": "config",
20664
+ "description": "The authentication process configuration. A dict contains either the certificate"
20455
20665
  },
20456
20666
  {
20457
20667
  "required": false,
@@ -20460,14 +20670,14 @@
20460
20670
  "in": "query"
20461
20671
  }
20462
20672
  ],
20463
- "summary": "Updates a webhook"
20673
+ "summary": "Adds a new webhook authentication type"
20464
20674
  },
20465
- "put": {
20675
+ "delete": {
20466
20676
  "responses": {
20467
20677
  "200": {
20468
- "description": "Successful PUT on Webhook resource",
20678
+ "description": "Successful DELETE on AuthProvider resource",
20469
20679
  "schema": {
20470
- "$ref": "#/definitions/Webhook"
20680
+ "$ref": "#/definitions/AuthProvider"
20471
20681
  }
20472
20682
  }
20473
20683
  },
@@ -20476,16 +20686,175 @@
20476
20686
  ],
20477
20687
  "description": "",
20478
20688
  "parameters": [
20479
- {
20480
- "required": true,
20481
- "in": "path",
20482
- "type": "integer",
20483
- "name": "id_webhook",
20484
- "description": ""
20485
- },
20486
20689
  {
20487
20690
  "required": false,
20488
- "in": "formData",
20691
+ "type": "string",
20692
+ "name": "expand",
20693
+ "in": "query"
20694
+ }
20695
+ ],
20696
+ "summary": "Deletes all webhook authentication types"
20697
+ }
20698
+ },
20699
+ "/webhooks/auth/{id_auth}": {
20700
+ "post": {
20701
+ "responses": {
20702
+ "200": {
20703
+ "description": "Successful POST on AuthProvider resource",
20704
+ "schema": {
20705
+ "$ref": "#/definitions/AuthProvider"
20706
+ }
20707
+ }
20708
+ },
20709
+ "tags": [
20710
+ "Administration"
20711
+ ],
20712
+ "description": "",
20713
+ "parameters": [
20714
+ {
20715
+ "required": true,
20716
+ "in": "path",
20717
+ "type": "integer",
20718
+ "name": "id_auth",
20719
+ "description": ""
20720
+ },
20721
+ {
20722
+ "required": true,
20723
+ "in": "formData",
20724
+ "type": "integer",
20725
+ "name": "type",
20726
+ "description": "The type of the authentication process (oauth, certificate, token, etc...)"
20727
+ },
20728
+ {
20729
+ "required": true,
20730
+ "in": "formData",
20731
+ "type": "string",
20732
+ "name": "name",
20733
+ "description": "The name of the authentication process to differentiate"
20734
+ },
20735
+ {
20736
+ "required": false,
20737
+ "in": "formData",
20738
+ "type": "string",
20739
+ "name": "config",
20740
+ "description": "The authentication process configuration. A dict containing either the certificate"
20741
+ },
20742
+ {
20743
+ "required": false,
20744
+ "type": "string",
20745
+ "name": "expand",
20746
+ "in": "query"
20747
+ }
20748
+ ],
20749
+ "summary": "Updates the webhook authentication type"
20750
+ },
20751
+ "put": {
20752
+ "responses": {
20753
+ "200": {
20754
+ "description": "Successful PUT on AuthProvider resource",
20755
+ "schema": {
20756
+ "$ref": "#/definitions/AuthProvider"
20757
+ }
20758
+ }
20759
+ },
20760
+ "tags": [
20761
+ "Administration"
20762
+ ],
20763
+ "description": "",
20764
+ "parameters": [
20765
+ {
20766
+ "required": true,
20767
+ "in": "path",
20768
+ "type": "integer",
20769
+ "name": "id_auth",
20770
+ "description": ""
20771
+ },
20772
+ {
20773
+ "required": true,
20774
+ "in": "formData",
20775
+ "type": "integer",
20776
+ "name": "type",
20777
+ "description": "The type of the authentication process (oauth, certificate, token, etc...)"
20778
+ },
20779
+ {
20780
+ "required": true,
20781
+ "in": "formData",
20782
+ "type": "string",
20783
+ "name": "name",
20784
+ "description": "The name of the authentication process to differentiate"
20785
+ },
20786
+ {
20787
+ "required": false,
20788
+ "in": "formData",
20789
+ "type": "string",
20790
+ "name": "config",
20791
+ "description": "The authentication process configuration. A dict containt either the certificate"
20792
+ },
20793
+ {
20794
+ "required": false,
20795
+ "type": "string",
20796
+ "name": "expand",
20797
+ "in": "query"
20798
+ }
20799
+ ],
20800
+ "summary": "Updates the webhook authentication type"
20801
+ },
20802
+ "delete": {
20803
+ "responses": {
20804
+ "200": {
20805
+ "description": "Successful DELETE on AuthProvider resource",
20806
+ "schema": {
20807
+ "$ref": "#/definitions/AuthProvider"
20808
+ }
20809
+ }
20810
+ },
20811
+ "tags": [
20812
+ "Administration"
20813
+ ],
20814
+ "description": "Updates the deleted field with the date of the deletion<br><br>",
20815
+ "parameters": [
20816
+ {
20817
+ "required": true,
20818
+ "in": "path",
20819
+ "type": "integer",
20820
+ "name": "id_auth",
20821
+ "description": ""
20822
+ },
20823
+ {
20824
+ "required": false,
20825
+ "type": "string",
20826
+ "name": "expand",
20827
+ "in": "query"
20828
+ }
20829
+ ],
20830
+ "summary": "Deletes the webhook authentication type"
20831
+ }
20832
+ },
20833
+ "/webhooks/{id_webhook}": {
20834
+ "post": {
20835
+ "responses": {
20836
+ "200": {
20837
+ "description": "Successful POST on Webhook resource",
20838
+ "schema": {
20839
+ "$ref": "#/definitions/Webhook"
20840
+ }
20841
+ }
20842
+ },
20843
+ "tags": [
20844
+ "Administration"
20845
+ ],
20846
+ "description": "",
20847
+ "parameters": [
20848
+ {
20849
+ "required": true,
20850
+ "in": "path",
20851
+ "type": "integer",
20852
+ "name": "id_webhook",
20853
+ "description": ""
20854
+ },
20855
+ {
20856
+ "required": false,
20857
+ "in": "formData",
20489
20858
  "type": "string",
20490
20859
  "name": "deleted",
20491
20860
  "description": "a date to delete the webhook or 'null' to enable it"
@@ -20504,6 +20873,86 @@
20504
20873
  "name": "id_service",
20505
20874
  "description": "The service ID to associate with the webhook"
20506
20875
  },
20876
+ {
20877
+ "required": false,
20878
+ "in": "formData",
20879
+ "type": "integer",
20880
+ "name": "id_auth",
20881
+ "description": "The webhook authentication process to use"
20882
+ },
20883
+ {
20884
+ "name": "url",
20885
+ "format": "float",
20886
+ "required": false,
20887
+ "in": "formData",
20888
+ "type": "number",
20889
+ "description": "The webhook callback url"
20890
+ },
20891
+ {
20892
+ "required": false,
20893
+ "in": "formData",
20894
+ "type": "string",
20895
+ "name": "event",
20896
+ "description": "The webhook event"
20897
+ },
20898
+ {
20899
+ "required": false,
20900
+ "type": "string",
20901
+ "name": "expand",
20902
+ "in": "query"
20903
+ }
20904
+ ],
20905
+ "summary": "Updates a webhook"
20906
+ },
20907
+ "put": {
20908
+ "responses": {
20909
+ "200": {
20910
+ "description": "Successful PUT on Webhook resource",
20911
+ "schema": {
20912
+ "$ref": "#/definitions/Webhook"
20913
+ }
20914
+ }
20915
+ },
20916
+ "tags": [
20917
+ "Administration"
20918
+ ],
20919
+ "description": "",
20920
+ "parameters": [
20921
+ {
20922
+ "required": true,
20923
+ "in": "path",
20924
+ "type": "integer",
20925
+ "name": "id_webhook",
20926
+ "description": ""
20927
+ },
20928
+ {
20929
+ "required": false,
20930
+ "in": "formData",
20931
+ "type": "string",
20932
+ "name": "deleted",
20933
+ "description": "a date to delete the webhook or 'null' to enable it"
20934
+ },
20935
+ {
20936
+ "required": false,
20937
+ "in": "formData",
20938
+ "type": "integer",
20939
+ "name": "id_user",
20940
+ "description": "The user ID to associate with the webhook"
20941
+ },
20942
+ {
20943
+ "required": false,
20944
+ "in": "formData",
20945
+ "type": "integer",
20946
+ "name": "id_service",
20947
+ "description": "The service ID to associate with the webhook"
20948
+ },
20949
+ {
20950
+ "required": false,
20951
+ "in": "formData",
20952
+ "type": "integer",
20953
+ "name": "id_auth",
20954
+ "description": "The webhook authentication process to use"
20955
+ },
20507
20956
  {
20508
20957
  "name": "url",
20509
20958
  "format": "float",
@@ -20559,6 +21008,50 @@
20559
21008
  "summary": "Deletes a webhook"
20560
21009
  }
20561
21010
  },
21011
+ "/webhooks/{id_webhook}/add_to_data": {
21012
+ "get": {
21013
+ "responses": {
21014
+ "200": {
21015
+ "description": "standard HTTP response"
21016
+ }
21017
+ },
21018
+ "tags": [
21019
+ "Administration"
21020
+ ],
21021
+ "description": "",
21022
+ "parameters": [
21023
+ {
21024
+ "required": true,
21025
+ "in": "path",
21026
+ "type": "integer",
21027
+ "name": "id_webhook",
21028
+ "description": ""
21029
+ }
21030
+ ],
21031
+ "summary": "retrieve the list of the value to add in webhooks when sending the requested webhook"
21032
+ },
21033
+ "post": {
21034
+ "responses": {
21035
+ "200": {
21036
+ "description": "standard HTTP response"
21037
+ }
21038
+ },
21039
+ "tags": [
21040
+ "HUB"
21041
+ ],
21042
+ "description": "For each parameter, a value will be added in the webhook data. Use the key to set the name of the field. The values that can be added are to be found in the user configuration.<br><br>",
21043
+ "parameters": [
21044
+ {
21045
+ "required": true,
21046
+ "in": "path",
21047
+ "type": "integer",
21048
+ "name": "id_webhook",
21049
+ "description": ""
21050
+ }
21051
+ ],
21052
+ "summary": "Setup a field to store in user config when calling the endpoint"
21053
+ }
21054
+ },
20562
21055
  "/webhooks/{id_webhook}/logs": {
20563
21056
  "get": {
20564
21057
  "responses": {
@@ -20645,7 +21138,8 @@
20645
21138
  "name",
20646
21139
  "id_weboob",
20647
21140
  "charged",
20648
- "beta"
21141
+ "beta",
21142
+ "uuid"
20649
21143
  ],
20650
21144
  "type": "object",
20651
21145
  "properties": {
@@ -20705,6 +21199,14 @@
20705
21199
  "type": "string",
20706
21200
  "description": "Authentication mechanism to use"
20707
21201
  },
21202
+ "siret": {
21203
+ "type": "string",
21204
+ "description": "SIRET code for Bill modules"
21205
+ },
21206
+ "uuid": {
21207
+ "type": "string",
21208
+ "description": "Unique connector identifier"
21209
+ },
20708
21210
  "fields": {
20709
21211
  "type": "array",
20710
21212
  "items": {
@@ -20724,7 +21226,9 @@
20724
21226
  "slug": "",
20725
21227
  "sync_frequency": 0,
20726
21228
  "months_to_fetch": 0,
20727
- "auth_mechanism": ""
21229
+ "auth_mechanism": "",
21230
+ "siret": "",
21231
+ "uuid": ""
20728
21232
  }
20729
21233
  },
20730
21234
  "Field": {
@@ -20876,6 +21380,66 @@
20876
21380
  "platform": ""
20877
21381
  }
20878
21382
  },
21383
+ "Keyword": {
21384
+ "required": [
21385
+ "id",
21386
+ "keyword",
21387
+ "id_category",
21388
+ "priority",
21389
+ "income"
21390
+ ],
21391
+ "type": "object",
21392
+ "properties": {
21393
+ "id": {
21394
+ "type": "integer"
21395
+ },
21396
+ "keyword": {
21397
+ "type": "string"
21398
+ },
21399
+ "id_category": {
21400
+ "type": "integer"
21401
+ },
21402
+ "priority": {
21403
+ "type": "integer"
21404
+ },
21405
+ "income": {
21406
+ "type": "boolean"
21407
+ }
21408
+ },
21409
+ "example": {
21410
+ "id": 0,
21411
+ "keyword": "",
21412
+ "id_category": 0,
21413
+ "priority": 0,
21414
+ "income": false
21415
+ }
21416
+ },
21417
+ "AuthProvider": {
21418
+ "required": [
21419
+ "id",
21420
+ "name",
21421
+ "type"
21422
+ ],
21423
+ "type": "object",
21424
+ "properties": {
21425
+ "id": {
21426
+ "type": "integer"
21427
+ },
21428
+ "name": {
21429
+ "type": "string",
21430
+ "description": "Name to differentiate the authentication type"
21431
+ },
21432
+ "type": {
21433
+ "type": "string",
21434
+ "description": "Authentication type to use when pushing the webhook"
21435
+ }
21436
+ },
21437
+ "example": {
21438
+ "id": 0,
21439
+ "name": "",
21440
+ "type": ""
21441
+ }
21442
+ },
20879
21443
  "TermsOfService": {
20880
21444
  "required": [
20881
21445
  "id",
@@ -21159,9 +21723,17 @@
21159
21723
  "type": "integer",
21160
21724
  "description": "ID of the webhook event"
21161
21725
  },
21726
+ "id_auth": {
21727
+ "type": "integer",
21728
+ "description": "ID of the authentication process"
21729
+ },
21162
21730
  "url": {
21163
21731
  "type": "string",
21164
21732
  "description": "URL of the webhook"
21733
+ },
21734
+ "add_to_data": {
21735
+ "type": "string",
21736
+ "description": "json object to describe data to add"
21165
21737
  }
21166
21738
  },
21167
21739
  "example": {
@@ -21172,9 +21744,69 @@
21172
21744
  "id_service": 0,
21173
21745
  "id_user": 0,
21174
21746
  "id_event": 0,
21747
+ "id_auth": 0,
21175
21748
  "url": ""
21176
21749
  }
21177
21750
  },
21751
+ "WebhookData": {
21752
+ "required": [
21753
+ "id",
21754
+ "id_webhook",
21755
+ "id_user",
21756
+ "created"
21757
+ ],
21758
+ "type": "object",
21759
+ "properties": {
21760
+ "id": {
21761
+ "type": "integer",
21762
+ "description": "ID of the webhook data"
21763
+ },
21764
+ "id_webhook": {
21765
+ "type": "integer",
21766
+ "description": "ID of the webhook"
21767
+ },
21768
+ "id_service": {
21769
+ "type": "integer",
21770
+ "description": "ID of the recipient service"
21771
+ },
21772
+ "id_user": {
21773
+ "type": "integer",
21774
+ "description": "ID of the emitter user"
21775
+ },
21776
+ "id_resource": {
21777
+ "type": "integer",
21778
+ "description": "a changing ID used to filter webhookdata depending on the event triggered"
21779
+ },
21780
+ "data": {
21781
+ "type": "string",
21782
+ "description": "Data emitted"
21783
+ },
21784
+ "mimetype": {
21785
+ "type": "string",
21786
+ "description": "Mimetype of the data"
21787
+ },
21788
+ "created": {
21789
+ "type": "string",
21790
+ "description": "Timestamp when the hook data was generated",
21791
+ "format": "date-time"
21792
+ },
21793
+ "success": {
21794
+ "type": "string",
21795
+ "description": "Timestamp when the hook has been successfully called",
21796
+ "format": "date-time"
21797
+ }
21798
+ },
21799
+ "example": {
21800
+ "id": 0,
21801
+ "id_webhook": 0,
21802
+ "id_service": 0,
21803
+ "id_user": 0,
21804
+ "id_resource": 0,
21805
+ "mimetype": "",
21806
+ "created": "2019-06-28 14:51:56.345068",
21807
+ "success": "2019-06-28 14:51:56.345133"
21808
+ }
21809
+ },
21178
21810
  "WebhookLog": {
21179
21811
  "required": [
21180
21812
  "id",
@@ -21974,8 +22606,7 @@
21974
22606
  "date_scraped",
21975
22607
  "rdate",
21976
22608
  "coming",
21977
- "active",
21978
- "nopurge"
22609
+ "active"
21979
22610
  ],
21980
22611
  "type": "object",
21981
22612
  "properties": {
@@ -22056,6 +22687,11 @@
22056
22687
  "description": "Value date of the transaction",
22057
22688
  "format": "date"
22058
22689
  },
22690
+ "bdate": {
22691
+ "type": "string",
22692
+ "description": "Date used by the bank for the transaction",
22693
+ "format": "date"
22694
+ },
22059
22695
  "coming": {
22060
22696
  "type": "boolean",
22061
22697
  "description": "If true, this transaction hasn't been yet debited"
@@ -22083,11 +22719,6 @@
22083
22719
  "description": "If set, this transaction has been removed from the bank",
22084
22720
  "format": "date-time"
22085
22721
  },
22086
- "nopurge": {
22087
- "default": false,
22088
- "type": "boolean",
22089
- "description": "If set to true, this transaction will never be considered as deleted"
22090
- },
22091
22722
  "original_value": {
22092
22723
  "type": "number",
22093
22724
  "description": "Value in the original currency",
@@ -22134,13 +22765,13 @@
22134
22765
  "date_scraped": "2019-03-12 13:08:00.787303",
22135
22766
  "rdate": "2019-03-12",
22136
22767
  "vdate": "2019-03-12",
22768
+ "bdate": "2019-06-28",
22137
22769
  "coming": false,
22138
22770
  "active": true,
22139
22771
  "id_cluster": 0,
22140
22772
  "comment": "",
22141
22773
  "last_update": "2019-03-12 13:08:00.787854",
22142
22774
  "deleted": "2019-03-12 13:08:00.787941",
22143
- "nopurge": false,
22144
22775
  "original_value": 0,
22145
22776
  "original_currency": "",
22146
22777
  "commission": 0,
@@ -22560,6 +23191,10 @@
22560
23191
  "type": "string",
22561
23192
  "description": "Account number"
22562
23193
  },
23194
+ "webid": {
23195
+ "type": "string",
23196
+ "description": "Account webid"
23197
+ },
22563
23198
  "original_name": {
22564
23199
  "type": "string",
22565
23200
  "description": "Original name of the account on the bank"
@@ -22633,6 +23268,10 @@
22633
23268
  "usage": {
22634
23269
  "type": "string",
22635
23270
  "description": "Account usage"
23271
+ },
23272
+ "ownership": {
23273
+ "type": "string",
23274
+ "description": "Relationship between the credentials owner and the account"
22636
23275
  }
22637
23276
  },
22638
23277
  "example": {
@@ -22641,6 +23280,7 @@
22641
23280
  "id_user": 0,
22642
23281
  "id_parent": 0,
22643
23282
  "number": "",
23283
+ "webid": "",
22644
23284
  "original_name": "",
22645
23285
  "balance": 0,
22646
23286
  "coming": 0,
@@ -22654,7 +23294,8 @@
22654
23294
  "bookmarked": false,
22655
23295
  "name": "",
22656
23296
  "error": "",
22657
- "usage": ""
23297
+ "usage": "",
23298
+ "ownership": ""
22658
23299
  }
22659
23300
  },
22660
23301
  "Project": {
@@ -23299,6 +23940,47 @@
23299
23940
  "worker": ""
23300
23941
  }
23301
23942
  },
23943
+ "ConfigLog": {
23944
+ "required": [
23945
+ "id",
23946
+ "key",
23947
+ "type",
23948
+ "timestamp"
23949
+ ],
23950
+ "type": "object",
23951
+ "properties": {
23952
+ "id": {
23953
+ "type": "integer"
23954
+ },
23955
+ "key": {
23956
+ "type": "string"
23957
+ },
23958
+ "previous_value": {
23959
+ "type": "string"
23960
+ },
23961
+ "new_value": {
23962
+ "type": "string"
23963
+ },
23964
+ "type": {
23965
+ "type": "string",
23966
+ "description": "Action done on the config: add, update or delete"
23967
+ },
23968
+ "timestamp": {
23969
+ "default": "CURRENT_TIMESTAMP",
23970
+ "type": "string",
23971
+ "description": "Timestamp of when the configuration key was changed",
23972
+ "format": "date-time"
23973
+ }
23974
+ },
23975
+ "example": {
23976
+ "id": 0,
23977
+ "key": "",
23978
+ "previous_value": "",
23979
+ "new_value": "",
23980
+ "type": "",
23981
+ "timestamp": "CURRENT_TIMESTAMP"
23982
+ }
23983
+ },
23302
23984
  "OidcWhitelist": {
23303
23985
  "required": [
23304
23986
  "id",
@@ -23342,6 +24024,9 @@
23342
24024
  {
23343
24025
  "name": "Documents"
23344
24026
  },
24027
+ {
24028
+ "name": "HUB"
24029
+ },
23345
24030
  {
23346
24031
  "name": "OCR"
23347
24032
  },
@@ -23399,4 +24084,4 @@
23399
24084
  "api_key": []
23400
24085
  }
23401
24086
  ]
23402
- }
24087
+ }