@ogcio/building-blocks-sdk 0.1.17 → 0.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 (37) hide show
  1. package/.gitleaksignore +2 -0
  2. package/.release-please-manifest.json +1 -1
  3. package/CHANGELOG.md +18 -0
  4. package/dist/client/clients/featureFlags/schema.d.ts +205 -63
  5. package/dist/client/clients/featureFlags/schema.d.ts.map +1 -1
  6. package/dist/client/clients/messaging/index.d.ts +2 -1835
  7. package/dist/client/clients/messaging/index.d.ts.map +1 -1
  8. package/dist/client/clients/messaging/index.js +3 -179
  9. package/dist/client/clients/messaging/index.js.map +1 -1
  10. package/dist/client/clients/messaging/schema.d.ts +2763 -2750
  11. package/dist/client/clients/messaging/schema.d.ts.map +1 -1
  12. package/dist/client/clients/payments/index.d.ts +240 -1
  13. package/dist/client/clients/payments/index.d.ts.map +1 -1
  14. package/dist/client/clients/payments/index.js +23 -0
  15. package/dist/client/clients/payments/index.js.map +1 -1
  16. package/dist/client/clients/payments/schema.d.ts +256 -1
  17. package/dist/client/clients/payments/schema.d.ts.map +1 -1
  18. package/dist/client/clients/profile/index.d.ts +852 -440
  19. package/dist/client/clients/profile/index.d.ts.map +1 -1
  20. package/dist/client/clients/profile/index.js +88 -54
  21. package/dist/client/clients/profile/index.js.map +1 -1
  22. package/dist/client/clients/profile/schema.d.ts +1237 -1114
  23. package/dist/client/clients/profile/schema.d.ts.map +1 -1
  24. package/dist/clients-configurations/clients-configuration.json +5 -4
  25. package/package.json +1 -1
  26. package/src/client/clients/featureFlags/open-api-definition.json +184 -95
  27. package/src/client/clients/featureFlags/schema.ts +205 -63
  28. package/src/client/clients/messaging/index.ts +2 -278
  29. package/src/client/clients/messaging/open-api-definition.json +30 -18
  30. package/src/client/clients/messaging/schema.ts +2763 -2750
  31. package/src/client/clients/payments/index.ts +37 -0
  32. package/src/client/clients/payments/open-api-definition.json +773 -185
  33. package/src/client/clients/payments/schema.ts +256 -1
  34. package/src/client/clients/profile/index.ts +140 -84
  35. package/src/client/clients/profile/open-api-definition.json +1825 -1323
  36. package/src/client/clients/profile/schema.ts +1237 -1114
  37. package/src/clients-configurations/clients-configuration.json +5 -4
@@ -996,7 +996,7 @@ export declare class Messaging extends BaseClient<paths> {
996
996
  id: string;
997
997
  providerName: string;
998
998
  isPrimary: boolean;
999
- type: "sms" | "email";
999
+ type: "email" | "sms";
1000
1000
  }[];
