| 1 | # [3.1.0](https://github.com/ideal-postcodes/core-interface/compare/3.0.0...3.1.0) (2022-04-04)
|
| 2 |
|
| 3 |
|
| 4 | ### Features
|
| 5 |
|
| 6 | * **USA:** Resolve addreses in US format ([76aff0c](https://github.com/ideal-postcodes/core-interface/commit/76aff0c9c462c7e53f890d04b48bdd764eab6acd))
|
| 7 |
|
| 8 | # [3.0.0](https://github.com/ideal-postcodes/core-interface/compare/2.0.3...3.0.0) (2022-02-14)
|
| 9 |
|
| 10 |
|
| 11 | ### Features
|
| 12 |
|
| 13 | * **OpenAPI:** Migrate from api-typings to openapi spec ([62c41b2](https://github.com/ideal-postcodes/core-interface/commit/62c41b24a3064f68a5c7216fdc9953ca71d68c27))
|
| 14 | * **Resolve:** Resolve address suggestions ([3c1ad61](https://github.com/ideal-postcodes/core-interface/commit/3c1ad612787ec54a4066c09763aa77f11c0a7da1))
|
| 15 |
|
| 16 |
|
| 17 | ### BREAKING CHANGES
|
| 18 |
|
| 19 | * **OpenAPI:** Core-Interface typings now uses
|
| 20 | @ideal-postcodes/openapi
|
| 21 |
|
| 22 | # [3.0.0-beta.1](https://github.com/ideal-postcodes/core-interface/compare/2.0.3...3.0.0-beta.1) (2022-02-03)
|
| 23 |
|
| 24 |
|
| 25 | ### Features
|
| 26 |
|
| 27 | * **OpenAPI:** Migrate from api-typings to openapi spec ([06ce31d](https://github.com/ideal-postcodes/core-interface/commit/06ce31d6de53b65837fbb30ba44f88d343c51c90))
|
| 28 | * **Resolve:** Resolve address suggestions ([c2cfef7](https://github.com/ideal-postcodes/core-interface/commit/c2cfef7ee4fcc5ec8a66989278f4ab5dbf778723))
|
| 29 |
|
| 30 |
|
| 31 | ### BREAKING CHANGES
|
| 32 |
|
| 33 | * **OpenAPI:** Core-Interface typings now uses
|
| 34 | @ideal-postcodes/openapi
|
| 35 |
|
| 36 | ## [2.0.3](https://github.com/ideal-postcodes/core-interface/compare/2.0.2...2.0.3) (2021-07-23)
|
| 37 |
|
| 38 |
|
| 39 | ### Bug Fixes
|
| 40 |
|
| 41 | * **ESM:** Pin target output to ES2020 ([78a8b74](https://github.com/ideal-postcodes/core-interface/commit/78a8b7464290710b69bb9d9abbff5413cfc7dca6))
|
| 42 |
|
| 43 | ## [2.0.2](https://github.com/ideal-postcodes/core-interface/compare/2.0.1...2.0.2) (2021-07-19)
|
| 44 |
|
| 45 |
|
| 46 | ### Bug Fixes
|
| 47 |
|
| 48 | * **Exports:** Drop namespaced exports ([9717306](https://github.com/ideal-postcodes/core-interface/commit/9717306545d6f61cd15ad7ea313727b3f3fd0446))
|
| 49 | * **Typings:** Move into dependencies ([8caef68](https://github.com/ideal-postcodes/core-interface/commit/8caef684af0fbfdcc705efc541625d1b55ac3f21))
|
| 50 |
|
| 51 | ## [2.0.1](https://github.com/ideal-postcodes/core-interface/compare/2.0.0...2.0.1) (2021-06-04)
|
| 52 |
|
| 53 |
|
| 54 | ### Bug Fixes
|
| 55 |
|
| 56 | * **Client Typings:** Make all but api_key config optional ([716cba1](https://github.com/ideal-postcodes/core-interface/commit/716cba155e4091450abfa82129ac938d61a32edd))
|
| 57 |
|
| 58 | # [2.0.0](https://github.com/ideal-postcodes/core-interface/compare/1.9.0...2.0.0) (2021-06-04)
|
| 59 |
|
| 60 |
|
| 61 | ### Code Refactoring
|
| 62 |
|
| 63 | * **Defaults:** Export `defaults` object ([6b9b698](https://github.com/ideal-postcodes/core-interface/commit/6b9b6981abd517061621436a2afef0f4f62cddb7))
|
| 64 |
|
| 65 |
|
| 66 | ### Features
|
| 67 |
|
| 68 | * **Version 2:** Reduce package size ([cfcae8a](https://github.com/ideal-postcodes/core-interface/commit/cfcae8a7087708820ec0ca1b2d97df3dabd056f5))
|
| 69 |
|
| 70 |
|
| 71 | ### BREAKING CHANGES
|
| 72 |
|
| 73 | * **Version 2:** - Package now exports a `defaults` object
|
| 74 | - Client.defaults has been removed
|
| 75 | - All client config is now stored in `client.config`
|
| 76 | - All resources have been removed from the client. Instead retrieve
|
| 77 | these from the library and inject the client. E.g.
|
| 78 | `client.postcodes.retrieve` becomes `postcodes.retrieve(client, ...)`
|
| 79 | - Helper methods (like lookupPostcode, ping) have been removed from the client.
|
| 80 | Instead retrieve these from teh library and inject the client. E.g.
|
| 81 | `client.lookupPostcode` becomes `lookupPostcode(client, ...)`
|
| 82 | * **Defaults:** Uppercased default variables no longer exported.
|
| 83 | Instead `defaults` object is supplied
|
| 84 |
|
| 85 | # [1.9.0](https://github.com/ideal-postcodes/core-interface/compare/1.8.1...1.9.0) (2021-01-15)
|
| 86 |
|
| 87 |
|
| 88 | ### Features
|
| 89 |
|
| 90 | * **Tagging:** Allow tags to be set by client ([5f40c0f](https://github.com/ideal-postcodes/core-interface/commit/5f40c0f98c8a19b46525d0c29aa9e37a339cf747))
|
| 91 |
|
| 92 | ## [1.8.1](https://github.com/ideal-postcodes/core-interface/compare/1.8.0...1.8.1) (2020-11-27)
|
| 93 |
|
| 94 |
|
| 95 | ### Bug Fixes
|
| 96 |
|
| 97 | * **tsconfig:** Bump tsconfig ([37504cd](https://github.com/ideal-postcodes/core-interface/commit/37504cdc2e4ecf6a610d672bce60cfdbb61a2e86))
|
| 98 |
|
| 99 | # [1.8.0](https://github.com/ideal-postcodes/core-interface/compare/1.7.0...1.8.0) (2020-10-22)
|
| 100 |
|
| 101 |
|
| 102 | ### Features
|
| 103 |
|
| 104 | * **ESM:** Target ESNext in ESM builds ([d44f960](https://github.com/ideal-postcodes/core-interface/commit/d44f960b314a89881b6afd67f9c8f44cc0a7621a))
|
| 105 |
|
| 106 | # [1.7.0](https://github.com/ideal-postcodes/core-interface/compare/1.6.0...1.7.0) (2020-10-21)
|
| 107 |
|
| 108 |
|
| 109 | ### Features
|
| 110 |
|
| 111 | * **ESM:** Publish ESM build ([acf45bb](https://github.com/ideal-postcodes/core-interface/commit/acf45bbac2f4f0b3872115289e1d35071991abae))
|
| 112 |
|
| 113 | # [1.6.0](https://github.com/ideal-postcodes/core-interface/compare/1.5.0...1.6.0) (2020-07-27)
|
| 114 |
|
| 115 |
|
| 116 | ### Features
|
| 117 |
|
| 118 | * **Query:** Allow non-string query attributes ([2de56cb](https://github.com/ideal-postcodes/core-interface/commit/2de56cb1905e04b6376e5a2a4dc52a9b65aff7be))
|
| 119 |
|
| 120 | # [1.5.0](https://github.com/ideal-postcodes/core-interface/compare/1.4.0...1.5.0) (2020-02-05)
|
| 121 |
|
| 122 |
|
| 123 | ### Features
|
| 124 |
|
| 125 | * **Keys:** Add ability to check licensee ([46d1cd6](https://github.com/ideal-postcodes/core-interface/commit/46d1cd63894d37f727ade827cb1a273fab3e3cf8))
|
| 126 |
|
| 127 | # [1.4.0](https://github.com/ideal-postcodes/core-interface/compare/1.3.0...1.4.0) (2019-12-06)
|
| 128 |
|
| 129 |
|
| 130 | ### Bug Fixes
|
| 131 |
|
| 132 | * **Browser Tests:** Migrate to SL ([2b96ae5](https://github.com/ideal-postcodes/core-interface/commit/2b96ae5))
|
| 133 | * **README:** Check against Markdown lint rules and correct grammar ([b210165](https://github.com/ideal-postcodes/core-interface/commit/b210165))
|
| 134 |
|
| 135 |
|
| 136 | ### Features
|
| 137 |
|
| 138 | * **Autocomplete:** Expose autocomplete resource ([b386ce0](https://github.com/ideal-postcodes/core-interface/commit/b386ce0))
|
| 139 |
|
| 140 | # [1.3.0](https://github.com/ideal-postcodes/core-interface/compare/1.2.0...1.3.0) (2019-06-09)
|
| 141 |
|
| 142 |
|
| 143 | ### Features
|
| 144 |
|
| 145 | * **Error:** Add specific 402 errors ([270cfed](https://github.com/ideal-postcodes/core-interface/commit/270cfed))
|
| 146 | * **Error:** Allow optional metadata attribute ([9d082a7](https://github.com/ideal-postcodes/core-interface/commit/9d082a7))
|
| 147 |
|
| 148 | # [1.2.0](https://github.com/ideal-postcodes/core-interface/compare/1.1.1...1.2.0) (2019-06-07)
|
| 149 |
|
| 150 |
|
| 151 | ### Bug Fixes
|
| 152 |
|
| 153 | * **Karma-Typescript:** Explicitly exclude typings module ([b11e9e3](https://github.com/ideal-postcodes/core-interface/commit/b11e9e3))
|
| 154 |
|
| 155 |
|
| 156 | ### Features
|
| 157 |
|
| 158 | * **Client#checkKeyUsability:** Implement key check ([df6a611](https://github.com/ideal-postcodes/core-interface/commit/df6a611))
|
| 159 | * **Client#lookupAddress:** Implement address lookup ([a53fb67](https://github.com/ideal-postcodes/core-interface/commit/a53fb67))
|
| 160 | * **Client#lookupPostcode:** Implement and document postcode lookup ([21e591e](https://github.com/ideal-postcodes/core-interface/commit/21e591e))
|
| 161 | * **Client#lookupPostcode:** Make results paginateable ([a155f9f](https://github.com/ideal-postcodes/core-interface/commit/a155f9f))
|
| 162 | * **Client#lookupUdprn:** Implement and document udprn search ([e709853](https://github.com/ideal-postcodes/core-interface/commit/e709853))
|
| 163 | * **Client#lookupUmprn:** Implement UMPRN lookup ([14227c3](https://github.com/ideal-postcodes/core-interface/commit/14227c3))
|
| 164 | * **Error:** Export errors on Client ([ff111f0](https://github.com/ideal-postcodes/core-interface/commit/ff111f0))
|
| 165 |
|
| 166 | ## [1.1.1](https://github.com/ideal-postcodes/core-interface/compare/1.1.0...1.1.1) (2019-06-06)
|
| 167 |
|
| 168 |
|
| 169 | ### Bug Fixes
|
| 170 |
|
| 171 | * **Karma-Typescript:** Explicitly exclude typings module ([ff40c04](https://github.com/ideal-postcodes/core-interface/commit/ff40c04))
|
| 172 |
|
| 173 | ## [1.1.1](https://github.com/ideal-postcodes/core-interface/compare/1.1.0...1.1.1) (2019-06-06)
|
| 174 |
|
| 175 |
|
| 176 | ### Bug Fixes
|
| 177 |
|
| 178 | * **Karma-Typescript:** Explicitly exclude typings module ([ff40c04](https://github.com/ideal-postcodes/core-interface/commit/ff40c04))
|
| 179 |
|
| 180 | # [1.1.0](https://github.com/ideal-postcodes/core-interface/compare/1.0.0...1.1.0) (2019-06-05)
|
| 181 |
|
| 182 |
|
| 183 | ### Bug Fixes
|
| 184 |
|
| 185 | * **Resource:** Escape ID by default ([b94d4f3](https://github.com/ideal-postcodes/core-interface/commit/b94d4f3))
|
| 186 |
|
| 187 |
|
| 188 | ### Features
|
| 189 |
|
| 190 | * **Client:** Export client config ([8dd2a37](https://github.com/ideal-postcodes/core-interface/commit/8dd2a37))
|
| 191 |
|
| 192 | # 1.0.0 (2019-06-04)
|
| 193 |
|
| 194 |
|
| 195 | ### Bug Fixes
|
| 196 |
|
| 197 | * **Error:** Invalid keys should return authorisation error ([6bea2fb](https://github.com/ideal-postcodes/core-interface/commit/6bea2fb))
|
| 198 |
|
| 199 |
|
| 200 | ### Features
|
| 201 |
|
| 202 | * **Addresses:** Implement addresses resource ([a37f907](https://github.com/ideal-postcodes/core-interface/commit/a37f907))
|
| 203 | * **Addresses:** Implement autocomplete ([d6f940e](https://github.com/ideal-postcodes/core-interface/commit/d6f940e))
|
| 204 | * **Keys:** Implement keys usage method ([e005900](https://github.com/ideal-postcodes/core-interface/commit/e005900))
|
| 205 | * **Keys:** Implement keys.retrieve ([d7710f7](https://github.com/ideal-postcodes/core-interface/commit/d7710f7))
|
| 206 | * **Semantic Release:** Automate git and npm releases ([13b56a7](https://github.com/ideal-postcodes/core-interface/commit/13b56a7))
|
| 207 | * **UDPRN:** Add udprn resource ([e7c4e0f](https://github.com/ideal-postcodes/core-interface/commit/e7c4e0f))
|
| 208 | * **UMPRN:** Implement UMPRN resource ([efd6a7a](https://github.com/ideal-postcodes/core-interface/commit/efd6a7a))
|