Skip to content

Commit

Permalink
Fix doc generation for audius/sdk (#5584)
Browse files Browse the repository at this point in the history
  • Loading branch information
sliptype authored Jul 11, 2023
1 parent f979936 commit 54764cc
Show file tree
Hide file tree
Showing 99 changed files with 11,004 additions and 656 deletions.
32 changes: 32 additions & 0 deletions docs/docs/developers/sdk/classes/AppAuth.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
id: "AppAuth"
title: "AppAuth"
sidebar_position: 0
custom_edit_url: null
---

AuthService for Developer Apps wishing to write on a user's behalf

## Implements

- [`AuthService`](../modules.md#authservice)

## Methods

### signTransaction

**signTransaction**(`data`): `Promise`<`string`\>

#### Parameters

| Name | Type |
| :------ | :------ |
| `data` | `EIP712TypedData` |

#### Returns

`Promise`<`string`\>

#### Implementation of

AuthService.signTransaction
10 changes: 10 additions & 0 deletions docs/docs/developers/sdk/classes/Auth.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
id: "Auth"
title: "Auth"
sidebar_position: 0
custom_edit_url: null
---

## Implements

- [`AuthService`](../modules.md#authservice)
153 changes: 153 additions & 0 deletions docs/docs/developers/sdk/classes/BaseAPI.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,153 @@
---
id: "BaseAPI"
title: "BaseAPI"
sidebar_position: 0
custom_edit_url: null
---

This is the base class for all generated API classes.

## Methods

### clone

`Private` **clone**<`T`\>(`this`): `T`

Create a shallow clone of `this` by constructing a new instance
and then shallow cloning data members.

#### Type parameters

| Name | Type |
| :------ | :------ |
| `T` | extends [`BaseAPI`](BaseAPI.md)<`T`\> |

#### Parameters

| Name | Type |
| :------ | :------ |
| `this` | `T` |

#### Returns

`T`

___

### createFetchParams

`Private` **createFetchParams**(`context`, `initOverrides?`): `Promise`<{ `init`: `RequestInit` ; `url`: `string` }\>

#### Parameters

| Name | Type |
| :------ | :------ |
| `context` | [`RequestOpts`](../interfaces/RequestOpts.md) |
| `initOverrides?` | `RequestInit` \| [`InitOverrideFunction`](../modules.md#initoverridefunction) |

#### Returns

`Promise`<{ `init`: `RequestInit` ; `url`: `string` }\>

___

### fetchApi

`Private` **fetchApi**(`url`, `init`): `Promise`<`Response`\>

#### Parameters

| Name | Type |
| :------ | :------ |
| `url` | `string` |
| `init` | `RequestInit` |

#### Returns

`Promise`<`Response`\>

___

### request

`Protected` **request**(`context`, `initOverrides?`): `Promise`<`Response`\>

#### Parameters

| Name | Type |
| :------ | :------ |
| `context` | [`RequestOpts`](../interfaces/RequestOpts.md) |
| `initOverrides?` | `RequestInit` \| [`InitOverrideFunction`](../modules.md#initoverridefunction) |

#### Returns

`Promise`<`Response`\>

___

### withMiddleware

**withMiddleware**<`T`\>(`this`, ...`middlewares`): `T`

#### Type parameters

| Name | Type |
| :------ | :------ |
| `T` | extends [`BaseAPI`](BaseAPI.md)<`T`\> |

#### Parameters

| Name | Type |
| :------ | :------ |
| `this` | `T` |
| `...middlewares` | [`Middleware`](../interfaces/Middleware.md)[] |

#### Returns

`T`

___

### withPostMiddleware

**withPostMiddleware**<`T`\>(`this`, ...`postMiddlewares`): `T`

#### Type parameters

| Name | Type |
| :------ | :------ |
| `T` | extends [`BaseAPI`](BaseAPI.md)<`T`\> |

#### Parameters

| Name | Type |
| :------ | :------ |
| `this` | `T` |
| `...postMiddlewares` | (`undefined` \| (`context`: [`ResponseContext`](../interfaces/ResponseContext.md)) => `Promise`<`void` \| `Response`\>)[] |

#### Returns

`T`

___

### withPreMiddleware

**withPreMiddleware**<`T`\>(`this`, ...`preMiddlewares`): `T`

#### Type parameters

| Name | Type |
| :------ | :------ |
| `T` | extends [`BaseAPI`](BaseAPI.md)<`T`\> |

#### Parameters

| Name | Type |
| :------ | :------ |
| `this` | `T` |
| `...preMiddlewares` | (`undefined` \| (`context`: [`RequestContext`](../interfaces/RequestContext.md)) => `Promise`<`void` \| [`FetchParams`](../interfaces/FetchParams.md)\>)[] |

#### Returns

`T`
16 changes: 16 additions & 0 deletions docs/docs/developers/sdk/classes/BlobApiResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
id: "BlobApiResponse"
title: "BlobResponse"
sidebar_position: 0
custom_edit_url: null
---

## Methods

### value

**value**(): `Promise`<`Blob`\>

#### Returns

`Promise`<`Blob`\>
32 changes: 24 additions & 8 deletions docs/docs/developers/sdk/classes/Configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,22 @@ ___

___

### config

`set` **config**(`configuration`): `void`

#### Parameters

| Name | Type |
| :------ | :------ |
| `configuration` | [`Configuration`](Configuration.md) |

#### Returns

`void`

___

### credentials

`get` **credentials**(): `undefined` \| `RequestCredentials`
Expand All @@ -49,31 +65,31 @@ ___

### fetchApi

`get` **fetchApi**(): [`FetchAPI`](../modules.md#fetchapi)
`get` **fetchApi**(): `undefined` \| (`input`: `RequestInfo`, `init?`: `RequestInit`) => `Promise`<`Response`\>

#### Returns

[`FetchAPI`](../modules.md#fetchapi)
`undefined` \| (`input`: `RequestInfo`, `init?`: `RequestInit`) => `Promise`<`Response`\>

___

### headers

`get` **headers**(): `undefined` \| `HTTPHeaders`
`get` **headers**(): `undefined` \| [`HTTPHeaders`](../modules.md#httpheaders)

#### Returns

`undefined` \| `HTTPHeaders`
`undefined` \| [`HTTPHeaders`](../modules.md#httpheaders)

___

### middleware

`get` **middleware**(): `Middleware`[]
`get` **middleware**(): [`Middleware`](../interfaces/Middleware.md)[]

#### Returns

`Middleware`[]
[`Middleware`](../interfaces/Middleware.md)[]

___

Expand All @@ -89,7 +105,7 @@ ___

### queryParamsStringify

`get` **queryParamsStringify**(): (`params`: `HTTPQuery`) => `string`
`get` **queryParamsStringify**(): (`params`: [`HTTPQuery`](../modules.md#httpquery)) => `string`

#### Returns

Expand All @@ -101,7 +117,7 @@ ___

| Name | Type |
| :------ | :------ |
| `params` | `HTTPQuery` |
| `params` | [`HTTPQuery`](../modules.md#httpquery) |

##### Returns

Expand Down
Loading

0 comments on commit 54764cc

Please sign in to comment.