@regulaforensics/facesdk-webclient 5.1.0 → 5.2.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 (253) hide show
  1. package/.github/workflows/run-smoke-test.yml +0 -3
  2. package/.github/workflows/trivy-scan.yaml +24 -0
  3. package/dist/cjs-es5/api/diagnostics-api.js +199 -0
  4. package/dist/cjs-es5/api/group-api.js +60 -60
  5. package/dist/cjs-es5/api/liveness20-api.js +14 -245
  6. package/dist/cjs-es5/api/matching-api.js +21 -21
  7. package/dist/cjs-es5/api/person-api.js +96 -189
  8. package/dist/cjs-es5/api/search-api.js +10 -10
  9. package/dist/cjs-es5/api.js +3 -2
  10. package/dist/cjs-es5/base.js +1 -1
  11. package/dist/cjs-es5/common.js +1 -1
  12. package/dist/cjs-es5/configuration.js +1 -1
  13. package/dist/cjs-es5/ext/person-api.js +1 -4
  14. package/dist/cjs-es5/models/crop.js +1 -1
  15. package/dist/cjs-es5/models/detect-request-attributes.js +16 -0
  16. package/dist/cjs-es5/models/detect-request.js +1 -1
  17. package/dist/cjs-es5/models/detect-response-all-of.js +1 -1
  18. package/dist/cjs-es5/models/detect-response.js +1 -1
  19. package/dist/cjs-es5/models/detect-result.js +1 -1
  20. package/dist/cjs-es5/models/detection-face.js +1 -1
  21. package/dist/cjs-es5/models/detection-quality.js +1 -1
  22. package/dist/cjs-es5/models/detection.js +1 -1
  23. package/dist/cjs-es5/models/face-attribute.js +37 -0
  24. package/dist/cjs-es5/models/face-image-quality-align-type.js +1 -1
  25. package/dist/cjs-es5/models/face-image-quality-groups.js +1 -1
  26. package/dist/cjs-es5/models/face-image-quality-status.js +1 -1
  27. package/dist/cjs-es5/models/face-quality-config-name.js +5 -4
  28. package/dist/cjs-es5/models/face-quality-scenarios.js +2 -2
  29. package/dist/cjs-es5/models/face-sdkresult-code.js +27 -26
  30. package/dist/cjs-es5/models/face-sdkresult.js +1 -1
  31. package/dist/cjs-es5/models/faces-response-all-of.js +1 -1
  32. package/dist/cjs-es5/models/faces-response.js +1 -1
  33. package/dist/cjs-es5/models/group-all-of.js +1 -1
  34. package/dist/cjs-es5/models/group-page-all-of.js +1 -1
  35. package/dist/cjs-es5/models/group-page.js +1 -1
  36. package/dist/cjs-es5/models/group-to-create.js +1 -1
  37. package/dist/cjs-es5/models/group.js +1 -1
  38. package/dist/cjs-es5/models/image-fields-image.js +1 -1
  39. package/dist/cjs-es5/models/image-fields.js +1 -1
  40. package/dist/cjs-es5/models/image-page-all-of.js +1 -1
  41. package/dist/cjs-es5/models/image-page.js +1 -1
  42. package/dist/cjs-es5/models/image-source.js +2 -2
  43. package/dist/cjs-es5/models/image.js +1 -1
  44. package/dist/cjs-es5/models/index.js +9 -2
  45. package/dist/cjs-es5/models/match-and-search-request-all-of-images.js +1 -1
  46. package/dist/cjs-es5/models/match-and-search-request-all-of.js +1 -1
  47. package/dist/cjs-es5/models/match-and-search-request.js +1 -1
  48. package/dist/cjs-es5/models/match-and-search-response-all-of-detections.js +1 -1
  49. package/dist/cjs-es5/models/match-and-search-response-all-of.js +1 -1
  50. package/dist/cjs-es5/models/match-and-search-response.js +1 -1
  51. package/dist/cjs-es5/models/match-image-detection.js +1 -1
  52. package/dist/cjs-es5/models/match-image-result.js +1 -1
  53. package/dist/cjs-es5/models/match-image.js +1 -1
  54. package/dist/cjs-es5/models/match-request.js +1 -1
  55. package/dist/cjs-es5/models/match-response-all-of.js +1 -1
  56. package/dist/cjs-es5/models/match-response.js +1 -1
  57. package/dist/cjs-es5/models/operation-log.js +1 -1
  58. package/dist/cjs-es5/models/output-image-params.js +1 -1
  59. package/dist/cjs-es5/models/page.js +1 -1
  60. package/dist/cjs-es5/models/person-all-of.js +1 -1
  61. package/dist/cjs-es5/models/person-created-response.js +16 -0
  62. package/dist/cjs-es5/models/person-fields.js +1 -1
  63. package/dist/cjs-es5/models/person-with-images-all-of.js +1 -1
  64. package/dist/cjs-es5/models/person-with-images.js +1 -1
  65. package/dist/cjs-es5/models/person.js +1 -1
  66. package/dist/cjs-es5/models/persons-page-all-of.js +1 -1
  67. package/dist/cjs-es5/models/persons-page.js +1 -1
  68. package/dist/cjs-es5/models/process-param.js +1 -1
  69. package/dist/cjs-es5/models/quality-config.js +1 -1
  70. package/dist/cjs-es5/models/quality-detail.js +1 -1
  71. package/dist/cjs-es5/models/quality-details-groups.js +1 -1
  72. package/dist/cjs-es5/models/quality-request.js +1 -1
  73. package/dist/cjs-es5/models/recognize-image-all-of.js +1 -1
  74. package/dist/cjs-es5/models/recognize-image.js +1 -1
  75. package/dist/cjs-es5/models/resize-options.js +16 -0
  76. package/dist/cjs-es5/models/search-bad-params.js +16 -0
  77. package/dist/cjs-es5/models/search-detection.js +16 -0
  78. package/dist/cjs-es5/models/search-parameters-create-person.js +16 -0
  79. package/dist/cjs-es5/models/search-parameters.js +1 -1
  80. package/dist/cjs-es5/models/search-person-all-of.js +1 -1
  81. package/dist/cjs-es5/models/search-person.js +1 -1
  82. package/dist/cjs-es5/models/search-request.js +1 -1
  83. package/dist/cjs-es5/models/search-result.js +1 -1
  84. package/dist/cjs-es5/models/transaction-info.js +16 -0
  85. package/dist/cjs-es5/models/update-group.js +1 -1
  86. package/dist/esm-es5/api/diagnostics-api.js +196 -0
  87. package/dist/esm-es5/api/group-api.js +60 -60
  88. package/dist/esm-es5/api/liveness20-api.js +14 -245
  89. package/dist/esm-es5/api/matching-api.js +21 -21
  90. package/dist/esm-es5/api/person-api.js +96 -189
  91. package/dist/esm-es5/api/search-api.js +10 -10
  92. package/dist/esm-es5/api.js +3 -2
  93. package/dist/esm-es5/base.js +1 -1
  94. package/dist/esm-es5/common.js +1 -1
  95. package/dist/esm-es5/configuration.js +1 -1
  96. package/dist/esm-es5/ext/person-api.js +1 -4
  97. package/dist/esm-es5/models/crop.js +1 -1
  98. package/dist/esm-es5/models/detect-request-attributes.js +14 -0
  99. package/dist/esm-es5/models/detect-request.js +1 -1
  100. package/dist/esm-es5/models/detect-response-all-of.js +1 -1
  101. package/dist/esm-es5/models/detect-response.js +1 -1
  102. package/dist/esm-es5/models/detect-result.js +1 -1
  103. package/dist/esm-es5/models/detection-face.js +1 -1
  104. package/dist/esm-es5/models/detection-quality.js +1 -1
  105. package/dist/esm-es5/models/detection.js +1 -1
  106. package/dist/esm-es5/models/face-attribute.js +34 -0
  107. package/dist/esm-es5/models/face-image-quality-align-type.js +1 -1
  108. package/dist/esm-es5/models/face-image-quality-groups.js +1 -1
  109. package/dist/esm-es5/models/face-image-quality-status.js +1 -1
  110. package/dist/esm-es5/models/face-quality-config-name.js +5 -4
  111. package/dist/esm-es5/models/face-quality-scenarios.js +2 -2
  112. package/dist/esm-es5/models/face-sdkresult-code.js +27 -26
  113. package/dist/esm-es5/models/face-sdkresult.js +1 -1
  114. package/dist/esm-es5/models/faces-response-all-of.js +1 -1
  115. package/dist/esm-es5/models/faces-response.js +1 -1
  116. package/dist/esm-es5/models/group-all-of.js +1 -1
  117. package/dist/esm-es5/models/group-page-all-of.js +1 -1
  118. package/dist/esm-es5/models/group-page.js +1 -1
  119. package/dist/esm-es5/models/group-to-create.js +1 -1
  120. package/dist/esm-es5/models/group.js +1 -1
  121. package/dist/esm-es5/models/image-fields-image.js +1 -1
  122. package/dist/esm-es5/models/image-fields.js +1 -1
  123. package/dist/esm-es5/models/image-page-all-of.js +1 -1
  124. package/dist/esm-es5/models/image-page.js +1 -1
  125. package/dist/esm-es5/models/image-source.js +2 -2
  126. package/dist/esm-es5/models/image.js +1 -1
  127. package/dist/esm-es5/models/index.js +9 -2
  128. package/dist/esm-es5/models/match-and-search-request-all-of-images.js +1 -1
  129. package/dist/esm-es5/models/match-and-search-request-all-of.js +1 -1
  130. package/dist/esm-es5/models/match-and-search-request.js +1 -1
  131. package/dist/esm-es5/models/match-and-search-response-all-of-detections.js +1 -1
  132. package/dist/esm-es5/models/match-and-search-response-all-of.js +1 -1
  133. package/dist/esm-es5/models/match-and-search-response.js +1 -1
  134. package/dist/esm-es5/models/match-image-detection.js +1 -1
  135. package/dist/esm-es5/models/match-image-result.js +1 -1
  136. package/dist/esm-es5/models/match-image.js +1 -1
  137. package/dist/esm-es5/models/match-request.js +1 -1
  138. package/dist/esm-es5/models/match-response-all-of.js +1 -1
  139. package/dist/esm-es5/models/match-response.js +1 -1
  140. package/dist/esm-es5/models/operation-log.js +1 -1
  141. package/dist/esm-es5/models/output-image-params.js +1 -1
  142. package/dist/esm-es5/models/page.js +1 -1
  143. package/dist/esm-es5/models/person-all-of.js +1 -1
  144. package/dist/esm-es5/models/person-created-response.js +14 -0
  145. package/dist/esm-es5/models/person-fields.js +1 -1
  146. package/dist/esm-es5/models/person-with-images-all-of.js +1 -1
  147. package/dist/esm-es5/models/person-with-images.js +1 -1
  148. package/dist/esm-es5/models/person.js +1 -1
  149. package/dist/esm-es5/models/persons-page-all-of.js +1 -1
  150. package/dist/esm-es5/models/persons-page.js +1 -1
  151. package/dist/esm-es5/models/process-param.js +1 -1
  152. package/dist/esm-es5/models/quality-config.js +1 -1
  153. package/dist/esm-es5/models/quality-detail.js +1 -1
  154. package/dist/esm-es5/models/quality-details-groups.js +1 -1
  155. package/dist/esm-es5/models/quality-request.js +1 -1
  156. package/dist/esm-es5/models/recognize-image-all-of.js +1 -1
  157. package/dist/esm-es5/models/recognize-image.js +1 -1
  158. package/dist/esm-es5/models/resize-options.js +14 -0
  159. package/dist/esm-es5/models/search-bad-params.js +14 -0
  160. package/dist/esm-es5/models/search-detection.js +14 -0
  161. package/dist/esm-es5/models/search-parameters-create-person.js +14 -0
  162. package/dist/esm-es5/models/search-parameters.js +1 -1
  163. package/dist/esm-es5/models/search-person-all-of.js +1 -1
  164. package/dist/esm-es5/models/search-person.js +1 -1
  165. package/dist/esm-es5/models/search-request.js +1 -1
  166. package/dist/esm-es5/models/search-result.js +1 -1
  167. package/dist/esm-es5/models/transaction-info.js +14 -0
  168. package/dist/esm-es5/models/update-group.js +1 -1
  169. package/package.json +1 -1
  170. package/src/api/diagnostics-api.ts +126 -0
  171. package/src/api/group-api.ts +79 -79
  172. package/src/api/liveness20-api.ts +14 -224
  173. package/src/api/matching-api.ts +21 -21
  174. package/src/api/person-api.ts +127 -217
  175. package/src/api/search-api.ts +12 -10
  176. package/src/api.ts +2 -1
  177. package/src/base.ts +1 -1
  178. package/src/common.ts +1 -1
  179. package/src/configuration.ts +1 -1
  180. package/src/ext/group-api.ts +5 -5
  181. package/src/ext/person-api.ts +8 -11
  182. package/src/models/crop.ts +3 -3
  183. package/src/models/detect-request-attributes.ts +31 -0
  184. package/src/models/detect-request.ts +5 -10
  185. package/src/models/detect-response-all-of.ts +1 -1
  186. package/src/models/detect-response.ts +1 -1
  187. package/src/models/detect-result.ts +1 -1
  188. package/src/models/detection-face.ts +9 -3
  189. package/src/models/detection-quality.ts +1 -1
  190. package/src/models/detection.ts +2 -2
  191. package/src/models/face-attribute.ts +42 -0
  192. package/src/models/face-image-quality-align-type.ts +1 -1
  193. package/src/models/face-image-quality-groups.ts +1 -1
  194. package/src/models/face-image-quality-status.ts +1 -1
  195. package/src/models/face-quality-config-name.ts +4 -3
  196. package/src/models/face-quality-scenarios.ts +2 -2
  197. package/src/models/face-sdkresult-code.ts +26 -25
  198. package/src/models/face-sdkresult.ts +1 -1
  199. package/src/models/faces-response-all-of.ts +1 -1
  200. package/src/models/faces-response.ts +1 -1
  201. package/src/models/group-all-of.ts +5 -5
  202. package/src/models/group-page-all-of.ts +2 -2
  203. package/src/models/group-page.ts +1 -1
  204. package/src/models/group-to-create.ts +7 -1
  205. package/src/models/group.ts +1 -1
  206. package/src/models/image-fields-image.ts +17 -4
  207. package/src/models/image-fields.ts +33 -2
  208. package/src/models/image-page-all-of.ts +1 -1
  209. package/src/models/image-page.ts +1 -1
  210. package/src/models/image-source.ts +2 -2
  211. package/src/models/image.ts +10 -10
  212. package/src/models/index.ts +8 -1
  213. package/src/models/match-and-search-request-all-of-images.ts +1 -1
  214. package/src/models/match-and-search-request-all-of.ts +8 -2
  215. package/src/models/match-and-search-request.ts +2 -1
  216. package/src/models/match-and-search-response-all-of-detections.ts +2 -2
  217. package/src/models/match-and-search-response-all-of.ts +1 -1
  218. package/src/models/match-and-search-response.ts +1 -1
  219. package/src/models/match-image-detection.ts +3 -3
  220. package/src/models/match-image-result.ts +20 -20
  221. package/src/models/match-image.ts +8 -2
  222. package/src/models/match-request.ts +3 -3
  223. package/src/models/match-response-all-of.ts +7 -7
  224. package/src/models/match-response.ts +1 -1
  225. package/src/models/operation-log.ts +2 -2
  226. package/src/models/output-image-params.ts +2 -2
  227. package/src/models/page.ts +2 -2
  228. package/src/models/person-all-of.ts +12 -6
  229. package/src/models/person-created-response.ts +43 -0
  230. package/src/models/person-fields.ts +13 -1
  231. package/src/models/person-with-images-all-of.ts +1 -1
  232. package/src/models/person-with-images.ts +1 -1
  233. package/src/models/person.ts +1 -1
  234. package/src/models/persons-page-all-of.ts +1 -1
  235. package/src/models/persons-page.ts +1 -1
  236. package/src/models/process-param.ts +7 -1
  237. package/src/models/quality-config.ts +5 -5
  238. package/src/models/quality-detail.ts +1 -1
  239. package/src/models/quality-details-groups.ts +3 -4
  240. package/src/models/quality-request.ts +2 -2
  241. package/src/models/recognize-image-all-of.ts +3 -3
  242. package/src/models/recognize-image.ts +1 -1
  243. package/src/models/resize-options.ts +42 -0
  244. package/src/models/search-bad-params.ts +42 -0
  245. package/src/models/search-detection.ts +90 -0
  246. package/src/models/search-parameters-create-person.ts +36 -0
  247. package/src/models/search-parameters.ts +7 -12
  248. package/src/models/search-person-all-of.ts +9 -2
  249. package/src/models/search-person.ts +2 -1
  250. package/src/models/search-request.ts +3 -1
  251. package/src/models/search-result.ts +3 -3
  252. package/src/models/transaction-info.ts +78 -0
  253. package/src/models/update-group.ts +5 -5
