# Class: ClaimReward\ Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1480](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts#L1480) ## Extends - [`BaseNumberTypeClass`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class)\<`ClaimReward`\<`T`\>\> ## Type Parameters ### T `T` *extends* [`NumberType`](https://docs.bitbadges.io/sdk/reference/type-aliases/number-type) ## Implements - [`iClaimReward`](https://docs.bitbadges.io/sdk/reference/interfaces/i-claim-reward)\<`T`\> ## Constructors ### Constructor > **new ClaimReward**\<`T`\>(`data`): `ClaimReward`\<`T`\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1495](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts#L1495) #### Parameters ##### data [`iClaimReward`](https://docs.bitbadges.io/sdk/reference/interfaces/i-claim-reward)\<`T`\> #### Returns `ClaimReward`\<`T`\> #### Overrides [`BaseNumberTypeClass`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class).[`constructor`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class#constructor) ## Properties ### automatic? > `optional` **automatic?**: `boolean` Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1489](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts#L1489) If true, the reward is automatically given to the user upon completion. No in-site logic is required. #### Implementation of [`iClaimReward`](https://docs.bitbadges.io/sdk/reference/interfaces/i-claim-reward).[`automatic`](https://docs.bitbadges.io/sdk/reference/interfaces/i-claim-reward#automatic) *** ### calculationMethod? > `optional` **calculationMethod?**: `object` Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1490](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts#L1490) Calculation method to use for the gated content. This is used to determine who is shown the gated content. By default, we check min 1 claim success for indexed claims and criteria met for non-indexed claims. #### alwaysShow? > `optional` **alwaysShow?**: `boolean` #### minClaimSuccesses? > `optional` **minClaimSuccesses?**: `number` #### Implementation of [`iClaimReward`](https://docs.bitbadges.io/sdk/reference/interfaces/i-claim-reward).[`calculationMethod`](https://docs.bitbadges.io/sdk/reference/interfaces/i-claim-reward#calculationmethod) *** ### gatedContent > **gatedContent**: [`iClaimGatedContent`](https://docs.bitbadges.io/sdk/reference/interfaces/i-claim-gated-content) Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1488](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts#L1488) The gated content to display upon completion. #### Implementation of [`iClaimReward`](https://docs.bitbadges.io/sdk/reference/interfaces/i-claim-reward).[`gatedContent`](https://docs.bitbadges.io/sdk/reference/interfaces/i-claim-reward#gatedcontent) *** ### instanceId > **instanceId**: `string` Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1482](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts#L1482) The instance ID of the reward. A unique identifier for the reward. #### Implementation of [`iClaimReward`](https://docs.bitbadges.io/sdk/reference/interfaces/i-claim-reward).[`instanceId`](https://docs.bitbadges.io/sdk/reference/interfaces/i-claim-reward#instanceid) *** ### metadata? > `optional` **metadata?**: `object` Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1483](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts#L1483) Metadata for the reward. This is public-facing, so do not include any gated content here. By default, we use the associated rewardId. #### description > **description**: `string` #### image > **image**: `string` #### name > **name**: `string` #### Implementation of [`iClaimReward`](https://docs.bitbadges.io/sdk/reference/interfaces/i-claim-reward).[`metadata`](https://docs.bitbadges.io/sdk/reference/interfaces/i-claim-reward#metadata) *** ### rewardId > **rewardId**: `string` Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1481](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts#L1481) The ID of the reward (either a pre-configured one or "custom"). Currently, this is not used for anything. #### Implementation of [`iClaimReward`](https://docs.bitbadges.io/sdk/reference/interfaces/i-claim-reward).[`rewardId`](https://docs.bitbadges.io/sdk/reference/interfaces/i-claim-reward#rewardid) ## Methods ### clone() > **clone**(): `ClaimReward` Defined in: [packages/bitbadgesjs-sdk/src/common/base.ts:151](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/common/base.ts#L151) Deep copies the object and returns a new instance. #### Returns `ClaimReward` #### Inherited from [`BaseNumberTypeClass`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class).[`clone`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class#clone) *** ### convert() > **convert**\<`U`\>(`convertFunction`, `options?`): `ClaimReward`\<`U`\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1509](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts#L1509) Converts the object to a different NumberType equivalent. #### Type Parameters ##### U `U` *extends* [`NumberType`](https://docs.bitbadges.io/sdk/reference/type-aliases/number-type) #### Parameters ##### convertFunction (`item`) => `U` ##### options? [`ConvertOptions`](https://docs.bitbadges.io/sdk/reference/interfaces/convert-options) #### Returns `ClaimReward`\<`U`\> #### Overrides [`BaseNumberTypeClass`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class).[`convert`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class#convert) *** ### equals() > **equals**\<`U`\>(`other`, `normalizeNumberTypes?`): `boolean` Defined in: [packages/bitbadgesjs-sdk/src/common/base.ts:147](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/common/base.ts#L147) 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 [`BaseNumberTypeClass`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class).[`equals`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class#equals) *** ### getNumberFieldNames() > **getNumberFieldNames**(): `string`[] Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts:1505](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/interfaces.ts#L1505) Internal helper method to convert the number fields of the object to a different NumberType equivalent. #### Returns `string`[] #### Overrides [`BaseNumberTypeClass`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class).[`getNumberFieldNames`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class#getnumberfieldnames) *** ### hasNumberFields() > **hasNumberFields**(): `boolean` Defined in: [packages/bitbadgesjs-sdk/src/common/base.ts:161](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/common/base.ts#L161) Checks if the object has number fields. #### Returns `boolean` #### Inherited from [`BaseNumberTypeClass`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class).[`hasNumberFields`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class#hasnumberfields) *** ### toJson() > **toJson**(): `JsonObject` Defined in: [packages/bitbadgesjs-sdk/src/common/base.ts:139](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/common/base.ts#L139) Converts the object to a JSON object with all primitive types. #### Returns `JsonObject` #### Inherited from [`BaseNumberTypeClass`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class).[`toJson`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class#tojson) *** ### toJsonString() > **toJsonString**(): `string` Defined in: [packages/bitbadgesjs-sdk/src/common/base.ts:143](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/common/base.ts#L143) Converts the object to a JSON string. #### Returns `string` #### Inherited from [`BaseNumberTypeClass`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class).[`toJsonString`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class#tojsonstring)