@clickup/rest-client 2.10.292

package/docs/classes/RestRateLimitError.md

@@ -0,0 +1,139 @@
+[@clickup/rest-client](../README.md) / [Exports](../modules.md) / RestRateLimitError
+
+# Class: RestRateLimitError
+
+## Hierarchy
+
+- [`RestResponseError`](RestResponseError.md)
+
+  ↳ **`RestRateLimitError`**
+
+## Constructors
+
+### constructor
+
+• **new RestRateLimitError**(`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/RestRateLimitError.ts:5](https://github.com/clickup/rest-client/blob/master/src/errors/RestRateLimitError.ts#L5)
+
+## Properties
+
+### delayMs
+
+• **delayMs**: `number`
+
+#### Defined in
+
+[src/errors/RestRateLimitError.ts:5](https://github.com/clickup/rest-client/blob/master/src/errors/RestRateLimitError.ts#L5)
+
+___
+
+### 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/RestRequest.md

@@ -0,0 +1,257 @@
+[@clickup/rest-client](../README.md) / [Exports](../modules.md) / RestRequest
+
+# Class: RestRequest<TAssertShape\>
+
+Type TAssertShape allows to limit json()'s assert callbacks to only those
+which return an object compatible with TAssertShape.
+
+## Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `TAssertShape` | `any` |
+
+## Constructors
+
+### constructor
+
+• **new RestRequest**<`TAssertShape`\>(`options`, `method`, `url`, `headers`, `body`, `shape?`)
+
+#### Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `TAssertShape` | `any` |
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `options` | [`RestOptions`](../interfaces/RestOptions.md) |
+| `method` | ``"GET"`` \| ``"POST"`` \| ``"PUT"`` \| ``"PATCH"`` \| ``"DELETE"`` |
+| `url` | `string` |
+| `headers` | `Headers` |
+| `body` | `string` \| `Buffer` \| `ReadableStream` |
+| `shape?` | `string` |
+
+#### Defined in
+
+[src/RestRequest.ts:30](https://github.com/clickup/rest-client/blob/master/src/RestRequest.ts#L30)
+
+## Properties
+
+### options
+
+• `Readonly` **options**: [`RestOptions`](../interfaces/RestOptions.md)
+
+#### Defined in
+
+[src/RestRequest.ts:28](https://github.com/clickup/rest-client/blob/master/src/RestRequest.ts#L28)
+
+___
+
+### method
+
+• `Readonly` **method**: ``"GET"`` \| ``"POST"`` \| ``"PUT"`` \| ``"PATCH"`` \| ``"DELETE"``
+
+#### Defined in
+
+[src/RestRequest.ts:32](https://github.com/clickup/rest-client/blob/master/src/RestRequest.ts#L32)
+
+___
+
+### url
+
+• **url**: `string`
+
+#### Defined in
+
+[src/RestRequest.ts:33](https://github.com/clickup/rest-client/blob/master/src/RestRequest.ts#L33)
+
+___
+
+### headers
+
+• `Readonly` **headers**: `Headers`
+
+#### Defined in
+
+[src/RestRequest.ts:34](https://github.com/clickup/rest-client/blob/master/src/RestRequest.ts#L34)
+
+___
+
+### body
+
+• `Readonly` **body**: `string` \| `Buffer` \| `ReadableStream`
+
+#### Defined in
+
+[src/RestRequest.ts:35](https://github.com/clickup/rest-client/blob/master/src/RestRequest.ts#L35)
+
+___
+
+### shape
+
+• `Optional` `Readonly` **shape**: `string`
+
+#### Defined in
+
+[src/RestRequest.ts:36](https://github.com/clickup/rest-client/blob/master/src/RestRequest.ts#L36)
+
+## Methods
+
+### setHeader
+
+▸ **setHeader**(`name`, `value`): [`RestRequest`](RestRequest.md)<`TAssertShape`\>
+
+Modifies the request by adding a custom HTTP header.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `name` | `string` |
+| `value` | `string` |
+
+#### Returns
+
+[`RestRequest`](RestRequest.md)<`TAssertShape`\>
+
+#### Defined in
+
+[src/RestRequest.ts:44](https://github.com/clickup/rest-client/blob/master/src/RestRequest.ts#L44)
+
+___
+
+### setOptions
+
+▸ **setOptions**(`options`): [`RestRequest`](RestRequest.md)<`TAssertShape`\>
+
+Modifies the request by adding a custom request option.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `options` | `Partial`<[`RestOptions`](../interfaces/RestOptions.md)\> |
+
+#### Returns
+
+[`RestRequest`](RestRequest.md)<`TAssertShape`\>
+
+#### Defined in
+
+[src/RestRequest.ts:52](https://github.com/clickup/rest-client/blob/master/src/RestRequest.ts#L52)
+
+___
+
+### setDebug
+
+▸ **setDebug**(`flag?`): [`RestRequest`](RestRequest.md)<`TAssertShape`\>
+
+Forces RestClient to debug-output the request and response to console.
+Never use in production.
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `flag` | `boolean` | `true` |
+
+#### Returns
+
+[`RestRequest`](RestRequest.md)<`TAssertShape`\>
+
+#### Defined in
+
+[src/RestRequest.ts:64](https://github.com/clickup/rest-client/blob/master/src/RestRequest.ts#L64)
+
+___
+
+### json
+
+▸ **json**<`TJson`\>(`assert`, `...checkers`): `Promise`<`TJson`\>
+
+Sends the request and reads the response a JSON. In absolute most of the
+cases, this method is used to reach API responses. The assert callback
+(typically generated by typescript-is) is intentionally made mandatory to
+not let people to do anti-patterns.
+
+#### Type parameters
+
+| Name |
+| :------ |
+| `TJson` |
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `assert` | { `mask`: (`obj`: `any`) => `TJson`  } \| { `$assert`: (`obj`: `any`) => `TJson`  } \| (`obj`: `any`) => `TJson` |
+| `...checkers` | (`json`: `TJson`, `res`: [`RestResponse`](RestResponse.md)) => ``false`` \| `Error`[] |
+
+#### Returns
+
+`Promise`<`TJson`\>
+
+#### Defined in
+
+[src/RestRequest.ts:75](https://github.com/clickup/rest-client/blob/master/src/RestRequest.ts#L75)
+
+___
+
+### text
+
+▸ **text**(): `Promise`<`string`\>
+
+Sends the request and returns plaintext response.
+
+#### Returns
+
+`Promise`<`string`\>
+
+#### Defined in
+
+[src/RestRequest.ts:107](https://github.com/clickup/rest-client/blob/master/src/RestRequest.ts#L107)
+
+___
+
+### response
+
+▸ **response**(): `Promise`<[`RestResponse`](RestResponse.md)\>
+
+Returns the entire RestResponse object with response status and headers
+information in it. Try to minimize usage of this method, because it doesn't
+make any assumptions on the response structure.
+
+#### Returns
+
+`Promise`<[`RestResponse`](RestResponse.md)\>
+
+#### Defined in
+
+[src/RestRequest.ts:118](https://github.com/clickup/rest-client/blob/master/src/RestRequest.ts#L118)
+
+___
+
+### stream
+
+▸ **stream**(`preloadChars?`): `Promise`<[`RestStream`](RestStream.md)\>
+
+Sends the requests and returns RestStream object. You MUST iterate over
+this object entirely (or call its return() method), otherwise the
+connection will remain dangling.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `preloadChars` | `number` |
+
+#### Returns
+
+`Promise`<[`RestStream`](RestStream.md)\>
+
+#### Defined in
+
+[src/RestRequest.ts:134](https://github.com/clickup/rest-client/blob/master/src/RestRequest.ts#L134)

package/docs/classes/RestResponse.md

@@ -0,0 +1,110 @@
+[@clickup/rest-client](../README.md) / [Exports](../modules.md) / RestResponse
+
+# Class: RestResponse
+
+RestResponse is intentionally not aware of the data structure it carries, and
+it doesn't do any assertions/validations which is the responsibility of
+RestRequest helper methods.
+
+We also use a concept of "body preloading". Sometimes, e.g. on non-successful
+HTTP status codes, we also need to know the body content (at least its
+beginning), do double check whether should we retry, throw through or through
+a user-friendly error. To do this, we need to preload the beginning of the
+body and make it a part of RestResponse abstraction.
+
+## Constructors
+
+### constructor
+
+• **new RestResponse**(`req`, `status`, `headers`, `text`, `textIsPartial`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `req` | [`RestRequest`](RestRequest.md)<`any`\> |
+| `status` | `number` |
+| `headers` | `Headers` |
+| `text` | `string` |
+| `textIsPartial` | `boolean` |
+
+#### Defined in
+
+[src/RestResponse.ts:17](https://github.com/clickup/rest-client/blob/master/src/RestResponse.ts#L17)
+
+## Properties
+
+### req
+
+• `Readonly` **req**: [`RestRequest`](RestRequest.md)<`any`\>
+
+#### Defined in
+
+[src/RestResponse.ts:18](https://github.com/clickup/rest-client/blob/master/src/RestResponse.ts#L18)
+
+___
+
+### status
+
+• `Readonly` **status**: `number`
+
+#### Defined in
+
+[src/RestResponse.ts:19](https://github.com/clickup/rest-client/blob/master/src/RestResponse.ts#L19)
+
+___
+
+### headers
+
+• `Readonly` **headers**: `Headers`
+
+#### Defined in
+
+[src/RestResponse.ts:20](https://github.com/clickup/rest-client/blob/master/src/RestResponse.ts#L20)
+
+___
+
+### text
+
+• `Readonly` **text**: `string`
+
+#### Defined in
+
+[src/RestResponse.ts:21](https://github.com/clickup/rest-client/blob/master/src/RestResponse.ts#L21)
+
+___
+
+### textIsPartial
+
+• `Readonly` **textIsPartial**: `boolean`
+
+#### Defined in
+
+[src/RestResponse.ts:22](https://github.com/clickup/rest-client/blob/master/src/RestResponse.ts#L22)
+
+## Accessors
+
+### json
+
+• `get` **json**(): `undefined` \| ``null`` \| `string` \| `number` \| `boolean` \| `object`
+
+A safe way to treat the response as JSON.
+- Never throws, i.e. we imply that the caller will verify the structure of
+  the response and do its own errors processing.
+- It's a getter, so we can use typescript-is'es is<xyz>() type guard, e.g.:
+  `if (is<{ errors: any[] }>(res.json) && res.json.errors.length) { ... }`
+
+Notice that there is NO `assert()` abstraction inside RestResponse class.
+This is because RestClient sometimes substitutes the response with some
+sub-field (e.g. see writeGraphQLX() method), and we still need to run the
+assertion in such cases. By not having strong typing here, we intentionally
+make the use of this method harder, so people will prefer using
+RestRequest.json() instead.
+
+#### Returns
+
+`undefined` \| ``null`` \| `string` \| `number` \| `boolean` \| `object`
+
+#### Defined in
+
+[src/RestResponse.ts:40](https://github.com/clickup/rest-client/blob/master/src/RestResponse.ts#L40)

package/docs/classes/RestResponseError.md

@@ -0,0 +1,110 @@
+[@clickup/rest-client](../README.md) / [Exports](../modules.md) / RestResponseError
+
+# Class: RestResponseError
+
+## Hierarchy
+
+- [`RestError`](RestError.md)
+
+  ↳ **`RestResponseError`**
+
+  ↳↳ [`RestContentSizeOverLimitError`](RestContentSizeOverLimitError.md)
+
+  ↳↳ [`RestRateLimitError`](RestRateLimitError.md)
+
+  ↳↳ [`RestRetriableError`](RestRetriableError.md)
+
+  ↳↳ [`RestTimeoutError`](RestTimeoutError.md)
+
+  ↳↳ [`RestTokenInvalidError`](RestTokenInvalidError.md)
+
+## Constructors
+
+### constructor
+
+• **new RestResponseError**(`message`, `res`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `message` | `string` |
+| `res` | [`RestResponse`](RestResponse.md) |
+
+#### Overrides
+
+[RestError](RestError.md).[constructor](RestError.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)
+
+#### Defined in
+
+[src/errors/RestResponseError.ts:10](https://github.com/clickup/rest-client/blob/master/src/errors/RestResponseError.ts#L10)
+
+___
+
+### method
+
+• `Readonly` **method**: `string`
+
+#### Defined in
+
+[src/errors/RestResponseError.ts:12](https://github.com/clickup/rest-client/blob/master/src/errors/RestResponseError.ts#L12)
+
+___
+
+### host
+
+• `Readonly` **host**: `string`
+
+#### Defined in
+
+[src/errors/RestResponseError.ts:13](https://github.com/clickup/rest-client/blob/master/src/errors/RestResponseError.ts#L13)
+
+___
+
+### pathname
+
+• `Readonly` **pathname**: `string`
+
+#### Defined in
+
+[src/errors/RestResponseError.ts:14](https://github.com/clickup/rest-client/blob/master/src/errors/RestResponseError.ts#L14)
+
+___
+
+### requestArgs
+
+• `Readonly` **requestArgs**: `string`
+
+#### Defined in
+
+[src/errors/RestResponseError.ts:15](https://github.com/clickup/rest-client/blob/master/src/errors/RestResponseError.ts#L15)
+
+___
+
+### requestBody
+
+• `Readonly` **requestBody**: `string`
+
+#### Defined in
+
+[src/errors/RestResponseError.ts:16](https://github.com/clickup/rest-client/blob/master/src/errors/RestResponseError.ts#L16)
+
+___
+
+### responseHeaders
+
+• `Readonly` **responseHeaders**: `string`
+
+#### Defined in
+
+[src/errors/RestResponseError.ts:17](https://github.com/clickup/rest-client/blob/master/src/errors/RestResponseError.ts#L17)