# Class: ApiKeyDoc

Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1117](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L1117)

## Extends

- [`CustomTypeClass`](https://docs.bitbadges.io/sdk/reference/classes/custom-type-class)\<`ApiKeyDoc`\>

## Implements

- [`iApiKeyDoc`](https://docs.bitbadges.io/sdk/reference/interfaces/i-api-key-doc)

## Constructors

### Constructor

> **new ApiKeyDoc**(`data`): `ApiKeyDoc`

Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1128](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L1128)

#### Parameters

##### data

[`iApiKeyDoc`](https://docs.bitbadges.io/sdk/reference/interfaces/i-api-key-doc)

#### Returns

`ApiKeyDoc`

#### Overrides

[`CustomTypeClass`](https://docs.bitbadges.io/sdk/reference/classes/custom-type-class).[`constructor`](https://docs.bitbadges.io/sdk/reference/classes/custom-type-class#constructor)

## Properties

### \_docId

> **\_docId**: `string`

Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1118](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L1118)

A unique stringified document ID

#### Implementation of

[`iApiKeyDoc`](https://docs.bitbadges.io/sdk/reference/interfaces/i-api-key-doc).[`_docId`](https://docs.bitbadges.io/sdk/reference/interfaces/i-api-key-doc#_docid)

***

### \_id?

> `optional` **\_id?**: `string`

Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1119](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L1119)

A unique document ID (Mongo DB ObjectID)

#### Implementation of

[`iApiKeyDoc`](https://docs.bitbadges.io/sdk/reference/interfaces/i-api-key-doc).[`_id`](https://docs.bitbadges.io/sdk/reference/interfaces/i-api-key-doc#_id)

***

### apiKey

> **apiKey**: `string`

Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1121](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L1121)

#### Implementation of

[`iApiKeyDoc`](https://docs.bitbadges.io/sdk/reference/interfaces/i-api-key-doc).[`apiKey`](https://docs.bitbadges.io/sdk/reference/interfaces/i-api-key-doc#apikey)

***

### bitbadgesAddress

> **bitbadgesAddress**: `string`

Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1122](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L1122)

#### Implementation of

[`iApiKeyDoc`](https://docs.bitbadges.io/sdk/reference/interfaces/i-api-key-doc).[`bitbadgesAddress`](https://docs.bitbadges.io/sdk/reference/interfaces/i-api-key-doc#bitbadgesaddress)

***

### createdAt

> **createdAt**: `number`

Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1125](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L1125)

#### Implementation of

[`iApiKeyDoc`](https://docs.bitbadges.io/sdk/reference/interfaces/i-api-key-doc).[`createdAt`](https://docs.bitbadges.io/sdk/reference/interfaces/i-api-key-doc#createdat)

***

### intendedUse

> **intendedUse**: `string`

Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1126](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L1126)

#### Implementation of

[`iApiKeyDoc`](https://docs.bitbadges.io/sdk/reference/interfaces/i-api-key-doc).[`intendedUse`](https://docs.bitbadges.io/sdk/reference/interfaces/i-api-key-doc#intendeduse)

***

### label

> **label**: `string`

Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1120](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L1120)

#### Implementation of

[`iApiKeyDoc`](https://docs.bitbadges.io/sdk/reference/interfaces/i-api-key-doc).[`label`](https://docs.bitbadges.io/sdk/reference/interfaces/i-api-key-doc#label)

***

### lastRequest

> **lastRequest**: `number`

Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1124](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L1124)

#### Implementation of

[`iApiKeyDoc`](https://docs.bitbadges.io/sdk/reference/interfaces/i-api-key-doc).[`lastRequest`](https://docs.bitbadges.io/sdk/reference/interfaces/i-api-key-doc#lastrequest)

***

### numRequests

> **numRequests**: `number`

Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:1123](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L1123)

#### Implementation of

[`iApiKeyDoc`](https://docs.bitbadges.io/sdk/reference/interfaces/i-api-key-doc).[`numRequests`](https://docs.bitbadges.io/sdk/reference/interfaces/i-api-key-doc#numrequests)

## Methods

### clone()

> **clone**(): `ApiKeyDoc`

Defined in: [packages/bitbadgesjs-sdk/src/common/base.ts:105](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/common/base.ts#L105)

Deep copies the object and returns a new instance.

#### Returns

`ApiKeyDoc`

#### Inherited from

[`CustomTypeClass`](https://docs.bitbadges.io/sdk/reference/classes/custom-type-class).[`clone`](https://docs.bitbadges.io/sdk/reference/classes/custom-type-class#clone)

***

### ~~convert()~~

> **convert**\<`U`\>(`_convertFunction?`, `options?`): [`CustomType`](https://docs.bitbadges.io/sdk/reference/interfaces/custom-type)\<`any`\>

Defined in: [packages/bitbadgesjs-sdk/src/common/base.ts:124](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/common/base.ts#L124)

#### Type Parameters

##### U

`U` *extends* [`NumberType`](https://docs.bitbadges.io/sdk/reference/type-aliases/number-type)

#### Parameters

##### \_convertFunction?

(`val`) => `U`

##### options?

[`ConvertOptions`](https://docs.bitbadges.io/sdk/reference/interfaces/convert-options)

#### Returns

[`CustomType`](https://docs.bitbadges.io/sdk/reference/interfaces/custom-type)\<`any`\>

#### Deprecated

This function is unnecessary as this field has no numeric types.
Please use the `.clone()` method instead.

#### Inherited from

[`CustomTypeClass`](https://docs.bitbadges.io/sdk/reference/classes/custom-type-class).[`convert`](https://docs.bitbadges.io/sdk/reference/classes/custom-type-class#convert)

***

### equals()

> **equals**\<`U`\>(`other`, `normalizeNumberTypes?`): `boolean`

Defined in: [packages/bitbadgesjs-sdk/src/common/base.ts:101](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/common/base.ts#L101)

Compares this object's fields to another object's fields for equality. Equality is determined by comparing the JSON representations of the objects.

If `normalizeNumberTypes` is true, then all number types will be compared as strings (i.e. "1n" === "1" === 1). Else, they will be compared as their native types (i.e. 1n !== 1 !== "1").

#### Type Parameters

##### U

`U` *extends* [`CustomType`](https://docs.bitbadges.io/sdk/reference/interfaces/custom-type)\<`U`\>

#### Parameters

##### other

[`CustomType`](https://docs.bitbadges.io/sdk/reference/interfaces/custom-type)\<`U`\> \| `null` \| `undefined`

##### normalizeNumberTypes?

`boolean`

#### Returns

`boolean`

#### Inherited from

[`CustomTypeClass`](https://docs.bitbadges.io/sdk/reference/classes/custom-type-class).[`equals`](https://docs.bitbadges.io/sdk/reference/classes/custom-type-class#equals)

***

### getNumberFieldNames()

> **getNumberFieldNames**(): `string`[]

Defined in: [packages/bitbadgesjs-sdk/src/common/base.ts:111](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/common/base.ts#L111)

Internal helper method to convert the number fields of the object to a different NumberType equivalent.

#### Returns

`string`[]

#### Inherited from

[`CustomTypeClass`](https://docs.bitbadges.io/sdk/reference/classes/custom-type-class).[`getNumberFieldNames`](https://docs.bitbadges.io/sdk/reference/classes/custom-type-class#getnumberfieldnames)

***

### hasNumberFields()

> **hasNumberFields**(): `boolean`

Defined in: [packages/bitbadgesjs-sdk/src/common/base.ts:115](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/common/base.ts#L115)

Checks if the object has number fields.

#### Returns

`boolean`

#### Inherited from

[`CustomTypeClass`](https://docs.bitbadges.io/sdk/reference/classes/custom-type-class).[`hasNumberFields`](https://docs.bitbadges.io/sdk/reference/classes/custom-type-class#hasnumberfields)

***

### toJson()

> **toJson**(): `JsonObject`

Defined in: [packages/bitbadgesjs-sdk/src/common/base.ts:93](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/common/base.ts#L93)

Converts the object to a JSON object with all primitive types.

#### Returns

`JsonObject`

#### Inherited from

[`CustomTypeClass`](https://docs.bitbadges.io/sdk/reference/classes/custom-type-class).[`toJson`](https://docs.bitbadges.io/sdk/reference/classes/custom-type-class#tojson)

***

### toJsonString()

> **toJsonString**(): `string`

Defined in: [packages/bitbadgesjs-sdk/src/common/base.ts:97](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/common/base.ts#L97)

Converts the object to a JSON string.

#### Returns

`string`

#### Inherited from

[`CustomTypeClass`](https://docs.bitbadges.io/sdk/reference/classes/custom-type-class).[`toJsonString`](https://docs.bitbadges.io/sdk/reference/classes/custom-type-class#tojsonstring)