# loyalty/actions
Documentation: next (source: develop).

Install the preview: `pnpm add @aephia/atlas-kit@next`. These docs follow develop and may include changes not yet published to npm.

Markdown source of https://develop.atlas-kit-docs.pages.dev/reference/loyalty/actions/ — see https://develop.atlas-kit-docs.pages.dev/ai/ for the full machine-readable surface.

## Interfaces

<a id="planclaimloyaltyatlasoptions"></a>

### PlanClaimLoyaltyAtlasOptions

Defined in: [packages/sage/src/loyalty/actions/index.ts:41](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/loyalty/actions/index.ts#L41)

Exact inputs for claiming one Loyalty ATLAS Bank's full raw balance.

#### Example

```ts
declare const authorization: PlanAuthorization;
const options: PlanClaimLoyaltyAtlasOptions = {
  atUnixSeconds: 1_786_000_000n,
  authorization,
};
```

#### Properties

<a id="atunixseconds"></a>

##### atUnixSeconds

```ts
readonly atUnixSeconds: bigint;
```

Defined in: [packages/sage/src/loyalty/actions/index.ts:43](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/loyalty/actions/index.ts#L43)

Explicit non-negative Unix timestamp used to evaluate Bank expiry.

<a id="authorization"></a>

##### authorization

```ts
readonly authorization: PlanAuthorization;
```

Defined in: [packages/sage/src/loyalty/actions/index.ts:44](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/loyalty/actions/index.ts#L44)

## Functions

<a id="planclaimloyaltyatlas"></a>

### planClaimLoyaltyAtlas()

```ts
function planClaimLoyaltyAtlas(
   ctx, 
   bank, 
input): Promise<Plan>;
```

Defined in: [packages/sage/src/loyalty/actions/index.ts:181](https://github.com/Aephia/atlas-kit/blob/develop/packages/sage/src/loyalty/actions/index.ts#L181)

Plans one full Loyalty ATLAS Bank claim without signing or writes.

Permission, final freshness, and concurrent claims remain
chain-authoritative.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `ctx` | [`SageContext`](/reference/#sagecontext) |
| `bank` | [`LoyaltyAtlasBankSnapshot`](/reference/loyalty/#loyaltyatlasbanksnapshot) |
| `input` | [`PlanClaimLoyaltyAtlasOptions`](/reference/loyalty/actions/#planclaimloyaltyatlasoptions) |

#### Returns

`Promise`\<[`Plan`](/reference/planning/#plan)\>

#### Example

```ts
declare const ctx: SageContext;
declare const bank: LoyaltyAtlasBankSnapshot;
declare const authorization: PlanAuthorization;
const plan = await planClaimLoyaltyAtlas(ctx, bank, {
  atUnixSeconds: 1_786_000_000n,
  authorization,
});
console.log(plan.describe());
```

## References

<a id="planauthorization"></a>

### PlanAuthorization

Re-exports [PlanAuthorization](/reference/cargo/actions/#planauthorization)