From 4783948dafbc6a60efba62f30dff07e7ea54025f Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Tue, 18 May 2021 16:53:28 +0000 Subject: [PATCH] chore(docs): updating docs for version v1.3.1 --- docs/CHANGELOG.md | 87 ++++++++++++++++++++++++- docs/api/README.md | 4 +- docs/api/classes/badrequesterror.md | 8 +-- docs/api/classes/dataprovider.md | 18 ++--- docs/api/classes/forbiddenerror.md | 8 +-- docs/api/classes/goneerror.md | 8 +-- docs/api/classes/internalservererror.md | 8 +-- docs/api/classes/ratelimiterror.md | 10 +-- docs/api/classes/response.md | 2 +- docs/api/classes/tradedesk.md | 34 +++++----- docs/api/classes/unauthorizederror.md | 8 +-- docs/api/enums/apiurlenvironments.md | 6 +- docs/api/enums/datacenterhostnames.md | 14 ++-- 13 files changed, 150 insertions(+), 65 deletions(-) diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md index f76b776..7bd5e8c 100644 --- a/docs/CHANGELOG.md +++ b/docs/CHANGELOG.md @@ -2,6 +2,85 @@ ## [Unreleased] + +## [v1.3.0] - 2021-05-18 +### Bug Fixes +- **release:** added required build steps to create distribution + +### Chore +- **docs:** updating docs for version v1.3.0 + + + +## [v1.2.2] - 2021-05-13 +### Chore +- **deps:** update all non-major dependencies ([#91](https://github.com/GoodwayGroup/lib-tradedesk/issues/91)) +- **deps:** update dependency handlebars to 4.7.7 [security] ([#93](https://github.com/GoodwayGroup/lib-tradedesk/issues/93)) +- **deps:** update dependency hosted-git-info to 2.8.9 [security] ([#94](https://github.com/GoodwayGroup/lib-tradedesk/issues/94)) +- **deps:** update dependency lodash to 4.17.21 [security] ([#95](https://github.com/GoodwayGroup/lib-tradedesk/issues/95)) +- **deps:** update all non-major dependencies ([#90](https://github.com/GoodwayGroup/lib-tradedesk/issues/90)) +- **docs:** updating docs for version v1.2.2 + +### Features +- **release:** v1.2.2 + + + +## [v1.2.1] - 2021-04-12 +### Chore +- **deps:** update all non-major dependencies ([#89](https://github.com/GoodwayGroup/lib-tradedesk/issues/89)) +- **deps:** update dependency husky to v6 ([#88](https://github.com/GoodwayGroup/lib-tradedesk/issues/88)) +- **deps:** update all non-major dependencies ([#87](https://github.com/GoodwayGroup/lib-tradedesk/issues/87)) +- **docs:** updating docs for version v1.2.1 + +### Features +- **release:** v1.2.1 + + + +## [v1.2.0] - 2021-03-18 +### Bug Fixes +- **github actions:** exclude all branches + +### Chore +- **deps:** update actions/checkout action to v2 ([#82](https://github.com/GoodwayGroup/lib-tradedesk/issues/82)) +- **deps:** update dependency husky to v5 +- **deps:** update node.js to v14 +- **deps:** update all non-major dependencies ([#85](https://github.com/GoodwayGroup/lib-tradedesk/issues/85)) +- **deps:** update all non-major dependencies ([#84](https://github.com/GoodwayGroup/lib-tradedesk/issues/84)) +- **deps:** update actions/setup-node action to v2 ([#83](https://github.com/GoodwayGroup/lib-tradedesk/issues/83)) +- **docs:** updating docs for version v1.2.0 + +### Features +- **cd:** add workflow dispatch to version and publish to npm ([#86](https://github.com/GoodwayGroup/lib-tradedesk/issues/86)) +- **release:** v1.2.0 + + + +## [v1.1.1] - 2021-03-07 +### Bug Fixes +- **typedoc:** update typdoc config for compatibility with new version + +### Chore +- **deps:** update all non-major dependencies ([#80](https://github.com/GoodwayGroup/lib-tradedesk/issues/80)) +- **deps:** update dependency marked to 2.0.0 [security] ([#81](https://github.com/GoodwayGroup/lib-tradedesk/issues/81)) +- **docs:** updating docs for version v1.1.1 +- **github action:** add Publish action + +### Features +- **release:** v1.1.1 + +### Pull Requests +- Merge pull request [#73](https://github.com/GoodwayGroup/lib-tradedesk/issues/73) from GoodwayGroup/release/v1.1.0 + + +###### Squashed Commits: +``` +feat(release): v1.1.0 +``` + + + ## [v1.1.0] - 2021-01-22 ### Chore @@ -15,6 +94,7 @@ ### Features - **DataProvider:** added class to support the data api ttdsignature header ([#65](https://github.com/GoodwayGroup/lib-tradedesk/issues/65)) +- **release:** v1.1.0 @@ -122,7 +202,12 @@ - initial commit -[Unreleased]: https://github.com/GoodwayGroup/lib-tradedesk/compare/v1.1.0...HEAD +[Unreleased]: https://github.com/GoodwayGroup/lib-tradedesk/compare/v1.3.0...HEAD +[v1.3.0]: https://github.com/GoodwayGroup/lib-tradedesk/compare/v1.2.2...v1.3.0 +[v1.2.2]: https://github.com/GoodwayGroup/lib-tradedesk/compare/v1.2.1...v1.2.2 +[v1.2.1]: https://github.com/GoodwayGroup/lib-tradedesk/compare/v1.2.0...v1.2.1 +[v1.2.0]: https://github.com/GoodwayGroup/lib-tradedesk/compare/v1.1.1...v1.2.0 +[v1.1.1]: https://github.com/GoodwayGroup/lib-tradedesk/compare/v1.1.0...v1.1.1 [v1.1.0]: https://github.com/GoodwayGroup/lib-tradedesk/compare/v1.0.3...v1.1.0 [v1.0.3]: https://github.com/GoodwayGroup/lib-tradedesk/compare/v1.0.2...v1.0.3 [v1.0.2]: https://github.com/GoodwayGroup/lib-tradedesk/compare/v1.0.1...v1.0.2 diff --git a/docs/api/README.md b/docs/api/README.md index 193a81e..25641fb 100644 --- a/docs/api/README.md +++ b/docs/api/README.md @@ -1,6 +1,6 @@ -@goodwaygroup/lib-tradedesk - v1.3.0 +@goodwaygroup/lib-tradedesk - v1.3.1 -# @goodwaygroup/lib-tradedesk - v1.3.0 +# @goodwaygroup/lib-tradedesk - v1.3.1 ## Table of contents diff --git a/docs/api/classes/badrequesterror.md b/docs/api/classes/badrequesterror.md index eb14806..8220cc4 100644 --- a/docs/api/classes/badrequesterror.md +++ b/docs/api/classes/badrequesterror.md @@ -1,4 +1,4 @@ -[@goodwaygroup/lib-tradedesk - v1.3.0](../README.md) / BadRequestError +[@goodwaygroup/lib-tradedesk - v1.3.1](../README.md) / BadRequestError # Class: BadRequestError @@ -42,7 +42,7 @@ **Returns:** [*BadRequestError*](badrequesterror.md) -Defined in: [src/errors.ts:20](https://github.com/GoodwayGroup/lib-tradedesk/blob/4f7584e/src/errors.ts#L20) +Defined in: [src/errors.ts:20](https://github.com/GoodwayGroup/lib-tradedesk/blob/a31ee87/src/errors.ts#L20) ## Properties @@ -58,7 +58,7 @@ ___ • **name**: *string*= 'BadRequestError' -Defined in: [src/errors.ts:18](https://github.com/GoodwayGroup/lib-tradedesk/blob/4f7584e/src/errors.ts#L18) +Defined in: [src/errors.ts:18](https://github.com/GoodwayGroup/lib-tradedesk/blob/a31ee87/src/errors.ts#L18) ___ @@ -91,7 +91,7 @@ ___ • **response**: [*Response*](response.md) -Defined in: [src/errors.ts:20](https://github.com/GoodwayGroup/lib-tradedesk/blob/4f7584e/src/errors.ts#L20) +Defined in: [src/errors.ts:20](https://github.com/GoodwayGroup/lib-tradedesk/blob/a31ee87/src/errors.ts#L20) ___ diff --git a/docs/api/classes/dataprovider.md b/docs/api/classes/dataprovider.md index 2e60b98..f7dfd77 100644 --- a/docs/api/classes/dataprovider.md +++ b/docs/api/classes/dataprovider.md @@ -1,4 +1,4 @@ -[@goodwaygroup/lib-tradedesk - v1.3.0](../README.md) / DataProvider +[@goodwaygroup/lib-tradedesk - v1.3.1](../README.md) / DataProvider # Class: DataProvider @@ -36,7 +36,7 @@ **Returns:** [*DataProvider*](dataprovider.md) -Defined in: [src/dataProvider.ts:54](https://github.com/GoodwayGroup/lib-tradedesk/blob/4f7584e/src/dataProvider.ts#L54) +Defined in: [src/dataProvider.ts:54](https://github.com/GoodwayGroup/lib-tradedesk/blob/a31ee87/src/dataProvider.ts#L54) ## Properties @@ -46,7 +46,7 @@ Defined in: [src/dataProvider.ts:54](https://github.com/GoodwayGroup/lib-tradede Options used to make requests -Defined in: [src/dataProvider.ts:49](https://github.com/GoodwayGroup/lib-tradedesk/blob/4f7584e/src/dataProvider.ts#L49) +Defined in: [src/dataProvider.ts:49](https://github.com/GoodwayGroup/lib-tradedesk/blob/a31ee87/src/dataProvider.ts#L49) ___ @@ -56,7 +56,7 @@ ___ Provider Provisioned Secret Key -Defined in: [src/dataProvider.ts:54](https://github.com/GoodwayGroup/lib-tradedesk/blob/4f7584e/src/dataProvider.ts#L54) +Defined in: [src/dataProvider.ts:54](https://github.com/GoodwayGroup/lib-tradedesk/blob/a31ee87/src/dataProvider.ts#L54) ## Methods @@ -74,7 +74,7 @@ Creates a HMAC SHA1 Signature **Returns:** *string* -Defined in: [src/dataProvider.ts:80](https://github.com/GoodwayGroup/lib-tradedesk/blob/4f7584e/src/dataProvider.ts#L80) +Defined in: [src/dataProvider.ts:80](https://github.com/GoodwayGroup/lib-tradedesk/blob/a31ee87/src/dataProvider.ts#L80) ___ @@ -92,7 +92,7 @@ Make URL by combining the apiUrl and the given uri **Returns:** *string* -Defined in: [src/dataProvider.ts:89](https://github.com/GoodwayGroup/lib-tradedesk/blob/4f7584e/src/dataProvider.ts#L89) +Defined in: [src/dataProvider.ts:89](https://github.com/GoodwayGroup/lib-tradedesk/blob/a31ee87/src/dataProvider.ts#L89) ___ @@ -112,7 +112,7 @@ Create a POST request **Returns:** *Promise*<[*Response*](response.md)\> -Defined in: [src/dataProvider.ts:153](https://github.com/GoodwayGroup/lib-tradedesk/blob/4f7584e/src/dataProvider.ts#L153) +Defined in: [src/dataProvider.ts:153](https://github.com/GoodwayGroup/lib-tradedesk/blob/a31ee87/src/dataProvider.ts#L153) ___ @@ -132,7 +132,7 @@ Make a http request with node-fetch with builtin retries **Returns:** *Promise*<[*Response*](response.md)\> -Defined in: [src/dataProvider.ts:96](https://github.com/GoodwayGroup/lib-tradedesk/blob/4f7584e/src/dataProvider.ts#L96) +Defined in: [src/dataProvider.ts:96](https://github.com/GoodwayGroup/lib-tradedesk/blob/a31ee87/src/dataProvider.ts#L96) ___ @@ -150,4 +150,4 @@ Set the API Url to an explicit url **Returns:** [*DataProvider*](dataprovider.md) -Defined in: [src/dataProvider.ts:70](https://github.com/GoodwayGroup/lib-tradedesk/blob/4f7584e/src/dataProvider.ts#L70) +Defined in: [src/dataProvider.ts:70](https://github.com/GoodwayGroup/lib-tradedesk/blob/a31ee87/src/dataProvider.ts#L70) diff --git a/docs/api/classes/forbiddenerror.md b/docs/api/classes/forbiddenerror.md index dceeac4..d07099d 100644 --- a/docs/api/classes/forbiddenerror.md +++ b/docs/api/classes/forbiddenerror.md @@ -1,4 +1,4 @@ -[@goodwaygroup/lib-tradedesk - v1.3.0](../README.md) / ForbiddenError +[@goodwaygroup/lib-tradedesk - v1.3.1](../README.md) / ForbiddenError # Class: ForbiddenError @@ -42,7 +42,7 @@ **Returns:** [*ForbiddenError*](forbiddenerror.md) -Defined in: [src/errors.ts:31](https://github.com/GoodwayGroup/lib-tradedesk/blob/4f7584e/src/errors.ts#L31) +Defined in: [src/errors.ts:31](https://github.com/GoodwayGroup/lib-tradedesk/blob/a31ee87/src/errors.ts#L31) ## Properties @@ -58,7 +58,7 @@ ___ • **name**: *string*= 'ForbiddenError' -Defined in: [src/errors.ts:29](https://github.com/GoodwayGroup/lib-tradedesk/blob/4f7584e/src/errors.ts#L29) +Defined in: [src/errors.ts:29](https://github.com/GoodwayGroup/lib-tradedesk/blob/a31ee87/src/errors.ts#L29) ___ @@ -91,7 +91,7 @@ ___ • **response**: [*Response*](response.md) -Defined in: [src/errors.ts:31](https://github.com/GoodwayGroup/lib-tradedesk/blob/4f7584e/src/errors.ts#L31) +Defined in: [src/errors.ts:31](https://github.com/GoodwayGroup/lib-tradedesk/blob/a31ee87/src/errors.ts#L31) ___ diff --git a/docs/api/classes/goneerror.md b/docs/api/classes/goneerror.md index 427da03..990a853 100644 --- a/docs/api/classes/goneerror.md +++ b/docs/api/classes/goneerror.md @@ -1,4 +1,4 @@ -[@goodwaygroup/lib-tradedesk - v1.3.0](../README.md) / GoneError +[@goodwaygroup/lib-tradedesk - v1.3.1](../README.md) / GoneError # Class: GoneError @@ -42,7 +42,7 @@ **Returns:** [*GoneError*](goneerror.md) -Defined in: [src/errors.ts:42](https://github.com/GoodwayGroup/lib-tradedesk/blob/4f7584e/src/errors.ts#L42) +Defined in: [src/errors.ts:42](https://github.com/GoodwayGroup/lib-tradedesk/blob/a31ee87/src/errors.ts#L42) ## Properties @@ -58,7 +58,7 @@ ___ • **name**: *string*= 'GoneError' -Defined in: [src/errors.ts:40](https://github.com/GoodwayGroup/lib-tradedesk/blob/4f7584e/src/errors.ts#L40) +Defined in: [src/errors.ts:40](https://github.com/GoodwayGroup/lib-tradedesk/blob/a31ee87/src/errors.ts#L40) ___ @@ -91,7 +91,7 @@ ___ • **response**: [*Response*](response.md) -Defined in: [src/errors.ts:42](https://github.com/GoodwayGroup/lib-tradedesk/blob/4f7584e/src/errors.ts#L42) +Defined in: [src/errors.ts:42](https://github.com/GoodwayGroup/lib-tradedesk/blob/a31ee87/src/errors.ts#L42) ___ diff --git a/docs/api/classes/internalservererror.md b/docs/api/classes/internalservererror.md index e2de34c..ddae1f1 100644 --- a/docs/api/classes/internalservererror.md +++ b/docs/api/classes/internalservererror.md @@ -1,4 +1,4 @@ -[@goodwaygroup/lib-tradedesk - v1.3.0](../README.md) / InternalServerError +[@goodwaygroup/lib-tradedesk - v1.3.1](../README.md) / InternalServerError # Class: InternalServerError @@ -42,7 +42,7 @@ **Returns:** [*InternalServerError*](internalservererror.md) -Defined in: [src/errors.ts:64](https://github.com/GoodwayGroup/lib-tradedesk/blob/4f7584e/src/errors.ts#L64) +Defined in: [src/errors.ts:64](https://github.com/GoodwayGroup/lib-tradedesk/blob/a31ee87/src/errors.ts#L64) ## Properties @@ -58,7 +58,7 @@ ___ • **name**: *string*= 'InternalServerError' -Defined in: [src/errors.ts:62](https://github.com/GoodwayGroup/lib-tradedesk/blob/4f7584e/src/errors.ts#L62) +Defined in: [src/errors.ts:62](https://github.com/GoodwayGroup/lib-tradedesk/blob/a31ee87/src/errors.ts#L62) ___ @@ -91,7 +91,7 @@ ___ • **response**: [*Response*](response.md) -Defined in: [src/errors.ts:64](https://github.com/GoodwayGroup/lib-tradedesk/blob/4f7584e/src/errors.ts#L64) +Defined in: [src/errors.ts:64](https://github.com/GoodwayGroup/lib-tradedesk/blob/a31ee87/src/errors.ts#L64) ___ diff --git a/docs/api/classes/ratelimiterror.md b/docs/api/classes/ratelimiterror.md index ec676c0..93c7d96 100644 --- a/docs/api/classes/ratelimiterror.md +++ b/docs/api/classes/ratelimiterror.md @@ -1,4 +1,4 @@ -[@goodwaygroup/lib-tradedesk - v1.3.0](../README.md) / RateLimitError +[@goodwaygroup/lib-tradedesk - v1.3.1](../README.md) / RateLimitError # Class: RateLimitError @@ -44,7 +44,7 @@ **Returns:** [*RateLimitError*](ratelimiterror.md) -Defined in: [src/errors.ts:8](https://github.com/GoodwayGroup/lib-tradedesk/blob/4f7584e/src/errors.ts#L8) +Defined in: [src/errors.ts:8](https://github.com/GoodwayGroup/lib-tradedesk/blob/a31ee87/src/errors.ts#L8) ## Properties @@ -52,7 +52,7 @@ Defined in: [src/errors.ts:8](https://github.com/GoodwayGroup/lib-tradedesk/blob • **attempts**: *number* -Defined in: [src/errors.ts:6](https://github.com/GoodwayGroup/lib-tradedesk/blob/4f7584e/src/errors.ts#L6) +Defined in: [src/errors.ts:6](https://github.com/GoodwayGroup/lib-tradedesk/blob/a31ee87/src/errors.ts#L6) ___ @@ -68,7 +68,7 @@ ___ • **name**: *string*= 'RateLimitError' -Defined in: [src/errors.ts:4](https://github.com/GoodwayGroup/lib-tradedesk/blob/4f7584e/src/errors.ts#L4) +Defined in: [src/errors.ts:4](https://github.com/GoodwayGroup/lib-tradedesk/blob/a31ee87/src/errors.ts#L4) ___ @@ -76,7 +76,7 @@ ___ • **response**: [*Response*](response.md) -Defined in: [src/errors.ts:8](https://github.com/GoodwayGroup/lib-tradedesk/blob/4f7584e/src/errors.ts#L8) +Defined in: [src/errors.ts:8](https://github.com/GoodwayGroup/lib-tradedesk/blob/a31ee87/src/errors.ts#L8) ___ diff --git a/docs/api/classes/response.md b/docs/api/classes/response.md index d692b3e..986083f 100644 --- a/docs/api/classes/response.md +++ b/docs/api/classes/response.md @@ -1,4 +1,4 @@ -[@goodwaygroup/lib-tradedesk - v1.3.0](../README.md) / Response +[@goodwaygroup/lib-tradedesk - v1.3.1](../README.md) / Response # Class: Response diff --git a/docs/api/classes/tradedesk.md b/docs/api/classes/tradedesk.md index 8eacd24..e9bf48a 100644 --- a/docs/api/classes/tradedesk.md +++ b/docs/api/classes/tradedesk.md @@ -1,4 +1,4 @@ -[@goodwaygroup/lib-tradedesk - v1.3.0](../README.md) / TradeDesk +[@goodwaygroup/lib-tradedesk - v1.3.1](../README.md) / TradeDesk # Class: TradeDesk @@ -41,7 +41,7 @@ **Returns:** [*TradeDesk*](tradedesk.md) -Defined in: [src/tradedesk.ts:69](https://github.com/GoodwayGroup/lib-tradedesk/blob/4f7584e/src/tradedesk.ts#L69) +Defined in: [src/tradedesk.ts:69](https://github.com/GoodwayGroup/lib-tradedesk/blob/a31ee87/src/tradedesk.ts#L69) ## Properties @@ -51,7 +51,7 @@ Defined in: [src/tradedesk.ts:69](https://github.com/GoodwayGroup/lib-tradedesk/ Options used to make requests -Defined in: [src/tradedesk.ts:69](https://github.com/GoodwayGroup/lib-tradedesk/blob/4f7584e/src/tradedesk.ts#L69) +Defined in: [src/tradedesk.ts:69](https://github.com/GoodwayGroup/lib-tradedesk/blob/a31ee87/src/tradedesk.ts#L69) ___ @@ -61,7 +61,7 @@ ___ The authentication token -Defined in: [src/tradedesk.ts:59](https://github.com/GoodwayGroup/lib-tradedesk/blob/4f7584e/src/tradedesk.ts#L59) +Defined in: [src/tradedesk.ts:59](https://github.com/GoodwayGroup/lib-tradedesk/blob/a31ee87/src/tradedesk.ts#L59) ___ @@ -71,7 +71,7 @@ ___ The time when the token was last set. This works to refresh a token before trying request with an expired token -Defined in: [src/tradedesk.ts:64](https://github.com/GoodwayGroup/lib-tradedesk/blob/4f7584e/src/tradedesk.ts#L64) +Defined in: [src/tradedesk.ts:64](https://github.com/GoodwayGroup/lib-tradedesk/blob/a31ee87/src/tradedesk.ts#L64) ## Methods @@ -83,7 +83,7 @@ Does this instance have enough data to attempt a login **Returns:** *boolean* -Defined in: [src/tradedesk.ts:195](https://github.com/GoodwayGroup/lib-tradedesk/blob/4f7584e/src/tradedesk.ts#L195) +Defined in: [src/tradedesk.ts:195](https://github.com/GoodwayGroup/lib-tradedesk/blob/a31ee87/src/tradedesk.ts#L195) ___ @@ -102,7 +102,7 @@ Create a DELETE request **Returns:** *Promise*<[*Response*](response.md)\> -Defined in: [src/tradedesk.ts:338](https://github.com/GoodwayGroup/lib-tradedesk/blob/4f7584e/src/tradedesk.ts#L338) +Defined in: [src/tradedesk.ts:338](https://github.com/GoodwayGroup/lib-tradedesk/blob/a31ee87/src/tradedesk.ts#L338) ___ @@ -121,7 +121,7 @@ Create a GET request **Returns:** *Promise*<[*Response*](response.md)\> -Defined in: [src/tradedesk.ts:287](https://github.com/GoodwayGroup/lib-tradedesk/blob/4f7584e/src/tradedesk.ts#L287) +Defined in: [src/tradedesk.ts:287](https://github.com/GoodwayGroup/lib-tradedesk/blob/a31ee87/src/tradedesk.ts#L287) ___ @@ -133,7 +133,7 @@ Login to TradeDesk API and grab an authentication token **Returns:** *Promise*<[*TradeDesk*](tradedesk.md)\> -Defined in: [src/tradedesk.ts:119](https://github.com/GoodwayGroup/lib-tradedesk/blob/4f7584e/src/tradedesk.ts#L119) +Defined in: [src/tradedesk.ts:119](https://github.com/GoodwayGroup/lib-tradedesk/blob/a31ee87/src/tradedesk.ts#L119) ▸ **login**(`username`: *string*, `password`: *string*, `tokenExpiration?`: *number*): *Promise*<[*TradeDesk*](tradedesk.md)\> @@ -149,7 +149,7 @@ Login to TradeDesk API and grab an authentication token **Returns:** *Promise*<[*TradeDesk*](tradedesk.md)\> -Defined in: [src/tradedesk.ts:128](https://github.com/GoodwayGroup/lib-tradedesk/blob/4f7584e/src/tradedesk.ts#L128) +Defined in: [src/tradedesk.ts:128](https://github.com/GoodwayGroup/lib-tradedesk/blob/a31ee87/src/tradedesk.ts#L128) ___ @@ -167,7 +167,7 @@ Make URL by combining the apiUrl and the given uri **Returns:** *string* -Defined in: [src/tradedesk.ts:188](https://github.com/GoodwayGroup/lib-tradedesk/blob/4f7584e/src/tradedesk.ts#L188) +Defined in: [src/tradedesk.ts:188](https://github.com/GoodwayGroup/lib-tradedesk/blob/a31ee87/src/tradedesk.ts#L188) ___ @@ -187,7 +187,7 @@ Create a POST request **Returns:** *Promise*<[*Response*](response.md)\> -Defined in: [src/tradedesk.ts:300](https://github.com/GoodwayGroup/lib-tradedesk/blob/4f7584e/src/tradedesk.ts#L300) +Defined in: [src/tradedesk.ts:300](https://github.com/GoodwayGroup/lib-tradedesk/blob/a31ee87/src/tradedesk.ts#L300) ___ @@ -207,7 +207,7 @@ Create a PUT request **Returns:** *Promise*<[*Response*](response.md)\> -Defined in: [src/tradedesk.ts:319](https://github.com/GoodwayGroup/lib-tradedesk/blob/4f7584e/src/tradedesk.ts#L319) +Defined in: [src/tradedesk.ts:319](https://github.com/GoodwayGroup/lib-tradedesk/blob/a31ee87/src/tradedesk.ts#L319) ___ @@ -228,7 +228,7 @@ Make a http request with node-fetch with builtin retries and automatic login **Returns:** *Promise*<[*Response*](response.md)\> -Defined in: [src/tradedesk.ts:202](https://github.com/GoodwayGroup/lib-tradedesk/blob/4f7584e/src/tradedesk.ts#L202) +Defined in: [src/tradedesk.ts:202](https://github.com/GoodwayGroup/lib-tradedesk/blob/a31ee87/src/tradedesk.ts#L202) ___ @@ -246,7 +246,7 @@ Set the API url based on an enumerated list **Returns:** [*TradeDesk*](tradedesk.md) -Defined in: [src/tradedesk.ts:97](https://github.com/GoodwayGroup/lib-tradedesk/blob/4f7584e/src/tradedesk.ts#L97) +Defined in: [src/tradedesk.ts:97](https://github.com/GoodwayGroup/lib-tradedesk/blob/a31ee87/src/tradedesk.ts#L97) ▸ **setApiUrl**(`url`: *string*): [*TradeDesk*](tradedesk.md) @@ -260,7 +260,7 @@ Set the API Url to an explicit url **Returns:** [*TradeDesk*](tradedesk.md) -Defined in: [src/tradedesk.ts:102](https://github.com/GoodwayGroup/lib-tradedesk/blob/4f7584e/src/tradedesk.ts#L102) +Defined in: [src/tradedesk.ts:102](https://github.com/GoodwayGroup/lib-tradedesk/blob/a31ee87/src/tradedesk.ts#L102) ___ @@ -276,4 +276,4 @@ ___ **Returns:** [*TradeDesk*](tradedesk.md) -Defined in: [src/tradedesk.ts:81](https://github.com/GoodwayGroup/lib-tradedesk/blob/4f7584e/src/tradedesk.ts#L81) +Defined in: [src/tradedesk.ts:81](https://github.com/GoodwayGroup/lib-tradedesk/blob/a31ee87/src/tradedesk.ts#L81) diff --git a/docs/api/classes/unauthorizederror.md b/docs/api/classes/unauthorizederror.md index c73b7e2..c46f20c 100644 --- a/docs/api/classes/unauthorizederror.md +++ b/docs/api/classes/unauthorizederror.md @@ -1,4 +1,4 @@ -[@goodwaygroup/lib-tradedesk - v1.3.0](../README.md) / UnauthorizedError +[@goodwaygroup/lib-tradedesk - v1.3.1](../README.md) / UnauthorizedError # Class: UnauthorizedError @@ -42,7 +42,7 @@ **Returns:** [*UnauthorizedError*](unauthorizederror.md) -Defined in: [src/errors.ts:53](https://github.com/GoodwayGroup/lib-tradedesk/blob/4f7584e/src/errors.ts#L53) +Defined in: [src/errors.ts:53](https://github.com/GoodwayGroup/lib-tradedesk/blob/a31ee87/src/errors.ts#L53) ## Properties @@ -58,7 +58,7 @@ ___ • **name**: *string*= 'UnauthorizedError' -Defined in: [src/errors.ts:51](https://github.com/GoodwayGroup/lib-tradedesk/blob/4f7584e/src/errors.ts#L51) +Defined in: [src/errors.ts:51](https://github.com/GoodwayGroup/lib-tradedesk/blob/a31ee87/src/errors.ts#L51) ___ @@ -91,7 +91,7 @@ ___ • **response**: [*Response*](response.md) -Defined in: [src/errors.ts:53](https://github.com/GoodwayGroup/lib-tradedesk/blob/4f7584e/src/errors.ts#L53) +Defined in: [src/errors.ts:53](https://github.com/GoodwayGroup/lib-tradedesk/blob/a31ee87/src/errors.ts#L53) ___ diff --git a/docs/api/enums/apiurlenvironments.md b/docs/api/enums/apiurlenvironments.md index a9a5e33..68bd390 100644 --- a/docs/api/enums/apiurlenvironments.md +++ b/docs/api/enums/apiurlenvironments.md @@ -1,4 +1,4 @@ -[@goodwaygroup/lib-tradedesk - v1.3.0](../README.md) / ApiUrlEnvironments +[@goodwaygroup/lib-tradedesk - v1.3.1](../README.md) / ApiUrlEnvironments # Enumeration: ApiUrlEnvironments @@ -15,7 +15,7 @@ • **production**: = "production" -Defined in: [src/tradedesk.ts:9](https://github.com/GoodwayGroup/lib-tradedesk/blob/4f7584e/src/tradedesk.ts#L9) +Defined in: [src/tradedesk.ts:9](https://github.com/GoodwayGroup/lib-tradedesk/blob/a31ee87/src/tradedesk.ts#L9) ___ @@ -23,4 +23,4 @@ ___ • **sandbox**: = "sandbox" -Defined in: [src/tradedesk.ts:10](https://github.com/GoodwayGroup/lib-tradedesk/blob/4f7584e/src/tradedesk.ts#L10) +Defined in: [src/tradedesk.ts:10](https://github.com/GoodwayGroup/lib-tradedesk/blob/a31ee87/src/tradedesk.ts#L10) diff --git a/docs/api/enums/datacenterhostnames.md b/docs/api/enums/datacenterhostnames.md index 6232894..e9f0f4c 100644 --- a/docs/api/enums/datacenterhostnames.md +++ b/docs/api/enums/datacenterhostnames.md @@ -1,4 +1,4 @@ -[@goodwaygroup/lib-tradedesk - v1.3.0](../README.md) / DatacenterHostnames +[@goodwaygroup/lib-tradedesk - v1.3.1](../README.md) / DatacenterHostnames # Enumeration: DatacenterHostnames @@ -19,7 +19,7 @@ • **APAC**: = "https://sin-data.adsrvr.org" -Defined in: [src/dataProvider.ts:11](https://github.com/GoodwayGroup/lib-tradedesk/blob/4f7584e/src/dataProvider.ts#L11) +Defined in: [src/dataProvider.ts:11](https://github.com/GoodwayGroup/lib-tradedesk/blob/a31ee87/src/dataProvider.ts#L11) ___ @@ -27,7 +27,7 @@ ___ • **China**: = "https://data-cn2.adsrvr.cn" -Defined in: [src/dataProvider.ts:14](https://github.com/GoodwayGroup/lib-tradedesk/blob/4f7584e/src/dataProvider.ts#L14) +Defined in: [src/dataProvider.ts:14](https://github.com/GoodwayGroup/lib-tradedesk/blob/a31ee87/src/dataProvider.ts#L14) ___ @@ -35,7 +35,7 @@ ___ • **Tokyo**: = "https://tok-data.adsrvr.org" -Defined in: [src/dataProvider.ts:13](https://github.com/GoodwayGroup/lib-tradedesk/blob/4f7584e/src/dataProvider.ts#L13) +Defined in: [src/dataProvider.ts:13](https://github.com/GoodwayGroup/lib-tradedesk/blob/a31ee87/src/dataProvider.ts#L13) ___ @@ -43,7 +43,7 @@ ___ • **UKEU**: = "https://euw-data.adsrvr.org" -Defined in: [src/dataProvider.ts:10](https://github.com/GoodwayGroup/lib-tradedesk/blob/4f7584e/src/dataProvider.ts#L10) +Defined in: [src/dataProvider.ts:10](https://github.com/GoodwayGroup/lib-tradedesk/blob/a31ee87/src/dataProvider.ts#L10) ___ @@ -51,7 +51,7 @@ ___ • **USEastCoast**: = "https://use-data.adsrvr.org" -Defined in: [src/dataProvider.ts:9](https://github.com/GoodwayGroup/lib-tradedesk/blob/4f7584e/src/dataProvider.ts#L9) +Defined in: [src/dataProvider.ts:9](https://github.com/GoodwayGroup/lib-tradedesk/blob/a31ee87/src/dataProvider.ts#L9) ___ @@ -59,4 +59,4 @@ ___ • **USWestCoast**: = "https://usw-data.adsrvr.org" -Defined in: [src/dataProvider.ts:12](https://github.com/GoodwayGroup/lib-tradedesk/blob/4f7584e/src/dataProvider.ts#L12) +Defined in: [src/dataProvider.ts:12](https://github.com/GoodwayGroup/lib-tradedesk/blob/a31ee87/src/dataProvider.ts#L12)