@@ -4,7 +4,7 @@
4
4
  * Regula FaceSDK Web API
5
5
  * Regula FaceSDK Web API # Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
6
6
  *
7
- * The version of the OpenAPI document: 4.1.3
7
+ * The version of the OpenAPI document: 5.2.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -15,22 +15,22 @@
15
15
 
16
16
 
17
17
  /**
18
- * Additional group data in the response, includes id and created_at.
18
+ * Additional group data in the response, includes id and createdAt.
19
19
  * @export
20
20
  * @interface GroupAllOf
21
21
  */
22
22
  export interface GroupAllOf {
23
23
  /**
24
24
  * Group ID.
25
- * @type {number}
25
+ * @type {string}
26
26
  * @memberof GroupAllOf
27
27
  */
28
- 'id'?: number;
28
+ 'id'?: string;
29
29
  /**
30
30
  * Group creation date.
31
31
  * @type {string}
32
32
  * @memberof GroupAllOf
33
33
  */
34
- 'created_at'?: string;
34
+ 'createdAt'?: string;
35
35
  }
36
36
 
@@ -4,7 +4,7 @@
4
4
  * Regula FaceSDK Web API
5
5
  * Regula FaceSDK Web API # Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
6
6
  *
7
- * The version of the OpenAPI document: 4.1.3
7
+ * The version of the OpenAPI document: 5.2.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -22,7 +22,7 @@ import { Group } from './group';
22
22
  */