1001
1001
  metadata?: {
1002
1002
  links?: {
@@ -1736,1579 +1736,7 @@ export declare class Messaging extends BaseClient<paths> {
1736
1736
  path: {
1737
1737
  providerId: string;
1738
1738
  };
1739
- };
1740
- }>>;
1741
- getSmsProviders(params?: {
1742
- primary?: boolean;
1743
- } & PaginationParams): Promise<{
1744
- error: import("openapi-typescript-helpers").ErrorResponse<{
1745
- 200: {
1746
- headers: {
1747
- [name: string]: unknown;
1748
- };
1749
- content: {
1750
- "application/json": {
1751
- data: {
1752
- id: string;
1753
- providerName: string;
1754
- isPrimary: boolean;
1755
- type: "sms" | "email";
1756
- }[];
1757
- metadata?: {
1758
- links?: {
1759
- self: {
1760
- href?: string;
1761
- };
1762
- next?: {
1763
- href?: string;
1764
- };
1765
- prev?: {
1766
- href?: string;
1767
- };
1768
- first: {
1769
- href?: string;
1770
- };
1771
- last: {
1772
- href?: string;
1773
- };
1774
- pages: {
1775
- [key: string]: {
1776
- href?: string;
1777
- };
1778
- };
1779
- };
1780
- totalCount?: number;
1781
- };
1782
- };
1783
- };
1784
- };
1785
- "5XX": {
1786
- headers: {
1787
- [name: string]: unknown;
1788
- };
1789
- content: {
1790
- "application/json": {
1791
- code: string;
1792
- detail: string;
1793
- requestId: string;
1794
- name: string;
1795
- validation?: {
1796
- fieldName: string;
1797
- message: string;
1798
- }[];
1799
- validationContext?: string;
1800
- };
1801
- };
1802
- };
1803
- "4XX": {
1804
- headers: {
1805
- [name: string]: unknown;
1806
- };
1807
- content: {
1808
- "application/json": {
1809
- code: string;
1810
- detail: string;
1811
- requestId: string;
1812
- name: string;
1813
- validation?: {
1814
- fieldName: string;
1815
- message: string;
1816
- }[];
1817
- validationContext?: string;
1818
- };
1819
- };
1820
- };
1821
- }, `${string}/${string}`> | undefined;
1822
- data: {
1823
- id: string;
1824
- providerName: string;
1825
- isPrimary: boolean;
1826
- }[] | undefined;
1827
- }>;
1828
- getSmsProvider(providerId: string): Promise<{
1829
- data: {
1830
- id: string;
1831
- providerName: string;
1832
- isPrimary: boolean;
1833
- type: "sms";
1834
- config: {
1835
- type: "AWS";
1836
- accessKey: string;
1837
- secretAccessKey: string;
1838
- region: string;
1839
- };
1840
- };
1841
- error?: undefined;
1842
- } | {
1843
- error: import("openapi-typescript-helpers").ErrorResponse<{
1844
- 200: {
1845
- headers: {
1846
- [name: string]: unknown;
1847
- };
1848
- content: {
1849
- "application/json": {
1850
- data: {
1851
- id: string;
1852
- providerName: string;
1853
- isPrimary: boolean;
1854
- type: "email";
1855
- smtpHost: string;
1856
- smtpPort: number;
1857
- username: string;
1858
- password: string;
1859
- throttle?: number;
1860
- fromAddress: string;
1861
- ssl: boolean;
1862
- } | {
1863
- id: string;
1864
- providerName: string;
1865
- isPrimary: boolean;
1866
- type: "sms";
1867
- config: {
1868
- type: "AWS";
1869
- accessKey: string;
1870
- secretAccessKey: string;
1871
- region: string;
1872
- };
1873
- };
1874
- metadata?: {
1875
- links?: {
1876
- self: {
1877
- href?: string;
1878
- };
1879
- next?: {
1880
- href?: string;
1881
- };
1882
- prev?: {
1883
- href?: string;
1884
- };
1885
- first: {
1886
- href?: string;
1887
- };
1888
- last: {
1889
- href?: string;
1890
- };
1891
- pages: {
1892
- [key: string]: {
1893
- href?: string;
1894
- };
1895
- };
1896
- };
1897
- totalCount?: number;
1898
- };
1899
- };
1900
- };
1901
- };
1902
- "5XX": {
1903
- headers: {
1904
- [name: string]: unknown;
1905
- };
1906
- content: {
1907
- "application/json": {
1908
- code: string;
1909
- detail: string;
1910
- requestId: string;
1911
- name: string;
1912
- validation?: {
1913
- fieldName: string;
1914
- message: string;
1915
- }[];
1916
- validationContext?: string;
1917
- };
1918
- };
1919
- };
1920
- "4XX": {
1921
- headers: {
1922
- [name: string]: unknown;
1923
- };
1924
- content: {
1925
- "application/json": {
1926
- code: string;
1927
- detail: string;
1928
- requestId: string;
1929
- name: string;
1930
- validation?: {
1931
- fieldName: string;
1932
- message: string;
1933
- }[];
1934
- validationContext?: string;
1935
- };
1936
- };
1937
- };
1938
- }, `${string}/${string}`> | undefined;
1939
- data?: undefined;
1940
- }>;
1941
- updateSmsProvider(provider: {
1942
- id: string;
1943
- providerName: string;
1944
- isPrimary: boolean;
1945
- config: {
1946
- type: "AWS";
1947
- accessKey: string;
1948
- secretAccessKey: string;
1949
- region: string;
1950
- };
1951
- }): Promise<import("../../utils/client-utils.js").DataResponseValue<{
1952
- parameters: {
1953
- query?: never;
1954
- header?: never;
1955
- path: {
1956
- providerId: string;
1957
- };
1958
- cookie?: never;
1959
- };
1960
- requestBody?: {
1961
- content: {
1962
- "application/json": {
1963
- id: string;
1964
- providerName: string;
1965
- isPrimary: boolean;
1966
- type: "email";
1967
- smtpHost: string;
1968
- smtpPort: number;
1969
- username: string;
1970
- password: string;
1971
- throttle?: number;
1972
- fromAddress: string;
1973
- ssl: boolean;
1974
- } | {
1975
- id: string;
1976
- providerName: string;
1977
- isPrimary: boolean;
1978
- type: "sms";
1979
- config: {
1980
- type: "AWS";
1981
- accessKey: string;
1982
- secretAccessKey: string;
1983
- region: string;
1984
- };
1985
- };
1986
- };
1987
- };
1988
- responses: {
1989
- 200: {
1990
- headers: {
1991
- [name: string]: unknown;
1992
- };
1993
- content: {
1994
- "application/json": {
1995
- data: {
1996
- id: string;
1997
- };
1998
- metadata?: {
1999
- links?: {
2000
- self: {
2001
- href?: string;
2002
- };
2003
- next?: {
2004
- href?: string;
2005
- };
2006
- prev?: {
2007
- href?: string;
2008
- };
2009
- first: {
2010
- href?: string;
2011
- };
2012
- last: {
2013
- href?: string;
2014
- };
2015
- pages: {
2016
- [key: string]: {
2017
- href?: string;
2018
- };
2019
- };
2020
- };
2021
- totalCount?: number;
2022
- };
2023
- };
2024
- };
2025
- };
2026
- "5XX": {
2027
- headers: {
2028
- [name: string]: unknown;
2029
- };
2030
- content: {
2031
- "application/json": {
2032
- code: string;
2033
- detail: string;
2034
- requestId: string;
2035
- name: string;
2036
- validation?: {
2037
- fieldName: string;
2038
- message: string;
2039
- }[];
2040
- validationContext?: string;
2041
- };
2042
- };
2043
- };
2044
- "4XX": {
2045
- headers: {
2046
- [name: string]: unknown;
2047
- };
2048
- content: {
2049
- "application/json": {
2050
- code: string;
2051
- detail: string;
2052
- requestId: string;
2053
- name: string;
2054
- validation?: {
2055
- fieldName: string;
2056
- message: string;
2057
- }[];
2058
- validationContext?: string;
2059
- };
2060
- };
2061
- };
2062
- };
2063
- }, import("openapi-fetch").FetchOptions<{
2064
- parameters: {
2065
- query?: never;
2066
- header?: never;
2067
- path: {
2068
- providerId: string;
2069
- };
2070
- cookie?: never;
2071
- };
2072
- requestBody?: {
2073
- content: {
2074
- "application/json": {
2075
- id: string;
2076
- providerName: string;
2077
- isPrimary: boolean;
2078
- type: "email";
2079
- smtpHost: string;
2080
- smtpPort: number;
2081
- username: string;
2082
- password: string;
2083
- throttle?: number;
2084
- fromAddress: string;
2085
- ssl: boolean;
2086
- } | {
2087
- id: string;
2088
- providerName: string;
2089
- isPrimary: boolean;
2090
- type: "sms";
2091
- config: {
2092
- type: "AWS";
2093
- accessKey: string;
2094
- secretAccessKey: string;
2095
- region: string;
2096
- };
2097
- };
2098
- };
2099
- };
2100
- responses: {
2101
- 200: {
2102
- headers: {
2103
- [name: string]: unknown;
2104
- };
2105
- content: {
2106
- "application/json": {
2107
- data: {
2108
- id: string;
2109
- };
2110
- metadata?: {
2111
- links?: {
2112
- self: {
2113
- href?: string;
2114
- };
2115
- next?: {
2116
- href?: string;
2117
- };
2118
- prev?: {
2119
- href?: string;
2120
- };
2121
- first: {
2122
- href?: string;
2123
- };
2124
- last: {
2125
- href?: string;
2126
- };
2127
- pages: {
2128
- [key: string]: {
2129
- href?: string;
2130
- };
2131
- };
2132
- };
2133
- totalCount?: number;
2134
- };
2135
- };
2136
- };
2137
- };
2138
- "5XX": {
2139
- headers: {
2140
- [name: string]: unknown;
2141
- };
2142
- content: {
2143
- "application/json": {
2144
- code: string;
2145
- detail: string;
2146
- requestId: string;
2147
- name: string;
2148
- validation?: {
2149
- fieldName: string;
2150
- message: string;
2151
- }[];
2152
- validationContext?: string;
2153
- };
2154
- };
2155
- };
2156
- "4XX": {
2157
- headers: {
2158
- [name: string]: unknown;
2159
- };
2160
- content: {
2161
- "application/json": {
2162
- code: string;
2163
- detail: string;
2164
- requestId: string;
2165
- name: string;
2166
- validation?: {
2167
- fieldName: string;
2168
- message: string;
2169
- }[];
2170
- validationContext?: string;
2171
- };
2172
- };
2173
- };
2174
- };
2175
- }>>>;
2176
- createSmsProvider(provider: {
2177
- providerName: string;
2178
- isPrimary: boolean;
2179
- config: {
2180
- type: "AWS";
2181
- accessKey: string;
2182
- secretAccessKey: string;
2183
- region: string;
2184
- };
2185
- }): Promise<import("../../utils/client-utils.js").DataResponseValue<{
2186
- parameters: {
2187
- query?: never;
2188
- header?: never;
2189
- path?: never;
2190
- cookie?: never;
2191
- };
2192
- requestBody?: {
2193
- content: {
2194
- "application/json": {
2195
- providerName: string;
2196
- isPrimary: boolean;
2197
- type: "email";
2198
- smtpHost: string;
2199
- smtpPort: number;
2200
- username: string;
2201
- password: string;
2202
- throttle?: number;
2203
- fromAddress: string;
2204
- ssl: boolean;
2205
- } | {
2206
- providerName: string;
2207
- isPrimary: boolean;
2208
- type: "sms";
2209
- config: {
2210
- type: "AWS";
2211
- accessKey: string;
2212
- secretAccessKey: string;
2213
- region: string;
2214
- };
2215
- };
2216
- };
2217
- };
2218
- responses: {
2219
- 201: {
2220
- headers: {
2221
- [name: string]: unknown;
2222
- };
2223
- content: {
2224
- "application/json": {
2225
- data: {
2226
- id: string;
2227
- };
2228
- metadata?: {
2229
- links?: {
2230
- self: {
2231
- href?: string;
2232
- };
2233
- next?: {
2234
- href?: string;
2235
- };
2236
- prev?: {
2237
- href?: string;
2238
- };
2239
- first: {
2240
- href?: string;
2241
- };
2242
- last: {
2243
- href?: string;
2244
- };
2245
- pages: {
2246
- [key: string]: {
2247
- href?: string;
2248
- };
2249
- };
2250
- };
2251
- totalCount?: number;
2252
- };
2253
- };
2254
- };
2255
- };
2256
- "5XX": {
2257
- headers: {
2258
- [name: string]: unknown;
2259
- };
2260
- content: {
2261
- "application/json": {
2262
- code: string;
2263
- detail: string;
2264
- requestId: string;
2265
- name: string;
2266
- validation?: {
2267
- fieldName: string;
2268
- message: string;
2269
- }[];
2270
- validationContext?: string;
2271
- };
2272
- };
2273
- };
2274
- "4XX": {
2275
- headers: {
2276
- [name: string]: unknown;
2277
- };
2278
- content: {
2279
- "application/json": {
2280
- code: string;
2281
- detail: string;
2282
- requestId: string;
2283
- name: string;
2284
- validation?: {
2285
- fieldName: string;
2286
- message: string;
2287
- }[];
2288
- validationContext?: string;
2289
- };
2290
- };
2291
- };
2292
- };
2293
- }, import("openapi-fetch").FetchOptions<{
2294
- parameters: {
2295
- query?: never;
2296
- header?: never;
2297
- path?: never;
2298
- cookie?: never;
2299
- };
2300
- requestBody?: {
2301
- content: {
2302
- "application/json": {
2303
- providerName: string;
2304
- isPrimary: boolean;
2305
- type: "email";
2306
- smtpHost: string;
2307
- smtpPort: number;
2308
- username: string;
2309
- password: string;
2310
- throttle?: number;
2311
- fromAddress: string;
2312
- ssl: boolean;
2313
- } | {
2314
- providerName: string;
2315
- isPrimary: boolean;
2316
- type: "sms";
2317
- config: {
2318
- type: "AWS";
2319
- accessKey: string;
2320
- secretAccessKey: string;
2321
- region: string;
2322
- };
2323
- };
2324
- };
2325
- };
2326
- responses: {
2327
- 201: {
2328
- headers: {
2329
- [name: string]: unknown;
2330
- };
2331
- content: {
2332
- "application/json": {
2333
- data: {
2334
- id: string;
2335
- };
2336
- metadata?: {
2337
- links?: {
2338
- self: {
2339
- href?: string;
2340
- };
2341
- next?: {
2342
- href?: string;
2343
- };
2344
- prev?: {
2345
- href?: string;
2346
- };
2347
- first: {
2348
- href?: string;
2349
- };
2350
- last: {
2351
- href?: string;
2352
- };
2353
- pages: {
2354
- [key: string]: {
2355
- href?: string;
2356
- };
2357
- };
2358
- };
2359
- totalCount?: number;
2360
- };
2361
- };
2362
- };
2363
- };
2364
- "5XX": {
2365
- headers: {
2366
- [name: string]: unknown;
2367
- };
2368
- content: {
2369
- "application/json": {
2370
- code: string;
2371
- detail: string;
2372
- requestId: string;
2373
- name: string;
2374
- validation?: {
2375
- fieldName: string;
2376
- message: string;
2377
- }[];
2378
- validationContext?: string;
2379
- };
2380
- };
2381
- };
2382
- "4XX": {
2383
- headers: {
2384
- [name: string]: unknown;
2385
- };
2386
- content: {
2387
- "application/json": {
2388
- code: string;
2389
- detail: string;
2390
- requestId: string;
2391
- name: string;
2392
- validation?: {
2393
- fieldName: string;
2394
- message: string;
2395
- }[];
2396
- validationContext?: string;
2397
- };
2398
- };
2399
- };
2400
- };
2401
- }> | undefined>>;
2402
- deleteSmsProvider(providerId: string): Promise<import("../../utils/client-utils.js").DataResponseValue<{
2403
- parameters: {
2404
- query?: never;
2405
- header?: never;
2406
- path: {
2407
- providerId: string;
2408
- };
2409
- cookie?: never;
2410
- };
2411
- requestBody?: never;
2412
- responses: {
2413
- 200: {
2414
- headers: {
2415
- [name: string]: unknown;
2416
- };
2417
- content: {
2418
- "application/json": {
2419
- data: {
2420
- id: string;
2421
- };
2422
- metadata?: {
2423
- links?: {
2424
- self: {
2425
- href?: string;
2426
- };
2427
- next?: {
2428
- href?: string;
2429
- };
2430
- prev?: {
2431
- href?: string;
2432
- };
2433
- first: {
2434
- href?: string;
2435
- };
2436
- last: {
2437
- href?: string;
2438
- };
2439
- pages: {
2440
- [key: string]: {
2441
- href?: string;
2442
- };
2443
- };
2444
- };
2445
- totalCount?: number;
2446
- };
2447
- };
2448
- };
2449
- };
2450
- "5XX": {
2451
- headers: {
2452
- [name: string]: unknown;
2453
- };
2454
- content: {
2455
- "application/json": {
2456
- code: string;
2457
- detail: string;
2458
- requestId: string;
2459
- name: string;
2460
- validation?: {
2461
- fieldName: string;
2462
- message: string;
2463
- }[];
2464
- validationContext?: string;
2465
- };
2466
- };
2467
- };
2468
- "4XX": {
2469
- headers: {
2470
- [name: string]: unknown;
2471
- };
2472
- content: {
2473
- "application/json": {
2474
- code: string;
2475
- detail: string;
2476
- requestId: string;
2477
- name: string;
2478
- validation?: {
2479
- fieldName: string;
2480
- message: string;
2481
- }[];
2482
- validationContext?: string;
2483
- };
2484
- };
2485
- };
2486
- };
2487
- }, {
2488
- params: {
2489
- path: {
2490
- providerId: string;
2491
- };
2492
- };
2493
- }>>;
2494
- importUsers(toImport: {
2495
- file?: File;
2496
- records?: object[];
2497
- }): Promise<{
2498
- data: {
2499
- id: string;
2500
- } | undefined;
2501
- error: import("openapi-typescript-helpers").ErrorResponse<{
2502
- 200: {
2503
- headers: {
2504
- [name: string]: unknown;
2505
- };
2506
- content: {
2507
- "application/json": {
2508
- data: {
2509
- id: string;
2510
- };
2511
- };
2512
- };
2513
- };
2514
- "5XX": {
2515
- headers: {
2516
- [name: string]: unknown;
2517
- };
2518
- content: {
2519
- "application/json": {
2520
- code: string;
2521
- detail: string;
2522
- requestId: string;
2523
- name: string;
2524
- validation?: {
2525
- fieldName: string;
2526
- message: string;
2527
- }[];
2528
- validationContext?: string;
2529
- };
2530
- };
2531
- };
2532
- "4XX": {
2533
- headers: {
2534
- [name: string]: unknown;
2535
- };
2536
- content: {
2537
- "application/json": {
2538
- code: string;
2539
- detail: string;
2540
- requestId: string;
2541
- name: string;
2542
- validation?: {
2543
- fieldName: string;
2544
- message: string;
2545
- }[];
2546
- validationContext?: string;
2547
- };
2548
- };
2549
- };
2550
- }, `${string}/${string}`> | undefined;
2551
- }>;
2552
- downloadUsersCsvTemplate(): Promise<import("../../utils/client-utils.js").DataResponseValue<{
2553
- parameters: {
2554
- query?: never;
2555
- header?: never;
2556
- path?: never;
2557
- cookie?: never;
2558
- };
2559
- requestBody?: never;
2560
- responses: {
2561
- 200: {
2562
- headers: {
2563
- [name: string]: unknown;
2564
- };
2565
- content: {
2566
- "text/csv": string;
2567
- };
2568
- };
2569
- };
2570
- }, {
2571
- parseAs: "blob";
2572
- }>>;
2573
- getUsersImports(pagination?: {
2574
- limit: number;
2575
- offset: number;
2576
- }): Promise<import("../../utils/client-utils.js").DataResponseValue<{
2577
- parameters: {
2578
- query?: {
2579
- offset?: string;
2580
- limit?: string;
2581
- };
2582
- header?: never;
2583
- path?: never;
2584
- cookie?: never;
2585
- };
2586
- requestBody?: never;
2587
- responses: {
2588
- 200: {
2589
- headers: {
2590
- [name: string]: unknown;
2591
- };
2592
- content: {
2593
- "application/json": {
2594
- data: {
2595
- organisationId: string;
2596
- importedAt: string;
2597
- importChannel: "api" | "csv";
2598
- retryCount: number;
2599
- lastRetryAt: string | null;
2600
- id: string;
2601
- }[];
2602
- metadata?: {
2603
- links?: {
2604
- self: {
2605
- href?: string;
2606
- };
2607
- next?: {
2608
- href?: string;
2609
- };
2610
- prev?: {
2611
- href?: string;
2612
- };
2613
- first: {
2614
- href?: string;
2615
- };
2616
- last: {
2617
- href?: string;
2618
- };
2619
- pages: {
2620
- [key: string]: {
2621
- href?: string;
2622
- };
2623
- };
2624
- };
2625
- totalCount?: number;
2626
- };
2627
- };
2628
- };
2629
- };
2630
- };
2631
- }, {
2632
- params: {
2633
- query: {
2634
- limit: string | undefined;
2635
- offset: string | undefined;
2636
- };
2637
- };
2638
- }>>;
2639
- getUsersImport(importId: string, includeUsersData?: boolean): Promise<import("../../utils/client-utils.js").DataResponseValue<{
2640
- parameters: {
2641
- query?: {
2642
- includeImportedData?: "true" | "false" | "0" | "1";
2643
- };
2644
- header?: never;
2645
- path: {
2646
- importId: string;
2647
- };
2648
- cookie?: never;
2649
- };
2650
- requestBody?: never;
2651
- responses: {
2652
- 200: {
2653
- headers: {
2654
- [name: string]: unknown;
2655
- };
2656
- content: {
2657
- "application/json": {
2658
- data: {
2659
- organisationId: string;
2660
- importedAt: string;
2661
- usersData: {
2662
- importIndex: number;
2663
- phoneNumber: null | string;
2664
- emailAddress: null | string;
2665
- importStatus: "pending" | "imported" | "not_found" | "error" | "missing_contacts";
2666
- importError: null | string;
2667
- relatedUserProfileId: null | string;
2668
- relatedUserId: null | string;
2669
- tags?: string[];
2670
- publicIdentityId: null | string;
2671
- firstName: null | string;
2672
- lastName: null | string;
2673
- birthDate: null | string;
2674
- address: {
2675
- city: null | string;
2676
- zipCode: null | string;
2677
- street: null | string;
2678
- country: null | string;
2679
- region: null | string;
2680
- } | null;
2681
- collectedConsent: boolean;
2682
- welcomed: boolean;
2683
- }[];
2684
- importChannel: "api" | "csv";
2685
- retryCount: number;
2686
- lastRetryAt: string | null;
2687
- id: string;
2688
- };
2689
- metadata?: {
2690
- links?: {
2691
- self: {
2692
- href?: string;
2693
- };
2694
- next?: {
2695
- href?: string;
2696
- };
2697
- prev?: {
2698
- href?: string;
2699
- };
2700
- first: {
2701
- href?: string;
2702
- };
2703
- last: {
2704
- href?: string;
2705
- };
2706
- pages: {
2707
- [key: string]: {
2708
- href?: string;
2709
- };
2710
- };
2711
- };
2712
- totalCount?: number;
2713
- };
2714
- };
2715
- };
2716
- };
2717
- "5XX": {
2718
- headers: {
2719
- [name: string]: unknown;
2720
- };
2721
- content: {
2722
- "application/json": {
2723
- code: string;
2724
- detail: string;
2725
- requestId: string;
2726
- name: string;
2727
- validation?: {
2728
- fieldName: string;
2729
- message: string;
2730
- }[];
2731
- validationContext?: string;
2732
- };
2733
- };
2734
- };
2735
- "4XX": {
2736
- headers: {
2737
- [name: string]: unknown;
2738
- };
2739
- content: {
2740
- "application/json": {
2741
- code: string;
2742
- detail: string;
2743
- requestId: string;
2744
- name: string;
2745
- validation?: {
2746
- fieldName: string;
2747
- message: string;
2748
- }[];
2749
- validationContext?: string;
2750
- };
2751
- };
2752
- };
2753
- };
2754
- }, {
2755
- params: {
2756
- path: {
2757
- importId: string;
2758
- };
2759
- query: {
2760
- includeImportedData: "true" | "false" | undefined;
2761
- };
2762
- };
2763
- }>>;
2764
- getUsersForImport(importId: string, activeOnly: boolean): Promise<import("../../utils/client-utils.js").DataResponseValue<{
2765
- parameters: {
2766
- query?: {
2767
- search?: string;
2768
- transports?: string;
2769
- importId?: string;
2770
- activeOnly?: string;
2771
- offset?: string;
2772
- limit?: string;
2773
- };
2774
- header?: never;
2775
- path?: never;
2776
- cookie?: never;
2777
- };
2778
- requestBody?: never;
2779
- responses: {
2780
- 200: {
2781
- headers: {
2782
- [name: string]: unknown;
2783
- };
2784
- content: {
2785
- "application/json": {
2786
- data: {
2787
- organisationSettingId: string;
2788
- firstName: null | string;
2789
- lastName: null | string;
2790
- birthDate: null | string;
2791
- lang: null | string;
2792
- ppsn: null | string;
2793
- id: string;
2794
- userProfileId: null | string;
2795
- phoneNumber: null | string;
2796
- emailAddress: null | string;
2797
- organisationId: string;
2798
- organisationInvitationStatus: "to_be_invited" | "pending" | "accepted" | "declined";
2799
- organisationInvitationSentAt?: string;
2800
- organisationInvitationFeedbackAt?: string;
2801
- organisationPreferredTransports: ("sms" | "email")[];
2802
- correlationQuality: "full" | "partial" | "not_related";
2803
- userStatus: "to_be_invited" | "pending" | "disabled" | "active";
2804
- details?: {
2805
- publicIdentityId: null | string;
2806
- firstName: null | string;
2807
- lastName: null | string;
2808
- birthDate: null | string;
2809
- address: {
2810
- city: null | string;
2811
- zipCode: null | string;
2812
- street: null | string;
2813
- country: null | string;
2814
- region: null | string;
2815
- } | null;
2816
- collectedConsent: boolean;
2817
- welcomed: boolean;
2818
- };
2819
- }[];
2820
- metadata?: {
2821
- links?: {
2822
- self: {
2823
- href?: string;
2824
- };
2825
- next?: {
2826
- href?: string;
2827
- };
2828
- prev?: {
2829
- href?: string;
2830
- };
2831
- first: {
2832
- href?: string;
2833
- };
2834
- last: {
2835
- href?: string;
2836
- };
2837
- pages: {
2838
- [key: string]: {
2839
- href?: string;
2840
- };
2841
- };
2842
- };
2843
- totalCount?: number;
2844
- };
2845
- };
2846
- };
2847
- };
2848
- "5XX": {
2849
- headers: {
2850
- [name: string]: unknown;
2851
- };
2852
- content: {
2853
- "application/json": {
2854
- code: string;
2855
- detail: string;
2856
- requestId: string;
2857
- name: string;
2858
- validation?: {
2859
- fieldName: string;
2860
- message: string;
2861
- }[];
2862
- validationContext?: string;
2863
- };
2864
- };
2865
- };
2866
- "4XX": {
2867
- headers: {
2868
- [name: string]: unknown;
2869
- };
2870
- content: {
2871
- "application/json": {
2872
- code: string;
2873
- detail: string;
2874
- requestId: string;
2875
- name: string;
2876
- validation?: {
2877
- fieldName: string;
2878
- message: string;
2879
- }[];
2880
- validationContext?: string;
2881
- };
2882
- };
2883
- };
2884
- };
2885
- }, {
2886
- params: {
2887
- query: {
2888
- importId: string;
2889
- activeOnly: string;
2890
- };
2891
- };
2892
- }>>;
2893
- getOrganisationsSettings(filter?: PaginationParams): Promise<import("../../utils/client-utils.js").DataResponseValue<{
2894
- parameters: {
2895
- query?: {
2896
- offset?: string;
2897
- limit?: string;
2898
- };
2899
- header?: never;
2900
- path?: never;
2901
- cookie?: never;
2902
- };
2903
- requestBody?: never;
2904
- responses: {
2905
- 200: {
2906
- headers: {
2907
- [name: string]: unknown;
2908
- };
2909
- content: {
2910
- "application/json": {
2911
- data: {
2912
- id: string;
2913
- userId: string;
2914
- userProfileId: null | string;
2915
- phoneNumber: null | string;
2916
- emailAddress: null | string;
2917
- organisationId: string;
2918
- organisationInvitationStatus: "to_be_invited" | "pending" | "accepted" | "declined";
2919
- organisationInvitationSentAt?: string;
2920
- organisationInvitationFeedbackAt?: string;
2921
- organisationPreferredTransports: ("sms" | "email")[];
2922
- correlationQuality: "full" | "partial" | "not_related";
2923
- userStatus: "to_be_invited" | "pending" | "disabled" | "active";
2924
- details?: {
2925
- publicIdentityId: null | string;
2926
- firstName: null | string;
2927
- lastName: null | string;
2928
- birthDate: null | string;
2929
- address: {
2930
- city: null | string;
2931
- zipCode: null | string;
2932
- street: null | string;
2933
- country: null | string;
2934
- region: null | string;
2935
- } | null;
2936
- collectedConsent: boolean;
2937
- welcomed: boolean;
2938
- };
2939
- }[];
2940
- metadata?: {
2941
- links?: {
2942
- self: {
2943
- href?: string;
2944
- };
2945
- next?: {
2946
- href?: string;
2947
- };
2948
- prev?: {
2949
- href?: string;
2950
- };
2951
- first: {
2952
- href?: string;
2953
- };
2954
- last: {
2955
- href?: string;
2956
- };
2957
- pages: {
2958
- [key: string]: {
2959
- href?: string;
2960
- };
2961
- };
2962
- };
2963
- totalCount?: number;
2964
- };
2965
- };
2966
- };
2967
- };
2968
- 400: {
2969
- headers: {
2970
- [name: string]: unknown;
2971
- };
2972
- content: {
2973
- "application/json": {
2974
- code: string;
2975
- detail: string;
2976
- requestId: string;
2977
- name: string;
2978
- validation?: {
2979
- fieldName: string;
2980
- message: string;
2981
- }[];
2982
- validationContext?: string;
2983
- };
2984
- };
2985
- };
2986
- 404: {
2987
- headers: {
2988
- [name: string]: unknown;
2989
- };
2990
- content: {
2991
- "application/json": {
2992
- code: string;
2993
- detail: string;
2994
- requestId: string;
2995
- name: string;
2996
- validation?: {
2997
- fieldName: string;
2998
- message: string;
2999
- }[];
3000
- validationContext?: string;
3001
- };
3002
- };
3003
- };
3004
- 500: {
3005
- headers: {
3006
- [name: string]: unknown;
3007
- };
3008
- content: {
3009
- "application/json": {
3010
- code: string;
3011
- detail: string;
3012
- requestId: string;
3013
- name: string;
3014
- validation?: {
3015
- fieldName: string;
3016
- message: string;
3017
- }[];
3018
- validationContext?: string;
3019
- };
3020
- };
3021
- };
3022
- };
3023
- }, {
3024
- params: {
3025
- query: {
3026
- offset?: string;
3027
- limit?: string;
3028
- };
3029
- };
3030
- }>>;
3031
- getOrganisationSettings(organisationSettingId: string): Promise<import("../../utils/client-utils.js").DataResponseValue<{
3032
- parameters: {
3033
- query?: never;
3034
- header?: never;
3035
- path: {
3036
- organisationSettingId: string;
3037
- };
3038
- cookie?: never;
3039
- };
3040
- requestBody?: never;
3041
- responses: {
3042
- 200: {
3043
- headers: {
3044
- [name: string]: unknown;
3045
- };
3046
- content: {
3047
- "application/json": {
3048
- data: {
3049
- id: string;
3050
- userId: string;
3051
- userProfileId: null | string;
3052
- phoneNumber: null | string;
3053
- emailAddress: null | string;
3054
- organisationId: string;
3055
- organisationInvitationStatus: "to_be_invited" | "pending" | "accepted" | "declined";
3056
- organisationInvitationSentAt?: string;
3057
- organisationInvitationFeedbackAt?: string;
3058
- organisationPreferredTransports: ("sms" | "email")[];
3059
- correlationQuality: "full" | "partial" | "not_related";
3060
- userStatus: "to_be_invited" | "pending" | "disabled" | "active";
3061
- details?: {
3062
- publicIdentityId: null | string;
3063
- firstName: null | string;
3064
- lastName: null | string;
3065
- birthDate: null | string;
3066
- address: {
3067
- city: null | string;
3068
- zipCode: null | string;
3069
- street: null | string;
3070
- country: null | string;
3071
- region: null | string;
3072
- } | null;
3073
- collectedConsent: boolean;
3074
- welcomed: boolean;
3075
- };
3076
- };
3077
- metadata?: {
3078
- links?: {
3079
- self: {
3080
- href?: string;
3081
- };
3082
- next?: {
3083
- href?: string;
3084
- };
3085
- prev?: {
3086
- href?: string;
3087
- };
3088
- first: {
3089
- href?: string;
3090
- };
3091
- last: {
3092
- href?: string;
3093
- };
3094
- pages: {
3095
- [key: string]: {
3096
- href?: string;
3097
- };
3098
- };
3099
- };
3100
- totalCount?: number;
3101
- };
3102
- };
3103
- };
3104
- };
3105
- 400: {
3106
- headers: {
3107
- [name: string]: unknown;
3108
- };
3109
- content: {
3110
- "application/json": {
3111
- code: string;
3112
- detail: string;
3113
- requestId: string;
3114
- name: string;
3115
- validation?: {
3116
- fieldName: string;
3117
- message: string;
3118
- }[];
3119
- validationContext?: string;
3120
- };
3121
- };
3122
- };
3123
- 404: {
3124
- headers: {
3125
- [name: string]: unknown;
3126
- };
3127
- content: {
3128
- "application/json": {
3129
- code: string;
3130
- detail: string;
3131
- requestId: string;
3132
- name: string;
3133
- validation?: {
3134
- fieldName: string;
3135
- message: string;
3136
- }[];
3137
- validationContext?: string;
3138
- };
3139
- };
3140
- };
3141
- 500: {
3142
- headers: {
3143
- [name: string]: unknown;
3144
- };
3145
- content: {
3146
- "application/json": {
3147
- code: string;
3148
- detail: string;
3149
- requestId: string;
3150
- name: string;
3151
- validation?: {
3152
- fieldName: string;
3153
- message: string;
3154
- }[];
3155
- validationContext?: string;
3156
- };
3157
- };
3158
- };
3159
- };
3160
- }, {
3161
- params: {
3162
- path: {
3163
- organisationSettingId: string;
3164
- };
3165
- };
3166
- }>>;
3167
- updateOrganisationSettings(organisationSettingId: string, body: paths["/api/v1/organisation-settings/{organisationSettingId}"]["patch"]["requestBody"]["content"]["application/json"]): Promise<import("../../utils/client-utils.js").DataResponseValue<{
3168
- parameters: {
3169
- query?: never;
3170
- header?: never;
3171
- path: {
3172
- organisationSettingId: string;
3173
- };
3174
- cookie?: never;
3175
- };
3176
- requestBody: {
3177
- content: {
3178
- "application/json": {
3179
- invitationStatusFeedback: "accepted" | "declined";
3180
- preferredTransports: ("sms" | "email")[];
3181
- };
3182
- };
3183
- };
3184
- responses: {
3185
- 202: {
3186
- headers: {
3187
- [name: string]: unknown;
3188
- };
3189
- content: {
3190
- "application/json": {
3191
- data: {
3192
- id: string;
3193
- userId: string;
3194
- userProfileId: null | string;
3195
- phoneNumber: null | string;
3196
- emailAddress: null | string;
3197
- organisationId: string;
3198
- organisationInvitationStatus: "to_be_invited" | "pending" | "accepted" | "declined";
3199
- organisationInvitationSentAt?: string;
3200
- organisationInvitationFeedbackAt?: string;
3201
- organisationPreferredTransports: ("sms" | "email")[];
3202
- correlationQuality: "full" | "partial" | "not_related";
3203
- userStatus: "to_be_invited" | "pending" | "disabled" | "active";
3204
- details?: {
3205
- publicIdentityId: null | string;
3206
- firstName: null | string;
3207
- lastName: null | string;
3208
- birthDate: null | string;
3209
- address: {
3210
- city: null | string;
3211
- zipCode: null | string;
3212
- street: null | string;
3213
- country: null | string;
3214
- region: null | string;
3215
- } | null;
3216
- collectedConsent: boolean;
3217
- welcomed: boolean;
3218
- };
3219
- };
3220
- metadata?: {
3221
- links?: {
3222
- self: {
3223
- href?: string;
3224
- };
3225
- next?: {
3226
- href?: string;
3227
- };
3228
- prev?: {
3229
- href?: string;
3230
- };
3231
- first: {
3232
- href?: string;
3233
- };
3234
- last: {
3235
- href?: string;
3236
- };
3237
- pages: {
3238
- [key: string]: {
3239
- href?: string;
3240
- };
3241
- };
3242
- };
3243
- totalCount?: number;
3244
- };
3245
- };
3246
- };
3247
- };
3248
- 400: {
3249
- headers: {
3250
- [name: string]: unknown;
3251
- };
3252
- content: {
3253
- "application/json": {
3254
- code: string;
3255
- detail: string;
3256
- requestId: string;
3257
- name: string;
3258
- validation?: {
3259
- fieldName: string;
3260
- message: string;
3261
- }[];
3262
- validationContext?: string;
3263
- };
3264
- };
3265
- };
3266
- 404: {
3267
- headers: {
3268
- [name: string]: unknown;
3269
- };
3270
- content: {
3271
- "application/json": {
3272
- code: string;
3273
- detail: string;
3274
- requestId: string;
3275
- name: string;
3276
- validation?: {
3277
- fieldName: string;
3278
- message: string;
3279
- }[];
3280
- validationContext?: string;
3281
- };
3282
- };
3283
- };
3284
- 500: {
3285
- headers: {
3286
- [name: string]: unknown;
3287
- };
3288
- content: {
3289
- "application/json": {
3290
- code: string;
3291
- detail: string;
3292
- requestId: string;
3293
- name: string;
3294
- validation?: {
3295
- fieldName: string;
3296
- message: string;
3297
- }[];
3298
- validationContext?: string;
3299
- };
3300
- };
3301
- };
3302
- };
3303
- }, {
3304
- body: {
3305
- invitationStatusFeedback: "accepted" | "declined";
3306
- preferredTransports: ("sms" | "email")[];
3307
- };
3308
- params: {
3309
- path: {
3310
- organisationSettingId: string;
3311
- };
1739
+ query: any;
3312
1740
  };
3313
1741
  }>>;
3314
1742
  getMessageEvents(params: {
@@ -3510,267 +1938,6 @@ export declare class Messaging extends BaseClient<paths> {
3510
1938
  };
3511
1939
  };
3512
1940
  }>>;
3513
- getUsers(query?: paths["/api/v1/users/"]["get"]["parameters"]["query"]): Promise<import("../../utils/client-utils.js").DataResponseValue<{
3514
- parameters: {
3515
- query?: {
3516
- search?: string;
3517
- transports?: string;
3518
- importId?: string;
3519
- activeOnly?: string;
3520
- offset?: string;
3521
- limit?: string;
3522
- };
3523
- header?: never;
3524
- path?: never;
3525
- cookie?: never;
3526
- };
3527
- requestBody?: never;
3528
- responses: {
3529
- 200: {
3530
- headers: {
3531
- [name: string]: unknown;
3532
- };
3533
- content: {
3534
- "application/json": {
3535
- data: {
3536
- organisationSettingId: string;
3537
- firstName: null | string;
3538
- lastName: null | string;
3539
- birthDate: null | string;
3540
- lang: null | string;
3541
- ppsn: null | string;
3542
- id: string;
3543
- userProfileId: null | string;
3544
- phoneNumber: null | string;
3545
- emailAddress: null | string;
3546
- organisationId: string;
3547
- organisationInvitationStatus: "to_be_invited" | "pending" | "accepted" | "declined";
3548
- organisationInvitationSentAt?: string;
3549
- organisationInvitationFeedbackAt?: string;
3550
- organisationPreferredTransports: ("sms" | "email")[];
3551
- correlationQuality: "full" | "partial" | "not_related";
3552
- userStatus: "to_be_invited" | "pending" | "disabled" | "active";
3553
- details?: {
3554
- publicIdentityId: null | string;
3555
- firstName: null | string;
3556
- lastName: null | string;
3557
- birthDate: null | string;
3558
- address: {
3559
- city: null | string;
3560
- zipCode: null | string;
3561
- street: null | string;
3562
- country: null | string;
3563
- region: null | string;
3564
- } | null;
3565
- collectedConsent: boolean;
3566
- welcomed: boolean;
3567
- };
3568
- }[];
3569
- metadata?: {
3570
- links?: {
3571
- self: {
3572
- href?: string;
3573
- };
3574
- next?: {
3575
- href?: string;
3576
- };
3577
- prev?: {
3578
- href?: string;
3579
- };
3580
- first: {
3581
- href?: string;
3582
- };
3583
- last: {
3584
- href?: string;
3585
- };
3586
- pages: {
3587
- [key: string]: {
3588
- href?: string;
3589
- };
3590
- };
3591
- };
3592
- totalCount?: number;
3593
- };
3594
- };
3595
- };
3596
- };
3597
- "5XX": {
3598
- headers: {
3599
- [name: string]: unknown;
3600
- };
3601
- content: {
3602
- "application/json": {
3603
- code: string;
3604
- detail: string;
3605
- requestId: string;
3606
- name: string;
3607
- validation?: {
3608
- fieldName: string;
3609
- message: string;
3610
- }[];
3611
- validationContext?: string;
3612
- };
3613
- };
3614
- };
3615
- "4XX": {
3616
- headers: {
3617
- [name: string]: unknown;
3618
- };
3619
- content: {
3620
- "application/json": {
3621
- code: string;
3622
- detail: string;
3623
- requestId: string;
3624
- name: string;
3625
- validation?: {
3626
- fieldName: string;
3627
- message: string;
3628
- }[];
3629
- validationContext?: string;
3630
- };
3631
- };
3632
- };
3633
- };
3634
- }, {
3635
- params: {
3636
- query: {
3637
- offset?: string;
3638
- limit?: string;
3639
- search?: string;
3640
- transports?: string;
3641
- importId?: string;
3642
- activeOnly?: string;
3643
- };
3644
- };
3645
- }>>;
3646
- getUser(userId: paths["/api/v1/users/{userId}"]["get"]["parameters"]["path"]["userId"], activeOnly: boolean): Promise<import("../../utils/client-utils.js").DataResponseValue<{
3647
- parameters: {
3648
- query?: {
3649
- activeOnly?: string;
3650
- };
3651
- header?: never;
3652
- path: {
3653
- userId: string;
3654
- };
3655
- cookie?: never;
3656
- };
3657
- requestBody?: never;
3658
- responses: {
3659
- 200: {
3660
- headers: {
3661
- [name: string]: unknown;
3662
- };
3663
- content: {
3664
- "application/json": {
3665
- data: {
3666
- organisationSettingId: string;
3667
- firstName: null | string;
3668
- lastName: null | string;
3669
- birthDate: null | string;
3670
- lang: null | string;
3671
- ppsn: null | string;
3672
- id: string;
3673
- userProfileId: null | string;
3674
- phoneNumber: null | string;
3675
- emailAddress: null | string;
3676
- organisationId: string;
3677
- organisationInvitationStatus: "to_be_invited" | "pending" | "accepted" | "declined";
3678
- organisationInvitationSentAt?: string;
3679
- organisationInvitationFeedbackAt?: string;
3680
- organisationPreferredTransports: ("sms" | "email")[];
3681
- correlationQuality: "full" | "partial" | "not_related";
3682
- userStatus: "to_be_invited" | "pending" | "disabled" | "active";
3683
- details?: {
3684
- publicIdentityId: null | string;
3685
- firstName: null | string;
3686
- lastName: null | string;
3687
- birthDate: null | string;
3688
- address: {
3689
- city: null | string;
3690
- zipCode: null | string;
3691
- street: null | string;
3692
- country: null | string;
3693
- region: null | string;
3694
- } | null;
3695
- collectedConsent: boolean;
3696
- welcomed: boolean;
3697
- };
3698
- };
3699
- metadata?: {
3700
- links?: {
3701
- self: {
3702
- href?: string;
3703
- };
3704
- next?: {
3705
- href?: string;
3706
- };
3707
- prev?: {
3708
- href?: string;
3709
- };
3710
- first: {
3711
- href?: string;
3712
- };
3713
- last: {
3714
- href?: string;
3715
- };
3716
- pages: {
3717
- [key: string]: {
3718
- href?: string;
3719
- };
3720
- };
3721
- };
3722
- totalCount?: number;
3723
- };
3724
- };
3725
- };
3726
- };
3727
- "5XX": {
3728
- headers: {
3729
- [name: string]: unknown;
3730
- };
3731
- content: {
3732
- "application/json": {
3733
- code: string;
3734
- detail: string;
3735
- requestId: string;
3736
- name: string;
3737
- validation?: {
3738
- fieldName: string;
3739
- message: string;
3740
- }[];
3741
- validationContext?: string;
3742
- };
3743
- };
3744
- };
3745
- "4XX": {
3746
- headers: {
3747
- [name: string]: unknown;
3748
- };
3749
- content: {
3750
- "application/json": {
3751
- code: string;
3752
- detail: string;
3753
- requestId: string;
3754
- name: string;
3755
- validation?: {
3756
- fieldName: string;
3757
- message: string;
3758
- }[];
3759
- validationContext?: string;
3760
- };
3761
- };
3762
- };
3763
- };
3764
- }, {
3765
- params: {
3766
- path: {
3767
- userId: string;
3768
- };
3769
- query: {
3770
- activeOnly: string | undefined;
3771
- };
3772
- };
3773
- }>>;
3774
1941
  seeMessage(messageId: string): Promise<never>;
3775
1942
  unseeMessage(messageId: string): Promise<never>;
3776
1943
  newInterpolator(interpolations: Record<string, string>): (acc: string, key: string) => string;