diff --git a/package-lock.json b/package-lock.json index 8ad867d..8ec6a9b 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "@adyen/api-library", - "version": "8.1.0", + "version": "8.2.0", "lockfileVersion": 1, "requires": true, "dependencies": { @@ -671,28 +671,28 @@ } }, "@nodelib/fs.scandir": { - "version": "2.1.4", - "resolved": "https://registry.npmjs.org/@nodelib/fs.scandir/-/fs.scandir-2.1.4.tgz", - "integrity": "sha512-33g3pMJk3bg5nXbL/+CY6I2eJDzZAni49PfJnL5fghPTggPvBd/pFNSgJsdAgWptuFu7qq/ERvOYFlhvsLTCKA==", + "version": "2.1.5", + "resolved": "https://registry.npmjs.org/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz", + "integrity": "sha512-vq24Bq3ym5HEQm2NKCr3yXDwjc7vTsEThRDnkp2DK9p1uqLR+DHurm/NOTo0KG7HYHU7eppKZj3MyqYuMBf62g==", "dev": true, "requires": { - "@nodelib/fs.stat": "2.0.4", + "@nodelib/fs.stat": "2.0.5", "run-parallel": "^1.1.9" } }, "@nodelib/fs.stat": { - "version": "2.0.4", - "resolved": "https://registry.npmjs.org/@nodelib/fs.stat/-/fs.stat-2.0.4.tgz", - "integrity": "sha512-IYlHJA0clt2+Vg7bccq+TzRdJvv19c2INqBSsoOLp1je7xjtr7J26+WXR72MCdvU9q1qTzIWDfhMf+DRvQJK4Q==", + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/@nodelib/fs.stat/-/fs.stat-2.0.5.tgz", + "integrity": "sha512-RkhPPp2zrqDAQA/2jNhnztcPAlv64XdhIp7a7454A5ovI7Bukxgt7MX7udwAu3zg1DcpPU0rz3VV1SeaqvY4+A==", "dev": true }, "@nodelib/fs.walk": { - "version": "1.2.6", - "resolved": "https://registry.npmjs.org/@nodelib/fs.walk/-/fs.walk-1.2.6.tgz", - "integrity": "sha512-8Broas6vTtW4GIXTAHDoE32hnN2M5ykgCpWGbuXHQ15vEMqr23pB76e/GZcYsZCHALv50ktd24qhEyKr6wBtow==", + "version": "1.2.7", + "resolved": "https://registry.npmjs.org/@nodelib/fs.walk/-/fs.walk-1.2.7.tgz", + "integrity": "sha512-BTIhocbPBSrRmHxOAJFtR18oLhxTtAFDAvL8hY1S3iU8k+E60W/YFs4jrixGzQjMpF4qPXxIQHcjVD9dz1C2QA==", "dev": true, "requires": { - "@nodelib/fs.scandir": "2.1.4", + "@nodelib/fs.scandir": "2.1.5", "fastq": "^1.6.0" } }, @@ -706,14 +706,14 @@ } }, "@octokit/core": { - "version": "3.4.0", - "resolved": "https://registry.npmjs.org/@octokit/core/-/core-3.4.0.tgz", - "integrity": "sha512-6/vlKPP8NF17cgYXqucdshWqmMZGXkuvtcrWCgU5NOI0Pl2GjlmZyWgBMrU8zJ3v2MJlM6++CiB45VKYmhiWWg==", + "version": "3.5.1", + "resolved": "https://registry.npmjs.org/@octokit/core/-/core-3.5.1.tgz", + "integrity": "sha512-omncwpLVxMP+GLpLPgeGJBF6IWJFjXDS5flY5VbppePYX9XehevbDykRH9PdCdvqt9TS5AOTiDide7h0qrkHjw==", "dev": true, "requires": { "@octokit/auth-token": "^2.4.4", "@octokit/graphql": "^4.5.8", - "@octokit/request": "^5.4.12", + "@octokit/request": "^5.6.0", "@octokit/request-error": "^2.0.5", "@octokit/types": "^6.0.3", "before-after-hook": "^2.2.0", @@ -721,9 +721,9 @@ } }, "@octokit/endpoint": { - "version": "6.0.11", - "resolved": "https://registry.npmjs.org/@octokit/endpoint/-/endpoint-6.0.11.tgz", - "integrity": "sha512-fUIPpx+pZyoLW4GCs3yMnlj2LfoXTWDUVPTC4V3MUEKZm48W+XYpeWSZCv+vYF1ZABUm2CqnDVf1sFtIYrj7KQ==", + "version": "6.0.12", + "resolved": "https://registry.npmjs.org/@octokit/endpoint/-/endpoint-6.0.12.tgz", + "integrity": "sha512-lF3puPwkQWGfkMClXb4k/eUT/nZKQfxinRWJrdZaJO85Dqwo/G0yOC434Jr2ojwafWJMYqFGFa5ms4jJUgujdA==", "dev": true, "requires": { "@octokit/types": "^6.0.3", @@ -740,56 +740,56 @@ } }, "@octokit/graphql": { - "version": "4.6.2", - "resolved": "https://registry.npmjs.org/@octokit/graphql/-/graphql-4.6.2.tgz", - "integrity": "sha512-WmsIR1OzOr/3IqfG9JIczI8gMJUMzzyx5j0XXQ4YihHtKlQc+u35VpVoOXhlKAlaBntvry1WpAzPl/a+s3n89Q==", + "version": "4.6.4", + "resolved": "https://registry.npmjs.org/@octokit/graphql/-/graphql-4.6.4.tgz", + "integrity": "sha512-SWTdXsVheRmlotWNjKzPOb6Js6tjSqA2a8z9+glDJng0Aqjzti8MEWOtuT8ZSu6wHnci7LZNuarE87+WJBG4vg==", "dev": true, "requires": { - "@octokit/request": "^5.3.0", + "@octokit/request": "^5.6.0", "@octokit/types": "^6.0.3", "universal-user-agent": "^6.0.0" } }, "@octokit/openapi-types": { - "version": "7.2.1", - "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-7.2.1.tgz", - "integrity": "sha512-IHQJpLciwzwDvciLxiFj3IEV5VYn7lSVcj5cu0jbTwMfK4IG6/g8SPrVp3Le1VRzIiYSRcBzm1dA7vgWelYP3Q==", + "version": "7.3.2", + "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-7.3.2.tgz", + "integrity": "sha512-oJhK/yhl9Gt430OrZOzAl2wJqR0No9445vmZ9Ey8GjUZUpwuu/vmEFP0TDhDXdpGDoxD6/EIFHJEcY8nHXpDTA==", "dev": true }, "@octokit/plugin-paginate-rest": { - "version": "2.13.3", - "resolved": "https://registry.npmjs.org/@octokit/plugin-paginate-rest/-/plugin-paginate-rest-2.13.3.tgz", - "integrity": "sha512-46lptzM9lTeSmIBt/sVP/FLSTPGx6DCzAdSX3PfeJ3mTf4h9sGC26WpaQzMEq/Z44cOcmx8VsOhO+uEgE3cjYg==", + "version": "2.13.5", + "resolved": "https://registry.npmjs.org/@octokit/plugin-paginate-rest/-/plugin-paginate-rest-2.13.5.tgz", + "integrity": "sha512-3WSAKBLa1RaR/7GG+LQR/tAZ9fp9H9waE9aPXallidyci9oZsfgsLn5M836d3LuDC6Fcym+2idRTBpssHZePVg==", "dev": true, "requires": { - "@octokit/types": "^6.11.0" + "@octokit/types": "^6.13.0" } }, "@octokit/plugin-request-log": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/@octokit/plugin-request-log/-/plugin-request-log-1.0.3.tgz", - "integrity": "sha512-4RFU4li238jMJAzLgAwkBAw+4Loile5haQMQr+uhFq27BmyJXcXSKvoQKqh0agsZEiUlW6iSv3FAgvmGkur7OQ==", + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/@octokit/plugin-request-log/-/plugin-request-log-1.0.4.tgz", + "integrity": "sha512-mLUsMkgP7K/cnFEw07kWqXGF5LKrOkD+lhCrKvPHXWDywAwuDUeDwWBpc69XK3pNX0uKiVt8g5z96PJ6z9xCFA==", "dev": true }, "@octokit/plugin-rest-endpoint-methods": { - "version": "5.0.1", - "resolved": "https://registry.npmjs.org/@octokit/plugin-rest-endpoint-methods/-/plugin-rest-endpoint-methods-5.0.1.tgz", - "integrity": "sha512-vvWbPtPqLyIzJ7A4IPdTl+8IeuKAwMJ4LjvmqWOOdfSuqWQYZXq2CEd0hsnkidff2YfKlguzujHs/reBdAx8Sg==", + "version": "5.3.1", + "resolved": "https://registry.npmjs.org/@octokit/plugin-rest-endpoint-methods/-/plugin-rest-endpoint-methods-5.3.1.tgz", + "integrity": "sha512-3B2iguGmkh6bQQaVOtCsS0gixrz8Lg0v4JuXPqBcFqLKuJtxAUf3K88RxMEf/naDOI73spD+goJ/o7Ie7Cvdjg==", "dev": true, "requires": { - "@octokit/types": "^6.13.1", + "@octokit/types": "^6.16.2", "deprecation": "^2.3.1" } }, "@octokit/request": { - "version": "5.4.15", - "resolved": "https://registry.npmjs.org/@octokit/request/-/request-5.4.15.tgz", - "integrity": "sha512-6UnZfZzLwNhdLRreOtTkT9n57ZwulCve8q3IT/Z477vThu6snfdkBuhxnChpOKNGxcQ71ow561Qoa6uqLdPtag==", + "version": "5.6.0", + "resolved": "https://registry.npmjs.org/@octokit/request/-/request-5.6.0.tgz", + "integrity": "sha512-4cPp/N+NqmaGQwbh3vUsYqokQIzt7VjsgTYVXiwpUP2pxd5YiZB2XuTedbb0SPtv9XS7nzAKjAuQxmY8/aZkiA==", "dev": true, "requires": { "@octokit/endpoint": "^6.0.1", - "@octokit/request-error": "^2.0.0", - "@octokit/types": "^6.7.1", + "@octokit/request-error": "^2.1.0", + "@octokit/types": "^6.16.1", "is-plain-object": "^5.0.0", "node-fetch": "^2.6.1", "universal-user-agent": "^6.0.0" @@ -804,9 +804,9 @@ } }, "@octokit/request-error": { - "version": "2.0.5", - "resolved": "https://registry.npmjs.org/@octokit/request-error/-/request-error-2.0.5.tgz", - "integrity": "sha512-T/2wcCFyM7SkXzNoyVNWjyVlUwBvW3igM3Btr/eKYiPmucXTtkxt2RBsf6gn3LTzaLSLTQtNmvg+dGsOxQrjZg==", + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/@octokit/request-error/-/request-error-2.1.0.tgz", + "integrity": "sha512-1VIvgXxs9WHSjicsRwq8PlR2LR2x6DwsJAaFgzdi0JfJoGSO8mYI/cHJQ+9FbN21aa+DrgNLnwObmyeSC8Rmpg==", "dev": true, "requires": { "@octokit/types": "^6.0.3", @@ -815,24 +815,24 @@ } }, "@octokit/rest": { - "version": "18.5.3", - "resolved": "https://registry.npmjs.org/@octokit/rest/-/rest-18.5.3.tgz", - "integrity": "sha512-KPAsUCr1DOdLVbZJgGNuE/QVLWEaVBpFQwDAz/2Cnya6uW2wJ/P5RVGk0itx7yyN1aGa8uXm2pri4umEqG1JBA==", + "version": "18.6.0", + "resolved": "https://registry.npmjs.org/@octokit/rest/-/rest-18.6.0.tgz", + "integrity": "sha512-MdHuXHDJM7e5sUBe3K9tt7th0cs4csKU5Bb52LRi2oHAeIMrMZ4XqaTrEv660HoUPoM1iDlnj27Ab/Nh3MtwlA==", "dev": true, "requires": { - "@octokit/core": "^3.2.3", + "@octokit/core": "^3.5.0", "@octokit/plugin-paginate-rest": "^2.6.2", "@octokit/plugin-request-log": "^1.0.2", - "@octokit/plugin-rest-endpoint-methods": "5.0.1" + "@octokit/plugin-rest-endpoint-methods": "5.3.1" } }, "@octokit/types": { - "version": "6.16.0", - "resolved": "https://registry.npmjs.org/@octokit/types/-/types-6.16.0.tgz", - "integrity": "sha512-EktqSNq8EKXE82a7Vw33ozOEhFXIRik+rZHJTHAgVZRm/p2K5r5ecn5fVpRkLCm3CAVFwchRvt3yvtmfbt2LCQ==", + "version": "6.16.4", + "resolved": "https://registry.npmjs.org/@octokit/types/-/types-6.16.4.tgz", + "integrity": "sha512-UxhWCdSzloULfUyamfOg4dJxV9B+XjgrIZscI0VCbp4eNrjmorGEw+4qdwcpTsu6DIrm9tQsFQS2pK5QkqQ04A==", "dev": true, "requires": { - "@octokit/openapi-types": "^7.2.0" + "@octokit/openapi-types": "^7.3.2" } }, "@sindresorhus/is": { @@ -1185,9 +1185,9 @@ "dev": true }, "acorn": { - "version": "8.3.0", - "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.3.0.tgz", - "integrity": "sha512-tqPKHZ5CaBJw0Xmy0ZZvLs1qTV+BNFSyvn77ASXkpBNfIRk8ev26fKrD9iLGwGA9zedPao52GSHzq8lyZG0NUw==", + "version": "8.4.1", + "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.4.1.tgz", + "integrity": "sha512-asabaBSkEKosYKMITunzX177CXxQ4Q8BSSzMTKD+FefUhipQC70gfW5SiUDhYQ3vk8G+81HqQk7Fv9OXwwn9KA==", "dev": true }, "acorn-globals": { @@ -1574,9 +1574,9 @@ } }, "before-after-hook": { - "version": "2.2.1", - "resolved": "https://registry.npmjs.org/before-after-hook/-/before-after-hook-2.2.1.tgz", - "integrity": "sha512-/6FKxSTWoJdbsLDF8tdIjaRiFXiE6UHsEHE3OPI/cwPURCVi1ukP0gmLn7XWEiFk5TcwQjjY5PWsU+j+tgXgmw==", + "version": "2.2.2", + "resolved": "https://registry.npmjs.org/before-after-hook/-/before-after-hook-2.2.2.tgz", + "integrity": "sha512-3pZEU3NT5BFUo/AD5ERPWOgQOCZITni6iavr5AUw5AUwQjMlI0kzu5btnyD39AF0gUEsDPwJT+oY1ORBJijPjQ==", "dev": true }, "big.js": { @@ -1756,9 +1756,9 @@ "dev": true }, "cacheable-request": { - "version": "7.0.1", - "resolved": "https://registry.npmjs.org/cacheable-request/-/cacheable-request-7.0.1.tgz", - "integrity": "sha512-lt0mJ6YAnsrBErpTMWeu5kl/tg9xMAWjavYTN6VQXM1A/teBITuNcccXsCxF0tDQQJf9DfAaX5O4e0zp0KlfZw==", + "version": "7.0.2", + "resolved": "https://registry.npmjs.org/cacheable-request/-/cacheable-request-7.0.2.tgz", + "integrity": "sha512-pouW8/FmiPQbuGpkXQ9BAPv/Mo5xDGANgSNXzTzJ8DrKGuXOssM4wIQRjfanNRh3Yu5cfYPvcorqbhg2KIJtew==", "dev": true, "requires": { "clone-response": "^1.0.2", @@ -1766,7 +1766,7 @@ "http-cache-semantics": "^4.0.0", "keyv": "^4.0.0", "lowercase-keys": "^2.0.0", - "normalize-url": "^4.1.0", + "normalize-url": "^6.0.1", "responselike": "^2.0.0" }, "dependencies": { @@ -1778,12 +1778,6 @@ "requires": { "pump": "^3.0.0" } - }, - "normalize-url": { - "version": "4.5.1", - "resolved": "https://registry.npmjs.org/normalize-url/-/normalize-url-4.5.1.tgz", - "integrity": "sha512-9UZCFRHQdNrfTpGg8+1INIg93B6zE0aXMVFkw1WFwvO4SlZywU6aLg5Of0Ap/PgcbSw4LNxvMWXMeugwMCX0AA==", - "dev": true } } }, @@ -1998,9 +1992,9 @@ "dev": true }, "color-string": { - "version": "1.5.4", - "resolved": "https://registry.npmjs.org/color-string/-/color-string-1.5.4.tgz", - "integrity": "sha512-57yF5yt8Xa3czSEW1jfQDE79Idk0+AkN/4KWad6tbdxUmAs3MvjxlWSWD4deYytcRfoZ9nhKyFl1kj5tBvidbw==", + "version": "1.5.5", + "resolved": "https://registry.npmjs.org/color-string/-/color-string-1.5.5.tgz", + "integrity": "sha512-jgIoum0OfQfq9Whcfc2z/VhCNcmQjWbey6qBX0vqt7YICflUmBCh9E9CiQD5GSJ+Uehixm3NUwHVhqUAWRivZg==", "dev": true, "requires": { "color-name": "^1.0.0", @@ -3151,9 +3145,9 @@ } }, "glob-parent": { - "version": "5.1.1", - "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-5.1.1.tgz", - "integrity": "sha512-FnI+VGOpnlGHWZxthPGR+QhR78fuiK0sNLkHQv+bL9fQi57lNNdquIbna/WrfROrolq8GK5Ek6BiMwqL/voRYQ==", + "version": "5.1.2", + "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-5.1.2.tgz", + "integrity": "sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow==", "dev": true, "requires": { "is-glob": "^4.0.1" @@ -3178,9 +3172,9 @@ } }, "globby": { - "version": "11.0.3", - "resolved": "https://registry.npmjs.org/globby/-/globby-11.0.3.tgz", - "integrity": "sha512-ffdmosjA807y7+lA1NM0jELARVmYul/715xiILEjo3hBLPTcirgQNnXECn5g3mtR8TOLCVbkfua1Hpen25/Xcg==", + "version": "11.0.4", + "resolved": "https://registry.npmjs.org/globby/-/globby-11.0.4.tgz", + "integrity": "sha512-9O4MVG9ioZJ08ffbcyVYyLOJLk5JQ688pJ4eMGLpdWLHq/Wr1D9BlriLQyL0E+jbkuePVZXYFj47QM/v093wHg==", "dev": true, "requires": { "array-union": "^2.1.0", @@ -4721,9 +4715,9 @@ } }, "macos-release": { - "version": "2.4.1", - "resolved": "https://registry.npmjs.org/macos-release/-/macos-release-2.4.1.tgz", - "integrity": "sha512-H/QHeBIN1fIGJX517pvK8IEK53yQOW7YcEI55oYtgjDdoCQQz7eJS94qt5kNrscReEyuD/JcdFCm2XBEcGOITg==", + "version": "2.5.0", + "resolved": "https://registry.npmjs.org/macos-release/-/macos-release-2.5.0.tgz", + "integrity": "sha512-EIgv+QZ9r+814gjJj0Bt5vSLJLzswGmSUbUpbi9AIr/fsN2IWFBl2NucV9PAiek+U1STK468tEkxmVYUtuAN3g==", "dev": true }, "make-dir": { @@ -5031,9 +5025,9 @@ "dev": true }, "normalize-url": { - "version": "3.3.0", - "resolved": "https://registry.npmjs.org/normalize-url/-/normalize-url-3.3.0.tgz", - "integrity": "sha512-U+JJi7duF1o+u2pynbp2zXDW2/PADgC30f0GsHZtRh+HOcXHnw137TrNlyxxRvWW5fjKd3bcLHPxofWuCjaeZg==", + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/normalize-url/-/normalize-url-6.0.1.tgz", + "integrity": "sha512-VU4pzAuh7Kip71XEmO9aNREYAdMHFGTVj/i+CaTImS8x0i1d3jUZkXhqluy/PRgjPLMgsLQulYY3PJ/aSbSjpQ==", "dev": true }, "npm-run-path": { @@ -5154,9 +5148,9 @@ } }, "ora": { - "version": "5.4.0", - "resolved": "https://registry.npmjs.org/ora/-/ora-5.4.0.tgz", - "integrity": "sha512-1StwyXQGoU6gdjYkyVcqOLnVlbKj+6yPNNOxJVgpt9t4eksKjiriiHuxktLYkgllwk+D6MbC4ihH84L1udRXPg==", + "version": "5.4.1", + "resolved": "https://registry.npmjs.org/ora/-/ora-5.4.1.tgz", + "integrity": "sha512-5b6Y85tPxZZ7QytO+BQzysW31HJku27cRIlkbAXaNx+BdcVi+LlRFmVXzeF6a7JCwJpyw5c4b+YSVImQIrBpuQ==", "dev": true, "requires": { "bl": "^4.1.0", @@ -5437,13 +5431,13 @@ } }, "parse-url": { - "version": "5.0.2", - "resolved": "https://registry.npmjs.org/parse-url/-/parse-url-5.0.2.tgz", - "integrity": "sha512-Czj+GIit4cdWtxo3ISZCvLiUjErSo0iI3wJ+q9Oi3QuMYTI6OZu+7cewMWZ+C1YAnKhYTk6/TLuhIgCypLthPA==", + "version": "5.0.3", + "resolved": "https://registry.npmjs.org/parse-url/-/parse-url-5.0.3.tgz", + "integrity": "sha512-nrLCVMJpqo12X8uUJT4GJPd5AFaTOrGx/QpJy3HNcVtq0AZSstVIsnxS5fqNPuoqMUs3MyfBoOP6Zvu2Arok5A==", "dev": true, "requires": { "is-ssh": "^1.3.0", - "normalize-url": "^3.3.0", + "normalize-url": "^6.0.1", "parse-path": "^4.0.0", "protocols": "^1.4.0" } @@ -5781,30 +5775,30 @@ } }, "release-it": { - "version": "14.7.0", - "resolved": "https://registry.npmjs.org/release-it/-/release-it-14.7.0.tgz", - "integrity": "sha512-g8z6BR7qsO1r0HtS4rquRU5PmwHrIZ5jYTuaaa1ZSLrh91Nm23PBpHR/0jsA549Qzujj4W/mkeskoAAIvHugWQ==", + "version": "14.10.0", + "resolved": "https://registry.npmjs.org/release-it/-/release-it-14.10.0.tgz", + "integrity": "sha512-BwL7W3VPILma+MwO2kEtZaAL0/G/mZafg4xgpfxy4MVxLd+28lBp22EDF2gS4GXHmcblawyV2IdbWo/56QIyJw==", "dev": true, "requires": { "@iarna/toml": "2.2.5", - "@octokit/rest": "18.5.3", + "@octokit/rest": "18.6.0", "async-retry": "1.3.1", "chalk": "4.1.1", "cosmiconfig": "7.0.0", "debug": "4.3.1", "deprecated-obj": "2.0.0", - "execa": "5.0.0", + "execa": "5.1.1", "find-up": "5.0.0", "form-data": "4.0.0", "git-url-parse": "11.4.4", - "globby": "11.0.3", + "globby": "11.0.4", "got": "11.8.2", "import-cwd": "3.0.0", - "inquirer": "8.1.0", + "inquirer": "8.1.1", "is-ci": "3.0.0", "lodash": "4.17.21", - "mime-types": "2.1.30", - "ora": "5.4.0", + "mime-types": "2.1.31", + "ora": "5.4.1", "os-name": "4.0.0", "parse-json": "5.2.0", "semver": "7.3.5", @@ -5827,9 +5821,9 @@ } }, "ci-info": { - "version": "3.1.1", - "resolved": "https://registry.npmjs.org/ci-info/-/ci-info-3.1.1.tgz", - "integrity": "sha512-kdRWLBIJwdsYJWYJFtAFFYxybguqeF91qpZaggjG5Nf8QKdizFG2hjqvaTXbxFIcYbSaD74KpAXv6BSm17DHEQ==", + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/ci-info/-/ci-info-3.2.0.tgz", + "integrity": "sha512-dVqRX7fLUm8J6FgHJ418XuIgDLZDkYcDFTeL6TA2gt5WlIZUQrrH6EZrNClwT/H0FateUsZkGIOPRrLbP+PR9A==", "dev": true }, "cross-spawn": { @@ -5853,9 +5847,9 @@ } }, "execa": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/execa/-/execa-5.0.0.tgz", - "integrity": "sha512-ov6w/2LCiuyO4RLYGdpFGjkcs0wMTgGE8PrkTHikeUy5iJekXyPIKUjifk5CsE0pt7sMCrMZ3YNqoCj6idQOnQ==", + "version": "5.1.1", + "resolved": "https://registry.npmjs.org/execa/-/execa-5.1.1.tgz", + "integrity": "sha512-8uSpZZocAZRBAPIEINJj3Lo9HyGitllczc27Eh5YYojjMFMn8yHMDMaUHE2Jqfq05D/wucwI4JGURyXt1vchyg==", "dev": true, "requires": { "cross-spawn": "^7.0.3", @@ -5903,9 +5897,9 @@ "dev": true }, "inquirer": { - "version": "8.1.0", - "resolved": "https://registry.npmjs.org/inquirer/-/inquirer-8.1.0.tgz", - "integrity": "sha512-1nKYPoalt1vMBfCMtpomsUc32wmOoWXAoq3kM/5iTfxyQ2f/BxjixQpC+mbZ7BI0JUXHED4/XPXekDVtJNpXYw==", + "version": "8.1.1", + "resolved": "https://registry.npmjs.org/inquirer/-/inquirer-8.1.1.tgz", + "integrity": "sha512-hUDjc3vBkh/uk1gPfMAD/7Z188Q8cvTGl0nxwaCdwSbzFh6ZKkZh+s2ozVxbE5G9ZNRyeY0+lgbAIOUFsFf98w==", "dev": true, "requires": { "ansi-escapes": "^4.2.1", @@ -5949,18 +5943,18 @@ } }, "mime-db": { - "version": "1.47.0", - "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.47.0.tgz", - "integrity": "sha512-QBmA/G2y+IfeS4oktet3qRZ+P5kPhCKRXxXnQEudYqUaEioAU1/Lq2us3D/t1Jfo4hE9REQPrbB7K5sOczJVIw==", + "version": "1.48.0", + "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.48.0.tgz", + "integrity": "sha512-FM3QwxV+TnZYQ2aRqhlKBMHxk10lTbMt3bBkMAp54ddrNeVSfcQYOOKuGuy3Ddrm38I04If834fOUSq1yzslJQ==", "dev": true }, "mime-types": { - "version": "2.1.30", - "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.30.tgz", - "integrity": "sha512-crmjA4bLtR8m9qLpHvgxSChT+XoSlZi8J4n/aIdn3z92e/U47Z0V/yl+Wh9W046GgFVAmoNR/fmdbZYcSSIUeg==", + "version": "2.1.31", + "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.31.tgz", + "integrity": "sha512-XGZnNzm3QvgKxa8dpzyhFTHmpP3l5YNusmne07VUOXxou9CqUqYa/HBy124RqtVh/O2pECas/MOcsDgpilPOPg==", "dev": true, "requires": { - "mime-db": "1.47.0" + "mime-db": "1.48.0" } }, "npm-run-path": { @@ -7369,9 +7363,9 @@ } }, "typescript": { - "version": "3.9.9", - "resolved": "https://registry.npmjs.org/typescript/-/typescript-3.9.9.tgz", - "integrity": "sha512-kdMjTiekY+z/ubJCATUPlRDl39vXYiMV9iyeMuEuXZh2we6zz80uovNN2WlAxmmdE/Z/YQe+EbOEXB5RHEED3w==", + "version": "3.9.10", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-3.9.10.tgz", + "integrity": "sha512-w6fIxVE/H1PkLKcCPsFqKE7Kv7QUwhU8qQY2MueZXWx5cPZdwFupLgKK3vntcK98BtNHZtAF4LA/yl2a7k8R6Q==", "dev": true }, "union-value": { diff --git a/package.json b/package.json index 25888f1..8254b7b 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@adyen/api-library", - "version": "8.1.1", + "version": "8.2.0", "description": "The Adyen API Library for NodeJS enables you to work with Adyen APIs.", "main": "lib/src/index.js", "types": "lib/src/index.d.ts", @@ -48,12 +48,12 @@ "kind-of": "^6.0.3", "minimist": ">=1.2.3", "nock": "13.1.0", - "release-it": "14.7.0", + "release-it": "14.10.0", "ts-auto-mock": "^2.6.5", "ts-jest": "25.5.1", "ts-loader": "8.0.10", "ttypescript": "^1.5.10", - "typescript": "3.9.9" + "typescript": "3.9.10" }, "dependencies": { "https-proxy-agent": "5.0.0" diff --git a/src/__tests__/platforms.spec.ts b/src/__tests__/platforms.spec.ts index c88b23b..31e627b 100644 --- a/src/__tests__/platforms.spec.ts +++ b/src/__tests__/platforms.spec.ts @@ -23,7 +23,7 @@ import { createBasicAuthClient } from "../__mocks__/base"; import { documentContent } from "../__mocks__/platforms/documentContent"; import { Client, Platforms } from "../index"; -import A = IPlatformsAccount; +import * as A from "../typings/platformsAccount/models"; import F = IPlatformsFund; import N = IPlatformsNotificationConfiguration; import H = IPlatformsHostedOnboardingPage; @@ -50,7 +50,7 @@ const accountHolderDetails: AccountHolderDetails = { individualDetails: { name: { firstName: "John", - gender: "MALE", + gender: A.ViasName.GenderEnum.Male, lastName: "Smith" } }, @@ -194,40 +194,40 @@ describe.skip("Platforms Test E2E", function(): void { accountHolder = await platforms.Account.createAccountHolder({ accountHolderCode: generateRandomCode(), accountHolderDetails, - legalEntity: "Individual", + legalEntity: A.CreateAccountHolderRequest.LegalEntityEnum.Individual, }); account = await platforms.Account.createAccount({ accountHolderCode: generateRandomCode(), description: "This is a new account", metadata: {meta: "data"}, - payoutSchedule: "WEEKLY" + payoutSchedule: A.CreateAccountRequest.PayoutScheduleEnum.Weekly, }); accountHolderToSuspend = await platforms.Account.createAccountHolder({ accountHolderCode: generateRandomCode(), accountHolderDetails, - legalEntity: "Individual" + legalEntity: A.CreateAccountHolderRequest.LegalEntityEnum.Individual, }); accountToClose = await platforms.Account.createAccount({ accountHolderCode: generateRandomCode(), description: "This is a new account", metadata: {meta: "data"}, - payoutSchedule: "WEEKLY" + payoutSchedule: A.CreateAccountRequest.PayoutScheduleEnum.Weekly, }); accountHolderToUnSuspend = await platforms.Account.createAccountHolder({ accountHolderCode: generateRandomCode(), accountHolderDetails, - legalEntity: "Individual" + legalEntity: A.CreateAccountHolderRequest.LegalEntityEnum.Individual, }); await platforms.Account.suspendAccountHolder({ accountHolderCode: accountHolderToUnSuspend.accountHolderCode}); accountHolderToClose = await platforms.Account.createAccountHolder({ accountHolderCode: generateRandomCode(), accountHolderDetails, - legalEntity: "Individual" + legalEntity: A.CreateAccountHolderRequest.LegalEntityEnum.Individual, }); notificationConfigurationToRetrieve = await platforms.NotificationConfiguration.createNotificationConfiguration({ @@ -284,7 +284,7 @@ describe.skip("Platforms Test E2E", function(): void { try { const result = await platforms.Account.checkAccountHolder({ accountHolderCode: accountHolder.accountHolderCode, - accountStateType: "Processing", + accountStateType: A.PerformVerificationRequest.AccountStateTypeEnum.Processing, tier: 2 }); expect(result.resultCode).toEqual("Success"); @@ -309,7 +309,7 @@ describe.skip("Platforms Test E2E", function(): void { documentContent, documentDetail: { accountHolderCode: account.accountHolderCode, - documentType: "ID_CARD_FRONT", + documentType: A.DocumentDetail.DocumentTypeEnum.IdCardFront, description: "test document 000", filename: "IDCardFront.png" } @@ -327,7 +327,7 @@ describe.skip("Platforms Test E2E", function(): void { documentContent, documentDetail: { accountHolderCode: account.accountHolderCode, - documentType: "ID_CARD_FRONT", + documentType: A.DocumentDetail.DocumentTypeEnum.IdCardFront, description: "test document 000", filename: "IDCardFront.png" } @@ -381,7 +381,7 @@ describe.skip("Platforms Test E2E", function(): void { const result = await platforms.Account.updateAccountHolderState({ accountHolderCode: accountHolder.accountHolderCode, disable: false, - stateType: "Payout" + stateType: A.UpdateAccountHolderStateRequest.StateTypeEnum.Payout }); expect(result.pspReference).toBeDefined(); } catch (e) { diff --git a/src/services/platforms.ts b/src/services/platforms.ts index e564fd1..c909d34 100644 --- a/src/services/platforms.ts +++ b/src/services/platforms.ts @@ -25,6 +25,36 @@ import getJsonResponse from "./../helpers/getJsonResponse"; import PlatformsFund from "./resource/platforms/fund"; import PlatformsHostedOnboardingPage from "./resource/platforms/hop"; import PlatformsNotificationConfiguration from "./resource/platforms/notificationConfiguration"; +import { + GetAccountHolderRequest, + GetUploadedDocumentsRequest, + GetAccountHolderResponse, + GetUploadedDocumentsResponse, + CreateAccountHolderRequest, + CreateAccountHolderResponse, + CloseAccountHolderRequest, + CloseAccountHolderResponse, + CreateAccountRequest, + CreateAccountResponse, + DeleteBankAccountRequest, + GenericResponse, + DeletePayoutMethodRequest, + UpdateAccountRequest, + UpdateAccountResponse, + UploadDocumentRequest, + UnSuspendAccountHolderRequest, + UnSuspendAccountHolderResponse, + CloseAccountRequest, + CloseAccountResponse, + SuspendAccountHolderRequest, + SuspendAccountHolderResponse, + UpdateAccountHolderRequest, + UpdateAccountHolderResponse, + DeleteShareholderRequest, + PerformVerificationRequest, + UpdateAccountHolderStateRequest, + GetAccountHolderStatusResponse +} from "../typings/platformsAccount/models"; type AccountType = AccountTypesEnum.Accounts; type VerificationType = AccountTypesEnum.Verification; @@ -125,41 +155,41 @@ class Platforms extends Service { } public get Account(): { - getAccountHolder: (request: IPlatformsAccount.GetAccountHolderRequest) => Promise; - getUploadedDocuments: (request: IPlatformsAccount.GetUploadedDocumentsRequest) => Promise; - createAccountHolder: (request: IPlatformsAccount.CreateAccountHolderRequest) => Promise; - closeAccountHolder: (request: IPlatformsAccount.CloseAccountHolderRequest) => Promise; - createAccount: (request: IPlatformsAccount.CreateAccountRequest) => Promise; - deleteBankAccounts: (request: IPlatformsAccount.DeleteBankAccountRequest) => Promise; - deletePayoutMethods: (request: IPlatformsAccount.DeletePayoutMethodRequest) => Promise; - updateAccount: (request: IPlatformsAccount.UpdateAccountRequest) => Promise; - uploadDocument: (request: IPlatformsAccount.UploadDocumentRequest) => Promise; - unSuspendAccountHolder: (request: IPlatformsAccount.UnSuspendAccountHolderRequest) => Promise; - closeAccount: (request: IPlatformsAccount.CloseAccountRequest) => Promise; - suspendAccountHolder: (request: IPlatformsAccount.SuspendAccountHolderRequest) => Promise; - updateAccountHolder: (request: IPlatformsAccount.UpdateAccountHolderRequest) => Promise; - deleteShareholders: (request: IPlatformsAccount.DeleteShareholderRequest) => Promise; - checkAccountHolder: (request: IPlatformsAccount.PerformVerificationRequest) => Promise; - updateAccountHolderState: (request: IPlatformsAccount.UpdateAccountHolderStateRequest) => Promise; + getAccountHolder: (request: GetAccountHolderRequest) => Promise; + getUploadedDocuments: (request: GetUploadedDocumentsRequest) => Promise; + createAccountHolder: (request: CreateAccountHolderRequest) => Promise; + closeAccountHolder: (request: CloseAccountHolderRequest) => Promise; + createAccount: (request: CreateAccountRequest) => Promise; + deleteBankAccounts: (request: DeleteBankAccountRequest) => Promise; + deletePayoutMethods: (request: DeletePayoutMethodRequest) => Promise; + updateAccount: (request: UpdateAccountRequest) => Promise; + uploadDocument: (request: UploadDocumentRequest) => Promise; + unSuspendAccountHolder: (request: UnSuspendAccountHolderRequest) => Promise; + closeAccount: (request: CloseAccountRequest) => Promise; + suspendAccountHolder: (request: SuspendAccountHolderRequest) => Promise; + updateAccountHolder: (request: UpdateAccountHolderRequest) => Promise; + deleteShareholders: (request: DeleteShareholderRequest) => Promise; + checkAccountHolder: (request: PerformVerificationRequest) => Promise; + updateAccountHolderState: (request: UpdateAccountHolderStateRequest) => Promise; } { - const closeAccount = this.createRequest(this._closeAccount); - const updateAccount = this.createRequest(this._updateAccount); - const createAccount = this.createRequest(this._createAccount); + const closeAccount = this.createRequest(this._closeAccount); + const updateAccount = this.createRequest(this._updateAccount); + const createAccount = this.createRequest(this._createAccount); - const uploadDocument = this.createRequest(this._uploadDocument); - const getUploadedDocuments = this.createRequest(this._getUploadedDocuments); - const deleteBankAccounts = this.createRequest(this._deleteBankAccounts); - const deletePayoutMethods = this.createRequest(this._deletePayoutMethods); - const deleteShareholders = this.createRequest(this._deleteShareholders); + const uploadDocument = this.createRequest(this._uploadDocument); + const getUploadedDocuments = this.createRequest(this._getUploadedDocuments); + const deleteBankAccounts = this.createRequest(this._deleteBankAccounts); + const deletePayoutMethods = this.createRequest(this._deletePayoutMethods); + const deleteShareholders = this.createRequest(this._deleteShareholders); - const createAccountHolder = this.createRequest(this._createAccountHolder); - const getAccountHolder = this.createRequest(this._getAccountHolder); - const updateAccountHolder = this.createRequest(this._updateAccountHolder); - const updateAccountHolderState = this.createRequest(this._updateAccountHolderState); - const suspendAccountHolder = this.createRequest(this._suspendAccountHolder); - const unSuspendAccountHolder = this.createRequest(this._unSuspendAccountHolder); - const closeAccountHolder = this.createRequest(this._closeAccountHolder); - const checkAccountHolder = this.createRequest(this._checkAccountHolder); + const createAccountHolder = this.createRequest(this._createAccountHolder); + const getAccountHolder = this.createRequest(this._getAccountHolder); + const updateAccountHolder = this.createRequest(this._updateAccountHolder); + const updateAccountHolderState = this.createRequest(this._updateAccountHolderState); + const suspendAccountHolder = this.createRequest(this._suspendAccountHolder); + const unSuspendAccountHolder = this.createRequest(this._unSuspendAccountHolder); + const closeAccountHolder = this.createRequest(this._closeAccountHolder); + const checkAccountHolder = this.createRequest(this._checkAccountHolder); const accounts = { closeAccount, updateAccount, createAccount }; const verification = { uploadDocument, getUploadedDocuments, deleteBankAccounts, deletePayoutMethods, deleteShareholders, checkAccountHolder }; diff --git a/src/typings/index.ts b/src/typings/index.ts index 0071264..de9c5ab 100644 --- a/src/typings/index.ts +++ b/src/typings/index.ts @@ -29,7 +29,6 @@ /// /// /// -/// /// /// /// diff --git a/src/typings/platformsAccount.ts b/src/typings/platformsAccount.ts deleted file mode 100644 index 30b6e64..0000000 --- a/src/typings/platformsAccount.ts +++ /dev/null @@ -1,1666 +0,0 @@ - -/* - * ###### - * ###### - * ############ ####( ###### #####. ###### ############ ############ - * ############# #####( ###### #####. ###### ############# ############# - * ###### #####( ###### #####. ###### ##### ###### ##### ###### - * ###### ###### #####( ###### #####. ###### ##### ##### ##### ###### - * ###### ###### #####( ###### #####. ###### ##### ##### ###### - * ############# ############# ############# ############# ##### ###### - * ############ ############ ############# ############ ##### ###### - * ###### - * ############# - * ############ - * - * Adyen NodeJS API Library - * - * Version of Platforms Account: v6 - * - * Copyright (c) 2020 Adyen B.V. - * This file is open source and available under the MIT license. - * See the LICENSE file for more info. - */ - - -declare namespace IPlatformsAccount { - export interface Account { - /** - * The code of the account. - */ - accountCode?: string; - /** - * The beneficiary of the account. - */ - beneficiaryAccount?: string; - /** - * The reason that a beneficiary has been set up for this account. This may have been supplied during the setup of a beneficiary at the discretion of the executing user. - */ - beneficiaryMerchantReference?: string; - /** - * A description of the account. - */ - description?: string; - /** - * A set of key and value pairs for general use by the merchant. - * The keys do not have specific names and may be used for storing miscellaneous data as desired. - * > Note that during an update of metadata, the omission of existing key-value pairs will result in the deletion of those key-value pairs. - */ - metadata?: { - [name: string]: string; - }; - /** - * The account's payout schedule. - */ - payoutSchedule?: PayoutScheduleResponse; - /** - * Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`. - */ - payoutSpeed?: "SAME_DAY" | "STANDARD"; - /** - * The status of the account. Possible values: `Active`, `Inactive`, `Suspended`, `Closed`. - */ - status?: string; - } - export interface AccountEvent { - /** - * The event. - * >Permitted values: `InactivateAccount`, `RefundNotPaidOutTransfers`. - * For more information, refer to [Verification checks](https://docs.adyen.com/platforms/onboarding-and-verification/verification-checks). - */ - event: "InactivateAccount" | "RefundNotPaidOutTransfers"; - /** - * The date on which the event will take place. - */ - executionDate: string; // date-time - /** - * The reason why this event has been created. - */ - reason: string; - } - export interface AccountHolderDetails { - /** - * The address of the account holder. - */ - address?: ViasAddress; - /** - * Each of the bank accounts associated with the account holder. - * > Each array entry should represent one bank account. - * > For comprehensive detail regarding the required `BankAccountDetail` fields, please refer to the [KYC Verification documentation](https://docs.adyen.com/platforms/onboarding-and-verification/verification-checks). - */ - bankAccountDetails?: BankAccountDetail[]; - /** - * The opaque reference value returned by the Adyen API during bank account login. - */ - bankAggregatorDataReference?: string; - /** - * Details applicable to `Business` legal entities. - * Populated only if the account holder's legal entity is of type `Business`. - * > Required when being used in a `/createAccountHolder` request in which the legal entity is `Business`. - */ - businessDetails?: BusinessDetails; - /** - * The email address of the account holder. - */ - email: string; - /** - * The phone number of the account holder provided as a single string. It will be handled as a landline phone. - * **Examples:** "0031 6 11 22 33 44", "+316/1122-3344", "(0031) 611223344" - */ - fullPhoneNumber: string; - /** - * Details applicable to `Individual` legal entities. - * Populated only if the account holder's legal entity is of type `Individual`. - * > Required when being used in a `/createAccountHolder` request in which the legal entity is `Individual`. - */ - individualDetails?: IndividualDetails; - /** - * The Merchant Category Code of the account holder. - * > If not specified in the request, this will be derived from the platform account (which is configured by Adyen). - */ - merchantCategoryCode?: string; - /** - * A set of key and value pairs for general use by the account holder or merchant. - * The keys do not have specific names and may be used for storing miscellaneous data as desired. - * > The values being stored have a maximum length of eighty (80) characters and will be truncated if necessary. - * > Note that during an update of metadata, the omission of existing key-value pairs will result in the deletion of those key-value pairs. - */ - metadata?: { - [name: string]: string; - }; - /** - * Each of the card tokens associated with the account holder. - * > Each array entry should represent one card token. - * > For comprehensive detail regarding the required `CardToken` fields, please refer to the [KYC Verification documentation](https://docs.adyen.com/platforms/onboarding-and-verification/verification-checks). - */ - payoutMethods?: PayoutMethod[]; - /** - * The URL of the website of the account holder. - */ - webAddress: string; - } - export interface AccountHolderStatus { - /** - * A list of events scheduled for the account holder. - */ - events?: AccountEvent[]; - /** - * The payout state of the account holder. - */ - payoutState?: AccountPayoutState; - /** - * The processing state of the account holder. - */ - processingState?: AccountProcessingState; - /** - * The status of the account holder. - * >Permitted values: `Active`, `Inactive`, `Suspended`, `Closed`. - */ - status: "Active" | "Closed" | "Inactive" | "Suspended"; - /** - * The reason why the status was assigned to the account holder. - */ - statusReason?: string; - } - export interface AccountPayoutState { - /** - * Indicates whether payouts are allowed. This field is the overarching payout status, and is the aggregate of multiple conditions (e.g., KYC status, disabled flag, etc). If this field is false, no payouts will be permitted for any of the account holder's accounts. If this field is true, payouts will be permitted for any of the account holder's accounts. - */ - allowPayout?: boolean; - /** - * The reason why payouts (to all of the account holder's accounts) have been disabled (by the platform). If the `disabled` field is true, this field can be used to explain why. - */ - disableReason?: string; - /** - * Indicates whether payouts have been disabled (by the platform) for all of the account holder's accounts. A platform may enable and disable this field at their discretion. If this field is true, `allowPayout` will be false and no payouts will be permitted for any of the account holder's accounts. If this field is false, `allowPayout` may or may not be enabled, depending on other factors. - */ - disabled?: boolean; - /** - * The reason why payouts (to all of the account holder's accounts) have been disabled (by Adyen). If payouts have been disabled by Adyen, this field will explain why. If this field is blank, payouts have not been disabled by Adyen. - */ - notAllowedReason?: string; - /** - * The maximum amount that payouts are limited to. Only applies if payouts are allowed but limited. - */ - payoutLimit?: Amount; - /** - * The payout tier that the account holder occupies. - */ - tierNumber?: number; // int32 - } - export interface AccountProcessingState { - /** - * The reason why processing has been disabled. - */ - disableReason?: string; - /** - * Indicates whether the processing of payments is allowed. - */ - disabled?: boolean; - /** - * The lower bound of the processing tier (i.e., an account holder must have processed at least this amount of money in order to be placed into this tier). - */ - processedFrom?: Amount; - /** - * The upper bound of the processing tier (i.e., an account holder must have processed less than this amount of money in order to be placed into this tier). - */ - processedTo?: Amount; - /** - * The processing tier that the account holder occupies. - */ - tierNumber?: number; // int32 - } - export interface Amount { - /** - * The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). - */ - currency: string; - /** - * The payable amount that can be charged for the transaction. - * - * The transaction amount needs to be represented in minor units according to the [following table](https://docs.adyen.com/development-resources/currency-codes). - */ - value: number; // int64 - } - export interface BankAccountDetail { - /** - * The bank account number (without separators). - * >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. - */ - accountNumber?: string; - /** - * The type of bank account. - * Only applicable to bank accounts held in the USA. - * The permitted values are: `checking`, `savings`. - * - * >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. - */ - accountType?: string; - /** - * The name of the bank account. - */ - bankAccountName?: string; - /** - * Merchant reference to the bank account. - */ - bankAccountReference?: string; - /** - * The unique identifier (UUID) of the Bank Account. - * >If, during an account holder create or update request, this field is left blank (but other fields provided), a new Bank Account will be created with a procedurally-generated UUID. - * - * >If, during an account holder create request, a UUID is provided, the creation of the Bank Account will fail while the creation of the account holder will continue. - * - * >If, during an account holder update request, a UUID that is not correlated with an existing Bank Account is provided, the update of the account holder will fail. - * - * >If, during an account holder update request, a UUID that is correlated with an existing Bank Account is provided, the existing Bank Account will be updated. - * - */ - bankAccountUUID?: string; - /** - * The bank identifier code. - * >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. - */ - bankBicSwift?: string; - /** - * The city in which the bank branch is located. - * - * >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. - */ - bankCity?: string; - /** - * The bank code of the banking institution with which the bank account is registered. - * - * >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. - */ - bankCode?: string; - /** - * The name of the banking institution with which the bank account is held. - * - * >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. - */ - bankName?: string; - /** - * The branch code of the branch under which the bank account is registered. The value to be specified in this parameter depends on the country of the bank account: - * * United States - Routing number - * * United Kingdom - Sort code - * * Germany - Bankleitzahl - * >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. - */ - branchCode?: string; - /** - * The check code of the bank account. - * - * >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. - */ - checkCode?: string; - /** - * The two-letter country code in which the bank account is registered. - * >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL'). - * - * >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. - */ - countryCode?: string; - /** - * The currency in which the bank account deals. - * >The permitted currency codes are defined in ISO-4217 (e.g. 'EUR'). - * - * >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. - */ - currencyCode?: string; - /** - * The international bank account number. - * >The IBAN standard is defined in ISO-13616. - * - * >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. - */ - iban?: string; - /** - * The city of residence of the bank account owner. - * >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. - */ - ownerCity?: string; - /** - * The country code of the country of residence of the bank account owner. - * >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL'). - * - * >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. - */ - ownerCountryCode?: string; - /** - * The date of birth of the bank account owner. - * - */ - ownerDateOfBirth?: string; - /** - * The house name or number of the residence of the bank account owner. - * >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. - */ - ownerHouseNumberOrName?: string; - /** - * The name of the bank account owner. - * >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. - */ - ownerName?: string; - /** - * The country code of the country of nationality of the bank account owner. - * >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL'). - * - * >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. - */ - ownerNationality?: string; - /** - * The postal code of the residence of the bank account owner. - * >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. - */ - ownerPostalCode?: string; - /** - * The state of residence of the bank account owner. - * >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. - */ - ownerState?: string; - /** - * The street name of the residence of the bank account owner. - * >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. - */ - ownerStreet?: string; - /** - * If set to true, the bank account is a primary account. - */ - primaryAccount?: boolean; - /** - * The tax ID number. - * - * >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. - */ - taxId?: string; - /** - * The URL to be used for bank account verification. - * This may be generated on bank account creation. - * - * >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. - */ - urlForVerification?: string; - } - export interface BusinessDetails { - /** - * The registered name of the company (if it differs from the legal name of the company). - */ - doingBusinessAs?: string; - /** - * The legal name of the company. - */ - legalBusinessName?: string; - /** - * The registration number of the company. - */ - registrationNumber?: string; - /** - * Each of the shareholders associated with the company. - * Each array entry should represent one shareholder. - */ - shareholders?: ShareholderContact[]; - /** - * Market Identifier Code (MIC). - */ - stockExchange?: string; - /** - * International Securities Identification Number (ISIN). - */ - stockNumber?: string; - /** - * Stock Ticker symbol. - */ - stockTicker?: string; - /** - * The tax ID of the company. - */ - taxId?: string; - } - export interface CloseAccountHolderRequest { - /** - * The code of the Account Holder to be closed. - */ - accountHolderCode: string; - } - export interface CloseAccountHolderResponse { - /** - * The new status of the Account Holder. - */ - accountHolderStatus: AccountHolderStatus; - /** - * Contains field validation errors that would prevent requests from being processed. - */ - invalidFields?: ErrorFieldType[]; - /** - * The reference of a request. Can be used to uniquely identify the request. - */ - pspReference?: string; - /** - * The result code. - */ - resultCode?: string; - } - export interface CloseAccountRequest { - /** - * The code of account to be closed. - */ - accountCode: string; - } - export interface CloseAccountResponse { - /** - * The account code of the account that is closed. - */ - accountCode?: string; - /** - * Contains field validation errors that would prevent requests from being processed. - */ - invalidFields?: ErrorFieldType[]; - /** - * The reference of a request. Can be used to uniquely identify the request. - */ - pspReference?: string; - /** - * The result code. - */ - resultCode?: string; - /** - * The new status of the account. - * >Permitted values: `Active`, `Inactive`, `Suspended`, `Closed`. - */ - status: "Active" | "Closed" | "Inactive" | "Suspended"; - } - export interface CreateAccountHolderRequest { - /** - * The desired code of the prospective account holder. - * > Must be between three (3) and fifty (50) characters long. Only letters, digits, and hyphens (-) are permitted. - */ - accountHolderCode: string; - /** - * The details of the prospective account holder. - */ - accountHolderDetails: AccountHolderDetails; - /** - * If set to true, an account with the default options is created for this account holder. - * **Default Value:** true - */ - createDefaultAccount?: boolean; - /** - * A description of the prospective account holder. - */ - description?: string; - /** - * The entity type. - * Permitted values: `Business`, `Individual` - * - * If an account holder is 'Business', then `accountHolderDetails.businessDetails` must be provided, as well as at least one entry in the `accountHolderDetails.businessDetails.shareholders` list. - * - * If an account holder is 'Individual', then `accountHolderDetails.individualDetails` must be provided. - */ - legalEntity: "Business" | "Individual" | "NonProfit" | "Partnership" | "PublicCompany"; - /** - * The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), with which the prospective account holder primarily deals. - */ - primaryCurrency?: string; - /** - * The starting [processing tier](https://docs.adyen.com/platforms/onboarding-and-verification/precheck-kyc-information) for the prospective account holder. - */ - processingTier?: number; // int32 - /** - * The identifier of the profile that applies to this entity. - */ - verificationProfile?: string; - } - export interface CreateAccountHolderResponse { - /** - * The code of a new account created for the account holder. - */ - accountCode?: string; - /** - * The code of the new account holder. - */ - accountHolderCode: string; - /** - * Details of the new account holder. - */ - accountHolderDetails: AccountHolderDetails; - /** - * The status of the new account holder. - */ - accountHolderStatus: AccountHolderStatus; - /** - * The description of the new account holder. - */ - description?: string; - /** - * A list of fields that caused the `/createAccountHolder` request to fail. - */ - invalidFields?: ErrorFieldType[]; - /** - * The type of legal entity of the new account holder. - */ - legalEntity: "Business" | "Individual" | "NonProfit" | "Partnership" | "PublicCompany"; - /** - * The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), with which the prospective account holder primarily deals. - */ - primaryCurrency?: string; - /** - * The reference of a request. Can be used to uniquely identify the request. - */ - pspReference?: string; - /** - * The result code. - */ - resultCode?: string; - /** - * The details of KYC Verification of the account holder. - */ - verification: KYCVerificationResult; - /** - * The identifier of the profile that applies to this entity. - */ - verificationProfile?: string; - } - export interface CreateAccountRequest { - /** - * The code of Account Holder under which to create the account. - */ - accountHolderCode: string; - /** - * The bankAccountUUID of the bank account held by the account holder to couple the account with. Scheduled payouts in currencies matching the currency of this bank account will be sent to this bank account. Payouts in different currencies will be sent to a matching bank account of the account holder. - */ - bankAccountUUID?: string; - /** - * A description of the account. - */ - description?: string; - /** - * A set of key and value pairs for general use by the merchant. - * The keys do not have specific names and may be used for storing miscellaneous data as desired. - * > Note that during an update of metadata, the omission of existing key-value pairs will result in the deletion of those key-value pairs. - */ - metadata?: { - [name: string]: string; - }; - /** - * The payout schedule of the prospective account. - * >Permitted values: `DEFAULT`, `HOLD`, `DAILY`, `WEEKLY`, `MONTHLY`. - */ - payoutSchedule?: "BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT" | "BIWEEKLY_ON_1ST_AND_15TH_AT_NOON" | "DAILY" | "DAILY_6PM" | "DAILY_AU" | "DAILY_EU" | "DAILY_US" | "DEFAULT" | "EVERY_6_HOURS_FROM_MIDNIGHT" | "HOLD" | "MONTHLY" | "WEEKLY" | "WEEKLY_ON_TUE_FRI_MIDNIGHT" | "YEARLY"; - /** - * The reason for the payout schedule choice. - * >Required if the payoutSchedule is `HOLD`. - */ - payoutScheduleReason?: string; - /** - * Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`. - */ - payoutSpeed?: "SAME_DAY" | "STANDARD"; - } - export interface CreateAccountResponse { - /** - * The code of the new account. - */ - accountCode: string; - /** - * The code of the account holder. - */ - accountHolderCode: string; - /** - * The bankAccountUUID of the bank account held by the account holder to couple the account with. Scheduled payouts in currencies matching the currency of this bank account will be sent to this bank account. Payouts in different currencies will be sent to a matching bank account of the account holder. - */ - bankAccountUUID?: string; - /** - * The description of the account. - */ - description?: string; - /** - * A list of fields that caused the `/createAccount` request to fail. - */ - invalidFields?: ErrorFieldType[]; - metadata?: { - [name: string]: string; - }; - /** - * The payout schedule of the account. - */ - payoutSchedule?: PayoutScheduleResponse; - /** - * Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`. - */ - payoutSpeed?: "SAME_DAY" | "STANDARD"; - /** - * The reference of a request. Can be used to uniquely identify the request. - */ - pspReference?: string; - /** - * The result code. - */ - resultCode?: string; - /** - * The status of the account. - * >Permitted values: `Active`. - */ - status: "Active" | "Closed" | "Inactive" | "Suspended"; - } - export interface DeleteBankAccountRequest { - /** - * The code of the Account Holder from which to delete the Bank Account(s). - */ - accountHolderCode: string; - /** - * The code(s) of the Bank Accounts to be deleted. - */ - bankAccountUUIDs: string[]; - } - export interface DeletePayoutMethodRequest { - /** - * The code of the account holder, from which to delete the payout methods. - */ - accountHolderCode: string; - /** - * The codes of the payout methods to be deleted. - */ - payoutMethodCodes: string[]; - } - export interface DeleteShareholderRequest { - /** - * The code of the Account Holder from which to delete the Shareholders. - */ - accountHolderCode: string; - /** - * The code(s) of the Shareholders to be deleted. - */ - shareholderCodes: string[]; - } - export interface DocumentDetail { - /** - * The code of account holder, to which the document applies. - */ - accountHolderCode: string; - /** - * The unique ID of the Bank Account to which the document applies. - * >Required if the documentType is `BANK_STATEMENT` (i.e., a document is being submitted in order to verify a bank account). - * - * >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on when a document should be submitted in order to verify a bank account. - */ - bankAccountUUID?: string; - /** - * Description of the document. - */ - description?: string; - /** - * The type of a document. Permitted values: - * * `BANK_STATEMENT` denotes an image containing a bank statement or other document proving ownership of a specific bank account. - * * `PASSPORT` denotes an image containing the identity page(s) of a passport. - * * `ID_CARD_FRONT` denotes an image containing only the front of the ID card. In order for a document to be usable, both the `ID_CARD_FRONT` and `ID_CARD_BACK` must be submitted. - * * `ID_CARD_BACK` denotes an image containing only the back of the ID card. In order for a document to be usable, both the `ID_CARD_FRONT` and `ID_CARD_BACK` must be submitted. - * * `DRIVING_LICENCE_FRONT` denotes an image containing only the front of the driving licence. In order for a document to be usable, both the `DRIVING_LICENCE_FRONT` and `DRIVING_LICENCE_BACK` must be submitted. - * * `DRIVING_LICENCE_BACK` denotes an image containing only the back of the driving licence. In order for a document to be usable, both the `DRIVING_LICENCE_FRONT` and `DRIVING_LICENCE_FRONT` must be submitted. - * - * >Please refer to [Verification checks](https://docs.adyen.com/platforms/onboarding-and-verification/verification-checks) for details on when each document type should be submitted. - */ - documentType: "BANK_STATEMENT" | "BSN" | "COMPANY_REGISTRATION_SCREENING" | "DRIVING_LICENCE" | "DRIVING_LICENCE_BACK" | "DRIVING_LICENCE_FRONT" | "ID_CARD" | "ID_CARD_BACK" | "ID_CARD_FRONT" | "PASSPORT" | "SSN" | "SUPPORTING_DOCUMENTS"; - /** - * Filename of the document. - */ - filename: string; - /** - * The code of the shareholder, to which the document applies. - * >Required if the account holder referred to by the `accountHolderCode` has a `legalEntity` of type `Business` and the `documentType` is either `PASSPORT`, `ID_CARD_FRONT`, `ID_CARD_BACK`, `DRIVING_LICENCE_FRONT`, `DRIVING_LICENCE_BACK` (i.e. a document is being submitted in order to verify a shareholder). - * - * >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on when a document should be submitted in order to verify a shareholder. - */ - shareholderCode?: string; - } - export interface ErrorFieldType { - /** - * The validation error code. - */ - errorCode?: number; // int32 - /** - * A description of the validation error. - */ - errorDescription?: string; - /** - * The type of error field. - */ - fieldType?: FieldType; - } - export interface FieldType { - /** - * The full name of the property. - */ - field?: string; - /** - * The type of the field. - */ - fieldName?: "accountCode" | "accountHolderCode" | "accountHolderDetails" | "accountNumber" | "accountStateType" | "accountStatus" | "accountType" | "address" | "bankAccount" | "bankAccountCode" | "bankAccountName" | "bankAccountUUID" | "bankBicSwift" | "bankCity" | "bankCode" | "bankName" | "bankStatement" | "branchCode" | "businessContact" | "cardToken" | "checkCode" | "city" | "companyRegistration" | "country" | "countryCode" | "currency" | "currencyCode" | "dateOfBirth" | "description" | "destinationAccountCode" | "document" | "documentExpirationDate" | "documentIssuerCountry" | "documentIssuerState" | "documentName" | "documentNumber" | "documentType" | "doingBusinessAs" | "drivingLicence" | "drivingLicenceBack" | "drivingLicense" | "email" | "firstName" | "fullPhoneNumber" | "gender" | "hopWebserviceUser" | "houseNumberOrName" | "iban" | "idCard" | "idCardBack" | "idCardFront" | "idNumber" | "identityDocument" | "individualDetails" | "lastName" | "legalBusinessName" | "legalEntity" | "legalEntityType" | "merchantAccount" | "merchantCategoryCode" | "merchantReference" | "microDeposit" | "name" | "nationality" | "originalReference" | "ownerCity" | "ownerCountryCode" | "ownerHouseNumberOrName" | "ownerName" | "ownerPostalCode" | "ownerState" | "ownerStreet" | "passport" | "passportNumber" | "payoutMethodCode" | "personalData" | "phoneCountryCode" | "phoneNumber" | "postalCode" | "primaryCurrency" | "reason" | "registrationNumber" | "returnUrl" | "schedule" | "shareholder" | "shareholderCode" | "socialSecurityNumber" | "sourceAccountCode" | "stateOrProvince" | "status" | "stockExchange" | "stockNumber" | "stockTicker" | "store" | "storeDetail" | "storeName" | "storeReference" | "street" | "taxId" | "tier" | "tierNumber" | "transferCode" | "unknown" | "value" | "virtualAccount" | "visaNumber" | "webAddress"; - /** - * The code of the shareholder that the field belongs to. If empty, the field belongs to an account holder. - */ - shareholderCode?: string; - } - export interface GenericResponse { - /** - * Contains field validation errors that would prevent requests from being processed. - */ - invalidFields?: ErrorFieldType[]; - /** - * The reference of a request. Can be used to uniquely identify the request. - */ - pspReference?: string; - /** - * The result code. - */ - resultCode?: string; - } - export interface GetAccountHolderRequest { - /** - * The code of the account of which to retrieve the details. - * > Required if no `accountHolderCode` is provided. - */ - accountCode?: string; - /** - * The code of the account holder of which to retrieve the details. - * > Required if no `accountCode` is provided. - */ - accountHolderCode?: string; - /** - * True if the request should return the account holder details - */ - showDetails?: boolean; - } - export interface GetAccountHolderResponse { - /** - * The code of the account holder. - */ - accountHolderCode: string; - /** - * Details of the account holder. - */ - accountHolderDetails: AccountHolderDetails; - /** - * The status of the account holder. - */ - accountHolderStatus: AccountHolderStatus; - /** - * A list of the accounts under the account holder. - */ - accounts?: Account[]; - /** - * The description of the account holder. - */ - description?: string; - /** - * Contains field validation errors that would prevent requests from being processed. - */ - invalidFields?: ErrorFieldType[]; - /** - * The legal entity of the account holder. - */ - legalEntity: "Business" | "Individual" | "NonProfit" | "Partnership" | "PublicCompany"; - /** - * The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), with which the prospective account holder primarily deals. - */ - primaryCurrency?: string; - /** - * The reference of a request. Can be used to uniquely identify the request. - */ - pspReference?: string; - /** - * The result code. - */ - resultCode?: string; - /** - * The time that shows how up to date is the information in the response. - */ - systemUpToDateTime?: string; // date-time - /** - * The details of KYC Verification of the account holder. - */ - verification: KYCVerificationResult; - /** - * The identifier of the profile that applies to this entity. - */ - verificationProfile?: string; - } - export interface GetAccountHolderStatusResponse { - /** - * The code of the Account Holder. - */ - accountHolderCode: string; - /** - * The status of the Account Holder. - */ - accountHolderStatus: AccountHolderStatus; - /** - * Contains field validation errors that would prevent requests from being processed. - */ - invalidFields?: ErrorFieldType[]; - /** - * The reference of a request. Can be used to uniquely identify the request. - */ - pspReference?: string; - /** - * The result code. - */ - resultCode?: string; - } - export interface GetUploadedDocumentsRequest { - /** - * The code of the Account Holder for which to retrieve the documents. - */ - accountHolderCode: string; - /** - * The code of the Bank Account for which to retrieve the documents. - */ - bankAccountUUID?: string; - /** - * The code of the Shareholder for which to retrieve the documents. - */ - shareholderCode?: string; - } - export interface GetUploadedDocumentsResponse { - /** - * A list of the documents and their details. - */ - documentDetails?: DocumentDetail[]; - /** - * Contains field validation errors that would prevent requests from being processed. - */ - invalidFields?: ErrorFieldType[]; - /** - * The reference of a request. Can be used to uniquely identify the request. - */ - pspReference?: string; - /** - * The result code. - */ - resultCode?: string; - } - export interface IndividualDetails { - /** - * The name of the individual. - * >Make sure your account holder registers using the name shown on their Photo ID. - */ - name?: ViasName; - /** - * Personal information of the individual. - */ - personalData?: ViasPersonalData; - } - export interface KYCCheckResult { - /** - * A list of the checks and their statuses. - */ - checks?: KYCCheckStatusData[]; - } - export interface KYCCheckStatusData { - /** - * A list of the fields required for execution of the check. - */ - requiredFields?: string[]; - /** - * The status of the check. - * >Permitted Values: `DATA_PROVIDED`, `PASSED`, `PENDING`, `AWAITING_DATA`, `RETRY_LIMIT_REACHED`, `INVALID_DATA`, `FAILED`. - */ - status: "AWAITING_DATA" | "DATA_PROVIDED" | "FAILED" | "INVALID_DATA" | "PASSED" | "PENDING" | "PENDING_REVIEW" | "RETRY_LIMIT_REACHED" | "UNCHECKED"; - /** - * A summary of the execution of the check. - */ - summary?: KYCCheckSummary; - /** - * The type of check. - * >Permitted Values: `COMPANY_VERIFICATION`, `IDENTITY_VERIFICATION`, `PASSPORT_VERIFICATION`, `BANK_ACCOUNT_VERIFICATION`, `NONPROFIT_VERIFICATION`, `CARD_VERIFICATION`. - */ - type: "BANK_ACCOUNT_VERIFICATION" | "CARD_VERIFICATION" | "COMPANY_VERIFICATION" | "IDENTITY_VERIFICATION" | "NONPROFIT_VERIFICATION" | "PASSPORT_VERIFICATION" | "PAYOUT_METHOD_VERIFICATION"; - } - export interface KYCCheckSummary { - /** - * The code of the check. - */ - kycCheckCode?: number; // int32 - /** - * A description of the check. - */ - kycCheckDescription?: string; - } - export interface KYCPayoutMethodCheckResult { - /** - * A list of the checks and their statuses. - */ - checks?: KYCCheckStatusData[]; - /** - * The unique ID of the payoput method to which the check applies. - */ - payoutMethodCode?: string; - } - export interface KYCShareholderCheckResult { - /** - * A list of the checks and their statuses. - */ - checks?: KYCCheckStatusData[]; - /** - * The code of the shareholder to which the check applies. - */ - shareholderCode?: string; - } - export interface KYCVerificationResult { - /** - * The result(s) of the checks on the account holder. - */ - accountHolder?: KYCCheckResult; - /** - * The result(s) of the checks on the payout method(s). - */ - payoutMethods?: KYCPayoutMethodCheckResult[]; - /** - * The result(s) of the checks on the shareholder(s). - */ - shareholders?: KYCShareholderCheckResult[]; - } - export interface PayoutMethod { - merchantAccount: string; - payoutMethodCode?: string; - payoutMethodType?: "CardToken"; - recurringDetailReference: string; - shopperReference: string; - } - export interface PayoutScheduleResponse { - /** - * The date of the next scheduled payout. - */ - nextScheduledPayout: string; // date-time - /** - * The payout schedule of the account. - * >Permitted values: `DEFAULT`, `HOLD`, `DAILY`, `WEEKLY`, `MONTHLY`. - */ - schedule: "BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT" | "BIWEEKLY_ON_1ST_AND_15TH_AT_NOON" | "DAILY" | "DAILY_6PM" | "DAILY_AU" | "DAILY_EU" | "DAILY_US" | "DEFAULT" | "EVERY_6_HOURS_FROM_MIDNIGHT" | "HOLD" | "MONTHLY" | "WEEKLY" | "WEEKLY_ON_TUE_FRI_MIDNIGHT" | "YEARLY"; - } - export interface PerformVerificationRequest { - /** - * The code of the account holder to verify. - */ - accountHolderCode: string; - /** - * The state required for the account holder. - * > Permitted values: `Processing`, `Payout`. - */ - accountStateType: "LimitedPayout" | "LimitedProcessing" | "LimitlessPayout" | "LimitlessProcessing" | "Payout" | "Processing"; - /** - * The tier required for the account holder. - */ - tier: number; // int32 - } - export interface PersonalDocumentData { - /** - * The expiration date of the document. - * The date should be in ISO-8601 format yyyy-mm-dd (e.g. 2000-01-31). - */ - expirationDate?: string; - /** - * The two-character country code of the issuer. - * >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL'). - */ - issuerCountry?: string; - /** - * The state issued the document (if applicable) - */ - issuerState?: string; - /** - * The number of the document. Delete the given type if the value empty. - */ - number?: string; - /** - * The type of the document. More then one item pert type does not allowed. - * Valid values: ID, PASSPORT, VISA, DRIVINGLICENSE - */ - type: "DRIVINGLICENSE" | "ID" | "PASSPORT" | "SOCIALSECURITY" | "VISA"; - } - export interface ShareholderContact { - /** - * The address of the contact. - */ - address?: ViasAddress; - /** - * The e-mail address of the contact. - */ - email?: string; - /** - * The phone number of the contact provided as a single string. It will be handled as a landline phone. - * **Examples:** "0031 6 11 22 33 44", "+316/1122-3344", "(0031) 611223344" - */ - fullPhoneNumber?: string; - /** - * The name of the contact. - */ - name?: ViasName; - /** - * Personal data of the Shareholder. - */ - personalData?: ViasPersonalData; - /** - * The phone number of the contact. - */ - phoneNumber?: ViasPhoneNumber; - /** - * The unique identifier (UUID) of the Shareholder. - * >**If, during an Account Holder create or update request, this field is left blank (but other fields provided), a new Shareholder will be created with a procedurally-generated UUID.** - * - * >**If, during an Account Holder create request, a UUID is provided, the creation of the Shareholder will fail while the creation of the Account Holder will continue.** - * - * >**If, during an Account Holder update request, a UUID that is not correlated with an existing Shareholder is provided, the update of the Shareholder will fail.** - * - * >**If, during an Account Holder update request, a UUID that is correlated with an existing Shareholder is provided, the existing Shareholder will be updated.** - * - */ - shareholderCode?: string; - /** - * Merchant reference to the Shareholder. - */ - shareholderReference?: string; - /** - * The URL of the website of the contact. - */ - webAddress?: string; - } - export interface SuspendAccountHolderRequest { - /** - * The code of the account holder to be suspended. - */ - accountHolderCode: string; - } - export interface SuspendAccountHolderResponse { - /** - * The new status of the Account Holder. - */ - accountHolderStatus: AccountHolderStatus; - /** - * Contains field validation errors that would prevent requests from being processed. - */ - invalidFields?: ErrorFieldType[]; - /** - * The reference of a request. Can be used to uniquely identify the request. - */ - pspReference?: string; - /** - * The result code. - */ - resultCode?: string; - } - export interface UnSuspendAccountHolderRequest { - /** - * The code of the account holder to be reinstated. - */ - accountHolderCode: string; - } - export interface UnSuspendAccountHolderResponse { - /** - * The new status of the Account Holder. - */ - accountHolderStatus: AccountHolderStatus; - /** - * Contains field validation errors that would prevent requests from being processed. - */ - invalidFields?: ErrorFieldType[]; - /** - * The reference of a request. Can be used to uniquely identify the request. - */ - pspReference?: string; - /** - * The result code. - */ - resultCode?: string; - } - export interface UpdateAccountHolderRequest { - /** - * The code of the Account Holder to be updated. - */ - accountHolderCode: string; - /** - * The details to which the Account Holder should be updated. - * - * Required if a processingTier is not provided. - */ - accountHolderDetails?: AccountHolderDetails; - /** - * The description to which the Account Holder should be updated. - */ - description?: string; - /** - * The entity type. - * Permitted values: `Business`, `Individual` - * - * If an account holder is 'Business', then `accountHolderDetails.businessDetails` must be provided, as well as at least one entry in the `accountHolderDetails.businessDetails.shareholders` list. - * - * If an account holder is 'Individual', then `accountHolderDetails.individualDetails` must be provided. - */ - legalEntity?: "Business" | "Individual" | "NonProfit" | "Partnership" | "PublicCompany"; - /** - * The primary three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), to which the account holder should be updated. - */ - primaryCurrency?: string; - /** - * The processing tier to which the Account Holder should be updated. - * >The processing tier can not be lowered through this request. - * - * >Required if accountHolderDetails are not provided. - */ - processingTier?: number; // int32 - /** - * The identifier of the profile that applies to this entity. - */ - verificationProfile?: string; - } - export interface UpdateAccountHolderResponse { - /** - * The code of the account holder. - */ - accountHolderCode?: string; - /** - * Details of the account holder. - */ - accountHolderDetails?: AccountHolderDetails; - /** - * The new status of the account holder. - */ - accountHolderStatus: AccountHolderStatus; - /** - * The description of the account holder. - */ - description?: string; - /** - * in case the account holder has not been updated, contains account holder fields, that did not pass the validation. - */ - invalidFields?: ErrorFieldType[]; - /** - * The legal entity of the account holder. - */ - legalEntity: "Business" | "Individual" | "NonProfit" | "Partnership" | "PublicCompany"; - /** - * The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), with which the prospective account holder primarily deals. - */ - primaryCurrency?: string; - /** - * The reference of a request. Can be used to uniquely identify the request. - */ - pspReference?: string; - /** - * The result code. - */ - resultCode?: string; - /** - * The details of KYC Verification of the account holder. - */ - verification: KYCVerificationResult; - /** - * The identifier of the profile that applies to this entity. - */ - verificationProfile?: string; - } - export interface UpdateAccountHolderStateRequest { - /** - * The code of the Account Holder on which to update the state. - */ - accountHolderCode: string; - /** - * If true, disable the requested state. If false, enable the requested state. - */ - disable: boolean; - /** - * The reason that the state is being updated. - * >Required if the state is being disabled. - */ - reason?: string; - /** - * The state to be updated. - * >Permitted values are: `Processing`, `Payout` - */ - stateType: "LimitedPayout" | "LimitedProcessing" | "LimitlessPayout" | "LimitlessProcessing" | "Payout" | "Processing"; - } - export interface UpdateAccountRequest { - /** - * The code of the account to update. - */ - accountCode: string; - /** - * The bankAccountUUID of the bank account held by the account holder to couple the account with. Scheduled payouts in currencies matching the currency of this bank account will be sent to this bank account. Payouts in different currencies will be sent to a matching bank account of the account holder. - */ - bankAccountUUID?: string; - /** - * A description of the account. - */ - description?: string; - /** - * A set of key and value pairs for general use by the merchant. - * The keys do not have specific names and may be used for storing miscellaneous data as desired. - * > Note that during an update of metadata, the omission of existing key-value pairs will result in the deletion of those key-value pairs. - */ - metadata?: { - [name: string]: string; - }; - /** - * The details of the payout schedule, to which the account should be updated. - */ - payoutSchedule?: UpdatePayoutScheduleRequest; - /** - * Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`. - */ - payoutSpeed?: "SAME_DAY" | "STANDARD"; - } - export interface UpdateAccountResponse { - /** - * The code of the account. - */ - accountCode: string; - /** - * The bankAccountUUID of the bank account held by the account holder to couple the account with. Scheduled payouts in currencies matching the currency of this bank account will be sent to this bank account. Payouts in different currencies will be sent to a matching bank account of the account holder. - */ - bankAccountUUID?: string; - /** - * The description of the account. - */ - description?: string; - /** - * A list of fields that caused the `/updateAccount` request to fail. - */ - invalidFields?: ErrorFieldType[]; - metadata?: { - [name: string]: string; - }; - /** - * The payout schedule of the account. - */ - payoutSchedule?: PayoutScheduleResponse; - /** - * Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`. - */ - payoutSpeed?: "SAME_DAY" | "STANDARD"; - /** - * The reference of a request. Can be used to uniquely identify the request. - */ - pspReference?: string; - /** - * The result code. - */ - resultCode?: string; - } - export interface UpdatePayoutScheduleRequest { - /** - * Direction on how to handle any payouts that have already been scheduled. - * Permitted values: - * * `CLOSE` will close the existing batch of payouts. - * * `UPDATE` will reschedule the existing batch to the new schedule. - * * `NOTHING` (**default**) will allow the payout to proceed. - */ - action?: "CLOSE" | "NOTHING" | "UPDATE"; - /** - * The reason for the payout schedule update. - * > This field is required when the `schedule` parameter is set to `HOLD`. - */ - reason?: string; - /** - * The payout schedule to which the account is to be updated. - * Permitted values: `DEFAULT`, `HOLD`, `DAILY`, `WEEKLY`, `MONTHLY`. - * `HOLD` will prevent scheduled payouts from happening but will still allow manual payouts to occur. - */ - schedule: "BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT" | "BIWEEKLY_ON_1ST_AND_15TH_AT_NOON" | "DAILY" | "DAILY_6PM" | "DAILY_AU" | "DAILY_EU" | "DAILY_US" | "DEFAULT" | "EVERY_6_HOURS_FROM_MIDNIGHT" | "HOLD" | "MONTHLY" | "WEEKLY" | "WEEKLY_ON_TUE_FRI_MIDNIGHT" | "YEARLY"; - } - export interface UploadDocumentRequest { - /** - * The content of the document as represented by a Base64-encoded string. - * - * To learn about requirements, see [Bank account check](https://docs.adyen.com/platforms/onboarding-and-verification/verification-checks/bank-account-check#requirements) and [Photo ID check](https://docs.adyen.com/platforms/onboarding-and-verification/verification-checks/photo-id-check#requirements). - */ - documentContent: string; // byte - /** - * Details of the document being submitted. - */ - documentDetail: DocumentDetail; - } - export interface ViasAddress { - /** - * The name of the city. - * >Required if either `houseNumberOrName`, `street`, `postalCode`, or `stateOrProvince` are provided. - */ - city?: string; - /** - * The two-character country code of the address. The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL'). - * > If you don't know the country or are not collecting the country from the shopper, provide `country` as `ZZ`. - */ - country: string; - /** - * The number or name of the house. - */ - houseNumberOrName?: string; - /** - * The postal code. - * >A maximum of five (5) digits for an address in the USA, or a maximum of ten (10) characters for an address in all other countries. - * >Required if either `houseNumberOrName`, `street`, `city`, or `stateOrProvince` are provided. - */ - postalCode?: string; - /** - * The abbreviation of the state or province. - * >Two (2) characters for an address in the USA or Canada, or a maximum of three (3) characters for an address in all other countries. - * >Required for an address in the USA or Canada if either `houseNumberOrName`, `street`, `city`, or `postalCode` are provided. - */ - stateOrProvince?: string; - /** - * The name of the street. - * >The house number should not be included in this field; it should be separately provided via `houseNumberOrName`. - * >Required if either `houseNumberOrName`, `city`, `postalCode`, or `stateOrProvince` are provided. - */ - street?: string; - } - export interface ViasName { - /** - * The first name. - */ - firstName: string; - /** - * The gender. - * >The following values are permitted: `MALE`, `FEMALE`, `UNKNOWN`. - */ - gender: "MALE" | "FEMALE" | "UNKNOWN"; - /** - * The name's infix, if applicable. - * >A maximum length of twenty (20) characters is imposed. - */ - infix?: string; - /** - * The last name. - */ - lastName: string; - } - export interface ViasPersonalData { - /** - * The date of birth of the person. - * The date should be in ISO-8601 format yyyy-mm-dd (e.g. 2000-01-31). - */ - dateOfBirth?: string; - /** - * Key value pairs of document type and identify numbers - */ - documentData?: PersonalDocumentData[]; - /** - * The nationality of the person represented by a two-character country code. - * >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL'). - */ - nationality?: string; - } - export interface ViasPhoneNumber { - /** - * The two-character country code of the phone number. - * >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL'). - */ - phoneCountryCode: string; - /** - * The phone number. - * >The inclusion of the phone number country code is not necessary. - */ - phoneNumber: string; - /** - * The type of the phone number. - * >The following values are permitted: `Landline`, `Mobile`, `SIP`, `Fax`. - */ - phoneType?: "Fax" | "Landline" | "Mobile" | "SIP"; - } -} -declare namespace Paths { - namespace PostCheckAccountHolder { - export type RequestBody = IPlatformsAccount.PerformVerificationRequest; - namespace Responses { - export type $200 = IPlatformsAccount.GenericResponse; - export interface $400 { - } - export interface $401 { - } - export interface $403 { - } - export interface $422 { - } - export interface $500 { - } - } - } - namespace PostCloseAccount { - export type RequestBody = IPlatformsAccount.CloseAccountRequest; - namespace Responses { - export type $200 = IPlatformsAccount.CloseAccountResponse; - export interface $400 { - } - export interface $401 { - } - export interface $403 { - } - export interface $422 { - } - export interface $500 { - } - } - } - namespace PostCloseAccountHolder { - export type RequestBody = IPlatformsAccount.CloseAccountHolderRequest; - namespace Responses { - export type $200 = IPlatformsAccount.CloseAccountHolderResponse; - export interface $400 { - } - export interface $401 { - } - export interface $403 { - } - export interface $422 { - } - export interface $500 { - } - } - } - namespace PostCreateAccount { - export type RequestBody = IPlatformsAccount.CreateAccountRequest; - namespace Responses { - export type $200 = IPlatformsAccount.CreateAccountResponse; - export interface $400 { - } - export interface $401 { - } - export interface $403 { - } - export interface $422 { - } - export interface $500 { - } - } - } - namespace PostCreateAccountHolder { - export type RequestBody = IPlatformsAccount.CreateAccountHolderRequest; - namespace Responses { - export type $200 = IPlatformsAccount.CreateAccountHolderResponse; - export interface $400 { - } - export interface $401 { - } - export interface $403 { - } - export interface $422 { - } - export interface $500 { - } - } - } - namespace PostDeleteBankAccounts { - export type RequestBody = IPlatformsAccount.DeleteBankAccountRequest; - namespace Responses { - export type $200 = IPlatformsAccount.GenericResponse; - export interface $400 { - } - export interface $401 { - } - export interface $403 { - } - export interface $422 { - } - export interface $500 { - } - } - } - namespace PostDeletePayoutMethods { - export type RequestBody = IPlatformsAccount.DeletePayoutMethodRequest; - namespace Responses { - export type $200 = IPlatformsAccount.GenericResponse; - export interface $400 { - } - export interface $401 { - } - export interface $403 { - } - export interface $422 { - } - export interface $500 { - } - } - } - namespace PostDeleteShareholders { - export type RequestBody = IPlatformsAccount.DeleteShareholderRequest; - namespace Responses { - export type $200 = IPlatformsAccount.GenericResponse; - export interface $400 { - } - export interface $401 { - } - export interface $403 { - } - export interface $422 { - } - export interface $500 { - } - } - } - namespace PostGetAccountHolder { - export type RequestBody = IPlatformsAccount.GetAccountHolderRequest; - namespace Responses { - export type $200 = IPlatformsAccount.GetAccountHolderResponse; - export interface $400 { - } - export interface $401 { - } - export interface $403 { - } - export interface $422 { - } - export interface $500 { - } - } - } - namespace PostGetUploadedDocuments { - export type RequestBody = IPlatformsAccount.GetUploadedDocumentsRequest; - namespace Responses { - export type $200 = IPlatformsAccount.GetUploadedDocumentsResponse; - export interface $400 { - } - export interface $401 { - } - export interface $403 { - } - export interface $422 { - } - export interface $500 { - } - } - } - namespace PostSuspendAccountHolder { - export type RequestBody = IPlatformsAccount.SuspendAccountHolderRequest; - namespace Responses { - export type $200 = IPlatformsAccount.SuspendAccountHolderResponse; - export interface $400 { - } - export interface $401 { - } - export interface $403 { - } - export interface $422 { - } - export interface $500 { - } - } - } - namespace PostUnSuspendAccountHolder { - export type RequestBody = IPlatformsAccount.UnSuspendAccountHolderRequest; - namespace Responses { - export type $200 = IPlatformsAccount.UnSuspendAccountHolderResponse; - export interface $400 { - } - export interface $401 { - } - export interface $403 { - } - export interface $422 { - } - export interface $500 { - } - } - } - namespace PostUpdateAccount { - export type RequestBody = IPlatformsAccount.UpdateAccountRequest; - namespace Responses { - export type $200 = IPlatformsAccount.UpdateAccountResponse; - export interface $400 { - } - export interface $401 { - } - export interface $403 { - } - export interface $422 { - } - export interface $500 { - } - } - } - namespace PostUpdateAccountHolder { - export type RequestBody = IPlatformsAccount.UpdateAccountHolderRequest; - namespace Responses { - export type $200 = IPlatformsAccount.UpdateAccountHolderResponse; - export interface $400 { - } - export interface $401 { - } - export interface $403 { - } - export interface $422 { - } - export interface $500 { - } - } - } - namespace PostUpdateAccountHolderState { - export type RequestBody = IPlatformsAccount.UpdateAccountHolderStateRequest; - namespace Responses { - export type $200 = IPlatformsAccount.GetAccountHolderStatusResponse; - export interface $400 { - } - export interface $401 { - } - export interface $403 { - } - export interface $422 { - } - export interface $500 { - } - } - } - namespace PostUploadDocument { - export type RequestBody = IPlatformsAccount.UploadDocumentRequest; - namespace Responses { - export type $200 = IPlatformsAccount.UpdateAccountHolderResponse; - export interface $400 { - } - export interface $401 { - } - export interface $403 { - } - export interface $422 { - } - export interface $500 { - } - } - } -} diff --git a/src/typings/platformsAccount/account.ts b/src/typings/platformsAccount/account.ts new file mode 100644 index 0000000..e4fa3be --- /dev/null +++ b/src/typings/platformsAccount/account.ts @@ -0,0 +1,119 @@ +/** + * Adyen for Platforms: Account API + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don\'t have one, contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@MarketPlace.YourMarketPlace\":\"YourWsPassword\" \\ -H \"Content-Type: application/json\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder ``` + * + * The version of the OpenAPI document: 6 + * Contact: developer-experience@adyen.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +import {PayoutScheduleResponse} from './payoutScheduleResponse'; + +export class Account { + /** + * The code of the account. + */ + 'accountCode'?: string; + /** + * The bankAccountUUID of the bank account held by the account holder to couple the account with. Scheduled payouts in currencies matching the currency of this bank account will be sent to this bank account. Payouts in different currencies will be sent to a matching bank account of the account holder. + */ + 'bankAccountUUID'?: string; + /** + * The beneficiary of the account. + */ + 'beneficiaryAccount'?: string; + /** + * The reason that a beneficiary has been set up for this account. This may have been supplied during the setup of a beneficiary at the discretion of the executing user. + */ + 'beneficiaryMerchantReference'?: string; + /** + * A description of the account. + */ + 'description'?: string; + /** + * A set of key and value pairs for general use by the merchant. The keys do not have specific names and may be used for storing miscellaneous data as desired. > Note that during an update of metadata, the omission of existing key-value pairs will result in the deletion of those key-value pairs. + */ + 'metadata'?: { [key: string]: string; }; + /** + * The payout method code held by the account holder to couple the account with. Scheduled card payouts will be sent using this payout method code. + */ + 'payoutMethodCode'?: string; + 'payoutSchedule'?: PayoutScheduleResponse; + /** + * Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`. + */ + 'payoutSpeed'?: Account.PayoutSpeedEnum; + /** + * The status of the account. Possible values: `Active`, `Inactive`, `Suspended`, `Closed`. + */ + 'status'?: string; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: Array<{ name: string, baseName: string, type: string }> = [ + { + "name": "accountCode", + "baseName": "accountCode", + "type": "string" + }, + { + "name": "bankAccountUUID", + "baseName": "bankAccountUUID", + "type": "string" + }, + { + "name": "beneficiaryAccount", + "baseName": "beneficiaryAccount", + "type": "string" + }, + { + "name": "beneficiaryMerchantReference", + "baseName": "beneficiaryMerchantReference", + "type": "string" + }, + { + "name": "description", + "baseName": "description", + "type": "string" + }, + { + "name": "metadata", + "baseName": "metadata", + "type": "{ [key: string]: string; }" + }, + { + "name": "payoutMethodCode", + "baseName": "payoutMethodCode", + "type": "string" + }, + { + "name": "payoutSchedule", + "baseName": "payoutSchedule", + "type": "PayoutScheduleResponse" + }, + { + "name": "payoutSpeed", + "baseName": "payoutSpeed", + "type": "Account.PayoutSpeedEnum" + }, + { + "name": "status", + "baseName": "status", + "type": "string" + }]; + + static getAttributeTypeMap() { + return Account.attributeTypeMap; + } +} + +export namespace Account { + export enum PayoutSpeedEnum { + Instant = 'INSTANT', + SameDay = 'SAME_DAY', + Standard = 'STANDARD' + } +} diff --git a/src/typings/platformsAccount/accountEvent.ts b/src/typings/platformsAccount/accountEvent.ts new file mode 100644 index 0000000..3c8a521 --- /dev/null +++ b/src/typings/platformsAccount/accountEvent.ts @@ -0,0 +1,56 @@ +/** + * Adyen for Platforms: Account API + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don\'t have one, contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@MarketPlace.YourMarketPlace\":\"YourWsPassword\" \\ -H \"Content-Type: application/json\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder ``` + * + * The version of the OpenAPI document: 6 + * Contact: developer-experience@adyen.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +export class AccountEvent { + /** + * The event. >Permitted values: `InactivateAccount`, `RefundNotPaidOutTransfers`. For more information, refer to [Verification checks](https://docs.adyen.com/platforms/verification-checks). + */ + 'event': AccountEvent.EventEnum; + /** + * The date on which the event will take place. + */ + 'executionDate': Date; + /** + * The reason why this event has been created. + */ + 'reason': string; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "event", + "baseName": "event", + "type": "AccountEvent.EventEnum" + }, + { + "name": "executionDate", + "baseName": "executionDate", + "type": "Date" + }, + { + "name": "reason", + "baseName": "reason", + "type": "string" + } ]; + + static getAttributeTypeMap() { + return AccountEvent.attributeTypeMap; + } +} + +export namespace AccountEvent { + export enum EventEnum { + InactivateAccount = 'InactivateAccount', + RefundNotPaidOutTransfers = 'RefundNotPaidOutTransfers' + } +} diff --git a/src/typings/platformsAccount/accountHolderDetails.ts b/src/typings/platformsAccount/accountHolderDetails.ts new file mode 100644 index 0000000..e9b78c8 --- /dev/null +++ b/src/typings/platformsAccount/accountHolderDetails.ts @@ -0,0 +1,145 @@ +/** + * Adyen for Platforms: Account API + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don\'t have one, contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@MarketPlace.YourMarketPlace\":\"YourWsPassword\" \\ -H \"Content-Type: application/json\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder ``` + * + * The version of the OpenAPI document: 6 + * Contact: developer-experience@adyen.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +import {BankAccountDetail} from './bankAccountDetail'; +import {BusinessDetails} from './businessDetails'; +import {IndividualDetails} from './individualDetails'; +import {LegalArrangementDetail} from './legalArrangementDetail'; +import {PayoutMethod} from './payoutMethod'; +import {StoreDetail} from './storeDetail'; +import {ViasAddress} from './viasAddress'; + +export class AccountHolderDetails { + 'address'?: ViasAddress; + /** + * Array of bank accounts associated with the account holder. For details about the required `BankAccountDetail` fields, refer to [Bank account check](https://docs.adyen.com/platforms/verification-checks/bank-account-check). + */ + 'bankAccountDetails'?: Array; + /** + * The opaque reference value returned by the Adyen API during bank account login. + */ + 'bankAggregatorDataReference'?: string; + 'businessDetails'?: BusinessDetails; + /** + * The email address of the account holder. + */ + 'email': string; + /** + * The phone number of the account holder provided as a single string. It will be handled as a landline phone. **Examples:** \"0031 6 11 22 33 44\", \"+316/1122-3344\", \"(0031) 611223344\" + */ + 'fullPhoneNumber': string; + 'individualDetails'?: IndividualDetails; + /** + * Array that contains information about legal arrangements, used when the account holder is acting on behalf of different parties or is part of a contractual business agreement. + */ + 'legalArrangements'?: Array; + /** + * The Merchant Category Code of the account holder. > If not specified in the request, this will be derived from the platform account (which is configured by Adyen). + */ + 'merchantCategoryCode'?: string; + /** + * A set of key and value pairs for general use by the account holder or merchant. The keys do not have specific names and may be used for storing miscellaneous data as desired. > The values being stored have a maximum length of eighty (80) characters and will be truncated if necessary. > Note that during an update of metadata, the omission of existing key-value pairs will result in the deletion of those key-value pairs. + */ + 'metadata'?: { [key: string]: string; }; + /** + * Array of tokenized card details associated with the account holder. For details about how you can use the tokens to pay out, refer to [Pay out to cards](https://docs.adyen.com/platforms/payout-to-cards). + */ + 'payoutMethods'?: Array; + 'principalBusinessAddress'?: ViasAddress; + /** + * Array of stores associated with the account holder. Required when onboarding account holders that have an Adyen [point of sale](https://docs.adyen.com/platforms/platforms-for-pos). + */ + 'storeDetails'?: Array; + /** + * The URL of the website of the account holder. + */ + 'webAddress': string; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "address", + "baseName": "address", + "type": "ViasAddress" + }, + { + "name": "bankAccountDetails", + "baseName": "bankAccountDetails", + "type": "Array" + }, + { + "name": "bankAggregatorDataReference", + "baseName": "bankAggregatorDataReference", + "type": "string" + }, + { + "name": "businessDetails", + "baseName": "businessDetails", + "type": "BusinessDetails" + }, + { + "name": "email", + "baseName": "email", + "type": "string" + }, + { + "name": "fullPhoneNumber", + "baseName": "fullPhoneNumber", + "type": "string" + }, + { + "name": "individualDetails", + "baseName": "individualDetails", + "type": "IndividualDetails" + }, + { + "name": "legalArrangements", + "baseName": "legalArrangements", + "type": "Array" + }, + { + "name": "merchantCategoryCode", + "baseName": "merchantCategoryCode", + "type": "string" + }, + { + "name": "metadata", + "baseName": "metadata", + "type": "{ [key: string]: string; }" + }, + { + "name": "payoutMethods", + "baseName": "payoutMethods", + "type": "Array" + }, + { + "name": "principalBusinessAddress", + "baseName": "principalBusinessAddress", + "type": "ViasAddress" + }, + { + "name": "storeDetails", + "baseName": "storeDetails", + "type": "Array" + }, + { + "name": "webAddress", + "baseName": "webAddress", + "type": "string" + } ]; + + static getAttributeTypeMap() { + return AccountHolderDetails.attributeTypeMap; + } +} + diff --git a/src/typings/platformsAccount/accountHolderStatus.ts b/src/typings/platformsAccount/accountHolderStatus.ts new file mode 100644 index 0000000..40efe28 --- /dev/null +++ b/src/typings/platformsAccount/accountHolderStatus.ts @@ -0,0 +1,74 @@ +/** + * Adyen for Platforms: Account API + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don\'t have one, contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@MarketPlace.YourMarketPlace\":\"YourWsPassword\" \\ -H \"Content-Type: application/json\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder ``` + * + * The version of the OpenAPI document: 6 + * Contact: developer-experience@adyen.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +import {AccountEvent} from './accountEvent'; +import {AccountPayoutState} from './accountPayoutState'; +import {AccountProcessingState} from './accountProcessingState'; + +export class AccountHolderStatus { + /** + * A list of events scheduled for the account holder. + */ + 'events'?: Array; + 'payoutState'?: AccountPayoutState; + 'processingState'?: AccountProcessingState; + /** + * The status of the account holder. >Permitted values: `Active`, `Inactive`, `Suspended`, `Closed`. + */ + 'status': AccountHolderStatus.StatusEnum; + /** + * The reason why the status was assigned to the account holder. + */ + 'statusReason'?: string; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "events", + "baseName": "events", + "type": "Array" + }, + { + "name": "payoutState", + "baseName": "payoutState", + "type": "AccountPayoutState" + }, + { + "name": "processingState", + "baseName": "processingState", + "type": "AccountProcessingState" + }, + { + "name": "status", + "baseName": "status", + "type": "AccountHolderStatus.StatusEnum" + }, + { + "name": "statusReason", + "baseName": "statusReason", + "type": "string" + } ]; + + static getAttributeTypeMap() { + return AccountHolderStatus.attributeTypeMap; + } +} + +export namespace AccountHolderStatus { + export enum StatusEnum { + Active = 'Active', + Closed = 'Closed', + Inactive = 'Inactive', + Suspended = 'Suspended' + } +} diff --git a/src/typings/platformsAccount/accountPayoutState.ts b/src/typings/platformsAccount/accountPayoutState.ts new file mode 100644 index 0000000..bcec318 --- /dev/null +++ b/src/typings/platformsAccount/accountPayoutState.ts @@ -0,0 +1,76 @@ +/** + * Adyen for Platforms: Account API + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don\'t have one, contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@MarketPlace.YourMarketPlace\":\"YourWsPassword\" \\ -H \"Content-Type: application/json\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder ``` + * + * The version of the OpenAPI document: 6 + * Contact: developer-experience@adyen.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +import {Amount} from './amount'; + +export class AccountPayoutState { + /** + * Indicates whether payouts are allowed. This field is the overarching payout status, and is the aggregate of multiple conditions (e.g., KYC status, disabled flag, etc). If this field is false, no payouts will be permitted for any of the account holder\'s accounts. If this field is true, payouts will be permitted for any of the account holder\'s accounts. + */ + 'allowPayout'?: boolean; + /** + * The reason why payouts (to all of the account holder\'s accounts) have been disabled (by the platform). If the `disabled` field is true, this field can be used to explain why. + */ + 'disableReason'?: string; + /** + * Indicates whether payouts have been disabled (by the platform) for all of the account holder\'s accounts. A platform may enable and disable this field at their discretion. If this field is true, `allowPayout` will be false and no payouts will be permitted for any of the account holder\'s accounts. If this field is false, `allowPayout` may or may not be enabled, depending on other factors. + */ + 'disabled'?: boolean; + /** + * The reason why payouts (to all of the account holder\'s accounts) have been disabled (by Adyen). If payouts have been disabled by Adyen, this field will explain why. If this field is blank, payouts have not been disabled by Adyen. + */ + 'notAllowedReason'?: string; + 'payoutLimit'?: Amount; + /** + * The payout tier that the account holder occupies. + */ + 'tierNumber'?: number; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "allowPayout", + "baseName": "allowPayout", + "type": "boolean" + }, + { + "name": "disableReason", + "baseName": "disableReason", + "type": "string" + }, + { + "name": "disabled", + "baseName": "disabled", + "type": "boolean" + }, + { + "name": "notAllowedReason", + "baseName": "notAllowedReason", + "type": "string" + }, + { + "name": "payoutLimit", + "baseName": "payoutLimit", + "type": "Amount" + }, + { + "name": "tierNumber", + "baseName": "tierNumber", + "type": "number" + } ]; + + static getAttributeTypeMap() { + return AccountPayoutState.attributeTypeMap; + } +} + diff --git a/src/typings/platformsAccount/accountProcessingState.ts b/src/typings/platformsAccount/accountProcessingState.ts new file mode 100644 index 0000000..6fb476c --- /dev/null +++ b/src/typings/platformsAccount/accountProcessingState.ts @@ -0,0 +1,64 @@ +/** + * Adyen for Platforms: Account API + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don\'t have one, contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@MarketPlace.YourMarketPlace\":\"YourWsPassword\" \\ -H \"Content-Type: application/json\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder ``` + * + * The version of the OpenAPI document: 6 + * Contact: developer-experience@adyen.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +import {Amount} from './amount'; + +export class AccountProcessingState { + /** + * The reason why processing has been disabled. + */ + 'disableReason'?: string; + /** + * Indicates whether the processing of payments is allowed. + */ + 'disabled'?: boolean; + 'processedFrom'?: Amount; + 'processedTo'?: Amount; + /** + * The processing tier that the account holder occupies. + */ + 'tierNumber'?: number; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "disableReason", + "baseName": "disableReason", + "type": "string" + }, + { + "name": "disabled", + "baseName": "disabled", + "type": "boolean" + }, + { + "name": "processedFrom", + "baseName": "processedFrom", + "type": "Amount" + }, + { + "name": "processedTo", + "baseName": "processedTo", + "type": "Amount" + }, + { + "name": "tierNumber", + "baseName": "tierNumber", + "type": "number" + } ]; + + static getAttributeTypeMap() { + return AccountProcessingState.attributeTypeMap; + } +} + diff --git a/src/typings/platformsAccount/amount.ts b/src/typings/platformsAccount/amount.ts new file mode 100644 index 0000000..390c664 --- /dev/null +++ b/src/typings/platformsAccount/amount.ts @@ -0,0 +1,41 @@ +/** + * Adyen for Platforms: Account API + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don\'t have one, contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@MarketPlace.YourMarketPlace\":\"YourWsPassword\" \\ -H \"Content-Type: application/json\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder ``` + * + * The version of the OpenAPI document: 6 + * Contact: developer-experience@adyen.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +export class Amount { + /** + * The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). + */ + 'currency': string; + /** + * The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + */ + 'value': number; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "currency", + "baseName": "currency", + "type": "string" + }, + { + "name": "value", + "baseName": "value", + "type": "number" + } ]; + + static getAttributeTypeMap() { + return Amount.attributeTypeMap; + } +} + diff --git a/src/typings/platformsAccount/bankAccountDetail.ts b/src/typings/platformsAccount/bankAccountDetail.ts new file mode 100644 index 0000000..1e8106d --- /dev/null +++ b/src/typings/platformsAccount/bankAccountDetail.ts @@ -0,0 +1,257 @@ +/** + * Adyen for Platforms: Account API + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don\'t have one, contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@MarketPlace.YourMarketPlace\":\"YourWsPassword\" \\ -H \"Content-Type: application/json\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder ``` + * + * The version of the OpenAPI document: 6 + * Contact: developer-experience@adyen.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +export class BankAccountDetail { + /** + * The bank account number (without separators). >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. + */ + 'accountNumber'?: string; + /** + * The type of bank account. Only applicable to bank accounts held in the USA. The permitted values are: `checking`, `savings`. >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. + */ + 'accountType'?: string; + /** + * The name of the bank account. + */ + 'bankAccountName'?: string; + /** + * Merchant reference to the bank account. + */ + 'bankAccountReference'?: string; + /** + * The unique identifier (UUID) of the Bank Account. >If, during an account holder create or update request, this field is left blank (but other fields provided), a new Bank Account will be created with a procedurally-generated UUID. >If, during an account holder create request, a UUID is provided, the creation of the Bank Account will fail while the creation of the account holder will continue. >If, during an account holder update request, a UUID that is not correlated with an existing Bank Account is provided, the update of the account holder will fail. >If, during an account holder update request, a UUID that is correlated with an existing Bank Account is provided, the existing Bank Account will be updated. + */ + 'bankAccountUUID'?: string; + /** + * The bank identifier code. >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. + */ + 'bankBicSwift'?: string; + /** + * The city in which the bank branch is located. >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. + */ + 'bankCity'?: string; + /** + * The bank code of the banking institution with which the bank account is registered. >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. + */ + 'bankCode'?: string; + /** + * The name of the banking institution with which the bank account is held. >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. + */ + 'bankName'?: string; + /** + * The branch code of the branch under which the bank account is registered. The value to be specified in this parameter depends on the country of the bank account: * United States - Routing number * United Kingdom - Sort code * Germany - Bankleitzahl >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. + */ + 'branchCode'?: string; + /** + * The check code of the bank account. >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. + */ + 'checkCode'?: string; + /** + * The two-letter country code in which the bank account is registered. >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. \'NL\'). >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. + */ + 'countryCode'?: string; + /** + * The currency in which the bank account deals. >The permitted currency codes are defined in ISO-4217 (e.g. \'EUR\'). >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. + */ + 'currencyCode'?: string; + /** + * The international bank account number. >The IBAN standard is defined in ISO-13616. >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. + */ + 'iban'?: string; + /** + * The city of residence of the bank account owner. >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. + */ + 'ownerCity'?: string; + /** + * The country code of the country of residence of the bank account owner. >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. \'NL\'). >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. + */ + 'ownerCountryCode'?: string; + /** + * The date of birth of the bank account owner. + */ + 'ownerDateOfBirth'?: string; + /** + * The house name or number of the residence of the bank account owner. >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. + */ + 'ownerHouseNumberOrName'?: string; + /** + * The name of the bank account owner. >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. + */ + 'ownerName'?: string; + /** + * The country code of the country of nationality of the bank account owner. >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. \'NL\'). >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. + */ + 'ownerNationality'?: string; + /** + * The postal code of the residence of the bank account owner. >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. + */ + 'ownerPostalCode'?: string; + /** + * The state of residence of the bank account owner. >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. + */ + 'ownerState'?: string; + /** + * The street name of the residence of the bank account owner. >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. + */ + 'ownerStreet'?: string; + /** + * If set to true, the bank account is a primary account. + */ + 'primaryAccount'?: boolean; + /** + * The tax ID number. >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. + */ + 'taxId'?: string; + /** + * The URL to be used for bank account verification. This may be generated on bank account creation. >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on field requirements. + */ + 'urlForVerification'?: string; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "accountNumber", + "baseName": "accountNumber", + "type": "string" + }, + { + "name": "accountType", + "baseName": "accountType", + "type": "string" + }, + { + "name": "bankAccountName", + "baseName": "bankAccountName", + "type": "string" + }, + { + "name": "bankAccountReference", + "baseName": "bankAccountReference", + "type": "string" + }, + { + "name": "bankAccountUUID", + "baseName": "bankAccountUUID", + "type": "string" + }, + { + "name": "bankBicSwift", + "baseName": "bankBicSwift", + "type": "string" + }, + { + "name": "bankCity", + "baseName": "bankCity", + "type": "string" + }, + { + "name": "bankCode", + "baseName": "bankCode", + "type": "string" + }, + { + "name": "bankName", + "baseName": "bankName", + "type": "string" + }, + { + "name": "branchCode", + "baseName": "branchCode", + "type": "string" + }, + { + "name": "checkCode", + "baseName": "checkCode", + "type": "string" + }, + { + "name": "countryCode", + "baseName": "countryCode", + "type": "string" + }, + { + "name": "currencyCode", + "baseName": "currencyCode", + "type": "string" + }, + { + "name": "iban", + "baseName": "iban", + "type": "string" + }, + { + "name": "ownerCity", + "baseName": "ownerCity", + "type": "string" + }, + { + "name": "ownerCountryCode", + "baseName": "ownerCountryCode", + "type": "string" + }, + { + "name": "ownerDateOfBirth", + "baseName": "ownerDateOfBirth", + "type": "string" + }, + { + "name": "ownerHouseNumberOrName", + "baseName": "ownerHouseNumberOrName", + "type": "string" + }, + { + "name": "ownerName", + "baseName": "ownerName", + "type": "string" + }, + { + "name": "ownerNationality", + "baseName": "ownerNationality", + "type": "string" + }, + { + "name": "ownerPostalCode", + "baseName": "ownerPostalCode", + "type": "string" + }, + { + "name": "ownerState", + "baseName": "ownerState", + "type": "string" + }, + { + "name": "ownerStreet", + "baseName": "ownerStreet", + "type": "string" + }, + { + "name": "primaryAccount", + "baseName": "primaryAccount", + "type": "boolean" + }, + { + "name": "taxId", + "baseName": "taxId", + "type": "string" + }, + { + "name": "urlForVerification", + "baseName": "urlForVerification", + "type": "string" + } ]; + + static getAttributeTypeMap() { + return BankAccountDetail.attributeTypeMap; + } +} + diff --git a/src/typings/platformsAccount/businessDetails.ts b/src/typings/platformsAccount/businessDetails.ts new file mode 100644 index 0000000..b0b6e2c --- /dev/null +++ b/src/typings/platformsAccount/businessDetails.ts @@ -0,0 +1,107 @@ +/** + * Adyen for Platforms: Account API + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don\'t have one, contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@MarketPlace.YourMarketPlace\":\"YourWsPassword\" \\ -H \"Content-Type: application/json\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder ``` + * + * The version of the OpenAPI document: 6 + * Contact: developer-experience@adyen.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +import {ShareholderContact} from './shareholderContact'; +import {SignatoryContact} from './signatoryContact'; + +export class BusinessDetails { + /** + * The registered name of the company (if it differs from the legal name of the company). + */ + 'doingBusinessAs'?: string; + /** + * The legal name of the company. + */ + 'legalBusinessName'?: string; + /** + * The registration number of the company. + */ + 'registrationNumber'?: string; + /** + * Array containing information about individuals associated with the account holder either through ownership or control. For details about how you can identify them, refer to [Identity check](https://docs.adyen.com/platforms/verification-checks/identity-check). + */ + 'shareholders'?: Array; + /** + * Signatories associated with the company. Each array entry should represent one signatory. + */ + 'signatories'?: Array; + /** + * Market Identifier Code (MIC). + */ + 'stockExchange'?: string; + /** + * International Securities Identification Number (ISIN). + */ + 'stockNumber'?: string; + /** + * Stock Ticker symbol. + */ + 'stockTicker'?: string; + /** + * The tax ID of the company. + */ + 'taxId'?: string; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "doingBusinessAs", + "baseName": "doingBusinessAs", + "type": "string" + }, + { + "name": "legalBusinessName", + "baseName": "legalBusinessName", + "type": "string" + }, + { + "name": "registrationNumber", + "baseName": "registrationNumber", + "type": "string" + }, + { + "name": "shareholders", + "baseName": "shareholders", + "type": "Array" + }, + { + "name": "signatories", + "baseName": "signatories", + "type": "Array" + }, + { + "name": "stockExchange", + "baseName": "stockExchange", + "type": "string" + }, + { + "name": "stockNumber", + "baseName": "stockNumber", + "type": "string" + }, + { + "name": "stockTicker", + "baseName": "stockTicker", + "type": "string" + }, + { + "name": "taxId", + "baseName": "taxId", + "type": "string" + } ]; + + static getAttributeTypeMap() { + return BusinessDetails.attributeTypeMap; + } +} + diff --git a/src/typings/platformsAccount/closeAccountHolderRequest.ts b/src/typings/platformsAccount/closeAccountHolderRequest.ts new file mode 100644 index 0000000..449ebe1 --- /dev/null +++ b/src/typings/platformsAccount/closeAccountHolderRequest.ts @@ -0,0 +1,32 @@ +/** + * Adyen for Platforms: Account API + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don\'t have one, contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@MarketPlace.YourMarketPlace\":\"YourWsPassword\" \\ -H \"Content-Type: application/json\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder ``` + * + * The version of the OpenAPI document: 6 + * Contact: developer-experience@adyen.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +export class CloseAccountHolderRequest { + /** + * The code of the Account Holder to be closed. + */ + 'accountHolderCode': string; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "accountHolderCode", + "baseName": "accountHolderCode", + "type": "string" + } ]; + + static getAttributeTypeMap() { + return CloseAccountHolderRequest.attributeTypeMap; + } +} + diff --git a/src/typings/platformsAccount/closeAccountHolderResponse.ts b/src/typings/platformsAccount/closeAccountHolderResponse.ts new file mode 100644 index 0000000..74fba47 --- /dev/null +++ b/src/typings/platformsAccount/closeAccountHolderResponse.ts @@ -0,0 +1,59 @@ +/** + * Adyen for Platforms: Account API + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don\'t have one, contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@MarketPlace.YourMarketPlace\":\"YourWsPassword\" \\ -H \"Content-Type: application/json\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder ``` + * + * The version of the OpenAPI document: 6 + * Contact: developer-experience@adyen.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +import {AccountHolderStatus} from './accountHolderStatus'; +import {ErrorFieldType} from './errorFieldType'; + +export class CloseAccountHolderResponse { + 'accountHolderStatus': AccountHolderStatus; + /** + * Contains field validation errors that would prevent requests from being processed. + */ + 'invalidFields'?: Array; + /** + * The reference of a request. Can be used to uniquely identify the request. + */ + 'pspReference'?: string; + /** + * The result code. + */ + 'resultCode'?: string; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "accountHolderStatus", + "baseName": "accountHolderStatus", + "type": "AccountHolderStatus" + }, + { + "name": "invalidFields", + "baseName": "invalidFields", + "type": "Array" + }, + { + "name": "pspReference", + "baseName": "pspReference", + "type": "string" + }, + { + "name": "resultCode", + "baseName": "resultCode", + "type": "string" + } ]; + + static getAttributeTypeMap() { + return CloseAccountHolderResponse.attributeTypeMap; + } +} + diff --git a/src/typings/platformsAccount/closeAccountRequest.ts b/src/typings/platformsAccount/closeAccountRequest.ts new file mode 100644 index 0000000..908f06d --- /dev/null +++ b/src/typings/platformsAccount/closeAccountRequest.ts @@ -0,0 +1,32 @@ +/** + * Adyen for Platforms: Account API + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don\'t have one, contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@MarketPlace.YourMarketPlace\":\"YourWsPassword\" \\ -H \"Content-Type: application/json\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder ``` + * + * The version of the OpenAPI document: 6 + * Contact: developer-experience@adyen.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +export class CloseAccountRequest { + /** + * The code of account to be closed. + */ + 'accountCode': string; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "accountCode", + "baseName": "accountCode", + "type": "string" + } ]; + + static getAttributeTypeMap() { + return CloseAccountRequest.attributeTypeMap; + } +} + diff --git a/src/typings/platformsAccount/closeAccountResponse.ts b/src/typings/platformsAccount/closeAccountResponse.ts new file mode 100644 index 0000000..a6a413d --- /dev/null +++ b/src/typings/platformsAccount/closeAccountResponse.ts @@ -0,0 +1,78 @@ +/** + * Adyen for Platforms: Account API + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don\'t have one, contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@MarketPlace.YourMarketPlace\":\"YourWsPassword\" \\ -H \"Content-Type: application/json\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder ``` + * + * The version of the OpenAPI document: 6 + * Contact: developer-experience@adyen.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +import {ErrorFieldType} from './errorFieldType'; + +export class CloseAccountResponse { + /** + * The account code of the account that is closed. + */ + 'accountCode'?: string; + /** + * Contains field validation errors that would prevent requests from being processed. + */ + 'invalidFields'?: Array; + /** + * The reference of a request. Can be used to uniquely identify the request. + */ + 'pspReference'?: string; + /** + * The result code. + */ + 'resultCode'?: string; + /** + * The new status of the account. >Permitted values: `Active`, `Inactive`, `Suspended`, `Closed`. + */ + 'status': CloseAccountResponse.StatusEnum; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "accountCode", + "baseName": "accountCode", + "type": "string" + }, + { + "name": "invalidFields", + "baseName": "invalidFields", + "type": "Array" + }, + { + "name": "pspReference", + "baseName": "pspReference", + "type": "string" + }, + { + "name": "resultCode", + "baseName": "resultCode", + "type": "string" + }, + { + "name": "status", + "baseName": "status", + "type": "CloseAccountResponse.StatusEnum" + } ]; + + static getAttributeTypeMap() { + return CloseAccountResponse.attributeTypeMap; + } +} + +export namespace CloseAccountResponse { + export enum StatusEnum { + Active = 'Active', + Closed = 'Closed', + Inactive = 'Inactive', + Suspended = 'Suspended' + } +} diff --git a/src/typings/platformsAccount/createAccountHolderRequest.ts b/src/typings/platformsAccount/createAccountHolderRequest.ts new file mode 100644 index 0000000..38f0aaf --- /dev/null +++ b/src/typings/platformsAccount/createAccountHolderRequest.ts @@ -0,0 +1,103 @@ +/** + * Adyen for Platforms: Account API + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don\'t have one, contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@MarketPlace.YourMarketPlace\":\"YourWsPassword\" \\ -H \"Content-Type: application/json\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder ``` + * + * The version of the OpenAPI document: 6 + * Contact: developer-experience@adyen.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +import {AccountHolderDetails} from './accountHolderDetails'; + +export class CreateAccountHolderRequest { + /** + * Your unique identifier for the prospective account holder. The length must be between three (3) and fifty (50) characters long. Only letters, digits, and hyphens (-) are allowed. + */ + 'accountHolderCode': string; + 'accountHolderDetails': AccountHolderDetails; + /** + * If set to **true**, an account with the default options is automatically created for the account holder. By default, this field is set to **true**. + */ + 'createDefaultAccount'?: boolean; + /** + * A description of the prospective account holder, maximum 256 characters. You can use alphanumeric characters (A-Z, a-z, 0-9), white spaces, and underscores `_`. + */ + 'description'?: string; + /** + * The legal entity type of the account holder. This determines the information that should be provided in the request. Possible values: **Business**, **Individual**, or **NonProfit**. * If set to **Business** or **NonProfit**, then `accountHolderDetails.businessDetails` must be provided, with at least one entry in the `accountHolderDetails.businessDetails.shareholders` list. * If set to **Individual**, then `accountHolderDetails.individualDetails` must be provided. + */ + 'legalEntity': CreateAccountHolderRequest.LegalEntityEnum; + /** + * The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), with which the prospective account holder primarily deals. + */ + 'primaryCurrency'?: string; + /** + * The starting [processing tier](https://docs.adyen.com/platforms/onboarding-and-verification/precheck-kyc-information) for the prospective account holder. + */ + 'processingTier'?: number; + /** + * The identifier of the profile that applies to this entity. + */ + 'verificationProfile'?: string; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "accountHolderCode", + "baseName": "accountHolderCode", + "type": "string" + }, + { + "name": "accountHolderDetails", + "baseName": "accountHolderDetails", + "type": "AccountHolderDetails" + }, + { + "name": "createDefaultAccount", + "baseName": "createDefaultAccount", + "type": "boolean" + }, + { + "name": "description", + "baseName": "description", + "type": "string" + }, + { + "name": "legalEntity", + "baseName": "legalEntity", + "type": "CreateAccountHolderRequest.LegalEntityEnum" + }, + { + "name": "primaryCurrency", + "baseName": "primaryCurrency", + "type": "string" + }, + { + "name": "processingTier", + "baseName": "processingTier", + "type": "number" + }, + { + "name": "verificationProfile", + "baseName": "verificationProfile", + "type": "string" + } ]; + + static getAttributeTypeMap() { + return CreateAccountHolderRequest.attributeTypeMap; + } +} + +export namespace CreateAccountHolderRequest { + export enum LegalEntityEnum { + Business = 'Business', + Individual = 'Individual', + NonProfit = 'NonProfit', + Partnership = 'Partnership', + PublicCompany = 'PublicCompany' + } +} diff --git a/src/typings/platformsAccount/createAccountHolderResponse.ts b/src/typings/platformsAccount/createAccountHolderResponse.ts new file mode 100644 index 0000000..cf5450f --- /dev/null +++ b/src/typings/platformsAccount/createAccountHolderResponse.ts @@ -0,0 +1,136 @@ +/** + * Adyen for Platforms: Account API + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don\'t have one, contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@MarketPlace.YourMarketPlace\":\"YourWsPassword\" \\ -H \"Content-Type: application/json\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder ``` + * + * The version of the OpenAPI document: 6 + * Contact: developer-experience@adyen.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +import {AccountHolderDetails} from './accountHolderDetails'; +import {AccountHolderStatus} from './accountHolderStatus'; +import {ErrorFieldType} from './errorFieldType'; +import {KYCVerificationResult2} from './kYCVerificationResult2'; + +export class CreateAccountHolderResponse { + /** + * The code of a new account created for the account holder. + */ + 'accountCode'?: string; + /** + * The code of the new account holder. + */ + 'accountHolderCode': string; + 'accountHolderDetails': AccountHolderDetails; + 'accountHolderStatus': AccountHolderStatus; + /** + * The description of the new account holder. + */ + 'description'?: string; + /** + * A list of fields that caused the `/createAccountHolder` request to fail. + */ + 'invalidFields'?: Array; + /** + * The type of legal entity of the new account holder. + */ + 'legalEntity': CreateAccountHolderResponse.LegalEntityEnum; + /** + * The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), with which the prospective account holder primarily deals. + */ + 'primaryCurrency'?: string; + /** + * The reference of a request. Can be used to uniquely identify the request. + */ + 'pspReference'?: string; + /** + * The result code. + */ + 'resultCode'?: string; + 'verification': KYCVerificationResult2; + /** + * The identifier of the profile that applies to this entity. + */ + 'verificationProfile'?: string; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "accountCode", + "baseName": "accountCode", + "type": "string" + }, + { + "name": "accountHolderCode", + "baseName": "accountHolderCode", + "type": "string" + }, + { + "name": "accountHolderDetails", + "baseName": "accountHolderDetails", + "type": "AccountHolderDetails" + }, + { + "name": "accountHolderStatus", + "baseName": "accountHolderStatus", + "type": "AccountHolderStatus" + }, + { + "name": "description", + "baseName": "description", + "type": "string" + }, + { + "name": "invalidFields", + "baseName": "invalidFields", + "type": "Array" + }, + { + "name": "legalEntity", + "baseName": "legalEntity", + "type": "CreateAccountHolderResponse.LegalEntityEnum" + }, + { + "name": "primaryCurrency", + "baseName": "primaryCurrency", + "type": "string" + }, + { + "name": "pspReference", + "baseName": "pspReference", + "type": "string" + }, + { + "name": "resultCode", + "baseName": "resultCode", + "type": "string" + }, + { + "name": "verification", + "baseName": "verification", + "type": "KYCVerificationResult2" + }, + { + "name": "verificationProfile", + "baseName": "verificationProfile", + "type": "string" + } ]; + + static getAttributeTypeMap() { + return CreateAccountHolderResponse.attributeTypeMap; + } +} + +export namespace CreateAccountHolderResponse { + export enum LegalEntityEnum { + Business = 'Business', + Individual = 'Individual', + NonProfit = 'NonProfit', + Partnership = 'Partnership', + PublicCompany = 'PublicCompany' + } +} diff --git a/src/typings/platformsAccount/createAccountRequest.ts b/src/typings/platformsAccount/createAccountRequest.ts new file mode 100644 index 0000000..4ff56c1 --- /dev/null +++ b/src/typings/platformsAccount/createAccountRequest.ts @@ -0,0 +1,120 @@ +/** + * Adyen for Platforms: Account API + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don\'t have one, contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@MarketPlace.YourMarketPlace\":\"YourWsPassword\" \\ -H \"Content-Type: application/json\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder ``` + * + * The version of the OpenAPI document: 6 + * Contact: developer-experience@adyen.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +export class CreateAccountRequest { + /** + * The code of Account Holder under which to create the account. + */ + 'accountHolderCode': string; + /** + * The bankAccountUUID of the bank account held by the account holder to couple the account with. Scheduled payouts in currencies matching the currency of this bank account will be sent to this bank account. Payouts in different currencies will be sent to a matching bank account of the account holder. + */ + 'bankAccountUUID'?: string; + /** + * A description of the account, maximum 256 characters. You can use alphanumeric characters (A-Z, a-z, 0-9), white spaces, and underscores `_`. + */ + 'description'?: string; + /** + * A set of key and value pairs for general use by the merchant. The keys do not have specific names and may be used for storing miscellaneous data as desired. > Note that during an update of metadata, the omission of existing key-value pairs will result in the deletion of those key-value pairs. + */ + 'metadata'?: { [key: string]: string; }; + /** + * The payout method code held by the account holder to couple the account with. Scheduled card payouts will be sent using this payout method code. + */ + 'payoutMethodCode'?: string; + /** + * The payout schedule of the prospective account. >Permitted values: `DEFAULT`, `HOLD`, `DAILY`, `WEEKLY`, `MONTHLY`. + */ + 'payoutSchedule'?: CreateAccountRequest.PayoutScheduleEnum; + /** + * The reason for the payout schedule choice. >Required if the payoutSchedule is `HOLD`. + */ + 'payoutScheduleReason'?: string; + /** + * Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`. + */ + 'payoutSpeed'?: CreateAccountRequest.PayoutSpeedEnum; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "accountHolderCode", + "baseName": "accountHolderCode", + "type": "string" + }, + { + "name": "bankAccountUUID", + "baseName": "bankAccountUUID", + "type": "string" + }, + { + "name": "description", + "baseName": "description", + "type": "string" + }, + { + "name": "metadata", + "baseName": "metadata", + "type": "{ [key: string]: string; }" + }, + { + "name": "payoutMethodCode", + "baseName": "payoutMethodCode", + "type": "string" + }, + { + "name": "payoutSchedule", + "baseName": "payoutSchedule", + "type": "CreateAccountRequest.PayoutScheduleEnum" + }, + { + "name": "payoutScheduleReason", + "baseName": "payoutScheduleReason", + "type": "string" + }, + { + "name": "payoutSpeed", + "baseName": "payoutSpeed", + "type": "CreateAccountRequest.PayoutSpeedEnum" + } ]; + + static getAttributeTypeMap() { + return CreateAccountRequest.attributeTypeMap; + } +} + +export namespace CreateAccountRequest { + export enum PayoutScheduleEnum { + BiweeklyOn1StAnd15ThAtMidnight = 'BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT', + BiweeklyOn1StAnd15ThAtNoon = 'BIWEEKLY_ON_1ST_AND_15TH_AT_NOON', + Daily = 'DAILY', + Daily6Pm = 'DAILY_6PM', + DailyAu = 'DAILY_AU', + DailyEu = 'DAILY_EU', + DailySg = 'DAILY_SG', + DailyUs = 'DAILY_US', + Default = 'DEFAULT', + Every6HoursFromMidnight = 'EVERY_6_HOURS_FROM_MIDNIGHT', + Hold = 'HOLD', + Monthly = 'MONTHLY', + MonthlyOn15ThAtMidnight = 'MONTHLY_ON_15TH_AT_MIDNIGHT', + Weekly = 'WEEKLY', + WeeklyOnTueFriMidnight = 'WEEKLY_ON_TUE_FRI_MIDNIGHT', + Yearly = 'YEARLY' + } + export enum PayoutSpeedEnum { + Instant = 'INSTANT', + SameDay = 'SAME_DAY', + Standard = 'STANDARD' + } +} diff --git a/src/typings/platformsAccount/createAccountResponse.ts b/src/typings/platformsAccount/createAccountResponse.ts new file mode 100644 index 0000000..0d21586 --- /dev/null +++ b/src/typings/platformsAccount/createAccountResponse.ts @@ -0,0 +1,144 @@ +/** + * Adyen for Platforms: Account API + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don\'t have one, contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@MarketPlace.YourMarketPlace\":\"YourWsPassword\" \\ -H \"Content-Type: application/json\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder ``` + * + * The version of the OpenAPI document: 6 + * Contact: developer-experience@adyen.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +import {ErrorFieldType} from './errorFieldType'; +import {PayoutScheduleResponse} from './payoutScheduleResponse'; + +export class CreateAccountResponse { + /** + * The code of the new account. + */ + 'accountCode': string; + /** + * The code of the account holder. + */ + 'accountHolderCode': string; + /** + * The bankAccountUUID of the bank account held by the account holder to couple the account with. Scheduled payouts in currencies matching the currency of this bank account will be sent to this bank account. Payouts in different currencies will be sent to a matching bank account of the account holder. + */ + 'bankAccountUUID'?: string; + /** + * The description of the account. + */ + 'description'?: string; + /** + * A list of fields that caused the `/createAccount` request to fail. + */ + 'invalidFields'?: Array; + /** + * A set of key and value pairs containing metadata. + */ + 'metadata'?: { [key: string]: string; }; + /** + * The payout method code held by the account holder to couple the account with. Scheduled card payouts will be sent using this payout method code. + */ + 'payoutMethodCode'?: string; + 'payoutSchedule'?: PayoutScheduleResponse; + /** + * Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`. + */ + 'payoutSpeed'?: CreateAccountResponse.PayoutSpeedEnum; + /** + * The reference of a request. Can be used to uniquely identify the request. + */ + 'pspReference'?: string; + /** + * The result code. + */ + 'resultCode'?: string; + /** + * The status of the account. >Permitted values: `Active`. + */ + 'status': CreateAccountResponse.StatusEnum; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "accountCode", + "baseName": "accountCode", + "type": "string" + }, + { + "name": "accountHolderCode", + "baseName": "accountHolderCode", + "type": "string" + }, + { + "name": "bankAccountUUID", + "baseName": "bankAccountUUID", + "type": "string" + }, + { + "name": "description", + "baseName": "description", + "type": "string" + }, + { + "name": "invalidFields", + "baseName": "invalidFields", + "type": "Array" + }, + { + "name": "metadata", + "baseName": "metadata", + "type": "{ [key: string]: string; }" + }, + { + "name": "payoutMethodCode", + "baseName": "payoutMethodCode", + "type": "string" + }, + { + "name": "payoutSchedule", + "baseName": "payoutSchedule", + "type": "PayoutScheduleResponse" + }, + { + "name": "payoutSpeed", + "baseName": "payoutSpeed", + "type": "CreateAccountResponse.PayoutSpeedEnum" + }, + { + "name": "pspReference", + "baseName": "pspReference", + "type": "string" + }, + { + "name": "resultCode", + "baseName": "resultCode", + "type": "string" + }, + { + "name": "status", + "baseName": "status", + "type": "CreateAccountResponse.StatusEnum" + } ]; + + static getAttributeTypeMap() { + return CreateAccountResponse.attributeTypeMap; + } +} + +export namespace CreateAccountResponse { + export enum PayoutSpeedEnum { + Instant = 'INSTANT', + SameDay = 'SAME_DAY', + Standard = 'STANDARD' + } + export enum StatusEnum { + Active = 'Active', + Closed = 'Closed', + Inactive = 'Inactive', + Suspended = 'Suspended' + } +} diff --git a/src/typings/platformsAccount/deleteBankAccountRequest.ts b/src/typings/platformsAccount/deleteBankAccountRequest.ts new file mode 100644 index 0000000..79d8194 --- /dev/null +++ b/src/typings/platformsAccount/deleteBankAccountRequest.ts @@ -0,0 +1,41 @@ +/** + * Adyen for Platforms: Account API + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don\'t have one, contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@MarketPlace.YourMarketPlace\":\"YourWsPassword\" \\ -H \"Content-Type: application/json\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder ``` + * + * The version of the OpenAPI document: 6 + * Contact: developer-experience@adyen.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +export class DeleteBankAccountRequest { + /** + * The code of the Account Holder from which to delete the Bank Account(s). + */ + 'accountHolderCode': string; + /** + * The code(s) of the Bank Accounts to be deleted. + */ + 'bankAccountUUIDs': Array; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "accountHolderCode", + "baseName": "accountHolderCode", + "type": "string" + }, + { + "name": "bankAccountUUIDs", + "baseName": "bankAccountUUIDs", + "type": "Array" + } ]; + + static getAttributeTypeMap() { + return DeleteBankAccountRequest.attributeTypeMap; + } +} + diff --git a/src/typings/platformsAccount/deletePayoutMethodRequest.ts b/src/typings/platformsAccount/deletePayoutMethodRequest.ts new file mode 100644 index 0000000..cc5f669 --- /dev/null +++ b/src/typings/platformsAccount/deletePayoutMethodRequest.ts @@ -0,0 +1,41 @@ +/** + * Adyen for Platforms: Account API + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don\'t have one, contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@MarketPlace.YourMarketPlace\":\"YourWsPassword\" \\ -H \"Content-Type: application/json\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder ``` + * + * The version of the OpenAPI document: 6 + * Contact: developer-experience@adyen.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +export class DeletePayoutMethodRequest { + /** + * The code of the account holder, from which to delete the payout methods. + */ + 'accountHolderCode': string; + /** + * The codes of the payout methods to be deleted. + */ + 'payoutMethodCodes': Array; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "accountHolderCode", + "baseName": "accountHolderCode", + "type": "string" + }, + { + "name": "payoutMethodCodes", + "baseName": "payoutMethodCodes", + "type": "Array" + } ]; + + static getAttributeTypeMap() { + return DeletePayoutMethodRequest.attributeTypeMap; + } +} + diff --git a/src/typings/platformsAccount/deleteShareholderRequest.ts b/src/typings/platformsAccount/deleteShareholderRequest.ts new file mode 100644 index 0000000..519d2a6 --- /dev/null +++ b/src/typings/platformsAccount/deleteShareholderRequest.ts @@ -0,0 +1,41 @@ +/** + * Adyen for Platforms: Account API + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don\'t have one, contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@MarketPlace.YourMarketPlace\":\"YourWsPassword\" \\ -H \"Content-Type: application/json\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder ``` + * + * The version of the OpenAPI document: 6 + * Contact: developer-experience@adyen.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +export class DeleteShareholderRequest { + /** + * The code of the Account Holder from which to delete the Shareholders. + */ + 'accountHolderCode': string; + /** + * The code(s) of the Shareholders to be deleted. + */ + 'shareholderCodes': Array; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "accountHolderCode", + "baseName": "accountHolderCode", + "type": "string" + }, + { + "name": "shareholderCodes", + "baseName": "shareholderCodes", + "type": "Array" + } ]; + + static getAttributeTypeMap() { + return DeleteShareholderRequest.attributeTypeMap; + } +} + diff --git a/src/typings/platformsAccount/deleteSignatoriesRequest.ts b/src/typings/platformsAccount/deleteSignatoriesRequest.ts new file mode 100644 index 0000000..d3ee138 --- /dev/null +++ b/src/typings/platformsAccount/deleteSignatoriesRequest.ts @@ -0,0 +1,41 @@ +/** + * Adyen for Platforms: Account API + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don\'t have one, contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@MarketPlace.YourMarketPlace\":\"YourWsPassword\" \\ -H \"Content-Type: application/json\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder ``` + * + * The version of the OpenAPI document: 6 + * Contact: developer-experience@adyen.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +export class DeleteSignatoriesRequest { + /** + * The code of the account holder from which to delete the signatories. + */ + 'accountHolderCode': string; + /** + * Array of codes of the signatories to be deleted. + */ + 'signatoryCodes': Array; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "accountHolderCode", + "baseName": "accountHolderCode", + "type": "string" + }, + { + "name": "signatoryCodes", + "baseName": "signatoryCodes", + "type": "Array" + } ]; + + static getAttributeTypeMap() { + return DeleteSignatoriesRequest.attributeTypeMap; + } +} + diff --git a/src/typings/platformsAccount/documentDetail.ts b/src/typings/platformsAccount/documentDetail.ts new file mode 100644 index 0000000..b3dc536 --- /dev/null +++ b/src/typings/platformsAccount/documentDetail.ts @@ -0,0 +1,103 @@ +/** + * Adyen for Platforms: Account API + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don\'t have one, contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@MarketPlace.YourMarketPlace\":\"YourWsPassword\" \\ -H \"Content-Type: application/json\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder ``` + * + * The version of the OpenAPI document: 6 + * Contact: developer-experience@adyen.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +export class DocumentDetail { + /** + * The code of account holder, to which the document applies. + */ + 'accountHolderCode': string; + /** + * The unique ID of the Bank Account to which the document applies. >Required if the `documentType` is **BANK_STATEMENT**, where a document is being submitted in order to verify a bank account. >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on when a document should be submitted in order to verify a bank account. + */ + 'bankAccountUUID'?: string; + /** + * Description of the document. + */ + 'description'?: string; + /** + * The type of the document. Refer to [Verification checks](https://docs.adyen.com/platforms/verification-checks) for details on when each document type should be submitted and for the accepted file formats. Permitted values: * **BANK_STATEMENT**: A file containing a bank statement or other document proving ownership of a specific bank account. * **COMPANY_REGISTRATION_SCREENING** (Supported from v5 and later): A file containing a company registration document. * **PASSPORT**: A file containing the identity page(s) of a passport. * **ID_CARD_FRONT**: A file containing only the front of the ID card. In order for a document to be usable, both the **ID_CARD_FRONT** and **ID_CARD_BACK** must be submitted. * **ID_CARD_BACK**: A file containing only the back of the ID card. In order for a document to be usable, both the **ID_CARD_FRONT** and **ID_CARD_BACK** must be submitted. * **DRIVING_LICENCE_FRONT**: A file containing only the front of the driving licence. In order for a document to be usable, both the **DRIVING_LICENCE_FRONT** and **DRIVING_LICENCE_BACK** must be submitted. * **DRIVING_LICENCE_BACK**: A file containing only the back of the driving licence. In order for a document to be usable, both the **DRIVING_LICENCE_FRONT** and **DRIVING_LICENCE_FRONT** must be submitted. + */ + 'documentType': DocumentDetail.DocumentTypeEnum; + /** + * Filename of the document. + */ + 'filename': string; + /** + * The code of the shareholder, to which the document applies. Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) for details on when a document should be submitted in order to verify a shareholder.>Required if the account holder referred to by the `accountHolderCode` has a `legalEntity` of type **Business** and the `documentType` is either **PASSPORT**, **ID_CARD_FRONT**, **ID_CARD_BACK**, **DRIVING_LICENCE_FRONT**, or **DRIVING_LICENCE_BACK**. >Refer to the [Onboarding and verification](https://docs.adyen.com/platforms/onboarding-and-verification) section for details on when a document should be submitted in order to verify a shareholder. + */ + 'shareholderCode'?: string; + /** + * The code of the signatory, to which the document applies + */ + 'signatoryCode'?: string; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "accountHolderCode", + "baseName": "accountHolderCode", + "type": "string" + }, + { + "name": "bankAccountUUID", + "baseName": "bankAccountUUID", + "type": "string" + }, + { + "name": "description", + "baseName": "description", + "type": "string" + }, + { + "name": "documentType", + "baseName": "documentType", + "type": "DocumentDetail.DocumentTypeEnum" + }, + { + "name": "filename", + "baseName": "filename", + "type": "string" + }, + { + "name": "shareholderCode", + "baseName": "shareholderCode", + "type": "string" + }, + { + "name": "signatoryCode", + "baseName": "signatoryCode", + "type": "string" + } ]; + + static getAttributeTypeMap() { + return DocumentDetail.attributeTypeMap; + } +} + +export namespace DocumentDetail { + export enum DocumentTypeEnum { + BankStatement = 'BANK_STATEMENT', + Bsn = 'BSN', + CompanyRegistrationScreening = 'COMPANY_REGISTRATION_SCREENING', + ConstitutionalDocument = 'CONSTITUTIONAL_DOCUMENT', + DrivingLicence = 'DRIVING_LICENCE', + DrivingLicenceBack = 'DRIVING_LICENCE_BACK', + DrivingLicenceFront = 'DRIVING_LICENCE_FRONT', + IdCard = 'ID_CARD', + IdCardBack = 'ID_CARD_BACK', + IdCardFront = 'ID_CARD_FRONT', + Passport = 'PASSPORT', + Ssn = 'SSN', + SupportingDocuments = 'SUPPORTING_DOCUMENTS' + } +} diff --git a/src/typings/platformsAccount/errorFieldType.ts b/src/typings/platformsAccount/errorFieldType.ts new file mode 100644 index 0000000..4f2e132 --- /dev/null +++ b/src/typings/platformsAccount/errorFieldType.ts @@ -0,0 +1,49 @@ +/** + * Adyen for Platforms: Account API + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don\'t have one, contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@MarketPlace.YourMarketPlace\":\"YourWsPassword\" \\ -H \"Content-Type: application/json\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder ``` + * + * The version of the OpenAPI document: 6 + * Contact: developer-experience@adyen.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +import {FieldType} from './fieldType'; + +export class ErrorFieldType { + /** + * The validation error code. + */ + 'errorCode'?: number; + /** + * A description of the validation error. + */ + 'errorDescription'?: string; + 'fieldType'?: FieldType; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "errorCode", + "baseName": "errorCode", + "type": "number" + }, + { + "name": "errorDescription", + "baseName": "errorDescription", + "type": "string" + }, + { + "name": "fieldType", + "baseName": "fieldType", + "type": "FieldType" + } ]; + + static getAttributeTypeMap() { + return ErrorFieldType.attributeTypeMap; + } +} + diff --git a/src/typings/platformsAccount/fieldType.ts b/src/typings/platformsAccount/fieldType.ts new file mode 100644 index 0000000..a34218f --- /dev/null +++ b/src/typings/platformsAccount/fieldType.ts @@ -0,0 +1,187 @@ +/** + * Adyen for Platforms: Account API + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don\'t have one, contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@MarketPlace.YourMarketPlace\":\"YourWsPassword\" \\ -H \"Content-Type: application/json\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder ``` + * + * The version of the OpenAPI document: 6 + * Contact: developer-experience@adyen.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +export class FieldType { + /** + * The full name of the property. + */ + 'field'?: string; + /** + * The type of the field. + */ + 'fieldName'?: FieldType.FieldNameEnum; + /** + * The code of the shareholder that the field belongs to. If empty, the field belongs to an account holder. + */ + 'shareholderCode'?: string; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "field", + "baseName": "field", + "type": "string" + }, + { + "name": "fieldName", + "baseName": "fieldName", + "type": "FieldType.FieldNameEnum" + }, + { + "name": "shareholderCode", + "baseName": "shareholderCode", + "type": "string" + } ]; + + static getAttributeTypeMap() { + return FieldType.attributeTypeMap; + } +} + +export namespace FieldType { + export enum FieldNameEnum { + AccountCode = 'accountCode', + AccountHolderCode = 'accountHolderCode', + AccountHolderDetails = 'accountHolderDetails', + AccountNumber = 'accountNumber', + AccountStateType = 'accountStateType', + AccountStatus = 'accountStatus', + AccountType = 'accountType', + Address = 'address', + BankAccount = 'bankAccount', + BankAccountCode = 'bankAccountCode', + BankAccountName = 'bankAccountName', + BankAccountUuid = 'bankAccountUUID', + BankBicSwift = 'bankBicSwift', + BankCity = 'bankCity', + BankCode = 'bankCode', + BankName = 'bankName', + BankStatement = 'bankStatement', + BranchCode = 'branchCode', + BusinessContact = 'businessContact', + CardToken = 'cardToken', + CheckCode = 'checkCode', + City = 'city', + CompanyRegistration = 'companyRegistration', + ConstitutionalDocument = 'constitutionalDocument', + Country = 'country', + CountryCode = 'countryCode', + Currency = 'currency', + CurrencyCode = 'currencyCode', + DateOfBirth = 'dateOfBirth', + Description = 'description', + DestinationAccountCode = 'destinationAccountCode', + Document = 'document', + DocumentExpirationDate = 'documentExpirationDate', + DocumentIssuerCountry = 'documentIssuerCountry', + DocumentIssuerState = 'documentIssuerState', + DocumentName = 'documentName', + DocumentNumber = 'documentNumber', + DocumentType = 'documentType', + DoingBusinessAs = 'doingBusinessAs', + DrivingLicence = 'drivingLicence', + DrivingLicenceBack = 'drivingLicenceBack', + DrivingLicense = 'drivingLicense', + Email = 'email', + FirstName = 'firstName', + FormType = 'formType', + FullPhoneNumber = 'fullPhoneNumber', + Gender = 'gender', + HopWebserviceUser = 'hopWebserviceUser', + HouseNumberOrName = 'houseNumberOrName', + Iban = 'iban', + IdCard = 'idCard', + IdCardBack = 'idCardBack', + IdCardFront = 'idCardFront', + IdNumber = 'idNumber', + IdentityDocument = 'identityDocument', + IndividualDetails = 'individualDetails', + JobTitle = 'jobTitle', + LastName = 'lastName', + LegalArrangement = 'legalArrangement', + LegalArrangementCode = 'legalArrangementCode', + LegalArrangementEntity = 'legalArrangementEntity', + LegalArrangementEntityCode = 'legalArrangementEntityCode', + LegalArrangementLegalForm = 'legalArrangementLegalForm', + LegalArrangementMember = 'legalArrangementMember', + LegalArrangementName = 'legalArrangementName', + LegalArrangementReference = 'legalArrangementReference', + LegalArrangementRegistrationNumber = 'legalArrangementRegistrationNumber', + LegalArrangementTaxNumber = 'legalArrangementTaxNumber', + LegalArrangementType = 'legalArrangementType', + LegalBusinessName = 'legalBusinessName', + LegalEntity = 'legalEntity', + LegalEntityType = 'legalEntityType', + MerchantAccount = 'merchantAccount', + MerchantCategoryCode = 'merchantCategoryCode', + MerchantReference = 'merchantReference', + MicroDeposit = 'microDeposit', + Name = 'name', + Nationality = 'nationality', + OriginalReference = 'originalReference', + OwnerCity = 'ownerCity', + OwnerCountryCode = 'ownerCountryCode', + OwnerHouseNumberOrName = 'ownerHouseNumberOrName', + OwnerName = 'ownerName', + OwnerPostalCode = 'ownerPostalCode', + OwnerState = 'ownerState', + OwnerStreet = 'ownerStreet', + Passport = 'passport', + PassportNumber = 'passportNumber', + PayoutMethodCode = 'payoutMethodCode', + PersonalData = 'personalData', + PhoneCountryCode = 'phoneCountryCode', + PhoneNumber = 'phoneNumber', + PostalCode = 'postalCode', + PrimaryCurrency = 'primaryCurrency', + Reason = 'reason', + RegistrationNumber = 'registrationNumber', + ReturnUrl = 'returnUrl', + Schedule = 'schedule', + Shareholder = 'shareholder', + ShareholderCode = 'shareholderCode', + ShareholderCodeAndSignatoryCode = 'shareholderCodeAndSignatoryCode', + ShareholderCodeOrSignatoryCode = 'shareholderCodeOrSignatoryCode', + ShareholderType = 'shareholderType', + ShopperInteraction = 'shopperInteraction', + Signatory = 'signatory', + SignatoryCode = 'signatoryCode', + SocialSecurityNumber = 'socialSecurityNumber', + SourceAccountCode = 'sourceAccountCode', + SplitAccount = 'splitAccount', + SplitCurrency = 'splitCurrency', + SplitValue = 'splitValue', + Splits = 'splits', + StateOrProvince = 'stateOrProvince', + Status = 'status', + StockExchange = 'stockExchange', + StockNumber = 'stockNumber', + StockTicker = 'stockTicker', + Store = 'store', + StoreDetail = 'storeDetail', + StoreName = 'storeName', + StoreReference = 'storeReference', + Street = 'street', + TaxId = 'taxId', + Tier = 'tier', + TierNumber = 'tierNumber', + TransferCode = 'transferCode', + Unknown = 'unknown', + Value = 'value', + VerificationType = 'verificationType', + VirtualAccount = 'virtualAccount', + VisaNumber = 'visaNumber', + WebAddress = 'webAddress', + Year = 'year' + } +} diff --git a/src/typings/platformsAccount/genericResponse.ts b/src/typings/platformsAccount/genericResponse.ts new file mode 100644 index 0000000..cc0bd48 --- /dev/null +++ b/src/typings/platformsAccount/genericResponse.ts @@ -0,0 +1,52 @@ +/** + * Adyen for Platforms: Account API + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don\'t have one, contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@MarketPlace.YourMarketPlace\":\"YourWsPassword\" \\ -H \"Content-Type: application/json\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder ``` + * + * The version of the OpenAPI document: 6 + * Contact: developer-experience@adyen.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +import {ErrorFieldType} from './errorFieldType'; + +export class GenericResponse { + /** + * Contains field validation errors that would prevent requests from being processed. + */ + 'invalidFields'?: Array; + /** + * The reference of a request. Can be used to uniquely identify the request. + */ + 'pspReference'?: string; + /** + * The result code. + */ + 'resultCode'?: string; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "invalidFields", + "baseName": "invalidFields", + "type": "Array" + }, + { + "name": "pspReference", + "baseName": "pspReference", + "type": "string" + }, + { + "name": "resultCode", + "baseName": "resultCode", + "type": "string" + } ]; + + static getAttributeTypeMap() { + return GenericResponse.attributeTypeMap; + } +} + diff --git a/src/typings/platformsAccount/getAccountHolderRequest.ts b/src/typings/platformsAccount/getAccountHolderRequest.ts new file mode 100644 index 0000000..0c4617b --- /dev/null +++ b/src/typings/platformsAccount/getAccountHolderRequest.ts @@ -0,0 +1,50 @@ +/** + * Adyen for Platforms: Account API + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don\'t have one, contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@MarketPlace.YourMarketPlace\":\"YourWsPassword\" \\ -H \"Content-Type: application/json\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder ``` + * + * The version of the OpenAPI document: 6 + * Contact: developer-experience@adyen.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +export class GetAccountHolderRequest { + /** + * The code of the account of which to retrieve the details. > Required if no `accountHolderCode` is provided. + */ + 'accountCode'?: string; + /** + * The code of the account holder of which to retrieve the details. > Required if no `accountCode` is provided. + */ + 'accountHolderCode'?: string; + /** + * True if the request should return the account holder details + */ + 'showDetails'?: boolean; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "accountCode", + "baseName": "accountCode", + "type": "string" + }, + { + "name": "accountHolderCode", + "baseName": "accountHolderCode", + "type": "string" + }, + { + "name": "showDetails", + "baseName": "showDetails", + "type": "boolean" + } ]; + + static getAttributeTypeMap() { + return GetAccountHolderRequest.attributeTypeMap; + } +} + diff --git a/src/typings/platformsAccount/getAccountHolderResponse.ts b/src/typings/platformsAccount/getAccountHolderResponse.ts new file mode 100644 index 0000000..f0a4627 --- /dev/null +++ b/src/typings/platformsAccount/getAccountHolderResponse.ts @@ -0,0 +1,146 @@ +/** + * Adyen for Platforms: Account API + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don\'t have one, contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@MarketPlace.YourMarketPlace\":\"YourWsPassword\" \\ -H \"Content-Type: application/json\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder ``` + * + * The version of the OpenAPI document: 6 + * Contact: developer-experience@adyen.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +import {Account} from './account'; +import {AccountHolderDetails} from './accountHolderDetails'; +import {AccountHolderStatus} from './accountHolderStatus'; +import {ErrorFieldType} from './errorFieldType'; +import {KYCVerificationResult2} from './kYCVerificationResult2'; + +export class GetAccountHolderResponse { + /** + * The code of the account holder. + */ + 'accountHolderCode': string; + 'accountHolderDetails': AccountHolderDetails; + 'accountHolderStatus': AccountHolderStatus; + /** + * A list of the accounts under the account holder. + */ + 'accounts'?: Array; + /** + * The description of the account holder. + */ + 'description'?: string; + /** + * Contains field validation errors that would prevent requests from being processed. + */ + 'invalidFields'?: Array; + /** + * The legal entity of the account holder. + */ + 'legalEntity': GetAccountHolderResponse.LegalEntityEnum; + /** + * The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), with which the prospective account holder primarily deals. + */ + 'primaryCurrency'?: string; + /** + * The reference of a request. Can be used to uniquely identify the request. + */ + 'pspReference'?: string; + /** + * The result code. + */ + 'resultCode'?: string; + /** + * The time that shows how up to date is the information in the response. + */ + 'systemUpToDateTime'?: Date; + 'verification': KYCVerificationResult2; + /** + * The identifier of the profile that applies to this entity. + */ + 'verificationProfile'?: string; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "accountHolderCode", + "baseName": "accountHolderCode", + "type": "string" + }, + { + "name": "accountHolderDetails", + "baseName": "accountHolderDetails", + "type": "AccountHolderDetails" + }, + { + "name": "accountHolderStatus", + "baseName": "accountHolderStatus", + "type": "AccountHolderStatus" + }, + { + "name": "accounts", + "baseName": "accounts", + "type": "Array" + }, + { + "name": "description", + "baseName": "description", + "type": "string" + }, + { + "name": "invalidFields", + "baseName": "invalidFields", + "type": "Array" + }, + { + "name": "legalEntity", + "baseName": "legalEntity", + "type": "GetAccountHolderResponse.LegalEntityEnum" + }, + { + "name": "primaryCurrency", + "baseName": "primaryCurrency", + "type": "string" + }, + { + "name": "pspReference", + "baseName": "pspReference", + "type": "string" + }, + { + "name": "resultCode", + "baseName": "resultCode", + "type": "string" + }, + { + "name": "systemUpToDateTime", + "baseName": "systemUpToDateTime", + "type": "Date" + }, + { + "name": "verification", + "baseName": "verification", + "type": "KYCVerificationResult2" + }, + { + "name": "verificationProfile", + "baseName": "verificationProfile", + "type": "string" + } ]; + + static getAttributeTypeMap() { + return GetAccountHolderResponse.attributeTypeMap; + } +} + +export namespace GetAccountHolderResponse { + export enum LegalEntityEnum { + Business = 'Business', + Individual = 'Individual', + NonProfit = 'NonProfit', + Partnership = 'Partnership', + PublicCompany = 'PublicCompany' + } +} diff --git a/src/typings/platformsAccount/getAccountHolderStatusResponse.ts b/src/typings/platformsAccount/getAccountHolderStatusResponse.ts new file mode 100644 index 0000000..0d4c12f --- /dev/null +++ b/src/typings/platformsAccount/getAccountHolderStatusResponse.ts @@ -0,0 +1,68 @@ +/** + * Adyen for Platforms: Account API + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don\'t have one, contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@MarketPlace.YourMarketPlace\":\"YourWsPassword\" \\ -H \"Content-Type: application/json\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder ``` + * + * The version of the OpenAPI document: 6 + * Contact: developer-experience@adyen.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +import {AccountHolderStatus} from './accountHolderStatus'; +import {ErrorFieldType} from './errorFieldType'; + +export class GetAccountHolderStatusResponse { + /** + * The code of the Account Holder. + */ + 'accountHolderCode': string; + 'accountHolderStatus': AccountHolderStatus; + /** + * Contains field validation errors that would prevent requests from being processed. + */ + 'invalidFields'?: Array; + /** + * The reference of a request. Can be used to uniquely identify the request. + */ + 'pspReference'?: string; + /** + * The result code. + */ + 'resultCode'?: string; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "accountHolderCode", + "baseName": "accountHolderCode", + "type": "string" + }, + { + "name": "accountHolderStatus", + "baseName": "accountHolderStatus", + "type": "AccountHolderStatus" + }, + { + "name": "invalidFields", + "baseName": "invalidFields", + "type": "Array" + }, + { + "name": "pspReference", + "baseName": "pspReference", + "type": "string" + }, + { + "name": "resultCode", + "baseName": "resultCode", + "type": "string" + } ]; + + static getAttributeTypeMap() { + return GetAccountHolderStatusResponse.attributeTypeMap; + } +} + diff --git a/src/typings/platformsAccount/getTaxFormRequest.ts b/src/typings/platformsAccount/getTaxFormRequest.ts new file mode 100644 index 0000000..4fdd049 --- /dev/null +++ b/src/typings/platformsAccount/getTaxFormRequest.ts @@ -0,0 +1,50 @@ +/** + * Adyen for Platforms: Account API + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don\'t have one, contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@MarketPlace.YourMarketPlace\":\"YourWsPassword\" \\ -H \"Content-Type: application/json\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder ``` + * + * The version of the OpenAPI document: 6 + * Contact: developer-experience@adyen.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +export class GetTaxFormRequest { + /** + * The account holder code you provided when you created the account holder. + */ + 'accountHolderCode': string; + /** + * Type of the requested tax form. For example, 1099-K. + */ + 'formType': string; + /** + * Applicable tax year in the YYYY format. + */ + 'year': number; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "accountHolderCode", + "baseName": "accountHolderCode", + "type": "string" + }, + { + "name": "formType", + "baseName": "formType", + "type": "string" + }, + { + "name": "year", + "baseName": "year", + "type": "number" + } ]; + + static getAttributeTypeMap() { + return GetTaxFormRequest.attributeTypeMap; + } +} + diff --git a/src/typings/platformsAccount/getTaxFormResponse.ts b/src/typings/platformsAccount/getTaxFormResponse.ts new file mode 100644 index 0000000..73d80ea --- /dev/null +++ b/src/typings/platformsAccount/getTaxFormResponse.ts @@ -0,0 +1,70 @@ +/** + * Adyen for Platforms: Account API + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don\'t have one, contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@MarketPlace.YourMarketPlace\":\"YourWsPassword\" \\ -H \"Content-Type: application/json\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder ``` + * + * The version of the OpenAPI document: 6 + * Contact: developer-experience@adyen.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +import {ErrorFieldType} from './errorFieldType'; + +export class GetTaxFormResponse { + /** + * The content of the tax form in the Base64 binary format. + */ + 'content'?: string; + /** + * The content type of the tax form. + */ + 'contentType'?: string; + /** + * Contains field validation errors that would prevent requests from being processed. + */ + 'invalidFields'?: Array; + /** + * The reference of a request. Can be used to uniquely identify the request. + */ + 'pspReference'?: string; + /** + * The result code. + */ + 'resultCode'?: string; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "content", + "baseName": "content", + "type": "string" + }, + { + "name": "contentType", + "baseName": "contentType", + "type": "string" + }, + { + "name": "invalidFields", + "baseName": "invalidFields", + "type": "Array" + }, + { + "name": "pspReference", + "baseName": "pspReference", + "type": "string" + }, + { + "name": "resultCode", + "baseName": "resultCode", + "type": "string" + } ]; + + static getAttributeTypeMap() { + return GetTaxFormResponse.attributeTypeMap; + } +} + diff --git a/src/typings/platformsAccount/getUploadedDocumentsRequest.ts b/src/typings/platformsAccount/getUploadedDocumentsRequest.ts new file mode 100644 index 0000000..3730113 --- /dev/null +++ b/src/typings/platformsAccount/getUploadedDocumentsRequest.ts @@ -0,0 +1,50 @@ +/** + * Adyen for Platforms: Account API + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don\'t have one, contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@MarketPlace.YourMarketPlace\":\"YourWsPassword\" \\ -H \"Content-Type: application/json\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder ``` + * + * The version of the OpenAPI document: 6 + * Contact: developer-experience@adyen.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +export class GetUploadedDocumentsRequest { + /** + * The code of the Account Holder for which to retrieve the documents. + */ + 'accountHolderCode': string; + /** + * The code of the Bank Account for which to retrieve the documents. + */ + 'bankAccountUUID'?: string; + /** + * The code of the Shareholder for which to retrieve the documents. + */ + 'shareholderCode'?: string; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "accountHolderCode", + "baseName": "accountHolderCode", + "type": "string" + }, + { + "name": "bankAccountUUID", + "baseName": "bankAccountUUID", + "type": "string" + }, + { + "name": "shareholderCode", + "baseName": "shareholderCode", + "type": "string" + } ]; + + static getAttributeTypeMap() { + return GetUploadedDocumentsRequest.attributeTypeMap; + } +} + diff --git a/src/typings/platformsAccount/getUploadedDocumentsResponse.ts b/src/typings/platformsAccount/getUploadedDocumentsResponse.ts new file mode 100644 index 0000000..9729ef7 --- /dev/null +++ b/src/typings/platformsAccount/getUploadedDocumentsResponse.ts @@ -0,0 +1,62 @@ +/** + * Adyen for Platforms: Account API + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don\'t have one, contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@MarketPlace.YourMarketPlace\":\"YourWsPassword\" \\ -H \"Content-Type: application/json\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder ``` + * + * The version of the OpenAPI document: 6 + * Contact: developer-experience@adyen.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +import {DocumentDetail} from './documentDetail'; +import {ErrorFieldType} from './errorFieldType'; + +export class GetUploadedDocumentsResponse { + /** + * A list of the documents and their details. + */ + 'documentDetails'?: Array; + /** + * Contains field validation errors that would prevent requests from being processed. + */ + 'invalidFields'?: Array; + /** + * The reference of a request. Can be used to uniquely identify the request. + */ + 'pspReference'?: string; + /** + * The result code. + */ + 'resultCode'?: string; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "documentDetails", + "baseName": "documentDetails", + "type": "Array" + }, + { + "name": "invalidFields", + "baseName": "invalidFields", + "type": "Array" + }, + { + "name": "pspReference", + "baseName": "pspReference", + "type": "string" + }, + { + "name": "resultCode", + "baseName": "resultCode", + "type": "string" + } ]; + + static getAttributeTypeMap() { + return GetUploadedDocumentsResponse.attributeTypeMap; + } +} + diff --git a/src/typings/platformsAccount/individualDetails.ts b/src/typings/platformsAccount/individualDetails.ts new file mode 100644 index 0000000..b1a7dc4 --- /dev/null +++ b/src/typings/platformsAccount/individualDetails.ts @@ -0,0 +1,38 @@ +/** + * Adyen for Platforms: Account API + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don\'t have one, contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@MarketPlace.YourMarketPlace\":\"YourWsPassword\" \\ -H \"Content-Type: application/json\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder ``` + * + * The version of the OpenAPI document: 6 + * Contact: developer-experience@adyen.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +import {ViasName} from './viasName'; +import {ViasPersonalData} from './viasPersonalData'; + +export class IndividualDetails { + 'name'?: ViasName; + 'personalData'?: ViasPersonalData; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "name", + "baseName": "name", + "type": "ViasName" + }, + { + "name": "personalData", + "baseName": "personalData", + "type": "ViasPersonalData" + } ]; + + static getAttributeTypeMap() { + return IndividualDetails.attributeTypeMap; + } +} + diff --git a/src/typings/platformsAccount/kYCCheckResult2.ts b/src/typings/platformsAccount/kYCCheckResult2.ts new file mode 100644 index 0000000..b274457 --- /dev/null +++ b/src/typings/platformsAccount/kYCCheckResult2.ts @@ -0,0 +1,34 @@ +/** + * Adyen for Platforms: Account API + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don\'t have one, contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@MarketPlace.YourMarketPlace\":\"YourWsPassword\" \\ -H \"Content-Type: application/json\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder ``` + * + * The version of the OpenAPI document: 6 + * Contact: developer-experience@adyen.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +import {KYCCheckStatusData} from './kYCCheckStatusData'; + +export class KYCCheckResult2 { + /** + * A list of the checks and their statuses. + */ + 'checks'?: Array; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "checks", + "baseName": "checks", + "type": "Array" + } ]; + + static getAttributeTypeMap() { + return KYCCheckResult2.attributeTypeMap; + } +} + diff --git a/src/typings/platformsAccount/kYCCheckStatusData.ts b/src/typings/platformsAccount/kYCCheckStatusData.ts new file mode 100644 index 0000000..37bc3b4 --- /dev/null +++ b/src/typings/platformsAccount/kYCCheckStatusData.ts @@ -0,0 +1,82 @@ +/** + * Adyen for Platforms: Account API + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don\'t have one, contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@MarketPlace.YourMarketPlace\":\"YourWsPassword\" \\ -H \"Content-Type: application/json\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder ``` + * + * The version of the OpenAPI document: 6 + * Contact: developer-experience@adyen.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +import {KYCCheckSummary} from './kYCCheckSummary'; + +export class KYCCheckStatusData { + /** + * A list of the fields required for execution of the check. + */ + 'requiredFields'?: Array; + /** + * The status of the check. Possible values: **AWAITING_DATA** , **DATA_PROVIDED**, **FAILED**, **INVALID_DATA**, **PASSED**, **PENDING**, **RETRY_LIMIT_REACHED**. + */ + 'status': KYCCheckStatusData.StatusEnum; + 'summary'?: KYCCheckSummary; + /** + * The type of check. Possible values: * **BANK_ACCOUNT_VERIFICATION**: Used in v5 and earlier. Replaced by **PAYOUT_METHOD_VERIFICATION** in v6 and later. * **COMPANY_VERIFICATION** * **CARD_VERIFICATION** * **IDENTITY_VERIFICATION** * **LEGAL_ARRANGEMENT_VERIFICATION** * **NONPROFIT_VERIFICATION** * **PASSPORT_VERIFICATION** * **PAYOUT_METHOD_VERIFICATION**: Used in v6 and later. * **PCI_VERIFICATION** + */ + 'type': KYCCheckStatusData.TypeEnum; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "requiredFields", + "baseName": "requiredFields", + "type": "Array" + }, + { + "name": "status", + "baseName": "status", + "type": "KYCCheckStatusData.StatusEnum" + }, + { + "name": "summary", + "baseName": "summary", + "type": "KYCCheckSummary" + }, + { + "name": "type", + "baseName": "type", + "type": "KYCCheckStatusData.TypeEnum" + } ]; + + static getAttributeTypeMap() { + return KYCCheckStatusData.attributeTypeMap; + } +} + +export namespace KYCCheckStatusData { + export enum StatusEnum { + AwaitingData = 'AWAITING_DATA', + DataProvided = 'DATA_PROVIDED', + Failed = 'FAILED', + InvalidData = 'INVALID_DATA', + Passed = 'PASSED', + Pending = 'PENDING', + PendingReview = 'PENDING_REVIEW', + RetryLimitReached = 'RETRY_LIMIT_REACHED', + Unchecked = 'UNCHECKED' + } + export enum TypeEnum { + BankAccountVerification = 'BANK_ACCOUNT_VERIFICATION', + CardVerification = 'CARD_VERIFICATION', + CompanyVerification = 'COMPANY_VERIFICATION', + IdentityVerification = 'IDENTITY_VERIFICATION', + LegalArrangementVerification = 'LEGAL_ARRANGEMENT_VERIFICATION', + NonprofitVerification = 'NONPROFIT_VERIFICATION', + PassportVerification = 'PASSPORT_VERIFICATION', + PayoutMethodVerification = 'PAYOUT_METHOD_VERIFICATION', + PciVerification = 'PCI_VERIFICATION' + } +} diff --git a/src/typings/platformsAccount/kYCCheckSummary.ts b/src/typings/platformsAccount/kYCCheckSummary.ts new file mode 100644 index 0000000..802319c --- /dev/null +++ b/src/typings/platformsAccount/kYCCheckSummary.ts @@ -0,0 +1,41 @@ +/** + * Adyen for Platforms: Account API + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don\'t have one, contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@MarketPlace.YourMarketPlace\":\"YourWsPassword\" \\ -H \"Content-Type: application/json\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder ``` + * + * The version of the OpenAPI document: 6 + * Contact: developer-experience@adyen.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +export class KYCCheckSummary { + /** + * The code of the check. For possible values, refer to [Verification codes](https://docs.adyen.com/platforms/verification-codes). + */ + 'kycCheckCode'?: number; + /** + * A description of the check. + */ + 'kycCheckDescription'?: string; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "kycCheckCode", + "baseName": "kycCheckCode", + "type": "number" + }, + { + "name": "kycCheckDescription", + "baseName": "kycCheckDescription", + "type": "string" + } ]; + + static getAttributeTypeMap() { + return KYCCheckSummary.attributeTypeMap; + } +} + diff --git a/src/typings/platformsAccount/kYCLegalArrangementCheckResult.ts b/src/typings/platformsAccount/kYCLegalArrangementCheckResult.ts new file mode 100644 index 0000000..0638eba --- /dev/null +++ b/src/typings/platformsAccount/kYCLegalArrangementCheckResult.ts @@ -0,0 +1,43 @@ +/** + * Adyen for Platforms: Account API + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don\'t have one, contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@MarketPlace.YourMarketPlace\":\"YourWsPassword\" \\ -H \"Content-Type: application/json\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder ``` + * + * The version of the OpenAPI document: 6 + * Contact: developer-experience@adyen.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +import {KYCCheckStatusData} from './kYCCheckStatusData'; + +export class KYCLegalArrangementCheckResult { + /** + * A list of the checks and their statuses. + */ + 'checks'?: Array; + /** + * The unique ID of the legal arrangement to which the check applies. + */ + 'legalArrangementCode'?: string; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "checks", + "baseName": "checks", + "type": "Array" + }, + { + "name": "legalArrangementCode", + "baseName": "legalArrangementCode", + "type": "string" + } ]; + + static getAttributeTypeMap() { + return KYCLegalArrangementCheckResult.attributeTypeMap; + } +} + diff --git a/src/typings/platformsAccount/kYCLegalArrangementEntityCheckResult.ts b/src/typings/platformsAccount/kYCLegalArrangementEntityCheckResult.ts new file mode 100644 index 0000000..90b7675 --- /dev/null +++ b/src/typings/platformsAccount/kYCLegalArrangementEntityCheckResult.ts @@ -0,0 +1,52 @@ +/** + * Adyen for Platforms: Account API + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don\'t have one, contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@MarketPlace.YourMarketPlace\":\"YourWsPassword\" \\ -H \"Content-Type: application/json\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder ``` + * + * The version of the OpenAPI document: 6 + * Contact: developer-experience@adyen.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +import {KYCCheckStatusData} from './kYCCheckStatusData'; + +export class KYCLegalArrangementEntityCheckResult { + /** + * A list of the checks and their statuses. + */ + 'checks'?: Array; + /** + * The unique ID of the legal arrangement to which the entity belongs. + */ + 'legalArrangementCode'?: string; + /** + * The unique ID of the legal arrangement entity to which the check applies. + */ + 'legalArrangementEntityCode'?: string; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "checks", + "baseName": "checks", + "type": "Array" + }, + { + "name": "legalArrangementCode", + "baseName": "legalArrangementCode", + "type": "string" + }, + { + "name": "legalArrangementEntityCode", + "baseName": "legalArrangementEntityCode", + "type": "string" + } ]; + + static getAttributeTypeMap() { + return KYCLegalArrangementEntityCheckResult.attributeTypeMap; + } +} + diff --git a/src/typings/platformsAccount/kYCPayoutMethodCheckResult.ts b/src/typings/platformsAccount/kYCPayoutMethodCheckResult.ts new file mode 100644 index 0000000..c35ca28 --- /dev/null +++ b/src/typings/platformsAccount/kYCPayoutMethodCheckResult.ts @@ -0,0 +1,43 @@ +/** + * Adyen for Platforms: Account API + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don\'t have one, contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@MarketPlace.YourMarketPlace\":\"YourWsPassword\" \\ -H \"Content-Type: application/json\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder ``` + * + * The version of the OpenAPI document: 6 + * Contact: developer-experience@adyen.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +import {KYCCheckStatusData} from './kYCCheckStatusData'; + +export class KYCPayoutMethodCheckResult { + /** + * A list of the checks and their statuses. + */ + 'checks'?: Array; + /** + * The unique ID of the payoput method to which the check applies. + */ + 'payoutMethodCode'?: string; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "checks", + "baseName": "checks", + "type": "Array" + }, + { + "name": "payoutMethodCode", + "baseName": "payoutMethodCode", + "type": "string" + } ]; + + static getAttributeTypeMap() { + return KYCPayoutMethodCheckResult.attributeTypeMap; + } +} + diff --git a/src/typings/platformsAccount/kYCShareholderCheckResult.ts b/src/typings/platformsAccount/kYCShareholderCheckResult.ts new file mode 100644 index 0000000..7e6c23f --- /dev/null +++ b/src/typings/platformsAccount/kYCShareholderCheckResult.ts @@ -0,0 +1,61 @@ +/** + * Adyen for Platforms: Account API + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don\'t have one, contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@MarketPlace.YourMarketPlace\":\"YourWsPassword\" \\ -H \"Content-Type: application/json\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder ``` + * + * The version of the OpenAPI document: 6 + * Contact: developer-experience@adyen.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +import {KYCCheckStatusData} from './kYCCheckStatusData'; + +export class KYCShareholderCheckResult { + /** + * A list of the checks and their statuses. + */ + 'checks'?: Array; + /** + * The unique ID of the legal arrangement to which the shareholder belongs, if applicable. + */ + 'legalArrangementCode'?: string; + /** + * The unique ID of the legal arrangement entity to which the shareholder belongs, if applicable. + */ + 'legalArrangementEntityCode'?: string; + /** + * The code of the shareholder to which the check applies. + */ + 'shareholderCode'?: string; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "checks", + "baseName": "checks", + "type": "Array" + }, + { + "name": "legalArrangementCode", + "baseName": "legalArrangementCode", + "type": "string" + }, + { + "name": "legalArrangementEntityCode", + "baseName": "legalArrangementEntityCode", + "type": "string" + }, + { + "name": "shareholderCode", + "baseName": "shareholderCode", + "type": "string" + } ]; + + static getAttributeTypeMap() { + return KYCShareholderCheckResult.attributeTypeMap; + } +} + diff --git a/src/typings/platformsAccount/kYCSignatoryCheckResult.ts b/src/typings/platformsAccount/kYCSignatoryCheckResult.ts new file mode 100644 index 0000000..29d817e --- /dev/null +++ b/src/typings/platformsAccount/kYCSignatoryCheckResult.ts @@ -0,0 +1,43 @@ +/** + * Adyen for Platforms: Account API + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don\'t have one, contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@MarketPlace.YourMarketPlace\":\"YourWsPassword\" \\ -H \"Content-Type: application/json\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder ``` + * + * The version of the OpenAPI document: 6 + * Contact: developer-experience@adyen.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +import {KYCCheckStatusData} from './kYCCheckStatusData'; + +export class KYCSignatoryCheckResult { + /** + * A list of the checks and their statuses. + */ + 'checks'?: Array; + /** + * The code of the signatory to which the check applies. + */ + 'signatoryCode'?: string; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "checks", + "baseName": "checks", + "type": "Array" + }, + { + "name": "signatoryCode", + "baseName": "signatoryCode", + "type": "string" + } ]; + + static getAttributeTypeMap() { + return KYCSignatoryCheckResult.attributeTypeMap; + } +} + diff --git a/src/typings/platformsAccount/kYCVerificationResult2.ts b/src/typings/platformsAccount/kYCVerificationResult2.ts new file mode 100644 index 0000000..4d71eb5 --- /dev/null +++ b/src/typings/platformsAccount/kYCVerificationResult2.ts @@ -0,0 +1,81 @@ +/** + * Adyen for Platforms: Account API + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don\'t have one, contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@MarketPlace.YourMarketPlace\":\"YourWsPassword\" \\ -H \"Content-Type: application/json\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder ``` + * + * The version of the OpenAPI document: 6 + * Contact: developer-experience@adyen.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +import {KYCCheckResult2} from './kYCCheckResult2'; +import {KYCLegalArrangementCheckResult} from './kYCLegalArrangementCheckResult'; +import {KYCLegalArrangementEntityCheckResult} from './kYCLegalArrangementEntityCheckResult'; +import {KYCPayoutMethodCheckResult} from './kYCPayoutMethodCheckResult'; +import {KYCShareholderCheckResult} from './kYCShareholderCheckResult'; +import {KYCSignatoryCheckResult} from './kYCSignatoryCheckResult'; + +export class KYCVerificationResult2 { + 'accountHolder'?: KYCCheckResult2; + /** + * The results of the checks on the legal arrangements. + */ + 'legalArrangements'?: Array; + /** + * The results of the checks on the legal arrangement entities. + */ + 'legalArrangementsEntities'?: Array; + /** + * The results of the checks on the payout methods. + */ + 'payoutMethods'?: Array; + /** + * The results of the checks on the shareholders. + */ + 'shareholders'?: Array; + /** + * The results of the checks on the signatories. + */ + 'signatories'?: Array; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "accountHolder", + "baseName": "accountHolder", + "type": "KYCCheckResult2" + }, + { + "name": "legalArrangements", + "baseName": "legalArrangements", + "type": "Array" + }, + { + "name": "legalArrangementsEntities", + "baseName": "legalArrangementsEntities", + "type": "Array" + }, + { + "name": "payoutMethods", + "baseName": "payoutMethods", + "type": "Array" + }, + { + "name": "shareholders", + "baseName": "shareholders", + "type": "Array" + }, + { + "name": "signatories", + "baseName": "signatories", + "type": "Array" + } ]; + + static getAttributeTypeMap() { + return KYCVerificationResult2.attributeTypeMap; + } +} + diff --git a/src/typings/platformsAccount/legalArrangementDetail.ts b/src/typings/platformsAccount/legalArrangementDetail.ts new file mode 100644 index 0000000..46f3e17 --- /dev/null +++ b/src/typings/platformsAccount/legalArrangementDetail.ts @@ -0,0 +1,130 @@ +/** + * Adyen for Platforms: Account API + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don\'t have one, contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@MarketPlace.YourMarketPlace\":\"YourWsPassword\" \\ -H \"Content-Type: application/json\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder ``` + * + * The version of the OpenAPI document: 6 + * Contact: developer-experience@adyen.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +import {LegalArrangementEntityDetail} from './legalArrangementEntityDetail'; +import {ViasAddress} from './viasAddress'; + +export class LegalArrangementDetail { + 'address'?: ViasAddress; + /** + * Adyen-generated unique alphanumeric identifier (UUID) for the entry, returned in the response when you create a legal arrangement. Required when updating an existing legal arrangement entry in an `/updateAccountHolder` request. + */ + 'legalArrangementCode'?: string; + /** + * Array that contains information about the entities or members that are part of the legal arrangement. + */ + 'legalArrangementEntities'?: Array; + /** + * Your reference for the legal arrangement. Must be between 3 to 128 characters. + */ + 'legalArrangementReference'?: string; + /** + * The structure of the legal arrangement as defined according to legislations in the country. Possible values: **CashManagementTrust**, **CorporateUnitTrust**, **DeceasedEstate**, **DiscretionaryInvestmentTrust**, **DiscretionaryServicesManagementTrust**, **DiscretionaryTradingTrust**, **FirstHomeSaverAccountsTrust**, **FixedTrust**, **FixedUnitTrust**, **HybridTrust**, **ListedPublicUnitTrust**, **OtherTrust**, **PooledSuperannuationTrust**, **PublicTradingTrust**, **UnlistedPublicUnitTrust**, **LimitedPartnership**, **FamilyPartnership**, **OtherPartnership**. + */ + 'legalForm'?: LegalArrangementDetail.LegalFormEnum; + /** + * The legal name of the legal arrangement. + */ + 'name'?: string; + /** + * The registration number of the legal arrangement. + */ + 'registrationNumber'?: string; + /** + * The tax identification number of the legal arrangement. + */ + 'taxNumber'?: string; + /** + * The type of legal arrangement. Possible values: - **Trust** - A legal agreement where the account holder is a trustee that manages assets for beneficiaries. - **Partnership** - A legal arrangement where the account holder is a partner that has an agreement with one or more partners to manage, operate and share profits of their jointly-owned business. + */ + 'type'?: LegalArrangementDetail.TypeEnum; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "address", + "baseName": "address", + "type": "ViasAddress" + }, + { + "name": "legalArrangementCode", + "baseName": "legalArrangementCode", + "type": "string" + }, + { + "name": "legalArrangementEntities", + "baseName": "legalArrangementEntities", + "type": "Array" + }, + { + "name": "legalArrangementReference", + "baseName": "legalArrangementReference", + "type": "string" + }, + { + "name": "legalForm", + "baseName": "legalForm", + "type": "LegalArrangementDetail.LegalFormEnum" + }, + { + "name": "name", + "baseName": "name", + "type": "string" + }, + { + "name": "registrationNumber", + "baseName": "registrationNumber", + "type": "string" + }, + { + "name": "taxNumber", + "baseName": "taxNumber", + "type": "string" + }, + { + "name": "type", + "baseName": "type", + "type": "LegalArrangementDetail.TypeEnum" + } ]; + + static getAttributeTypeMap() { + return LegalArrangementDetail.attributeTypeMap; + } +} + +export namespace LegalArrangementDetail { + export enum LegalFormEnum { + CashManagementTrust = 'CashManagementTrust', + CorporateUnitTrust = 'CorporateUnitTrust', + DeceasedEstate = 'DeceasedEstate', + DiscretionaryInvestmentTrust = 'DiscretionaryInvestmentTrust', + DiscretionaryServicesManagementTrust = 'DiscretionaryServicesManagementTrust', + DiscretionaryTradingTrust = 'DiscretionaryTradingTrust', + FirstHomeSaverAccountsTrust = 'FirstHomeSaverAccountsTrust', + FixedTrust = 'FixedTrust', + FixedUnitTrust = 'FixedUnitTrust', + HybridTrust = 'HybridTrust', + ListedPublicUnitTrust = 'ListedPublicUnitTrust', + OtherTrust = 'OtherTrust', + PooledSuperannuationTrust = 'PooledSuperannuationTrust', + PublicTradingTrust = 'PublicTradingTrust', + UnlistedPublicUnitTrust = 'UnlistedPublicUnitTrust', + LimitedPartnership = 'LimitedPartnership', + FamilyPartnership = 'FamilyPartnership', + OtherPartnership = 'OtherPartnership' + } + export enum TypeEnum { + Partnership = 'Partnership', + Trust = 'Trust' + } +} diff --git a/src/typings/platformsAccount/legalArrangementEntityDetail.ts b/src/typings/platformsAccount/legalArrangementEntityDetail.ts new file mode 100644 index 0000000..323c861 --- /dev/null +++ b/src/typings/platformsAccount/legalArrangementEntityDetail.ts @@ -0,0 +1,136 @@ +/** + * Adyen for Platforms: Account API + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don\'t have one, contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@MarketPlace.YourMarketPlace\":\"YourWsPassword\" \\ -H \"Content-Type: application/json\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder ``` + * + * The version of the OpenAPI document: 6 + * Contact: developer-experience@adyen.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +import {BusinessDetails} from './businessDetails'; +import {IndividualDetails} from './individualDetails'; +import {ViasAddress} from './viasAddress'; +import {ViasPhoneNumber} from './viasPhoneNumber'; + +export class LegalArrangementEntityDetail { + 'address'?: ViasAddress; + 'businessDetails'?: BusinessDetails; + /** + * The e-mail address of the entity. + */ + 'email'?: string; + /** + * The phone number of the contact provided as a single string. It will be handled as a landline phone. **Examples:** \"0031 6 11 22 33 44\", \"+316/1122-3344\", \"(0031) 611223344\" + */ + 'fullPhoneNumber'?: string; + 'individualDetails'?: IndividualDetails; + /** + * Adyen-generated unique alphanumeric identifier (UUID) for the entry, returned in the response when you create a legal arrangement entity. + */ + 'legalArrangementEntityCode'?: string; + /** + * Your reference for the legal arrangement entity. + */ + 'legalArrangementEntityReference'?: string; + /** + * The role of the entity in the legal arrangement. The values depend on the `legalArragementType`. Possible values: - For `legalArragementType` **Trust**, you can use **Trustee**, **Settlor**, **Protector**, **Beneficiary**, or **Shareholder**. - For `legalArragementType` **Partnership**, you can use **Partner** or **Shareholder**. + */ + 'legalArrangementMember'?: LegalArrangementEntityDetail.LegalArrangementMemberEnum; + /** + * The legal entity type. Possible values: **Business**, **Individual**, **NonProfit**, **PublicCompany**, or **Partnership**. + */ + 'legalEntityType': LegalArrangementEntityDetail.LegalEntityTypeEnum; + 'phoneNumber'?: ViasPhoneNumber; + /** + * The URL of the website of the contact. + */ + 'webAddress'?: string; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "address", + "baseName": "address", + "type": "ViasAddress" + }, + { + "name": "businessDetails", + "baseName": "businessDetails", + "type": "BusinessDetails" + }, + { + "name": "email", + "baseName": "email", + "type": "string" + }, + { + "name": "fullPhoneNumber", + "baseName": "fullPhoneNumber", + "type": "string" + }, + { + "name": "individualDetails", + "baseName": "individualDetails", + "type": "IndividualDetails" + }, + { + "name": "legalArrangementEntityCode", + "baseName": "legalArrangementEntityCode", + "type": "string" + }, + { + "name": "legalArrangementEntityReference", + "baseName": "legalArrangementEntityReference", + "type": "string" + }, + { + "name": "legalArrangementMember", + "baseName": "legalArrangementMember", + "type": "LegalArrangementEntityDetail.LegalArrangementMemberEnum" + }, + { + "name": "legalEntityType", + "baseName": "legalEntityType", + "type": "LegalArrangementEntityDetail.LegalEntityTypeEnum" + }, + { + "name": "phoneNumber", + "baseName": "phoneNumber", + "type": "ViasPhoneNumber" + }, + { + "name": "webAddress", + "baseName": "webAddress", + "type": "string" + } ]; + + static getAttributeTypeMap() { + return LegalArrangementEntityDetail.attributeTypeMap; + } +} + +export namespace LegalArrangementEntityDetail { + export enum LegalArrangementMemberEnum { + Associate = 'Associate', + Beneficiary = 'Beneficiary', + Chairman = 'Chairman', + Partner = 'Partner', + Protector = 'Protector', + Secretary = 'Secretary', + Settlor = 'Settlor', + Shareholder = 'Shareholder', + Treasurer = 'Treasurer', + Trustee = 'Trustee' + } + export enum LegalEntityTypeEnum { + Business = 'Business', + Individual = 'Individual', + NonProfit = 'NonProfit', + Partnership = 'Partnership', + PublicCompany = 'PublicCompany' + } +} diff --git a/src/typings/platformsAccount/models.ts b/src/typings/platformsAccount/models.ts new file mode 100644 index 0000000..523c3fb --- /dev/null +++ b/src/typings/platformsAccount/models.ts @@ -0,0 +1,397 @@ +/* + * ###### + * ###### + * ############ ####( ###### #####. ###### ############ ############ + * ############# #####( ###### #####. ###### ############# ############# + * ###### #####( ###### #####. ###### ##### ###### ##### ###### + * ###### ###### #####( ###### #####. ###### ##### ##### ##### ###### + * ###### ###### #####( ###### #####. ###### ##### ##### ###### + * ############# ############# ############# ############# ##### ###### + * ############ ############ ############# ############ ##### ###### + * ###### + * ############# + * ############ + * Adyen NodeJS API Library + * Copyright (c) 2020 Adyen B.V. + * This file is open source and available under the MIT license. + * See the LICENSE file for more info. + */ + +export * from './account'; +export * from './accountEvent'; +export * from './accountHolderDetails'; +export * from './accountHolderStatus'; +export * from './accountPayoutState'; +export * from './accountProcessingState'; +export * from './amount'; +export * from './bankAccountDetail'; +export * from './businessDetails'; +export * from './closeAccountHolderRequest'; +export * from './closeAccountHolderResponse'; +export * from './closeAccountRequest'; +export * from './closeAccountResponse'; +export * from './createAccountHolderRequest'; +export * from './createAccountHolderResponse'; +export * from './createAccountRequest'; +export * from './createAccountResponse'; +export * from './deleteBankAccountRequest'; +export * from './deletePayoutMethodRequest'; +export * from './deleteShareholderRequest'; +export * from './deleteSignatoriesRequest'; +export * from './documentDetail'; +export * from './errorFieldType'; +export * from './fieldType'; +export * from './genericResponse'; +export * from './getAccountHolderRequest'; +export * from './getAccountHolderResponse'; +export * from './getAccountHolderStatusResponse'; +export * from './getTaxFormRequest'; +export * from './getTaxFormResponse'; +export * from './getUploadedDocumentsRequest'; +export * from './getUploadedDocumentsResponse'; +export * from './individualDetails'; +export * from './kYCCheckResult2'; +export * from './kYCCheckStatusData'; +export * from './kYCCheckSummary'; +export * from './kYCLegalArrangementCheckResult'; +export * from './kYCLegalArrangementEntityCheckResult'; +export * from './kYCPayoutMethodCheckResult'; +export * from './kYCShareholderCheckResult'; +export * from './kYCSignatoryCheckResult'; +export * from './kYCVerificationResult2'; +export * from './legalArrangementDetail'; +export * from './legalArrangementEntityDetail'; +export * from './payoutMethod'; +export * from './payoutScheduleResponse'; +export * from './performVerificationRequest'; +export * from './personalDocumentData'; +export * from './serviceError'; +export * from './shareholderContact'; +export * from './signatoryContact'; +export * from './storeDetail'; +export * from './suspendAccountHolderRequest'; +export * from './suspendAccountHolderResponse'; +export * from './unSuspendAccountHolderRequest'; +export * from './unSuspendAccountHolderResponse'; +export * from './updateAccountHolderRequest'; +export * from './updateAccountHolderResponse'; +export * from './updateAccountHolderStateRequest'; +export * from './updateAccountRequest'; +export * from './updateAccountResponse'; +export * from './updatePayoutScheduleRequest'; +export * from './uploadDocumentRequest'; +export * from './viasAddress'; +export * from './viasName'; +export * from './viasPersonalData'; +export * from './viasPhoneNumber'; + +import * as fs from 'fs'; +import {Account} from './account'; +import {AccountEvent} from './accountEvent'; +import {AccountHolderDetails} from './accountHolderDetails'; +import {AccountHolderStatus} from './accountHolderStatus'; +import {AccountPayoutState} from './accountPayoutState'; +import {AccountProcessingState} from './accountProcessingState'; +import {Amount} from './amount'; +import {BankAccountDetail} from './bankAccountDetail'; +import {BusinessDetails} from './businessDetails'; +import {CloseAccountHolderRequest} from './closeAccountHolderRequest'; +import {CloseAccountHolderResponse} from './closeAccountHolderResponse'; +import {CloseAccountRequest} from './closeAccountRequest'; +import {CloseAccountResponse} from './closeAccountResponse'; +import {CreateAccountHolderRequest} from './createAccountHolderRequest'; +import {CreateAccountHolderResponse} from './createAccountHolderResponse'; +import {CreateAccountRequest} from './createAccountRequest'; +import {CreateAccountResponse} from './createAccountResponse'; +import {DeleteBankAccountRequest} from './deleteBankAccountRequest'; +import {DeletePayoutMethodRequest} from './deletePayoutMethodRequest'; +import {DeleteShareholderRequest} from './deleteShareholderRequest'; +import {DeleteSignatoriesRequest} from './deleteSignatoriesRequest'; +import {DocumentDetail} from './documentDetail'; +import {ErrorFieldType} from './errorFieldType'; +import {FieldType} from './fieldType'; +import {GenericResponse} from './genericResponse'; +import {GetAccountHolderRequest} from './getAccountHolderRequest'; +import {GetAccountHolderResponse} from './getAccountHolderResponse'; +import {GetAccountHolderStatusResponse} from './getAccountHolderStatusResponse'; +import {GetTaxFormRequest} from './getTaxFormRequest'; +import {GetTaxFormResponse} from './getTaxFormResponse'; +import {GetUploadedDocumentsRequest} from './getUploadedDocumentsRequest'; +import {GetUploadedDocumentsResponse} from './getUploadedDocumentsResponse'; +import {IndividualDetails} from './individualDetails'; +import {KYCCheckResult2} from './kYCCheckResult2'; +import {KYCCheckStatusData} from './kYCCheckStatusData'; +import {KYCCheckSummary} from './kYCCheckSummary'; +import {KYCLegalArrangementCheckResult} from './kYCLegalArrangementCheckResult'; +import {KYCLegalArrangementEntityCheckResult} from './kYCLegalArrangementEntityCheckResult'; +import {KYCPayoutMethodCheckResult} from './kYCPayoutMethodCheckResult'; +import {KYCShareholderCheckResult} from './kYCShareholderCheckResult'; +import {KYCSignatoryCheckResult} from './kYCSignatoryCheckResult'; +import {KYCVerificationResult2} from './kYCVerificationResult2'; +import {LegalArrangementDetail} from './legalArrangementDetail'; +import {LegalArrangementEntityDetail} from './legalArrangementEntityDetail'; +import {PayoutMethod} from './payoutMethod'; +import {PayoutScheduleResponse} from './payoutScheduleResponse'; +import {PerformVerificationRequest} from './performVerificationRequest'; +import {PersonalDocumentData} from './personalDocumentData'; +import {ServiceError} from './serviceError'; +import {ShareholderContact} from './shareholderContact'; +import {SignatoryContact} from './signatoryContact'; +import {StoreDetail} from './storeDetail'; +import {SuspendAccountHolderRequest} from './suspendAccountHolderRequest'; +import {SuspendAccountHolderResponse} from './suspendAccountHolderResponse'; +import {UnSuspendAccountHolderRequest} from './unSuspendAccountHolderRequest'; +import {UnSuspendAccountHolderResponse} from './unSuspendAccountHolderResponse'; +import {UpdateAccountHolderRequest} from './updateAccountHolderRequest'; +import {UpdateAccountHolderResponse} from './updateAccountHolderResponse'; +import {UpdateAccountHolderStateRequest} from './updateAccountHolderStateRequest'; +import {UpdateAccountRequest} from './updateAccountRequest'; +import {UpdateAccountResponse} from './updateAccountResponse'; +import {UpdatePayoutScheduleRequest} from './updatePayoutScheduleRequest'; +import {UploadDocumentRequest} from './uploadDocumentRequest'; +import {ViasAddress} from './viasAddress'; +import {ViasName} from './viasName'; +import {ViasPersonalData} from './viasPersonalData'; +import {ViasPhoneNumber} from './viasPhoneNumber'; + +export interface RequestDetailedFile { + value: Buffer; + options?: { + filename?: string; + contentType?: string; + } +} + +export type RequestFile = string | Buffer | fs.ReadStream | RequestDetailedFile; + + +/* tslint:disable:no-unused-variable */ +let primitives = [ + "string", + "boolean", + "double", + "integer", + "long", + "float", + "number", + "any" + ]; + +let enumsMap: {[index: string]: any} = { + "Account.PayoutSpeedEnum": Account.PayoutSpeedEnum, + "AccountEvent.EventEnum": AccountEvent.EventEnum, + "AccountHolderStatus.StatusEnum": AccountHolderStatus.StatusEnum, + "CloseAccountResponse.StatusEnum": CloseAccountResponse.StatusEnum, + "CreateAccountHolderRequest.LegalEntityEnum": CreateAccountHolderRequest.LegalEntityEnum, + "CreateAccountHolderResponse.LegalEntityEnum": CreateAccountHolderResponse.LegalEntityEnum, + "CreateAccountRequest.PayoutScheduleEnum": CreateAccountRequest.PayoutScheduleEnum, + "CreateAccountRequest.PayoutSpeedEnum": CreateAccountRequest.PayoutSpeedEnum, + "CreateAccountResponse.PayoutSpeedEnum": CreateAccountResponse.PayoutSpeedEnum, + "CreateAccountResponse.StatusEnum": CreateAccountResponse.StatusEnum, + "DocumentDetail.DocumentTypeEnum": DocumentDetail.DocumentTypeEnum, + "FieldType.FieldNameEnum": FieldType.FieldNameEnum, + "GetAccountHolderResponse.LegalEntityEnum": GetAccountHolderResponse.LegalEntityEnum, + "KYCCheckStatusData.StatusEnum": KYCCheckStatusData.StatusEnum, + "KYCCheckStatusData.TypeEnum": KYCCheckStatusData.TypeEnum, + "LegalArrangementDetail.LegalFormEnum": LegalArrangementDetail.LegalFormEnum, + "LegalArrangementDetail.TypeEnum": LegalArrangementDetail.TypeEnum, + "LegalArrangementEntityDetail.LegalArrangementMemberEnum": LegalArrangementEntityDetail.LegalArrangementMemberEnum, + "LegalArrangementEntityDetail.LegalEntityTypeEnum": LegalArrangementEntityDetail.LegalEntityTypeEnum, + "PayoutMethod.PayoutMethodTypeEnum": PayoutMethod.PayoutMethodTypeEnum, + "PayoutScheduleResponse.ScheduleEnum": PayoutScheduleResponse.ScheduleEnum, + "PerformVerificationRequest.AccountStateTypeEnum": PerformVerificationRequest.AccountStateTypeEnum, + "PersonalDocumentData.TypeEnum": PersonalDocumentData.TypeEnum, + "ShareholderContact.ShareholderTypeEnum": ShareholderContact.ShareholderTypeEnum, + "StoreDetail.ShopperInteractionEnum": StoreDetail.ShopperInteractionEnum, + "StoreDetail.StatusEnum": StoreDetail.StatusEnum, + "UpdateAccountHolderRequest.LegalEntityEnum": UpdateAccountHolderRequest.LegalEntityEnum, + "UpdateAccountHolderResponse.LegalEntityEnum": UpdateAccountHolderResponse.LegalEntityEnum, + "UpdateAccountHolderStateRequest.StateTypeEnum": UpdateAccountHolderStateRequest.StateTypeEnum, + "UpdateAccountRequest.PayoutSpeedEnum": UpdateAccountRequest.PayoutSpeedEnum, + "UpdateAccountResponse.PayoutSpeedEnum": UpdateAccountResponse.PayoutSpeedEnum, + "UpdatePayoutScheduleRequest.ActionEnum": UpdatePayoutScheduleRequest.ActionEnum, + "UpdatePayoutScheduleRequest.ScheduleEnum": UpdatePayoutScheduleRequest.ScheduleEnum, + "ViasName.GenderEnum": ViasName.GenderEnum, + "ViasPhoneNumber.PhoneTypeEnum": ViasPhoneNumber.PhoneTypeEnum, +} + +let typeMap: {[index: string]: any} = { + "Account": Account, + "AccountEvent": AccountEvent, + "AccountHolderDetails": AccountHolderDetails, + "AccountHolderStatus": AccountHolderStatus, + "AccountPayoutState": AccountPayoutState, + "AccountProcessingState": AccountProcessingState, + "Amount": Amount, + "BankAccountDetail": BankAccountDetail, + "BusinessDetails": BusinessDetails, + "CloseAccountHolderRequest": CloseAccountHolderRequest, + "CloseAccountHolderResponse": CloseAccountHolderResponse, + "CloseAccountRequest": CloseAccountRequest, + "CloseAccountResponse": CloseAccountResponse, + "CreateAccountHolderRequest": CreateAccountHolderRequest, + "CreateAccountHolderResponse": CreateAccountHolderResponse, + "CreateAccountRequest": CreateAccountRequest, + "CreateAccountResponse": CreateAccountResponse, + "DeleteBankAccountRequest": DeleteBankAccountRequest, + "DeletePayoutMethodRequest": DeletePayoutMethodRequest, + "DeleteShareholderRequest": DeleteShareholderRequest, + "DeleteSignatoriesRequest": DeleteSignatoriesRequest, + "DocumentDetail": DocumentDetail, + "ErrorFieldType": ErrorFieldType, + "FieldType": FieldType, + "GenericResponse": GenericResponse, + "GetAccountHolderRequest": GetAccountHolderRequest, + "GetAccountHolderResponse": GetAccountHolderResponse, + "GetAccountHolderStatusResponse": GetAccountHolderStatusResponse, + "GetTaxFormRequest": GetTaxFormRequest, + "GetTaxFormResponse": GetTaxFormResponse, + "GetUploadedDocumentsRequest": GetUploadedDocumentsRequest, + "GetUploadedDocumentsResponse": GetUploadedDocumentsResponse, + "IndividualDetails": IndividualDetails, + "KYCCheckResult2": KYCCheckResult2, + "KYCCheckStatusData": KYCCheckStatusData, + "KYCCheckSummary": KYCCheckSummary, + "KYCLegalArrangementCheckResult": KYCLegalArrangementCheckResult, + "KYCLegalArrangementEntityCheckResult": KYCLegalArrangementEntityCheckResult, + "KYCPayoutMethodCheckResult": KYCPayoutMethodCheckResult, + "KYCShareholderCheckResult": KYCShareholderCheckResult, + "KYCSignatoryCheckResult": KYCSignatoryCheckResult, + "KYCVerificationResult2": KYCVerificationResult2, + "LegalArrangementDetail": LegalArrangementDetail, + "LegalArrangementEntityDetail": LegalArrangementEntityDetail, + "PayoutMethod": PayoutMethod, + "PayoutScheduleResponse": PayoutScheduleResponse, + "PerformVerificationRequest": PerformVerificationRequest, + "PersonalDocumentData": PersonalDocumentData, + "ServiceError": ServiceError, + "ShareholderContact": ShareholderContact, + "SignatoryContact": SignatoryContact, + "StoreDetail": StoreDetail, + "SuspendAccountHolderRequest": SuspendAccountHolderRequest, + "SuspendAccountHolderResponse": SuspendAccountHolderResponse, + "UnSuspendAccountHolderRequest": UnSuspendAccountHolderRequest, + "UnSuspendAccountHolderResponse": UnSuspendAccountHolderResponse, + "UpdateAccountHolderRequest": UpdateAccountHolderRequest, + "UpdateAccountHolderResponse": UpdateAccountHolderResponse, + "UpdateAccountHolderStateRequest": UpdateAccountHolderStateRequest, + "UpdateAccountRequest": UpdateAccountRequest, + "UpdateAccountResponse": UpdateAccountResponse, + "UpdatePayoutScheduleRequest": UpdatePayoutScheduleRequest, + "UploadDocumentRequest": UploadDocumentRequest, + "ViasAddress": ViasAddress, + "ViasName": ViasName, + "ViasPersonalData": ViasPersonalData, + "ViasPhoneNumber": ViasPhoneNumber, +} + +export class ObjectSerializer { + public static findCorrectType(data: any, expectedType: string) { + if (data == undefined) { + return expectedType; + } else if (primitives.indexOf(expectedType.toLowerCase()) !== -1) { + return expectedType; + } else if (expectedType === "Date") { + return expectedType; + } else { + if (enumsMap[expectedType]) { + return expectedType; + } + + if (!typeMap[expectedType]) { + return expectedType; // w/e we don't know the type + } + + // Check the discriminator + let discriminatorProperty = typeMap[expectedType].discriminator; + if (discriminatorProperty == null) { + return expectedType; // the type does not have a discriminator. use it. + } else { + if (data[discriminatorProperty]) { + var discriminatorType = data[discriminatorProperty]; + if(typeMap[discriminatorType]){ + return discriminatorType; // use the type given in the discriminator + } else { + return expectedType; // discriminator did not map to a type + } + } else { + return expectedType; // discriminator was not present (or an empty string) + } + } + } + } + + public static serialize(data: any, type: string) { + if (data == undefined) { + return data; + } else if (primitives.indexOf(type.toLowerCase()) !== -1) { + return data; + } else if (type.lastIndexOf("Array<", 0) === 0) { // string.startsWith pre es6 + let subType: string = type.replace("Array<", ""); // Array => Type> + subType = subType.substring(0, subType.length - 1); // Type> => Type + let transformedData: any[] = []; + for (let index = 0; index < data.length; index++) { + let datum = data[index]; + transformedData.push(ObjectSerializer.serialize(datum, subType)); + } + return transformedData; + } else if (type === "Date") { + return data.toISOString(); + } else { + if (enumsMap[type]) { + return data; + } + if (!typeMap[type]) { // in case we dont know the type + return data; + } + + // Get the actual type of this object + type = this.findCorrectType(data, type); + + // get the map for the correct type. + let attributeTypes = typeMap[type].getAttributeTypeMap(); + let instance: {[index: string]: any} = {}; + for (let index = 0; index < attributeTypes.length; index++) { + let attributeType = attributeTypes[index]; + instance[attributeType.baseName] = ObjectSerializer.serialize(data[attributeType.name], attributeType.type); + } + return instance; + } + } + + public static deserialize(data: any, type: string) { + // polymorphism may change the actual type. + type = ObjectSerializer.findCorrectType(data, type); + if (data == undefined) { + return data; + } else if (primitives.indexOf(type.toLowerCase()) !== -1) { + return data; + } else if (type.lastIndexOf("Array<", 0) === 0) { // string.startsWith pre es6 + let subType: string = type.replace("Array<", ""); // Array => Type> + subType = subType.substring(0, subType.length - 1); // Type> => Type + let transformedData: any[] = []; + for (let index = 0; index < data.length; index++) { + let datum = data[index]; + transformedData.push(ObjectSerializer.deserialize(datum, subType)); + } + return transformedData; + } else if (type === "Date") { + return new Date(data); + } else { + if (enumsMap[type]) {// is Enum + return data; + } + + if (!typeMap[type]) { // dont know the type + return data; + } + let instance = new typeMap[type](); + let attributeTypes = typeMap[type].getAttributeTypeMap(); + for (let index = 0; index < attributeTypes.length; index++) { + let attributeType = attributeTypes[index]; + instance[attributeType.name] = ObjectSerializer.deserialize(data[attributeType.baseName], attributeType.type); + } + return instance; + } + } +} \ No newline at end of file diff --git a/src/typings/platformsAccount/payoutMethod.ts b/src/typings/platformsAccount/payoutMethod.ts new file mode 100644 index 0000000..8a7c5f0 --- /dev/null +++ b/src/typings/platformsAccount/payoutMethod.ts @@ -0,0 +1,58 @@ +/** + * Adyen for Platforms: Account API + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don\'t have one, contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@MarketPlace.YourMarketPlace\":\"YourWsPassword\" \\ -H \"Content-Type: application/json\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder ``` + * + * The version of the OpenAPI document: 6 + * Contact: developer-experience@adyen.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +export class PayoutMethod { + 'merchantAccount': string; + 'payoutMethodCode'?: string; + 'payoutMethodType'?: PayoutMethod.PayoutMethodTypeEnum; + 'recurringDetailReference': string; + 'shopperReference': string; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "merchantAccount", + "baseName": "merchantAccount", + "type": "string" + }, + { + "name": "payoutMethodCode", + "baseName": "payoutMethodCode", + "type": "string" + }, + { + "name": "payoutMethodType", + "baseName": "payoutMethodType", + "type": "PayoutMethod.PayoutMethodTypeEnum" + }, + { + "name": "recurringDetailReference", + "baseName": "recurringDetailReference", + "type": "string" + }, + { + "name": "shopperReference", + "baseName": "shopperReference", + "type": "string" + } ]; + + static getAttributeTypeMap() { + return PayoutMethod.attributeTypeMap; + } +} + +export namespace PayoutMethod { + export enum PayoutMethodTypeEnum { + CardToken = 'CardToken' + } +} diff --git a/src/typings/platformsAccount/payoutScheduleResponse.ts b/src/typings/platformsAccount/payoutScheduleResponse.ts new file mode 100644 index 0000000..1c77a76 --- /dev/null +++ b/src/typings/platformsAccount/payoutScheduleResponse.ts @@ -0,0 +1,61 @@ +/** + * Adyen for Platforms: Account API + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don\'t have one, contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@MarketPlace.YourMarketPlace\":\"YourWsPassword\" \\ -H \"Content-Type: application/json\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder ``` + * + * The version of the OpenAPI document: 6 + * Contact: developer-experience@adyen.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +export class PayoutScheduleResponse { + /** + * The date of the next scheduled payout. + */ + 'nextScheduledPayout'?: Date; + /** + * The payout schedule of the account. >Permitted values: `DEFAULT`, `HOLD`, `DAILY`, `WEEKLY`, `MONTHLY`. + */ + 'schedule': PayoutScheduleResponse.ScheduleEnum; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "nextScheduledPayout", + "baseName": "nextScheduledPayout", + "type": "Date" + }, + { + "name": "schedule", + "baseName": "schedule", + "type": "PayoutScheduleResponse.ScheduleEnum" + } ]; + + static getAttributeTypeMap() { + return PayoutScheduleResponse.attributeTypeMap; + } +} + +export namespace PayoutScheduleResponse { + export enum ScheduleEnum { + BiweeklyOn1StAnd15ThAtMidnight = 'BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT', + BiweeklyOn1StAnd15ThAtNoon = 'BIWEEKLY_ON_1ST_AND_15TH_AT_NOON', + Daily = 'DAILY', + Daily6Pm = 'DAILY_6PM', + DailyAu = 'DAILY_AU', + DailyEu = 'DAILY_EU', + DailySg = 'DAILY_SG', + DailyUs = 'DAILY_US', + Default = 'DEFAULT', + Every6HoursFromMidnight = 'EVERY_6_HOURS_FROM_MIDNIGHT', + Hold = 'HOLD', + Monthly = 'MONTHLY', + MonthlyOn15ThAtMidnight = 'MONTHLY_ON_15TH_AT_MIDNIGHT', + Weekly = 'WEEKLY', + WeeklyOnTueFriMidnight = 'WEEKLY_ON_TUE_FRI_MIDNIGHT', + Yearly = 'YEARLY' + } +} diff --git a/src/typings/platformsAccount/performVerificationRequest.ts b/src/typings/platformsAccount/performVerificationRequest.ts new file mode 100644 index 0000000..a968894 --- /dev/null +++ b/src/typings/platformsAccount/performVerificationRequest.ts @@ -0,0 +1,60 @@ +/** + * Adyen for Platforms: Account API + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don\'t have one, contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@MarketPlace.YourMarketPlace\":\"YourWsPassword\" \\ -H \"Content-Type: application/json\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder ``` + * + * The version of the OpenAPI document: 6 + * Contact: developer-experience@adyen.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +export class PerformVerificationRequest { + /** + * The code of the account holder to verify. + */ + 'accountHolderCode': string; + /** + * The state required for the account holder. > Permitted values: `Processing`, `Payout`. + */ + 'accountStateType': PerformVerificationRequest.AccountStateTypeEnum; + /** + * The tier required for the account holder. + */ + 'tier': number; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "accountHolderCode", + "baseName": "accountHolderCode", + "type": "string" + }, + { + "name": "accountStateType", + "baseName": "accountStateType", + "type": "PerformVerificationRequest.AccountStateTypeEnum" + }, + { + "name": "tier", + "baseName": "tier", + "type": "number" + } ]; + + static getAttributeTypeMap() { + return PerformVerificationRequest.attributeTypeMap; + } +} + +export namespace PerformVerificationRequest { + export enum AccountStateTypeEnum { + LimitedPayout = 'LimitedPayout', + LimitedProcessing = 'LimitedProcessing', + LimitlessPayout = 'LimitlessPayout', + LimitlessProcessing = 'LimitlessProcessing', + Payout = 'Payout', + Processing = 'Processing' + } +} diff --git a/src/typings/platformsAccount/personalDocumentData.ts b/src/typings/platformsAccount/personalDocumentData.ts new file mode 100644 index 0000000..79e54db --- /dev/null +++ b/src/typings/platformsAccount/personalDocumentData.ts @@ -0,0 +1,77 @@ +/** + * Adyen for Platforms: Account API + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don\'t have one, contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@MarketPlace.YourMarketPlace\":\"YourWsPassword\" \\ -H \"Content-Type: application/json\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder ``` + * + * The version of the OpenAPI document: 6 + * Contact: developer-experience@adyen.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +export class PersonalDocumentData { + /** + * The expiry date of the document, in ISO-8601 YYYY-MM-DD format. For example, **2000-01-31**. + */ + 'expirationDate'?: string; + /** + * The country where the document was issued, in the two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. For example, **NL**. + */ + 'issuerCountry'?: string; + /** + * The state where the document was issued (if applicable). + */ + 'issuerState'?: string; + /** + * The number in the document. + */ + 'number'?: string; + /** + * The type of the document. Possible values: **ID**, **DRIVINGLICENSE**, **PASSPORT**, **SOCIALSECURITY**, **VISA**. To delete an existing entry for a document `type`, send only the `type` field in your request. + */ + 'type': PersonalDocumentData.TypeEnum; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "expirationDate", + "baseName": "expirationDate", + "type": "string" + }, + { + "name": "issuerCountry", + "baseName": "issuerCountry", + "type": "string" + }, + { + "name": "issuerState", + "baseName": "issuerState", + "type": "string" + }, + { + "name": "number", + "baseName": "number", + "type": "string" + }, + { + "name": "type", + "baseName": "type", + "type": "PersonalDocumentData.TypeEnum" + } ]; + + static getAttributeTypeMap() { + return PersonalDocumentData.attributeTypeMap; + } +} + +export namespace PersonalDocumentData { + export enum TypeEnum { + Drivinglicense = 'DRIVINGLICENSE', + Id = 'ID', + Passport = 'PASSPORT', + Socialsecurity = 'SOCIALSECURITY', + Visa = 'VISA' + } +} diff --git a/src/typings/platformsAccount/serviceError.ts b/src/typings/platformsAccount/serviceError.ts new file mode 100644 index 0000000..853a98d --- /dev/null +++ b/src/typings/platformsAccount/serviceError.ts @@ -0,0 +1,68 @@ +/** + * Adyen for Platforms: Account API + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don\'t have one, contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@MarketPlace.YourMarketPlace\":\"YourWsPassword\" \\ -H \"Content-Type: application/json\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder ``` + * + * The version of the OpenAPI document: 6 + * Contact: developer-experience@adyen.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +export class ServiceError { + /** + * The error code mapped to the error message. + */ + 'errorCode'?: string; + /** + * The category of the error. + */ + 'errorType'?: string; + /** + * A short explanation of the issue. + */ + 'message'?: string; + /** + * The PSP reference of the payment. + */ + 'pspReference'?: string; + /** + * The HTTP response status. + */ + 'status'?: number; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "errorCode", + "baseName": "errorCode", + "type": "string" + }, + { + "name": "errorType", + "baseName": "errorType", + "type": "string" + }, + { + "name": "message", + "baseName": "message", + "type": "string" + }, + { + "name": "pspReference", + "baseName": "pspReference", + "type": "string" + }, + { + "name": "status", + "baseName": "status", + "type": "number" + } ]; + + static getAttributeTypeMap() { + return ServiceError.attributeTypeMap; + } +} + diff --git a/src/typings/platformsAccount/shareholderContact.ts b/src/typings/platformsAccount/shareholderContact.ts new file mode 100644 index 0000000..8efffe2 --- /dev/null +++ b/src/typings/platformsAccount/shareholderContact.ts @@ -0,0 +1,122 @@ +/** + * Adyen for Platforms: Account API + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don\'t have one, contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@MarketPlace.YourMarketPlace\":\"YourWsPassword\" \\ -H \"Content-Type: application/json\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder ``` + * + * The version of the OpenAPI document: 6 + * Contact: developer-experience@adyen.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +import {ViasAddress} from './viasAddress'; +import {ViasName} from './viasName'; +import {ViasPersonalData} from './viasPersonalData'; +import {ViasPhoneNumber} from './viasPhoneNumber'; + +export class ShareholderContact { + 'address'?: ViasAddress; + /** + * The e-mail address of the person. + */ + 'email'?: string; + /** + * The phone number of the person provided as a single string. It will be handled as a landline phone. Examples: \"0031 6 11 22 33 44\", \"+316/1122-3344\", \"(0031) 611223344\" + */ + 'fullPhoneNumber'?: string; + /** + * Job title of the person. Required when the `shareholderType` is **Controller**. Example values: **Chief Executive Officer**, **Chief Financial Officer**, **Chief Operating Officer**, **President**, **Vice President**, **Executive President**, **Managing Member**, **Partner**, **Treasurer**, **Director**, or **Other**. + */ + 'jobTitle'?: string; + 'name'?: ViasName; + 'personalData'?: ViasPersonalData; + 'phoneNumber'?: ViasPhoneNumber; + /** + * The unique identifier (UUID) of the shareholder entry. >**If, during an Account Holder create or update request, this field is left blank (but other fields provided), a new Shareholder will be created with a procedurally-generated UUID.** >**If, during an Account Holder create request, a UUID is provided, the creation of the Shareholder will fail while the creation of the Account Holder will continue.** >**If, during an Account Holder update request, a UUID that is not correlated with an existing Shareholder is provided, the update of the Shareholder will fail.** >**If, during an Account Holder update request, a UUID that is correlated with an existing Shareholder is provided, the existing Shareholder will be updated.** + */ + 'shareholderCode'?: string; + /** + * Your reference for the shareholder entry. + */ + 'shareholderReference'?: string; + /** + * Specifies how the person is associated with the account holder. Possible values: * **Owner**: Individuals who directly or indirectly own 25% or more of a company. * **Controller**: Individuals who are members of senior management staff responsible for managing a company or organization. + */ + 'shareholderType'?: ShareholderContact.ShareholderTypeEnum; + /** + * The URL of the person\'s website. + */ + 'webAddress'?: string; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "address", + "baseName": "address", + "type": "ViasAddress" + }, + { + "name": "email", + "baseName": "email", + "type": "string" + }, + { + "name": "fullPhoneNumber", + "baseName": "fullPhoneNumber", + "type": "string" + }, + { + "name": "jobTitle", + "baseName": "jobTitle", + "type": "string" + }, + { + "name": "name", + "baseName": "name", + "type": "ViasName" + }, + { + "name": "personalData", + "baseName": "personalData", + "type": "ViasPersonalData" + }, + { + "name": "phoneNumber", + "baseName": "phoneNumber", + "type": "ViasPhoneNumber" + }, + { + "name": "shareholderCode", + "baseName": "shareholderCode", + "type": "string" + }, + { + "name": "shareholderReference", + "baseName": "shareholderReference", + "type": "string" + }, + { + "name": "shareholderType", + "baseName": "shareholderType", + "type": "ShareholderContact.ShareholderTypeEnum" + }, + { + "name": "webAddress", + "baseName": "webAddress", + "type": "string" + } ]; + + static getAttributeTypeMap() { + return ShareholderContact.attributeTypeMap; + } +} + +export namespace ShareholderContact { + export enum ShareholderTypeEnum { + Controller = 'Controller', + Owner = 'Owner', + Signatory = 'Signatory' + } +} diff --git a/src/typings/platformsAccount/signatoryContact.ts b/src/typings/platformsAccount/signatoryContact.ts new file mode 100644 index 0000000..dad0cd0 --- /dev/null +++ b/src/typings/platformsAccount/signatoryContact.ts @@ -0,0 +1,106 @@ +/** + * Adyen for Platforms: Account API + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don\'t have one, contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@MarketPlace.YourMarketPlace\":\"YourWsPassword\" \\ -H \"Content-Type: application/json\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder ``` + * + * The version of the OpenAPI document: 6 + * Contact: developer-experience@adyen.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +import {ViasAddress} from './viasAddress'; +import {ViasName} from './viasName'; +import {ViasPersonalData} from './viasPersonalData'; +import {ViasPhoneNumber} from './viasPhoneNumber'; + +export class SignatoryContact { + 'address'?: ViasAddress; + /** + * The e-mail address of the person. + */ + 'email'?: string; + /** + * The phone number of the person provided as a single string. It will be handled as a landline phone. Examples: \"0031 6 11 22 33 44\", \"+316/1122-3344\", \"(0031) 611223344\" + */ + 'fullPhoneNumber'?: string; + /** + * Job title of the signatory. Example values: **Chief Executive Officer**, **Chief Financial Officer**, **Chief Operating Officer**, **President**, **Vice President**, **Executive President**, **Managing Member**, **Partner**, **Treasurer**, **Director**, or **Other**. + */ + 'jobTitle'?: string; + 'name'?: ViasName; + 'personalData'?: ViasPersonalData; + 'phoneNumber'?: ViasPhoneNumber; + /** + * The unique identifier (UUID) of the Signatory. >**If, during an Account Holder create or update request, this field is left blank (but other fields provided), a new Signatory will be created with a procedurally-generated UUID.** >**If, during an Account Holder create request, a UUID is provided, the creation of the Signatory will fail while the creation of the Account Holder will continue.** >**If, during an Account Holder update request, a UUID that is not correlated with an existing Signatory is provided, the update of the Signatory will fail.** >**If, during an Account Holder update request, a UUID that is correlated with an existing Signatory is provided, the existing Signatory will be updated.** + */ + 'signatoryCode'?: string; + /** + * Your reference for the Signatory. + */ + 'signatoryReference'?: string; + /** + * The URL of the person\'s website. + */ + 'webAddress'?: string; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "address", + "baseName": "address", + "type": "ViasAddress" + }, + { + "name": "email", + "baseName": "email", + "type": "string" + }, + { + "name": "fullPhoneNumber", + "baseName": "fullPhoneNumber", + "type": "string" + }, + { + "name": "jobTitle", + "baseName": "jobTitle", + "type": "string" + }, + { + "name": "name", + "baseName": "name", + "type": "ViasName" + }, + { + "name": "personalData", + "baseName": "personalData", + "type": "ViasPersonalData" + }, + { + "name": "phoneNumber", + "baseName": "phoneNumber", + "type": "ViasPhoneNumber" + }, + { + "name": "signatoryCode", + "baseName": "signatoryCode", + "type": "string" + }, + { + "name": "signatoryReference", + "baseName": "signatoryReference", + "type": "string" + }, + { + "name": "webAddress", + "baseName": "webAddress", + "type": "string" + } ]; + + static getAttributeTypeMap() { + return SignatoryContact.attributeTypeMap; + } +} + diff --git a/src/typings/platformsAccount/storeDetail.ts b/src/typings/platformsAccount/storeDetail.ts new file mode 100644 index 0000000..d5a1403 --- /dev/null +++ b/src/typings/platformsAccount/storeDetail.ts @@ -0,0 +1,150 @@ +/** + * Adyen for Platforms: Account API + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don\'t have one, contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@MarketPlace.YourMarketPlace\":\"YourWsPassword\" \\ -H \"Content-Type: application/json\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder ``` + * + * The version of the OpenAPI document: 6 + * Contact: developer-experience@adyen.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +import {ViasAddress} from './viasAddress'; +import {ViasPhoneNumber} from './viasPhoneNumber'; + +export class StoreDetail { + 'address': ViasAddress; + /** + * The phone number of the store provided as a single string. It will be handled as a landline phone. Examples: \"0031 6 11 22 33 44\", \"+316/1122-3344\", \"(0031) 611223344\" + */ + 'fullPhoneNumber'?: string; + /** + * The merchant account to which the store belongs. + */ + 'merchantAccount': string; + /** + * The merchant category code (MCC) that classifies the business of the account holder. + */ + 'merchantCategoryCode': string; + 'phoneNumber'?: ViasPhoneNumber; + /** + * The sales channel. Possible values: **Ecommerce**, **POS**. + */ + 'shopperInteraction'?: StoreDetail.ShopperInteractionEnum; + /** + * The unique reference for the split configuration, returned when you configure splits in your Customer Area. When this is provided, the `virtualAccount` is also required. Adyen uses the configuration and the `virtualAccount` to split funds between accounts in your platform. + */ + 'splitConfigurationUUID'?: string; + /** + * The status of the store. Possible values: **Pending**, **Active**, **Inactive**, **InactiveWithModifications**, **Closed**. + */ + 'status'?: StoreDetail.StatusEnum; + /** + * Adyen-generated unique alphanumeric identifier (UUID) for the store, returned in the response when you create a store. Required when updating an existing store in an `/updateAccountHolder` request. + */ + 'store'?: string; + /** + * The name of the account holder\'s store, between 3 to 22 characters in length. This value will be shown in shopper statements. + */ + 'storeName'?: string; + /** + * Your unique identifier for the store, between 3 to 128 characters in length. This value will be shown as the store description in your Customer Area. + */ + 'storeReference': string; + /** + * The account holder\'s `accountCode` where the split amount will be sent. Required when you provide the `splitConfigurationUUID`. + */ + 'virtualAccount'?: string; + /** + * URL of the ecommerce store. + */ + 'webAddress'?: string; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "address", + "baseName": "address", + "type": "ViasAddress" + }, + { + "name": "fullPhoneNumber", + "baseName": "fullPhoneNumber", + "type": "string" + }, + { + "name": "merchantAccount", + "baseName": "merchantAccount", + "type": "string" + }, + { + "name": "merchantCategoryCode", + "baseName": "merchantCategoryCode", + "type": "string" + }, + { + "name": "phoneNumber", + "baseName": "phoneNumber", + "type": "ViasPhoneNumber" + }, + { + "name": "shopperInteraction", + "baseName": "shopperInteraction", + "type": "StoreDetail.ShopperInteractionEnum" + }, + { + "name": "splitConfigurationUUID", + "baseName": "splitConfigurationUUID", + "type": "string" + }, + { + "name": "status", + "baseName": "status", + "type": "StoreDetail.StatusEnum" + }, + { + "name": "store", + "baseName": "store", + "type": "string" + }, + { + "name": "storeName", + "baseName": "storeName", + "type": "string" + }, + { + "name": "storeReference", + "baseName": "storeReference", + "type": "string" + }, + { + "name": "virtualAccount", + "baseName": "virtualAccount", + "type": "string" + }, + { + "name": "webAddress", + "baseName": "webAddress", + "type": "string" + } ]; + + static getAttributeTypeMap() { + return StoreDetail.attributeTypeMap; + } +} + +export namespace StoreDetail { + export enum ShopperInteractionEnum { + Ecommerce = 'Ecommerce', + Pos = 'POS' + } + export enum StatusEnum { + Active = 'Active', + Closed = 'Closed', + Inactive = 'Inactive', + InactiveWithModifications = 'InactiveWithModifications', + Pending = 'Pending' + } +} diff --git a/src/typings/platformsAccount/suspendAccountHolderRequest.ts b/src/typings/platformsAccount/suspendAccountHolderRequest.ts new file mode 100644 index 0000000..977eaaf --- /dev/null +++ b/src/typings/platformsAccount/suspendAccountHolderRequest.ts @@ -0,0 +1,32 @@ +/** + * Adyen for Platforms: Account API + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don\'t have one, contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@MarketPlace.YourMarketPlace\":\"YourWsPassword\" \\ -H \"Content-Type: application/json\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder ``` + * + * The version of the OpenAPI document: 6 + * Contact: developer-experience@adyen.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +export class SuspendAccountHolderRequest { + /** + * The code of the account holder to be suspended. + */ + 'accountHolderCode': string; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "accountHolderCode", + "baseName": "accountHolderCode", + "type": "string" + } ]; + + static getAttributeTypeMap() { + return SuspendAccountHolderRequest.attributeTypeMap; + } +} + diff --git a/src/typings/platformsAccount/suspendAccountHolderResponse.ts b/src/typings/platformsAccount/suspendAccountHolderResponse.ts new file mode 100644 index 0000000..ed1cd15 --- /dev/null +++ b/src/typings/platformsAccount/suspendAccountHolderResponse.ts @@ -0,0 +1,59 @@ +/** + * Adyen for Platforms: Account API + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don\'t have one, contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@MarketPlace.YourMarketPlace\":\"YourWsPassword\" \\ -H \"Content-Type: application/json\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder ``` + * + * The version of the OpenAPI document: 6 + * Contact: developer-experience@adyen.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +import {AccountHolderStatus} from './accountHolderStatus'; +import {ErrorFieldType} from './errorFieldType'; + +export class SuspendAccountHolderResponse { + 'accountHolderStatus': AccountHolderStatus; + /** + * Contains field validation errors that would prevent requests from being processed. + */ + 'invalidFields'?: Array; + /** + * The reference of a request. Can be used to uniquely identify the request. + */ + 'pspReference'?: string; + /** + * The result code. + */ + 'resultCode'?: string; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "accountHolderStatus", + "baseName": "accountHolderStatus", + "type": "AccountHolderStatus" + }, + { + "name": "invalidFields", + "baseName": "invalidFields", + "type": "Array" + }, + { + "name": "pspReference", + "baseName": "pspReference", + "type": "string" + }, + { + "name": "resultCode", + "baseName": "resultCode", + "type": "string" + } ]; + + static getAttributeTypeMap() { + return SuspendAccountHolderResponse.attributeTypeMap; + } +} + diff --git a/src/typings/platformsAccount/unSuspendAccountHolderRequest.ts b/src/typings/platformsAccount/unSuspendAccountHolderRequest.ts new file mode 100644 index 0000000..f92edc0 --- /dev/null +++ b/src/typings/platformsAccount/unSuspendAccountHolderRequest.ts @@ -0,0 +1,32 @@ +/** + * Adyen for Platforms: Account API + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don\'t have one, contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@MarketPlace.YourMarketPlace\":\"YourWsPassword\" \\ -H \"Content-Type: application/json\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder ``` + * + * The version of the OpenAPI document: 6 + * Contact: developer-experience@adyen.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +export class UnSuspendAccountHolderRequest { + /** + * The code of the account holder to be reinstated. + */ + 'accountHolderCode': string; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "accountHolderCode", + "baseName": "accountHolderCode", + "type": "string" + } ]; + + static getAttributeTypeMap() { + return UnSuspendAccountHolderRequest.attributeTypeMap; + } +} + diff --git a/src/typings/platformsAccount/unSuspendAccountHolderResponse.ts b/src/typings/platformsAccount/unSuspendAccountHolderResponse.ts new file mode 100644 index 0000000..8bb5977 --- /dev/null +++ b/src/typings/platformsAccount/unSuspendAccountHolderResponse.ts @@ -0,0 +1,59 @@ +/** + * Adyen for Platforms: Account API + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don\'t have one, contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@MarketPlace.YourMarketPlace\":\"YourWsPassword\" \\ -H \"Content-Type: application/json\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder ``` + * + * The version of the OpenAPI document: 6 + * Contact: developer-experience@adyen.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +import {AccountHolderStatus} from './accountHolderStatus'; +import {ErrorFieldType} from './errorFieldType'; + +export class UnSuspendAccountHolderResponse { + 'accountHolderStatus': AccountHolderStatus; + /** + * Contains field validation errors that would prevent requests from being processed. + */ + 'invalidFields'?: Array; + /** + * The reference of a request. Can be used to uniquely identify the request. + */ + 'pspReference'?: string; + /** + * The result code. + */ + 'resultCode'?: string; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "accountHolderStatus", + "baseName": "accountHolderStatus", + "type": "AccountHolderStatus" + }, + { + "name": "invalidFields", + "baseName": "invalidFields", + "type": "Array" + }, + { + "name": "pspReference", + "baseName": "pspReference", + "type": "string" + }, + { + "name": "resultCode", + "baseName": "resultCode", + "type": "string" + } ]; + + static getAttributeTypeMap() { + return UnSuspendAccountHolderResponse.attributeTypeMap; + } +} + diff --git a/src/typings/platformsAccount/updateAccountHolderRequest.ts b/src/typings/platformsAccount/updateAccountHolderRequest.ts new file mode 100644 index 0000000..cd64878 --- /dev/null +++ b/src/typings/platformsAccount/updateAccountHolderRequest.ts @@ -0,0 +1,94 @@ +/** + * Adyen for Platforms: Account API + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don\'t have one, contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@MarketPlace.YourMarketPlace\":\"YourWsPassword\" \\ -H \"Content-Type: application/json\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder ``` + * + * The version of the OpenAPI document: 6 + * Contact: developer-experience@adyen.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +import {AccountHolderDetails} from './accountHolderDetails'; + +export class UpdateAccountHolderRequest { + /** + * The code of the Account Holder to be updated. + */ + 'accountHolderCode': string; + 'accountHolderDetails'?: AccountHolderDetails; + /** + * A description of the account holder, maximum 256 characters. You can use alphanumeric characters (A-Z, a-z, 0-9), white spaces, and underscores `_`. + */ + 'description'?: string; + /** + * The legal entity type of the account holder. This determines the information that should be provided in the request. Possible values: **Business**, **Individual**, or **NonProfit**. * If set to **Business** or **NonProfit**, then `accountHolderDetails.businessDetails` must be provided, with at least one entry in the `accountHolderDetails.businessDetails.shareholders` list. * If set to **Individual**, then `accountHolderDetails.individualDetails` must be provided. + */ + 'legalEntity'?: UpdateAccountHolderRequest.LegalEntityEnum; + /** + * The primary three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), to which the account holder should be updated. + */ + 'primaryCurrency'?: string; + /** + * The processing tier to which the Account Holder should be updated. >The processing tier can not be lowered through this request. >Required if accountHolderDetails are not provided. + */ + 'processingTier'?: number; + /** + * The identifier of the profile that applies to this entity. + */ + 'verificationProfile'?: string; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "accountHolderCode", + "baseName": "accountHolderCode", + "type": "string" + }, + { + "name": "accountHolderDetails", + "baseName": "accountHolderDetails", + "type": "AccountHolderDetails" + }, + { + "name": "description", + "baseName": "description", + "type": "string" + }, + { + "name": "legalEntity", + "baseName": "legalEntity", + "type": "UpdateAccountHolderRequest.LegalEntityEnum" + }, + { + "name": "primaryCurrency", + "baseName": "primaryCurrency", + "type": "string" + }, + { + "name": "processingTier", + "baseName": "processingTier", + "type": "number" + }, + { + "name": "verificationProfile", + "baseName": "verificationProfile", + "type": "string" + } ]; + + static getAttributeTypeMap() { + return UpdateAccountHolderRequest.attributeTypeMap; + } +} + +export namespace UpdateAccountHolderRequest { + export enum LegalEntityEnum { + Business = 'Business', + Individual = 'Individual', + NonProfit = 'NonProfit', + Partnership = 'Partnership', + PublicCompany = 'PublicCompany' + } +} diff --git a/src/typings/platformsAccount/updateAccountHolderResponse.ts b/src/typings/platformsAccount/updateAccountHolderResponse.ts new file mode 100644 index 0000000..081cd2c --- /dev/null +++ b/src/typings/platformsAccount/updateAccountHolderResponse.ts @@ -0,0 +1,127 @@ +/** + * Adyen for Platforms: Account API + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don\'t have one, contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@MarketPlace.YourMarketPlace\":\"YourWsPassword\" \\ -H \"Content-Type: application/json\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder ``` + * + * The version of the OpenAPI document: 6 + * Contact: developer-experience@adyen.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +import {AccountHolderDetails} from './accountHolderDetails'; +import {AccountHolderStatus} from './accountHolderStatus'; +import {ErrorFieldType} from './errorFieldType'; +import {KYCVerificationResult2} from './kYCVerificationResult2'; + +export class UpdateAccountHolderResponse { + /** + * The code of the account holder. + */ + 'accountHolderCode'?: string; + 'accountHolderDetails'?: AccountHolderDetails; + 'accountHolderStatus': AccountHolderStatus; + /** + * The description of the account holder. + */ + 'description'?: string; + /** + * in case the account holder has not been updated, contains account holder fields, that did not pass the validation. + */ + 'invalidFields'?: Array; + /** + * The legal entity of the account holder. + */ + 'legalEntity': UpdateAccountHolderResponse.LegalEntityEnum; + /** + * The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes), with which the prospective account holder primarily deals. + */ + 'primaryCurrency'?: string; + /** + * The reference of a request. Can be used to uniquely identify the request. + */ + 'pspReference'?: string; + /** + * The result code. + */ + 'resultCode'?: string; + 'verification': KYCVerificationResult2; + /** + * The identifier of the profile that applies to this entity. + */ + 'verificationProfile'?: string; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "accountHolderCode", + "baseName": "accountHolderCode", + "type": "string" + }, + { + "name": "accountHolderDetails", + "baseName": "accountHolderDetails", + "type": "AccountHolderDetails" + }, + { + "name": "accountHolderStatus", + "baseName": "accountHolderStatus", + "type": "AccountHolderStatus" + }, + { + "name": "description", + "baseName": "description", + "type": "string" + }, + { + "name": "invalidFields", + "baseName": "invalidFields", + "type": "Array" + }, + { + "name": "legalEntity", + "baseName": "legalEntity", + "type": "UpdateAccountHolderResponse.LegalEntityEnum" + }, + { + "name": "primaryCurrency", + "baseName": "primaryCurrency", + "type": "string" + }, + { + "name": "pspReference", + "baseName": "pspReference", + "type": "string" + }, + { + "name": "resultCode", + "baseName": "resultCode", + "type": "string" + }, + { + "name": "verification", + "baseName": "verification", + "type": "KYCVerificationResult2" + }, + { + "name": "verificationProfile", + "baseName": "verificationProfile", + "type": "string" + } ]; + + static getAttributeTypeMap() { + return UpdateAccountHolderResponse.attributeTypeMap; + } +} + +export namespace UpdateAccountHolderResponse { + export enum LegalEntityEnum { + Business = 'Business', + Individual = 'Individual', + NonProfit = 'NonProfit', + Partnership = 'Partnership', + PublicCompany = 'PublicCompany' + } +} diff --git a/src/typings/platformsAccount/updateAccountHolderStateRequest.ts b/src/typings/platformsAccount/updateAccountHolderStateRequest.ts new file mode 100644 index 0000000..977e79d --- /dev/null +++ b/src/typings/platformsAccount/updateAccountHolderStateRequest.ts @@ -0,0 +1,69 @@ +/** + * Adyen for Platforms: Account API + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don\'t have one, contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@MarketPlace.YourMarketPlace\":\"YourWsPassword\" \\ -H \"Content-Type: application/json\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder ``` + * + * The version of the OpenAPI document: 6 + * Contact: developer-experience@adyen.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +export class UpdateAccountHolderStateRequest { + /** + * The code of the Account Holder on which to update the state. + */ + 'accountHolderCode': string; + /** + * If true, disable the requested state. If false, enable the requested state. + */ + 'disable': boolean; + /** + * The reason that the state is being updated. >Required if the state is being disabled. + */ + 'reason'?: string; + /** + * The state to be updated. >Permitted values are: `Processing`, `Payout` + */ + 'stateType': UpdateAccountHolderStateRequest.StateTypeEnum; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "accountHolderCode", + "baseName": "accountHolderCode", + "type": "string" + }, + { + "name": "disable", + "baseName": "disable", + "type": "boolean" + }, + { + "name": "reason", + "baseName": "reason", + "type": "string" + }, + { + "name": "stateType", + "baseName": "stateType", + "type": "UpdateAccountHolderStateRequest.StateTypeEnum" + } ]; + + static getAttributeTypeMap() { + return UpdateAccountHolderStateRequest.attributeTypeMap; + } +} + +export namespace UpdateAccountHolderStateRequest { + export enum StateTypeEnum { + LimitedPayout = 'LimitedPayout', + LimitedProcessing = 'LimitedProcessing', + LimitlessPayout = 'LimitlessPayout', + LimitlessProcessing = 'LimitlessProcessing', + Payout = 'Payout', + Processing = 'Processing' + } +} diff --git a/src/typings/platformsAccount/updateAccountRequest.ts b/src/typings/platformsAccount/updateAccountRequest.ts new file mode 100644 index 0000000..c4737c4 --- /dev/null +++ b/src/typings/platformsAccount/updateAccountRequest.ts @@ -0,0 +1,92 @@ +/** + * Adyen for Platforms: Account API + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don\'t have one, contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@MarketPlace.YourMarketPlace\":\"YourWsPassword\" \\ -H \"Content-Type: application/json\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder ``` + * + * The version of the OpenAPI document: 6 + * Contact: developer-experience@adyen.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +import {UpdatePayoutScheduleRequest} from './updatePayoutScheduleRequest'; + +export class UpdateAccountRequest { + /** + * The code of the account to update. + */ + 'accountCode': string; + /** + * The bankAccountUUID of the bank account held by the account holder to couple the account with. Scheduled payouts in currencies matching the currency of this bank account will be sent to this bank account. Payouts in different currencies will be sent to a matching bank account of the account holder. + */ + 'bankAccountUUID'?: string; + /** + * A description of the account, maximum 256 characters.You can use alphanumeric characters (A-Z, a-z, 0-9), white spaces, and underscores `_`. + */ + 'description'?: string; + /** + * A set of key and value pairs for general use by the merchant. The keys do not have specific names and may be used for storing miscellaneous data as desired. > Note that during an update of metadata, the omission of existing key-value pairs will result in the deletion of those key-value pairs. + */ + 'metadata'?: { [key: string]: string; }; + /** + * The payout method code held by the account holder to couple the account with. Scheduled card payouts will be sent using this payout method code. + */ + 'payoutMethodCode'?: string; + 'payoutSchedule'?: UpdatePayoutScheduleRequest; + /** + * Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`. + */ + 'payoutSpeed'?: UpdateAccountRequest.PayoutSpeedEnum; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "accountCode", + "baseName": "accountCode", + "type": "string" + }, + { + "name": "bankAccountUUID", + "baseName": "bankAccountUUID", + "type": "string" + }, + { + "name": "description", + "baseName": "description", + "type": "string" + }, + { + "name": "metadata", + "baseName": "metadata", + "type": "{ [key: string]: string; }" + }, + { + "name": "payoutMethodCode", + "baseName": "payoutMethodCode", + "type": "string" + }, + { + "name": "payoutSchedule", + "baseName": "payoutSchedule", + "type": "UpdatePayoutScheduleRequest" + }, + { + "name": "payoutSpeed", + "baseName": "payoutSpeed", + "type": "UpdateAccountRequest.PayoutSpeedEnum" + } ]; + + static getAttributeTypeMap() { + return UpdateAccountRequest.attributeTypeMap; + } +} + +export namespace UpdateAccountRequest { + export enum PayoutSpeedEnum { + Instant = 'INSTANT', + SameDay = 'SAME_DAY', + Standard = 'STANDARD' + } +} diff --git a/src/typings/platformsAccount/updateAccountResponse.ts b/src/typings/platformsAccount/updateAccountResponse.ts new file mode 100644 index 0000000..07f81cd --- /dev/null +++ b/src/typings/platformsAccount/updateAccountResponse.ts @@ -0,0 +1,120 @@ +/** + * Adyen for Platforms: Account API + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don\'t have one, contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@MarketPlace.YourMarketPlace\":\"YourWsPassword\" \\ -H \"Content-Type: application/json\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder ``` + * + * The version of the OpenAPI document: 6 + * Contact: developer-experience@adyen.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +import {ErrorFieldType} from './errorFieldType'; +import {PayoutScheduleResponse} from './payoutScheduleResponse'; + +export class UpdateAccountResponse { + /** + * The code of the account. + */ + 'accountCode': string; + /** + * The bankAccountUUID of the bank account held by the account holder to couple the account with. Scheduled payouts in currencies matching the currency of this bank account will be sent to this bank account. Payouts in different currencies will be sent to a matching bank account of the account holder. + */ + 'bankAccountUUID'?: string; + /** + * The description of the account. + */ + 'description'?: string; + /** + * A list of fields that caused the `/updateAccount` request to fail. + */ + 'invalidFields'?: Array; + /** + * A set of key and value pairs containing metadata. + */ + 'metadata'?: { [key: string]: string; }; + /** + * The payout method code held by the account holder to couple the account with. Scheduled card payouts will be sent using this payout method code. + */ + 'payoutMethodCode'?: string; + 'payoutSchedule'?: PayoutScheduleResponse; + /** + * Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`. + */ + 'payoutSpeed'?: UpdateAccountResponse.PayoutSpeedEnum; + /** + * The reference of a request. Can be used to uniquely identify the request. + */ + 'pspReference'?: string; + /** + * The result code. + */ + 'resultCode'?: string; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "accountCode", + "baseName": "accountCode", + "type": "string" + }, + { + "name": "bankAccountUUID", + "baseName": "bankAccountUUID", + "type": "string" + }, + { + "name": "description", + "baseName": "description", + "type": "string" + }, + { + "name": "invalidFields", + "baseName": "invalidFields", + "type": "Array" + }, + { + "name": "metadata", + "baseName": "metadata", + "type": "{ [key: string]: string; }" + }, + { + "name": "payoutMethodCode", + "baseName": "payoutMethodCode", + "type": "string" + }, + { + "name": "payoutSchedule", + "baseName": "payoutSchedule", + "type": "PayoutScheduleResponse" + }, + { + "name": "payoutSpeed", + "baseName": "payoutSpeed", + "type": "UpdateAccountResponse.PayoutSpeedEnum" + }, + { + "name": "pspReference", + "baseName": "pspReference", + "type": "string" + }, + { + "name": "resultCode", + "baseName": "resultCode", + "type": "string" + } ]; + + static getAttributeTypeMap() { + return UpdateAccountResponse.attributeTypeMap; + } +} + +export namespace UpdateAccountResponse { + export enum PayoutSpeedEnum { + Instant = 'INSTANT', + SameDay = 'SAME_DAY', + Standard = 'STANDARD' + } +} diff --git a/src/typings/platformsAccount/updatePayoutScheduleRequest.ts b/src/typings/platformsAccount/updatePayoutScheduleRequest.ts new file mode 100644 index 0000000..c7b5c27 --- /dev/null +++ b/src/typings/platformsAccount/updatePayoutScheduleRequest.ts @@ -0,0 +1,75 @@ +/** + * Adyen for Platforms: Account API + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don\'t have one, contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@MarketPlace.YourMarketPlace\":\"YourWsPassword\" \\ -H \"Content-Type: application/json\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder ``` + * + * The version of the OpenAPI document: 6 + * Contact: developer-experience@adyen.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +export class UpdatePayoutScheduleRequest { + /** + * Direction on how to handle any payouts that have already been scheduled. Permitted values: * `CLOSE` will close the existing batch of payouts. * `UPDATE` will reschedule the existing batch to the new schedule. * `NOTHING` (**default**) will allow the payout to proceed. + */ + 'action'?: UpdatePayoutScheduleRequest.ActionEnum; + /** + * The reason for the payout schedule update. > This field is required when the `schedule` parameter is set to `HOLD`. + */ + 'reason'?: string; + /** + * The payout schedule to which the account is to be updated. Permitted values: `DEFAULT`, `HOLD`, `DAILY`, `WEEKLY`, `MONTHLY`. `HOLD` will prevent scheduled payouts from happening but will still allow manual payouts to occur. + */ + 'schedule': UpdatePayoutScheduleRequest.ScheduleEnum; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "action", + "baseName": "action", + "type": "UpdatePayoutScheduleRequest.ActionEnum" + }, + { + "name": "reason", + "baseName": "reason", + "type": "string" + }, + { + "name": "schedule", + "baseName": "schedule", + "type": "UpdatePayoutScheduleRequest.ScheduleEnum" + } ]; + + static getAttributeTypeMap() { + return UpdatePayoutScheduleRequest.attributeTypeMap; + } +} + +export namespace UpdatePayoutScheduleRequest { + export enum ActionEnum { + Close = 'CLOSE', + Nothing = 'NOTHING', + Update = 'UPDATE' + } + export enum ScheduleEnum { + BiweeklyOn1StAnd15ThAtMidnight = 'BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT', + BiweeklyOn1StAnd15ThAtNoon = 'BIWEEKLY_ON_1ST_AND_15TH_AT_NOON', + Daily = 'DAILY', + Daily6Pm = 'DAILY_6PM', + DailyAu = 'DAILY_AU', + DailyEu = 'DAILY_EU', + DailySg = 'DAILY_SG', + DailyUs = 'DAILY_US', + Default = 'DEFAULT', + Every6HoursFromMidnight = 'EVERY_6_HOURS_FROM_MIDNIGHT', + Hold = 'HOLD', + Monthly = 'MONTHLY', + MonthlyOn15ThAtMidnight = 'MONTHLY_ON_15TH_AT_MIDNIGHT', + Weekly = 'WEEKLY', + WeeklyOnTueFriMidnight = 'WEEKLY_ON_TUE_FRI_MIDNIGHT', + Yearly = 'YEARLY' + } +} diff --git a/src/typings/platformsAccount/uploadDocumentRequest.ts b/src/typings/platformsAccount/uploadDocumentRequest.ts new file mode 100644 index 0000000..483ccd5 --- /dev/null +++ b/src/typings/platformsAccount/uploadDocumentRequest.ts @@ -0,0 +1,40 @@ +/** + * Adyen for Platforms: Account API + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don\'t have one, contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@MarketPlace.YourMarketPlace\":\"YourWsPassword\" \\ -H \"Content-Type: application/json\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder ``` + * + * The version of the OpenAPI document: 6 + * Contact: developer-experience@adyen.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +import {DocumentDetail} from './documentDetail'; + +export class UploadDocumentRequest { + /** + * The content of the document, in Base64-encoded string format. To learn about document requirements, refer to [Verification checks](https://docs.adyen.com/platforms/verification-checks). + */ + 'documentContent': string; + 'documentDetail': DocumentDetail; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "documentContent", + "baseName": "documentContent", + "type": "string" + }, + { + "name": "documentDetail", + "baseName": "documentDetail", + "type": "DocumentDetail" + } ]; + + static getAttributeTypeMap() { + return UploadDocumentRequest.attributeTypeMap; + } +} + diff --git a/src/typings/platformsAccount/viasAddress.ts b/src/typings/platformsAccount/viasAddress.ts new file mode 100644 index 0000000..880cc56 --- /dev/null +++ b/src/typings/platformsAccount/viasAddress.ts @@ -0,0 +1,77 @@ +/** + * Adyen for Platforms: Account API + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don\'t have one, contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@MarketPlace.YourMarketPlace\":\"YourWsPassword\" \\ -H \"Content-Type: application/json\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder ``` + * + * The version of the OpenAPI document: 6 + * Contact: developer-experience@adyen.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +export class ViasAddress { + /** + * The name of the city. >Required if either `houseNumberOrName`, `street`, `postalCode`, or `stateOrProvince` are provided. + */ + 'city'?: string; + /** + * The two-character country code of the address. The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. \'NL\'). > If you don\'t know the country or are not collecting the country from the shopper, provide `country` as `ZZ`. + */ + 'country': string; + /** + * The number or name of the house. + */ + 'houseNumberOrName'?: string; + /** + * The postal code. >A maximum of five (5) digits for an address in the USA, or a maximum of ten (10) characters for an address in all other countries. >Required if either `houseNumberOrName`, `street`, `city`, or `stateOrProvince` are provided. + */ + 'postalCode'?: string; + /** + * The abbreviation of the state or province. >Two (2) characters for an address in the USA or Canada, or a maximum of three (3) characters for an address in all other countries. >Required for an address in the USA or Canada if either `houseNumberOrName`, `street`, `city`, or `postalCode` are provided. + */ + 'stateOrProvince'?: string; + /** + * The name of the street. >The house number should not be included in this field; it should be separately provided via `houseNumberOrName`. >Required if either `houseNumberOrName`, `city`, `postalCode`, or `stateOrProvince` are provided. + */ + 'street'?: string; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "city", + "baseName": "city", + "type": "string" + }, + { + "name": "country", + "baseName": "country", + "type": "string" + }, + { + "name": "houseNumberOrName", + "baseName": "houseNumberOrName", + "type": "string" + }, + { + "name": "postalCode", + "baseName": "postalCode", + "type": "string" + }, + { + "name": "stateOrProvince", + "baseName": "stateOrProvince", + "type": "string" + }, + { + "name": "street", + "baseName": "street", + "type": "string" + } ]; + + static getAttributeTypeMap() { + return ViasAddress.attributeTypeMap; + } +} + diff --git a/src/typings/platformsAccount/viasName.ts b/src/typings/platformsAccount/viasName.ts new file mode 100644 index 0000000..9d8a0e6 --- /dev/null +++ b/src/typings/platformsAccount/viasName.ts @@ -0,0 +1,66 @@ +/** + * Adyen for Platforms: Account API + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don\'t have one, contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@MarketPlace.YourMarketPlace\":\"YourWsPassword\" \\ -H \"Content-Type: application/json\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder ``` + * + * The version of the OpenAPI document: 6 + * Contact: developer-experience@adyen.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +export class ViasName { + /** + * The first name. + */ + 'firstName': string; + /** + * The gender. >The following values are permitted: `MALE`, `FEMALE`, `UNKNOWN`. + */ + 'gender'?: ViasName.GenderEnum; + /** + * The name\'s infix, if applicable. >A maximum length of twenty (20) characters is imposed. + */ + 'infix'?: string; + /** + * The last name. + */ + 'lastName': string; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "firstName", + "baseName": "firstName", + "type": "string" + }, + { + "name": "gender", + "baseName": "gender", + "type": "ViasName.GenderEnum" + }, + { + "name": "infix", + "baseName": "infix", + "type": "string" + }, + { + "name": "lastName", + "baseName": "lastName", + "type": "string" + } ]; + + static getAttributeTypeMap() { + return ViasName.attributeTypeMap; + } +} + +export namespace ViasName { + export enum GenderEnum { + Male = 'MALE', + Female = 'FEMALE', + Unknown = 'UNKNOWN' + } +} diff --git a/src/typings/platformsAccount/viasPersonalData.ts b/src/typings/platformsAccount/viasPersonalData.ts new file mode 100644 index 0000000..2e9728c --- /dev/null +++ b/src/typings/platformsAccount/viasPersonalData.ts @@ -0,0 +1,52 @@ +/** + * Adyen for Platforms: Account API + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don\'t have one, contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@MarketPlace.YourMarketPlace\":\"YourWsPassword\" \\ -H \"Content-Type: application/json\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder ``` + * + * The version of the OpenAPI document: 6 + * Contact: developer-experience@adyen.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +import {PersonalDocumentData} from './personalDocumentData'; + +export class ViasPersonalData { + /** + * The person\'s date of birth, in ISO-8601 YYYY-MM-DD format. For example, **2000-01-31**. + */ + 'dateOfBirth'?: string; + /** + * Array that contains information about the person\'s identification document. You can submit only one entry per document type. + */ + 'documentData'?: Array; + /** + * The nationality of the person represented by a two-character country code, in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. For example, **NL**. + */ + 'nationality'?: string; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "dateOfBirth", + "baseName": "dateOfBirth", + "type": "string" + }, + { + "name": "documentData", + "baseName": "documentData", + "type": "Array" + }, + { + "name": "nationality", + "baseName": "nationality", + "type": "string" + } ]; + + static getAttributeTypeMap() { + return ViasPersonalData.attributeTypeMap; + } +} + diff --git a/src/typings/platformsAccount/viasPhoneNumber.ts b/src/typings/platformsAccount/viasPhoneNumber.ts new file mode 100644 index 0000000..207586f --- /dev/null +++ b/src/typings/platformsAccount/viasPhoneNumber.ts @@ -0,0 +1,58 @@ +/** + * Adyen for Platforms: Account API + * The Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and KYC-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them. For more information, refer to our [documentation](https://docs.adyen.com/platforms). ## Authentication To connect to the Account API, you must use basic authentication credentials of your web service user. If you don\'t have one, contact the [Adyen Support Team](https://support.adyen.com/hc/en-us/requests/new). Then use its credentials to authenticate your request, for example: ``` curl -U \"ws@MarketPlace.YourMarketPlace\":\"YourWsPassword\" \\ -H \"Content-Type: application/json\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Account API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder ``` + * + * The version of the OpenAPI document: 6 + * Contact: developer-experience@adyen.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +export class ViasPhoneNumber { + /** + * The two-character country code of the phone number. >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. \'NL\'). + */ + 'phoneCountryCode': string; + /** + * The phone number. >The inclusion of the phone number country code is not necessary. + */ + 'phoneNumber': string; + /** + * The type of the phone number. >The following values are permitted: `Landline`, `Mobile`, `SIP`, `Fax`. + */ + 'phoneType'?: ViasPhoneNumber.PhoneTypeEnum; + + static discriminator: string | undefined = undefined; + + static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [ + { + "name": "phoneCountryCode", + "baseName": "phoneCountryCode", + "type": "string" + }, + { + "name": "phoneNumber", + "baseName": "phoneNumber", + "type": "string" + }, + { + "name": "phoneType", + "baseName": "phoneType", + "type": "ViasPhoneNumber.PhoneTypeEnum" + } ]; + + static getAttributeTypeMap() { + return ViasPhoneNumber.attributeTypeMap; + } +} + +export namespace ViasPhoneNumber { + export enum PhoneTypeEnum { + Fax = 'Fax', + Landline = 'Landline', + Mobile = 'Mobile', + Sip = 'SIP' + } +} diff --git a/yarn.lock b/yarn.lock index a10dff0..38bab14 100644 --- a/yarn.lock +++ b/yarn.lock @@ -508,14 +508,14 @@ dependencies: "@octokit/types" "^6.0.3" -"@octokit/core@^3.2.3": - version "3.4.0" - resolved "https://registry.yarnpkg.com/@octokit/core/-/core-3.4.0.tgz#b48aa27d755b339fe7550548b340dcc2b513b742" - integrity sha512-6/vlKPP8NF17cgYXqucdshWqmMZGXkuvtcrWCgU5NOI0Pl2GjlmZyWgBMrU8zJ3v2MJlM6++CiB45VKYmhiWWg== +"@octokit/core@^3.5.0": + version "3.5.1" + resolved "https://registry.yarnpkg.com/@octokit/core/-/core-3.5.1.tgz#8601ceeb1ec0e1b1b8217b960a413ed8e947809b" + integrity sha512-omncwpLVxMP+GLpLPgeGJBF6IWJFjXDS5flY5VbppePYX9XehevbDykRH9PdCdvqt9TS5AOTiDide7h0qrkHjw== dependencies: "@octokit/auth-token" "^2.4.4" "@octokit/graphql" "^4.5.8" - "@octokit/request" "^5.4.12" + "@octokit/request" "^5.6.0" "@octokit/request-error" "^2.0.5" "@octokit/types" "^6.0.3" before-after-hook "^2.2.0" @@ -544,10 +544,10 @@ resolved "https://registry.yarnpkg.com/@octokit/openapi-types/-/openapi-types-6.1.0.tgz#cf0f859f9a4833b7fa5141b53e1d62d5d1cbc78f" integrity sha512-Z9fDZVbGj4dFLErEoXUSuZhk3wJ8KVGnbrUwoPijsQ9EyNwOeQ+U2jSqaHUz8WtgIWf0aeO59oJyhMpWCKaabg== -"@octokit/openapi-types@^7.0.0": - version "7.0.0" - resolved "https://registry.yarnpkg.com/@octokit/openapi-types/-/openapi-types-7.0.0.tgz#0f6992db9854af15eca77d71ab0ec7fad2f20411" - integrity sha512-gV/8DJhAL/04zjTI95a7FhQwS6jlEE0W/7xeYAzuArD0KVAVWDLP2f3vi98hs3HLTczxXdRK/mF0tRoQPpolEw== +"@octokit/openapi-types@^7.3.2": + version "7.3.2" + resolved "https://registry.yarnpkg.com/@octokit/openapi-types/-/openapi-types-7.3.2.tgz#065ce49b338043ec7f741316ce06afd4d459d944" + integrity sha512-oJhK/yhl9Gt430OrZOzAl2wJqR0No9445vmZ9Ey8GjUZUpwuu/vmEFP0TDhDXdpGDoxD6/EIFHJEcY8nHXpDTA== "@octokit/plugin-paginate-rest@^2.6.2": version "2.13.3" @@ -561,12 +561,12 @@ resolved "https://registry.yarnpkg.com/@octokit/plugin-request-log/-/plugin-request-log-1.0.3.tgz#70a62be213e1edc04bb8897ee48c311482f9700d" integrity sha512-4RFU4li238jMJAzLgAwkBAw+4Loile5haQMQr+uhFq27BmyJXcXSKvoQKqh0agsZEiUlW6iSv3FAgvmGkur7OQ== -"@octokit/plugin-rest-endpoint-methods@5.0.1": - version "5.0.1" - resolved "https://registry.yarnpkg.com/@octokit/plugin-rest-endpoint-methods/-/plugin-rest-endpoint-methods-5.0.1.tgz#631b8d4edc6798b03489911252a25f2a4e58c594" - integrity sha512-vvWbPtPqLyIzJ7A4IPdTl+8IeuKAwMJ4LjvmqWOOdfSuqWQYZXq2CEd0hsnkidff2YfKlguzujHs/reBdAx8Sg== +"@octokit/plugin-rest-endpoint-methods@5.3.1": + version "5.3.1" + resolved "https://registry.yarnpkg.com/@octokit/plugin-rest-endpoint-methods/-/plugin-rest-endpoint-methods-5.3.1.tgz#deddce769b4ec3179170709ab42e4e9e6195aaa9" + integrity sha512-3B2iguGmkh6bQQaVOtCsS0gixrz8Lg0v4JuXPqBcFqLKuJtxAUf3K88RxMEf/naDOI73spD+goJ/o7Ie7Cvdjg== dependencies: - "@octokit/types" "^6.13.1" + "@octokit/types" "^6.16.2" deprecation "^2.3.1" "@octokit/request-error@^2.0.0": @@ -587,6 +587,15 @@ deprecation "^2.0.0" once "^1.4.0" +"@octokit/request-error@^2.1.0": + version "2.1.0" + resolved "https://registry.yarnpkg.com/@octokit/request-error/-/request-error-2.1.0.tgz#9e150357831bfc788d13a4fd4b1913d60c74d677" + integrity sha512-1VIvgXxs9WHSjicsRwq8PlR2LR2x6DwsJAaFgzdi0JfJoGSO8mYI/cHJQ+9FbN21aa+DrgNLnwObmyeSC8Rmpg== + dependencies: + "@octokit/types" "^6.0.3" + deprecation "^2.0.0" + once "^1.4.0" + "@octokit/request@^5.3.0": version "5.4.9" resolved "https://registry.yarnpkg.com/@octokit/request/-/request-5.4.9.tgz#0a46f11b82351b3416d3157261ad9b1558c43365" @@ -601,27 +610,27 @@ once "^1.4.0" universal-user-agent "^6.0.0" -"@octokit/request@^5.4.12": - version "5.4.15" - resolved "https://registry.yarnpkg.com/@octokit/request/-/request-5.4.15.tgz#829da413dc7dd3aa5e2cdbb1c7d0ebe1f146a128" - integrity sha512-6UnZfZzLwNhdLRreOtTkT9n57ZwulCve8q3IT/Z477vThu6snfdkBuhxnChpOKNGxcQ71ow561Qoa6uqLdPtag== +"@octokit/request@^5.6.0": + version "5.6.0" + resolved "https://registry.yarnpkg.com/@octokit/request/-/request-5.6.0.tgz#6084861b6e4fa21dc40c8e2a739ec5eff597e672" + integrity sha512-4cPp/N+NqmaGQwbh3vUsYqokQIzt7VjsgTYVXiwpUP2pxd5YiZB2XuTedbb0SPtv9XS7nzAKjAuQxmY8/aZkiA== dependencies: "@octokit/endpoint" "^6.0.1" - "@octokit/request-error" "^2.0.0" - "@octokit/types" "^6.7.1" + "@octokit/request-error" "^2.1.0" + "@octokit/types" "^6.16.1" is-plain-object "^5.0.0" node-fetch "^2.6.1" universal-user-agent "^6.0.0" -"@octokit/rest@18.5.3": - version "18.5.3" - resolved "https://registry.yarnpkg.com/@octokit/rest/-/rest-18.5.3.tgz#6a2e6006a87ebbc34079c419258dd29ec9ff659d" - integrity sha512-KPAsUCr1DOdLVbZJgGNuE/QVLWEaVBpFQwDAz/2Cnya6uW2wJ/P5RVGk0itx7yyN1aGa8uXm2pri4umEqG1JBA== +"@octokit/rest@18.6.0": + version "18.6.0" + resolved "https://registry.yarnpkg.com/@octokit/rest/-/rest-18.6.0.tgz#9a8457374c78c2773d3ab3f50aaffc62f3ed4f76" + integrity sha512-MdHuXHDJM7e5sUBe3K9tt7th0cs4csKU5Bb52LRi2oHAeIMrMZ4XqaTrEv660HoUPoM1iDlnj27Ab/Nh3MtwlA== dependencies: - "@octokit/core" "^3.2.3" + "@octokit/core" "^3.5.0" "@octokit/plugin-paginate-rest" "^2.6.2" "@octokit/plugin-request-log" "^1.0.2" - "@octokit/plugin-rest-endpoint-methods" "5.0.1" + "@octokit/plugin-rest-endpoint-methods" "5.3.1" "@octokit/types@^5.0.0", "@octokit/types@^5.0.1": version "5.5.0" @@ -630,19 +639,19 @@ dependencies: "@types/node" ">= 8" -"@octokit/types@^6.0.3", "@octokit/types@^6.11.0", "@octokit/types@^6.7.1": +"@octokit/types@^6.0.3", "@octokit/types@^6.11.0": version "6.13.1" resolved "https://registry.yarnpkg.com/@octokit/types/-/types-6.13.1.tgz#85f447f97dc7edb672f221df51f56a51785c131a" integrity sha512-UF/PL0y4SKGx/p1azFf7e6j9lB78tVwAFvnHtslzOJ6VipshYks74qm9jjTEDlCyaTmbhbk2h3Run5l0CtCF6A== dependencies: "@octokit/openapi-types" "^6.0.0" -"@octokit/types@^6.13.1": - version "6.14.2" - resolved "https://registry.yarnpkg.com/@octokit/types/-/types-6.14.2.tgz#64c9457f38fb8522bdbba3c8cc814590a2d61bf5" - integrity sha512-wiQtW9ZSy4OvgQ09iQOdyXYNN60GqjCL/UdMsepDr1Gr0QzpW6irIKbH3REuAHXAhxkEk9/F2a3Gcs1P6kW5jA== +"@octokit/types@^6.16.1", "@octokit/types@^6.16.2": + version "6.16.4" + resolved "https://registry.yarnpkg.com/@octokit/types/-/types-6.16.4.tgz#d24f5e1bacd2fe96d61854b5bda0e88cf8288dfe" + integrity sha512-UxhWCdSzloULfUyamfOg4dJxV9B+XjgrIZscI0VCbp4eNrjmorGEw+4qdwcpTsu6DIrm9tQsFQS2pK5QkqQ04A== dependencies: - "@octokit/openapi-types" "^7.0.0" + "@octokit/openapi-types" "^7.3.2" "@sindresorhus/is@^0.14.0": version "0.14.0" @@ -920,9 +929,9 @@ acorn@^7.1.0, acorn@^7.1.1: integrity sha512-+G7P8jJmCHr+S+cLfQxygbWhXy+8YTVGzAkpEbcLo2mLoL7tij/VG41QSHACSf5QgYRhMZYHuNc6drJaO0Da+w== acorn@^8.0.1: - version "8.3.0" - resolved "https://registry.yarnpkg.com/acorn/-/acorn-8.3.0.tgz#1193f9b96c4e8232f00b11a9edff81b2c8b98b88" - integrity sha512-tqPKHZ5CaBJw0Xmy0ZZvLs1qTV+BNFSyvn77ASXkpBNfIRk8ev26fKrD9iLGwGA9zedPao52GSHzq8lyZG0NUw== + version "8.4.1" + resolved "https://registry.yarnpkg.com/acorn/-/acorn-8.4.1.tgz#56c36251fc7cabc7096adc18f05afe814321a28c" + integrity sha512-asabaBSkEKosYKMITunzX177CXxQ4Q8BSSzMTKD+FefUhipQC70gfW5SiUDhYQ3vk8G+81HqQk7Fv9OXwwn9KA== agent-base@6: version "6.0.1" @@ -1488,9 +1497,9 @@ color-name@^1.0.0, color-name@~1.1.4: integrity sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA== color-string@^1.5.2: - version "1.5.3" - resolved "https://registry.yarnpkg.com/color-string/-/color-string-1.5.3.tgz#c9bbc5f01b58b5492f3d6857459cb6590ce204cc" - integrity sha512-dC2C5qeWoYkxki5UAXapdjqO672AM4vZuPGRQfO8b5HKuKGBbKWpITyDYN7TOFKvRW7kOgAn3746clDBMDJyQw== + version "1.5.5" + resolved "https://registry.yarnpkg.com/color-string/-/color-string-1.5.5.tgz#65474a8f0e7439625f3d27a6a19d89fc45223014" + integrity sha512-jgIoum0OfQfq9Whcfc2z/VhCNcmQjWbey6qBX0vqt7YICflUmBCh9E9CiQD5GSJ+Uehixm3NUwHVhqUAWRivZg== dependencies: color-name "^1.0.0" simple-swizzle "^0.2.2" @@ -2003,10 +2012,10 @@ exec-sh@^0.3.2: resolved "https://registry.yarnpkg.com/exec-sh/-/exec-sh-0.3.4.tgz#3a018ceb526cc6f6df2bb504b2bfe8e3a4934ec5" integrity sha512-sEFIkc61v75sWeOe72qyrqg2Qg0OuLESziUDk/O/z2qgS15y2gWVFrI6f2Qn/qw/0/NCfCEsmNA4zOjkwEZT1A== -execa@5.0.0: - version "5.0.0" - resolved "https://registry.yarnpkg.com/execa/-/execa-5.0.0.tgz#4029b0007998a841fbd1032e5f4de86a3c1e3376" - integrity sha512-ov6w/2LCiuyO4RLYGdpFGjkcs0wMTgGE8PrkTHikeUy5iJekXyPIKUjifk5CsE0pt7sMCrMZ3YNqoCj6idQOnQ== +execa@5.1.1: + version "5.1.1" + resolved "https://registry.yarnpkg.com/execa/-/execa-5.1.1.tgz#f80ad9cbf4298f7bd1d4c9555c21e93741c411dd" + integrity sha512-8uSpZZocAZRBAPIEINJj3Lo9HyGitllczc27Eh5YYojjMFMn8yHMDMaUHE2Jqfq05D/wucwI4JGURyXt1vchyg== dependencies: cross-spawn "^7.0.3" get-stream "^6.0.0" @@ -2379,9 +2388,9 @@ git-url-parse@11.4.4: git-up "^4.0.0" glob-parent@^5.0.0, glob-parent@^5.1.0: - version "5.1.1" - resolved "https://registry.yarnpkg.com/glob-parent/-/glob-parent-5.1.1.tgz#b6c1ef417c4e5663ea498f1c45afac6916bbc229" - integrity sha512-FnI+VGOpnlGHWZxthPGR+QhR78fuiK0sNLkHQv+bL9fQi57lNNdquIbna/WrfROrolq8GK5Ek6BiMwqL/voRYQ== + version "5.1.2" + resolved "https://registry.yarnpkg.com/glob-parent/-/glob-parent-5.1.2.tgz#869832c58034fe68a4093c17dc15e8340d8401c4" + integrity sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow== dependencies: is-glob "^4.0.1" @@ -2416,10 +2425,10 @@ globals@^12.1.0: dependencies: type-fest "^0.8.1" -globby@11.0.3: - version "11.0.3" - resolved "https://registry.yarnpkg.com/globby/-/globby-11.0.3.tgz#9b1f0cb523e171dd1ad8c7b2a9fb4b644b9593cb" - integrity sha512-ffdmosjA807y7+lA1NM0jELARVmYul/715xiILEjo3hBLPTcirgQNnXECn5g3mtR8TOLCVbkfua1Hpen25/Xcg== +globby@11.0.4: + version "11.0.4" + resolved "https://registry.yarnpkg.com/globby/-/globby-11.0.4.tgz#2cbaff77c2f2a62e71e9b2813a67b97a3a3001a5" + integrity sha512-9O4MVG9ioZJ08ffbcyVYyLOJLk5JQ688pJ4eMGLpdWLHq/Wr1D9BlriLQyL0E+jbkuePVZXYFj47QM/v093wHg== dependencies: array-union "^2.1.0" dir-glob "^3.0.1" @@ -2673,10 +2682,10 @@ ini@~1.3.0: resolved "https://registry.yarnpkg.com/ini/-/ini-1.3.7.tgz#a09363e1911972ea16d7a8851005d84cf09a9a84" integrity sha512-iKpRpXP+CrP2jyrxvg1kMUpXDyRUFDWurxbnVT1vQPx+Wz9uCYsMIqYuSBLV+PAaZG/d7kRLKRFc9oDMsH+mFQ== -inquirer@8.1.0: - version "8.1.0" - resolved "https://registry.yarnpkg.com/inquirer/-/inquirer-8.1.0.tgz#68ce5ce5376cf0e89765c993d8b7c1e62e184d69" - integrity sha512-1nKYPoalt1vMBfCMtpomsUc32wmOoWXAoq3kM/5iTfxyQ2f/BxjixQpC+mbZ7BI0JUXHED4/XPXekDVtJNpXYw== +inquirer@8.1.1: + version "8.1.1" + resolved "https://registry.yarnpkg.com/inquirer/-/inquirer-8.1.1.tgz#7c53d94c6d03011c7bb2a947f0dca3b98246c26a" + integrity sha512-hUDjc3vBkh/uk1gPfMAD/7Z188Q8cvTGl0nxwaCdwSbzFh6ZKkZh+s2ozVxbE5G9ZNRyeY0+lgbAIOUFsFf98w== dependencies: ansi-escapes "^4.2.1" chalk "^4.1.1" @@ -3758,17 +3767,17 @@ micromatch@^3.1.4: snapdragon "^0.8.1" to-regex "^3.0.2" -mime-db@1.47.0: - version "1.47.0" - resolved "https://registry.yarnpkg.com/mime-db/-/mime-db-1.47.0.tgz#8cb313e59965d3c05cfbf898915a267af46a335c" - integrity sha512-QBmA/G2y+IfeS4oktet3qRZ+P5kPhCKRXxXnQEudYqUaEioAU1/Lq2us3D/t1Jfo4hE9REQPrbB7K5sOczJVIw== +mime-db@1.48.0: + version "1.48.0" + resolved "https://registry.yarnpkg.com/mime-db/-/mime-db-1.48.0.tgz#e35b31045dd7eada3aaad537ed88a33afbef2d1d" + integrity sha512-FM3QwxV+TnZYQ2aRqhlKBMHxk10lTbMt3bBkMAp54ddrNeVSfcQYOOKuGuy3Ddrm38I04If834fOUSq1yzslJQ== -mime-types@2.1.30, mime-types@^2.1.12, mime-types@~2.1.19: - version "2.1.30" - resolved "https://registry.yarnpkg.com/mime-types/-/mime-types-2.1.30.tgz#6e7be8b4c479825f85ed6326695db73f9305d62d" - integrity sha512-crmjA4bLtR8m9qLpHvgxSChT+XoSlZi8J4n/aIdn3z92e/U47Z0V/yl+Wh9W046GgFVAmoNR/fmdbZYcSSIUeg== +mime-types@2.1.31, mime-types@^2.1.12, mime-types@~2.1.19: + version "2.1.31" + resolved "https://registry.yarnpkg.com/mime-types/-/mime-types-2.1.31.tgz#a00d76b74317c61f9c2db2218b8e9f8e9c5c9e6b" + integrity sha512-XGZnNzm3QvgKxa8dpzyhFTHmpP3l5YNusmne07VUOXxou9CqUqYa/HBy124RqtVh/O2pECas/MOcsDgpilPOPg== dependencies: - mime-db "1.47.0" + mime-db "1.48.0" mimic-fn@^2.1.0: version "2.1.0" @@ -4002,10 +4011,10 @@ optionator@^0.8.1, optionator@^0.8.3: type-check "~0.3.2" word-wrap "~1.2.3" -ora@5.4.0, ora@^5.3.0: - version "5.4.0" - resolved "https://registry.yarnpkg.com/ora/-/ora-5.4.0.tgz#42eda4855835b9cd14d33864c97a3c95a3f56bf4" - integrity sha512-1StwyXQGoU6gdjYkyVcqOLnVlbKj+6yPNNOxJVgpt9t4eksKjiriiHuxktLYkgllwk+D6MbC4ihH84L1udRXPg== +ora@5.4.1, ora@^5.3.0: + version "5.4.1" + resolved "https://registry.yarnpkg.com/ora/-/ora-5.4.1.tgz#1b2678426af4ac4a509008e5e4ac9e9959db9e18" + integrity sha512-5b6Y85tPxZZ7QytO+BQzysW31HJku27cRIlkbAXaNx+BdcVi+LlRFmVXzeF6a7JCwJpyw5c4b+YSVImQIrBpuQ== dependencies: bl "^4.1.0" chalk "^4.1.0" @@ -4405,30 +4414,30 @@ registry-url@^5.0.0: dependencies: rc "^1.2.8" -release-it@14.7.0: - version "14.7.0" - resolved "https://registry.yarnpkg.com/release-it/-/release-it-14.7.0.tgz#57c63bee1ea668e5186f7fd018d88fbd01120ada" - integrity sha512-g8z6BR7qsO1r0HtS4rquRU5PmwHrIZ5jYTuaaa1ZSLrh91Nm23PBpHR/0jsA549Qzujj4W/mkeskoAAIvHugWQ== +release-it@14.10.0: + version "14.10.0" + resolved "https://registry.yarnpkg.com/release-it/-/release-it-14.10.0.tgz#2ad9aa5357f257ee92d4c632a0c64dfe8286bff0" + integrity sha512-BwL7W3VPILma+MwO2kEtZaAL0/G/mZafg4xgpfxy4MVxLd+28lBp22EDF2gS4GXHmcblawyV2IdbWo/56QIyJw== dependencies: "@iarna/toml" "2.2.5" - "@octokit/rest" "18.5.3" + "@octokit/rest" "18.6.0" async-retry "1.3.1" chalk "4.1.1" cosmiconfig "7.0.0" debug "4.3.1" deprecated-obj "2.0.0" - execa "5.0.0" + execa "5.1.1" find-up "5.0.0" form-data "4.0.0" git-url-parse "11.4.4" - globby "11.0.3" + globby "11.0.4" got "11.8.2" import-cwd "3.0.0" - inquirer "8.1.0" + inquirer "8.1.1" is-ci "3.0.0" lodash "4.17.21" - mime-types "2.1.30" - ora "5.4.0" + mime-types "2.1.31" + ora "5.4.1" os-name "4.0.0" parse-json "5.2.0" semver "7.3.5" @@ -5269,10 +5278,10 @@ typedarray-to-buffer@^3.1.5: dependencies: is-typedarray "^1.0.0" -typescript@3.9.9: - version "3.9.9" - resolved "https://registry.yarnpkg.com/typescript/-/typescript-3.9.9.tgz#e69905c54bc0681d0518bd4d587cc6f2d0b1a674" - integrity sha512-kdMjTiekY+z/ubJCATUPlRDl39vXYiMV9iyeMuEuXZh2we6zz80uovNN2WlAxmmdE/Z/YQe+EbOEXB5RHEED3w== +typescript@3.9.10: + version "3.9.10" + resolved "https://registry.yarnpkg.com/typescript/-/typescript-3.9.10.tgz#70f3910ac7a51ed6bef79da7800690b19bf778b8" + integrity sha512-w6fIxVE/H1PkLKcCPsFqKE7Kv7QUwhU8qQY2MueZXWx5cPZdwFupLgKK3vntcK98BtNHZtAF4LA/yl2a7k8R6Q== union-value@^1.0.0: version "1.0.1"