@clickup/rest-client 2.10.292

package/docs/classes/RestRetriableError.md

@@ -0,0 +1,139 @@
+[@clickup/rest-client](../README.md) / [Exports](../modules.md) / RestRetriableError
+
+# Class: RestRetriableError
+
+## Hierarchy
+
+- [`RestResponseError`](RestResponseError.md)
+
+  ↳ **`RestRetriableError`**
+
+## Constructors
+
+### constructor
+
+• **new RestRetriableError**(`message`, `delayMs`, `res`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `message` | `string` |
+| `delayMs` | `number` |
+| `res` | [`RestResponse`](RestResponse.md) |
+
+#### Overrides
+
+[RestResponseError](RestResponseError.md).[constructor](RestResponseError.md#constructor)
+
+#### Defined in
+
+[src/errors/RestRetriableError.ts:5](https://github.com/clickup/rest-client/blob/master/src/errors/RestRetriableError.ts#L5)
+
+## Properties
+
+### res
+
+• `Readonly` **res**: [`RestResponse`](RestResponse.md)
+
+#### Inherited from
+
+[RestResponseError](RestResponseError.md).[res](RestResponseError.md#res)
+
+#### Defined in
+
+[src/errors/RestResponseError.ts:10](https://github.com/clickup/rest-client/blob/master/src/errors/RestResponseError.ts#L10)
+
+___
+
+### method
+
+• `Readonly` **method**: `string`
+
+#### Inherited from
+
+[RestResponseError](RestResponseError.md).[method](RestResponseError.md#method)
+
+#### Defined in
+
+[src/errors/RestResponseError.ts:12](https://github.com/clickup/rest-client/blob/master/src/errors/RestResponseError.ts#L12)
+
+___
+
+### host
+
+• `Readonly` **host**: `string`
+
+#### Inherited from
+
+[RestResponseError](RestResponseError.md).[host](RestResponseError.md#host)
+
+#### Defined in
+
+[src/errors/RestResponseError.ts:13](https://github.com/clickup/rest-client/blob/master/src/errors/RestResponseError.ts#L13)
+
+___
+
+### pathname
+
+• `Readonly` **pathname**: `string`
+
+#### Inherited from
+
+[RestResponseError](RestResponseError.md).[pathname](RestResponseError.md#pathname)
+
+#### Defined in
+
+[src/errors/RestResponseError.ts:14](https://github.com/clickup/rest-client/blob/master/src/errors/RestResponseError.ts#L14)
+
+___
+
+### requestArgs
+
+• `Readonly` **requestArgs**: `string`
+
+#### Inherited from
+
+[RestResponseError](RestResponseError.md).[requestArgs](RestResponseError.md#requestargs)
+
+#### Defined in
+
+[src/errors/RestResponseError.ts:15](https://github.com/clickup/rest-client/blob/master/src/errors/RestResponseError.ts#L15)
+
+___
+
+### requestBody
+
+• `Readonly` **requestBody**: `string`
+
+#### Inherited from
+
+[RestResponseError](RestResponseError.md).[requestBody](RestResponseError.md#requestbody)
+
+#### Defined in
+
+[src/errors/RestResponseError.ts:16](https://github.com/clickup/rest-client/blob/master/src/errors/RestResponseError.ts#L16)
+
+___
+
+### responseHeaders
+
+• `Readonly` **responseHeaders**: `string`
+
+#### Inherited from
+
+[RestResponseError](RestResponseError.md).[responseHeaders](RestResponseError.md#responseheaders)
+
+#### Defined in
+
+[src/errors/RestResponseError.ts:17](https://github.com/clickup/rest-client/blob/master/src/errors/RestResponseError.ts#L17)
+
+___
+
+### delayMs
+
+• **delayMs**: `number`
+
+#### Defined in
+
+[src/errors/RestRetriableError.ts:5](https://github.com/clickup/rest-client/blob/master/src/errors/RestRetriableError.ts#L5)

package/docs/classes/RestStream.md

@@ -0,0 +1,92 @@
+[@clickup/rest-client](../README.md) / [Exports](../modules.md) / RestStream
+
+# Class: RestStream
+
+Once created, RestStream must be iterated in full, otherwise the connection
+will remain dangling. Also, this class is where we hide the details of the
+actual stream reading using AsyncGenerator bridge abstraction.
+
+## Constructors
+
+### constructor
+
+• **new RestStream**(`res`, `readerIterable`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `res` | [`RestResponse`](RestResponse.md) |
+| `readerIterable` | `Object` |
+| `readerIterable.[asyncIterator]` | () => `AsyncGenerator`<`string`, `void`, `unknown`\> |
+
+#### Defined in
+
+[src/RestStream.ts:12](https://github.com/clickup/rest-client/blob/master/src/RestStream.ts#L12)
+
+## Properties
+
+### res
+
+• `Readonly` **res**: [`RestResponse`](RestResponse.md)
+
+#### Defined in
+
+[src/RestStream.ts:13](https://github.com/clickup/rest-client/blob/master/src/RestStream.ts#L13)
+
+## Methods
+
+### consumeReturningPrefix
+
+▸ **consumeReturningPrefix**(`maxChars`): `Promise`<`string`\>
+
+Reads the prefix of the stream. Closes the connection after the read is
+done in all cases, so safe to be used to e.g. receive a trimmed response.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `maxChars` | `number` |
+
+#### Returns
+
+`Promise`<`string`\>
+
+#### Defined in
+
+[src/RestStream.ts:25](https://github.com/clickup/rest-client/blob/master/src/RestStream.ts#L25)
+
+___
+
+### close
+
+▸ **close**(): `Promise`<`void`\>
+
+Closes the connection.
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Defined in
+
+[src/RestStream.ts:44](https://github.com/clickup/rest-client/blob/master/src/RestStream.ts#L44)
+
+___
+
+### [asyncIterator]
+
+▸ **[asyncIterator]**(): `AsyncGenerator`<`string`, `void`, `unknown`\>
+
+Allows to iterate over the entire stream of data. You must consume the
+entire iterable or at least call this.close(), otherwise the connection may
+remain open.
+
+#### Returns
+
+`AsyncGenerator`<`string`, `void`, `unknown`\>
+
+#### Defined in
+
+[src/RestStream.ts:66](https://github.com/clickup/rest-client/blob/master/src/RestStream.ts#L66)

package/docs/classes/RestTimeoutError.md

@@ -0,0 +1,128 @@
+[@clickup/rest-client](../README.md) / [Exports](../modules.md) / RestTimeoutError
+
+# Class: RestTimeoutError
+
+## Hierarchy
+
+- [`RestResponseError`](RestResponseError.md)
+
+  ↳ **`RestTimeoutError`**
+
+## Constructors
+
+### constructor
+
+• **new RestTimeoutError**(`message`, `res`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `message` | `string` |
+| `res` | [`RestResponse`](RestResponse.md) |
+
+#### Inherited from
+
+[RestResponseError](RestResponseError.md).[constructor](RestResponseError.md#constructor)
+
+#### Defined in
+
+[src/errors/RestResponseError.ts:19](https://github.com/clickup/rest-client/blob/master/src/errors/RestResponseError.ts#L19)
+
+## Properties
+
+### res
+
+• `Readonly` **res**: [`RestResponse`](RestResponse.md)
+
+#### Inherited from
+
+[RestResponseError](RestResponseError.md).[res](RestResponseError.md#res)
+
+#### Defined in
+
+[src/errors/RestResponseError.ts:10](https://github.com/clickup/rest-client/blob/master/src/errors/RestResponseError.ts#L10)
+
+___
+
+### method
+
+• `Readonly` **method**: `string`
+
+#### Inherited from
+
+[RestResponseError](RestResponseError.md).[method](RestResponseError.md#method)
+
+#### Defined in
+
+[src/errors/RestResponseError.ts:12](https://github.com/clickup/rest-client/blob/master/src/errors/RestResponseError.ts#L12)
+
+___
+
+### host
+
+• `Readonly` **host**: `string`
+
+#### Inherited from
+
+[RestResponseError](RestResponseError.md).[host](RestResponseError.md#host)
+
+#### Defined in
+
+[src/errors/RestResponseError.ts:13](https://github.com/clickup/rest-client/blob/master/src/errors/RestResponseError.ts#L13)
+
+___
+
+### pathname
+
+• `Readonly` **pathname**: `string`
+
+#### Inherited from
+
+[RestResponseError](RestResponseError.md).[pathname](RestResponseError.md#pathname)
+
+#### Defined in
+
+[src/errors/RestResponseError.ts:14](https://github.com/clickup/rest-client/blob/master/src/errors/RestResponseError.ts#L14)
+
+___
+
+### requestArgs
+
+• `Readonly` **requestArgs**: `string`
+
+#### Inherited from
+
+[RestResponseError](RestResponseError.md).[requestArgs](RestResponseError.md#requestargs)
+
+#### Defined in
+
+[src/errors/RestResponseError.ts:15](https://github.com/clickup/rest-client/blob/master/src/errors/RestResponseError.ts#L15)
+
+___
+
+### requestBody
+
+• `Readonly` **requestBody**: `string`
+
+#### Inherited from
+
+[RestResponseError](RestResponseError.md).[requestBody](RestResponseError.md#requestbody)
+
+#### Defined in
+
+[src/errors/RestResponseError.ts:16](https://github.com/clickup/rest-client/blob/master/src/errors/RestResponseError.ts#L16)
+
+___
+
+### responseHeaders
+
+• `Readonly` **responseHeaders**: `string`
+
+#### Inherited from
+
+[RestResponseError](RestResponseError.md).[responseHeaders](RestResponseError.md#responseheaders)
+
+#### Defined in
+
+[src/errors/RestResponseError.ts:17](https://github.com/clickup/rest-client/blob/master/src/errors/RestResponseError.ts#L17)

package/docs/classes/RestTokenInvalidError.md

@@ -0,0 +1,138 @@
+[@clickup/rest-client](../README.md) / [Exports](../modules.md) / RestTokenInvalidError
+
+# Class: RestTokenInvalidError
+
+## Hierarchy
+
+- [`RestResponseError`](RestResponseError.md)
+
+  ↳ **`RestTokenInvalidError`**
+
+## Constructors
+
+### constructor
+
+• **new RestTokenInvalidError**(`humanReason`, `res`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `humanReason` | `string` |
+| `res` | [`RestResponse`](RestResponse.md) |
+
+#### Overrides
+
+[RestResponseError](RestResponseError.md).[constructor](RestResponseError.md#constructor)
+
+#### Defined in
+
+[src/errors/RestTokenInvalidError.ts:5](https://github.com/clickup/rest-client/blob/master/src/errors/RestTokenInvalidError.ts#L5)
+
+## Properties
+
+### res
+
+• `Readonly` **res**: [`RestResponse`](RestResponse.md)
+
+#### Inherited from
+
+[RestResponseError](RestResponseError.md).[res](RestResponseError.md#res)
+
+#### Defined in
+
+[src/errors/RestResponseError.ts:10](https://github.com/clickup/rest-client/blob/master/src/errors/RestResponseError.ts#L10)
+
+___
+
+### method
+
+• `Readonly` **method**: `string`
+
+#### Inherited from
+
+[RestResponseError](RestResponseError.md).[method](RestResponseError.md#method)
+
+#### Defined in
+
+[src/errors/RestResponseError.ts:12](https://github.com/clickup/rest-client/blob/master/src/errors/RestResponseError.ts#L12)
+
+___
+
+### host
+
+• `Readonly` **host**: `string`
+
+#### Inherited from
+
+[RestResponseError](RestResponseError.md).[host](RestResponseError.md#host)
+
+#### Defined in
+
+[src/errors/RestResponseError.ts:13](https://github.com/clickup/rest-client/blob/master/src/errors/RestResponseError.ts#L13)
+
+___
+
+### pathname
+
+• `Readonly` **pathname**: `string`
+
+#### Inherited from
+
+[RestResponseError](RestResponseError.md).[pathname](RestResponseError.md#pathname)
+
+#### Defined in
+
+[src/errors/RestResponseError.ts:14](https://github.com/clickup/rest-client/blob/master/src/errors/RestResponseError.ts#L14)
+
+___
+
+### requestArgs
+
+• `Readonly` **requestArgs**: `string`
+
+#### Inherited from
+
+[RestResponseError](RestResponseError.md).[requestArgs](RestResponseError.md#requestargs)
+
+#### Defined in
+
+[src/errors/RestResponseError.ts:15](https://github.com/clickup/rest-client/blob/master/src/errors/RestResponseError.ts#L15)
+
+___
+
+### requestBody
+
+• `Readonly` **requestBody**: `string`
+
+#### Inherited from
+
+[RestResponseError](RestResponseError.md).[requestBody](RestResponseError.md#requestbody)
+
+#### Defined in
+
+[src/errors/RestResponseError.ts:16](https://github.com/clickup/rest-client/blob/master/src/errors/RestResponseError.ts#L16)
+
+___
+
+### responseHeaders
+
+• `Readonly` **responseHeaders**: `string`
+
+#### Inherited from
+
+[RestResponseError](RestResponseError.md).[responseHeaders](RestResponseError.md#responseheaders)
+
+#### Defined in
+
+[src/errors/RestResponseError.ts:17](https://github.com/clickup/rest-client/blob/master/src/errors/RestResponseError.ts#L17)
+
+___
+
+### humanReason
+
+• `Readonly` **humanReason**: `string`
+
+#### Defined in
+
+[src/errors/RestTokenInvalidError.ts:5](https://github.com/clickup/rest-client/blob/master/src/errors/RestTokenInvalidError.ts#L5)

package/docs/interfaces/Middleware.md

@@ -0,0 +1,27 @@
+[@clickup/rest-client](../README.md) / [Exports](../modules.md) / Middleware
+
+# Interface: Middleware
+
+Middlewares allow to modify RestRequest and RestResponse objects during the
+request processing.
+
+## Callable
+
+### Middleware
+
+▸ **Middleware**(`req`, `next`): `Promise`<[`RestResponse`](../classes/RestResponse.md)\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `req` | [`RestRequest`](../classes/RestRequest.md)<`any`\> |
+| `next` | (`req`: [`RestRequest`](../classes/RestRequest.md)<`any`\>) => `Promise`<[`RestResponse`](../classes/RestResponse.md)\> |
+
+#### Returns
+
+`Promise`<[`RestResponse`](../classes/RestResponse.md)\>
+
+#### Defined in
+
+[src/RestOptions.ts:28](https://github.com/clickup/rest-client/blob/master/src/RestOptions.ts#L28)

package/docs/interfaces/Pacer.md

@@ -0,0 +1,40 @@
+[@clickup/rest-client](../README.md) / [Exports](../modules.md) / Pacer
+
+# Interface: Pacer
+
+Pacer is a class which allows to pace requests on some resource identified by
+the instance of this class.
+
+## Implemented by
+
+- [`PacerComposite`](../classes/PacerComposite.md)
+- [`PacerQPS`](../classes/PacerQPS.md)
+
+## Properties
+
+### name
+
+• `Readonly` **name**: `string`
+
+Human readable name of the pacer, used when composing multiple pacers.
+
+#### Defined in
+
+[src/pacers/Pacer.ts:15](https://github.com/clickup/rest-client/blob/master/src/pacers/Pacer.ts#L15)
+
+## Methods
+
+### touch
+
+▸ **touch**(): `Promise`<[`PacerDelay`](PacerDelay.md)\>
+
+Signals that we're about to send a request. Returns the delay we need to
+wait for before actually sending.
+
+#### Returns
+
+`Promise`<[`PacerDelay`](PacerDelay.md)\>
+
+#### Defined in
+
+[src/pacers/Pacer.ts:21](https://github.com/clickup/rest-client/blob/master/src/pacers/Pacer.ts#L21)

package/docs/interfaces/PacerDelay.md

@@ -0,0 +1,25 @@
+[@clickup/rest-client](../README.md) / [Exports](../modules.md) / PacerDelay
+
+# Interface: PacerDelay
+
+A result of some Pacer work.
+
+## Properties
+
+### delayMs
+
+• **delayMs**: `number`
+
+#### Defined in
+
+[src/pacers/Pacer.ts:5](https://github.com/clickup/rest-client/blob/master/src/pacers/Pacer.ts#L5)
+
+___
+
+### reason
+
+• **reason**: `string`
+
+#### Defined in
+
+[src/pacers/Pacer.ts:6](https://github.com/clickup/rest-client/blob/master/src/pacers/Pacer.ts#L6)

package/docs/interfaces/PacerQPSBackend.md

@@ -0,0 +1,44 @@
+[@clickup/rest-client](../README.md) / [Exports](../modules.md) / PacerQPSBackend
+
+# Interface: PacerQPSBackend
+
+## Properties
+
+### key
+
+• `Readonly` **key**: `string`
+
+Resource key which this backend is operating on.
+
+#### Defined in
+
+[src/pacers/PacerQPS.ts:33](https://github.com/clickup/rest-client/blob/master/src/pacers/PacerQPS.ts#L33)
+
+## Methods
+
+### push
+
+▸ **push**(`props`): `Promise`<{ `count`: `number` ; `sum`: `number` ; `avg`: `number` ; `median`: `number`  }\>
+
+Maintains the array of numbers somewhere in memory (time-value pairs),
+inserts a new time-value pair to the end of this list, and removes all the
+entries which are earlier than `minTime`. Returns the size of the resulting
+array and some central tendency statistics about its values.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `props` | `Object` |
+| `props.time` | `number` |
+| `props.minTime` | `number` |
+| `props.value` | `number` |
+| `props.minCountForCentralTendency` | `number` |
+
+#### Returns
+
+`Promise`<{ `count`: `number` ; `sum`: `number` ; `avg`: `number` ; `median`: `number`  }\>
+
+#### Defined in
+
+[src/pacers/PacerQPS.ts:41](https://github.com/clickup/rest-client/blob/master/src/pacers/PacerQPS.ts#L41)

package/docs/interfaces/PacerQPSOptions.md

@@ -0,0 +1,40 @@
+[@clickup/rest-client](../README.md) / [Exports](../modules.md) / PacerQPSOptions
+
+# Interface: PacerQPSOptions
+
+## Properties
+
+### qps
+
+• **qps**: `number`
+
+The maximum QPS allowed within the rolling window.
+
+#### Defined in
+
+[src/pacers/PacerQPS.ts:51](https://github.com/clickup/rest-client/blob/master/src/pacers/PacerQPS.ts#L51)
+
+___
+
+### windowSec
+
+• `Optional` **windowSec**: `number`
+
+The length of the rolling windows in milliseconds.
+
+#### Defined in
+
+[src/pacers/PacerQPS.ts:53](https://github.com/clickup/rest-client/blob/master/src/pacers/PacerQPS.ts#L53)
+
+___
+
+### decreaseThreshold
+
+• `Optional` **decreaseThreshold**: `number`
+
+Decrease the delay if the number of requests in the window has dropped
+below `decreaseThreshold` portion of the limit.
+
+#### Defined in
+
+[src/pacers/PacerQPS.ts:56](https://github.com/clickup/rest-client/blob/master/src/pacers/PacerQPS.ts#L56)