23
23
  export interface GroupPageAllOf {
24
24
  /**
25
- * The array of Groups that are found during the search.
25
+ * Array of Groups that are found during the search.
26
26
  * @type {Array<Group>}
27
27
  * @memberof GroupPageAllOf
28
28
  */
@@ -4,7 +4,7 @@
4
4
  * Regula FaceSDK Web API
5
5
  * Regula FaceSDK Web API # Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
6
6
  *
7
- * The version of the OpenAPI document: 4.1.3
7
+ * The version of the OpenAPI document: 5.2.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -4,7 +4,7 @@
4
4
  * Regula FaceSDK Web API
5
5
  * Regula FaceSDK Web API # Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
6
6
  *
7
- * The version of the OpenAPI document: 4.1.3
7
+ * The version of the OpenAPI document: 5.2.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -20,6 +20,12 @@
20
20
  * @interface GroupToCreate
21
21
  */
22
22
  export interface GroupToCreate {
23
+ /**
24
+ * Session identificator.
25
+ * @type {string}
26
+ * @memberof GroupToCreate
27
+ */
28
+ 'tag'?: string;
23
29
  /**
24
30
  * Group to create name.
25
31
  * @type {string}
@@ -4,7 +4,7 @@
4
4
  * Regula FaceSDK Web API
5
5
  * Regula FaceSDK Web API # Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
6
6
  *
7
- * The version of the OpenAPI document: 4.1.3
7
+ * The version of the OpenAPI document: 5.2.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -4,7 +4,7 @@
4
4
  * Regula FaceSDK Web API
5
5
  * Regula FaceSDK Web API # Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
6
6
  *
7
- * The version of the OpenAPI document: 4.1.3
7
+ * The version of the OpenAPI document: 5.2.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -13,25 +13,38 @@
13
13
  */
14
14
 
15
15
 
16
+ import { ResizeOptions } from './resize-options';
16
17
  import { ImageData } from './image-data';
17
18
 
18
19
  /**
19
- * The uploaded image.
20
+ * Uploaded image.
20
21
  * @export
21
22
  * @interface ImageFieldsImage
22
23
  */
23
24
  export interface ImageFieldsImage {
24
25
  /**
25
- * The original media type of the uploaded image.
26
+ * Original media type of the uploaded image.
26
27
  * @type {string}
27
28
  * @memberof ImageFieldsImage
28
29
  */
29
- 'content_type'?: string;
30
+ 'contentType'?: string;
30
31
  /**
31
32
  *
32
33
  * @type {ImageData}
33
34
  * @memberof ImageFieldsImage
34
35
  */
35
36
  'content'?: ImageData;
37
+ /**
38
+ * Image URL, can be a link to Amazon S3, Google Storage, File System, or HTTP(S).
39
+ * @type {string}
40
+ * @memberof ImageFieldsImage
41
+ */
42
+ 'imageUrl'?: string;
43
+ /**
44
+ *
45
+ * @type {ResizeOptions}
46
+ * @memberof ImageFieldsImage
47
+ */
48
+ 'resizeOptions'?: ResizeOptions;
36
49
  }
37
50
 
@@ -4,7 +4,7 @@
4
4
  * Regula FaceSDK Web API
5
5
  * Regula FaceSDK Web API # Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
6
6
  *
7
- * The version of the OpenAPI document: 4.1.3
7
+ * The version of the OpenAPI document: 5.2.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -14,18 +14,49 @@
14
14
 
15
15
 
16
16
  import { ImageFieldsImage } from './image-fields-image';
17
+ import { OutputImageParams } from './output-image-params';
17
18
 
18
19
  /**
19
- * Image in the request data, includes image and content_type.
20
+ * Image in the request data, includes image and contentType.
20
21
  * @export
21
22
  * @interface ImageFields
22
23
  */
23
24
  export interface ImageFields {
25
+ /**
26
+ * Session identificator.
27
+ * @type {string}
28
+ * @memberof ImageFields
29
+ */
30
+ 'tag'?: string;
24
31
  /**
25
32
  *
26
33
  * @type {ImageFieldsImage}
27
34
  * @memberof ImageFields
28
35
  */
29
36
  'image'?: ImageFieldsImage;
37
+ /**
38
+ *
39
+ * @type {OutputImageParams}
40
+ * @memberof ImageFields
41
+ */
42
+ 'outputImageParams'?: OutputImageParams;
43
+ /**
44
+ * Whether to detect all faces in the image. If set to false, only the most central face is detected.
45
+ * @type {boolean}
46
+ * @memberof ImageFields
47
+ */
48
+ 'detectAll'?: boolean;
49
+ /**
50
+ * The similarity threshold.
51
+ * @type {number}
52
+ * @memberof ImageFields
53
+ */
54
+ 'threshold'?: number;
55
+ /**
56
+ * The maximum number of results to be returned.
57
+ * @type {number}
58
+ * @memberof ImageFields
59
+ */
60
+ 'limit'?: number;
30
61
  }
31
62
 
@@ -4,7 +4,7 @@
4
4
  * Regula FaceSDK Web API
5
5
  * Regula FaceSDK Web API # Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
6
6
  *
7
- * The version of the OpenAPI document: 4.1.3
7
+ * The version of the OpenAPI document: 5.2.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -4,7 +4,7 @@
4
4
  * Regula FaceSDK Web API
5
5
  * Regula FaceSDK Web API # Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
6
6
  *
7
- * The version of the OpenAPI document: 4.1.3
7
+ * The version of the OpenAPI document: 5.2.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -4,7 +4,7 @@
4
4
  * Regula FaceSDK Web API
5
5
  * Regula FaceSDK Web API # Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
6
6
  *
7
- * The version of the OpenAPI document: 4.1.3
7
+ * The version of the OpenAPI document: 5.2.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -15,7 +15,7 @@
15
15
 
16
16
 
17
17
  /**
18
- * Face photo image source.
18
+ * The type of the image, defines the way the comparison is performed. See the enum: https://docs.regulaforensics.com/develop/face-sdk/web-service/development/enums/image-source/
19
19
  * @export
20
20
  * @enum {string}
21
21
  */
@@ -4,7 +4,7 @@
4
4
  * Regula FaceSDK Web API
5
5
  * Regula FaceSDK Web API # Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
6
6
  *
7
- * The version of the OpenAPI document: 4.1.3
7
+ * The version of the OpenAPI document: 5.2.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -21,37 +21,37 @@
21
21
  */
22
22
  export interface Image {
23
23
  /**
24
- * Response image ID.
24
+ * Response image ID. The list is sorted by decreasing ID value.
25
25
  * @type {number}
26
26
  * @memberof Image
27
27
  */
28
28
  'id'?: number;
29
29
  /**
30
- * The original media type of the returned image.
30
+ * Original media type of the returned image.
31
31
  * @type {string}
32
32
  * @memberof Image
33
33
  */
34
- 'content_type'?: string;
34
+ 'contentType'?: string;
35
35
  /**
36
- * The returned image creation date.
36
+ * Returned image creation date.
37
37
  * @type {string}
38
38
  * @memberof Image
39
39
  */
40
- 'created_at'?: string;
40
+ 'createdAt'?: string;
41
41
  /**
42
- * The returned image update date.
42
+ * Returned image update date.
43
43
  * @type {string}
44
44
  * @memberof Image
45
45
  */
46
- 'updated_at'?: string;
46
+ 'updatedAt'?: string;
47
47
  /**
48
- * The returned image S3 path.
48
+ * Returned image S3 path.
49
49
  * @type {string}
50
50
  * @memberof Image
51
51
  */
52
52
  'path'?: string;
53
53
  /**
54
- * The returned image URL.
54
+ * Returned image URL.
55
55
  * @type {string}
56
56
  * @memberof Image
57
57
  */
@@ -1,11 +1,13 @@
1
1
  export * from './crop';
2
2
  export * from './detect-request';
3
+ export * from './detect-request-attributes';
3
4
  export * from './detect-response';
4
5
  export * from './detect-response-all-of';
5
6
  export * from './detect-result';
6
7
  export * from './detection';
7
8
  export * from './detection-face';
8
9
  export * from './detection-quality';
10
+ export * from './face-attribute';
9
11
  export * from './face-image-quality-align-type';
10
12
  export * from './face-image-quality-groups';
11
13
  export * from './face-image-quality-status';
@@ -26,7 +28,6 @@ export * from './image-fields-image';
26
28
  export * from './image-page';
27
29
  export * from './image-page-all-of';
28
30
  export * from './image-source';
29
- export * from './liveness-transaction';
30
31
  export * from './match-and-search-request';
31
32
  export * from './match-and-search-request-all-of';
32
33
  export * from './match-and-search-request-all-of-images';
@@ -44,6 +45,7 @@ export * from './output-image-params';
44
45
  export * from './page';
45
46
  export * from './person';
46
47
  export * from './person-all-of';
48
+ export * from './person-created-response';
47
49
  export * from './person-fields';
48
50
  export * from './person-with-images';
49
51
  export * from './person-with-images-all-of';
@@ -56,9 +58,14 @@ export * from './quality-details-groups';
56
58
  export * from './quality-request';
57
59
  export * from './recognize-image';
58
60
  export * from './recognize-image-all-of';
61
+ export * from './resize-options';
62
+ export * from './search-bad-params';
63
+ export * from './search-detection';
59
64
  export * from './search-parameters';
65
+ export * from './search-parameters-create-person';
60
66
  export * from './search-person';
61
67
  export * from './search-person-all-of';
62
68
  export * from './search-request';
63
69
  export * from './search-result';
70
+ export * from './transaction-info';
64
71
  export * from './update-group';
@@ -4,7 +4,7 @@
4
4
  * Regula FaceSDK Web API
5
5
  * Regula FaceSDK Web API # Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
6
6
  *
7
- * The version of the OpenAPI document: 4.1.3
7
+ * The version of the OpenAPI document: 5.2.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -4,7 +4,7 @@
4
4
  * Regula FaceSDK Web API
5
5
  * Regula FaceSDK Web API # Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
6
6
  *
7
- * The version of the OpenAPI document: 4.1.3
7
+ * The version of the OpenAPI document: 5.2.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -22,7 +22,13 @@ import { MatchAndSearchRequestAllOfImages } from './match-and-search-request-all
22
22
  */
23
23
  export interface MatchAndSearchRequestAllOf {
24
24
  /**
25
- *
25
+ * Session identificator.
26
+ * @type {string}
27
+ * @memberof MatchAndSearchRequestAllOf
28
+ */
29
+ 'tag'?: string;
30
+ /**
31
+ * Array of Person images.
26
32
  * @type {Array<MatchAndSearchRequestAllOfImages>}
27
33
  * @memberof MatchAndSearchRequestAllOf
28
34
  */
@@ -4,7 +4,7 @@
4
4
  * Regula FaceSDK Web API
5
5
  * Regula FaceSDK Web API # Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
6
6
  *
7
- * The version of the OpenAPI document: 4.1.3
7
+ * The version of the OpenAPI document: 5.2.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -16,6 +16,7 @@
16
16
  import { MatchAndSearchRequestAllOf } from './match-and-search-request-all-of';
17
17
  import { MatchAndSearchRequestAllOfImages } from './match-and-search-request-all-of-images';
18
18
  import { SearchParameters } from './search-parameters';
19
+ import { SearchParametersCreatePerson } from './search-parameters-create-person';
19
20
 
20
21
  /**
21
22
  * @type MatchAndSearchRequest
@@ -4,7 +4,7 @@
4
4
  * Regula FaceSDK Web API
5
5
  * Regula FaceSDK Web API # Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
6
6
  *
7
- * The version of the OpenAPI document: 4.1.3
7
+ * The version of the OpenAPI document: 5.2.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -29,7 +29,7 @@ export interface MatchAndSearchResponseAllOfDetections {
29
29
  */
30
30
  'faces'?: Array<FacesResponse>;
31
31
  /**
32
- * Image index used to identify input photos between themselves. If not specified, than input list index is used.
32
+ * The image index number. Can be given; if not given, the index numbers are set automatically starting from 0. All index numbers must be whole and unique—not repeated.
33
33
  * @type {number}
34
34
  * @memberof MatchAndSearchResponseAllOfDetections
35
35
  */
@@ -4,7 +4,7 @@
4
4
  * Regula FaceSDK Web API
5
5
  * Regula FaceSDK Web API # Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
6
6
  *
7
- * The version of the OpenAPI document: 4.1.3
7
+ * The version of the OpenAPI document: 5.2.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -4,7 +4,7 @@
4
4
  * Regula FaceSDK Web API
5
5
  * Regula FaceSDK Web API # Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
6
6
  *
7
- * The version of the OpenAPI document: 4.1.3
7
+ * The version of the OpenAPI document: 5.2.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -4,7 +4,7 @@
4
4
  * Regula FaceSDK Web API
5
5
  * Regula FaceSDK Web API # Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
6
6
  *
7
- * The version of the OpenAPI document: 4.1.3
7
+ * The version of the OpenAPI document: 5.2.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -23,13 +23,13 @@ import { FaceSDKResultCode } from './face-sdkresult-code';
23
23
  */
24
24
  export interface MatchImageDetection {
25
25
  /**
26
- *
26
+ * The array of detected faces.
27
27
  * @type {Array<DetectionFace>}
28
28
  * @memberof MatchImageDetection
29
29
  */
30
30
  'faces'?: Array<DetectionFace>;
31
31
  /**
32
- * Image index used to identify input photos between themselves. If not specified, than input list index is used.
32
+ * The image index number. Can be given; if not given, the index numbers are set automatically starting from 0. All index numbers must be whole and unique—not repeated.
33
33
  * @type {number}
34
34
  * @memberof MatchImageDetection
35
35
  */
@@ -4,7 +4,7 @@
4
4
  * Regula FaceSDK Web API
5
5
  * Regula FaceSDK Web API # Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
6
6
  *
7
- * The version of the OpenAPI document: 4.1.3
7
+ * The version of the OpenAPI document: 5.2.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -13,7 +13,7 @@
13
13
  */
14
14
 
15
15
 
16
- import { FaceSDKResultCode } from './face-sdkresult-code';
16
+ import { ImageSource } from './image-source';
17
17
 
18
18
  /**
19
19
  *
@@ -22,52 +22,52 @@ import { FaceSDKResultCode } from './face-sdkresult-code';
22
22
  */
23
23
  export interface MatchImageResult {
24
24
  /**
25
- * Image index used to identify input photos between themselves. If not specified, than input list index is used.
25
+ * The image index number. Can be given; if not given, the index numbers are set automatically starting from 0. All index numbers must be whole and unique—not repeated.
26
26
  * @type {number}
27
27
  * @memberof MatchImageResult
28
28
  */
29
29
  'firstIndex': number;
30
30
  /**
31
- * Faces index used to identify faces in scope of one photo.
31
+ * The detected face index number.
32
32
  * @type {number}
33
33
  * @memberof MatchImageResult
34
34
  */
35
35
  'firstFaceIndex'?: number;
36
36
  /**
37
- * Image index used to identify input photos between themselves. If not specified, than input list index is used.
38
- * @type {number}
37
+ *
38
+ * @type {ImageSource}
39
39
  * @memberof MatchImageResult
40
40
  */
41
- 'secondIndex': number;
41
+ 'first'?: ImageSource;
42
42
  /**
43
- * Faces index used to identify faces in scope of one photo.
43
+ * The image index number. Can be given; if not given, the index numbers are set automatically starting from 0. All index numbers must be whole and unique—not repeated.
44
44
  * @type {number}
45
45
  * @memberof MatchImageResult
46
46
  */
47
- 'secondFaceIndex'?: number;
47
+ 'secondIndex': number;
48
48
  /**
49
- * The matching score.
49
+ * The detected face index number.
50
50
  * @type {number}
51
51
  * @memberof MatchImageResult
52
52
  */
53
- 'score'?: number;
53
+ 'secondFaceIndex'?: number;
54
54
  /**
55
- * The similarity score.
56
- * @type {number}
55
+ *
56
+ * @type {ImageSource}
57
57
  * @memberof MatchImageResult
58
58
  */
59
- 'similarity'?: number;
59
+ 'second'?: ImageSource;
60
60
  /**
61
- *
62
- * @type {FaceSDKResultCode}
61
+ * A dimensionless number that shows how similar the compared faces are. 0—absolutely identical faces.
62
+ * @type {number}
63
63
  * @memberof MatchImageResult
64
64
  */
65
- 'errorCode'?: FaceSDKResultCode;
65
+ 'score'?: number;
66
66
  /**
67
- * The error message if any.
68
- * @type {string}
67
+ * The detected faces similarity, %. 100%—absolutely identical faces, 0%—absolutely not identical.
68
+ * @type {number}
69
69
  * @memberof MatchImageResult
70
70
  */
71
- 'errorMsg'?: string;
71
+ 'similarity'?: number;
72
72
  }
73
73
 
@@ -4,7 +4,7 @@
4
4
  * Regula FaceSDK Web API
5
5
  * Regula FaceSDK Web API # Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
6
6
  *
7
- * The version of the OpenAPI document: 4.1.3
7
+ * The version of the OpenAPI document: 5.2.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -23,7 +23,7 @@ import { ImageData } from './image-data';
23
23
  */
24
24
  export interface MatchImage {
25
25
  /**
26
- * Image index used to identify input photos between themselves. If not specified, than input list index is used.
26
+ * The image index number. Can be given; if not given, the index numbers are set automatically starting from 0. All index numbers must be whole and unique—not repeated.
27
27
  * @type {number}
28
28
  * @memberof MatchImage
29
29
  */
@@ -40,5 +40,11 @@ export interface MatchImage {
40
40
  * @memberof MatchImage
41
41
  */
42
42
  'data': ImageData;
43
+ /**
44
+ * Whether to detect all faces in the image. If set to false, only the most central face is detected.
45
+ * @type {boolean}
46
+ * @memberof MatchImage
47
+ */
48
+ 'detectAll'?: boolean;
43
49
  }
44
50
 
@@ -4,7 +4,7 @@
4
4
  * Regula FaceSDK Web API
5
5
  * Regula FaceSDK Web API # Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
6
6
  *
7
- * The version of the OpenAPI document: 4.1.3
7
+ * The version of the OpenAPI document: 5.2.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -28,13 +28,13 @@ export interface MatchRequest {
28
28
  */
29
29
  'tag'?: string;
30
30
  /**
31
- * Whether to return cropped portraits of the detected people.
31
+ * Whether to return thumbnails: Base64 cropped images that contain vertically aligned faces.
32
32
  * @type {boolean}
33
33
  * @memberof MatchRequest
34
34
  */
35
35
  'thumbnails'?: boolean;
36
36
  /**
37
- * Base64 images.
37
+ * The array of all images included in the comparison.
38
38
  * @type {Array<MatchImage>}
39
39
  * @memberof MatchRequest
40
40
  */