# Class: GetClaimPayload

Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/requests/requests.ts:476](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/requests/requests.ts#L476)

## Extends

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

## Implements

- [`iGetClaimPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-get-claim-payload)

## Constructors

### Constructor

> **new GetClaimPayload**(`payload`): `GetClaimPayload`

Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/requests/requests.ts:481](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/requests/requests.ts#L481)

#### Parameters

##### payload

[`iGetClaimPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-get-claim-payload)

#### Returns

`GetClaimPayload`

#### 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

### fetchAllClaimedUsers?

> `optional` **fetchAllClaimedUsers?**: `boolean`

Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/requests/requests.ts:478](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/requests/requests.ts#L478)

Fetch all claimed users for the claim.  If true, you will be able to find all { [bitbadgesAddress]: [...zeroIndexedClaimNumbers] }
on the numUses plugin's publicState.

#### Implementation of

[`iGetClaimPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-get-claim-payload).[`fetchAllClaimedUsers`](https://docs.bitbadges.io/sdk/reference/interfaces/i-get-claim-payload#fetchallclaimedusers)

***

### fetchPrivateParams?

> `optional` **fetchPrivateParams?**: `boolean`

Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/requests/requests.ts:477](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/requests/requests.ts#L477)

Fetch private parameters for the claim. Only applicable if you are the creator / manager of the claim.

#### Implementation of

[`iGetClaimPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-get-claim-payload).[`fetchPrivateParams`](https://docs.bitbadges.io/sdk/reference/interfaces/i-get-claim-payload#fetchprivateparams)

***

### privateStatesToFetch?

> `optional` **privateStatesToFetch?**: `string`[]

Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/requests/requests.ts:479](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/requests/requests.ts#L479)

The private state instance IDs to fetch. By default, we do not fetch any private states.

#### Implementation of

[`iGetClaimPayload`](https://docs.bitbadges.io/sdk/reference/interfaces/i-get-claim-payload).[`privateStatesToFetch`](https://docs.bitbadges.io/sdk/reference/interfaces/i-get-claim-payload#privatestatestofetch)

## Methods

### clone()

> **clone**(): `GetClaimPayload`

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

`GetClaimPayload`

#### 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)

***

### FromQuery()

> `static` **FromQuery**(`query`): `GetClaimPayload`

Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/requests/requests.ts:488](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/requests/requests.ts#L488)

#### Parameters

##### query

[`ParsedQs`](https://docs.bitbadges.io/sdk/reference/interfaces/parsed-qs)

#### Returns

`GetClaimPayload`