@lightsparkdev/lightspark-sdk 1.2.1 → 1.2.2

package/src/client.ts

@@ -25,15 +25,20 @@ import {
 } from "@lightsparkdev/core";
 import packageJson from "../package.json";
 import { BitcoinFeeEstimate as BitcoinFeeEstimateQuery } from "./graphql/BitcoinFeeEstimate.js";
+import { ClaimUmaInvitation } from "./graphql/ClaimUmaInvitation.js";
+import { ClaimUmaInvitationWithIncentives } from "./graphql/ClaimUmaInvitationWithIncentives.js";
 import { CreateApiToken } from "./graphql/CreateApiToken.js";
 import { CreateInvoice } from "./graphql/CreateInvoice.js";
 import { CreateLnurlInvoice } from "./graphql/CreateLnurlInvoice.js";
 import { CreateNodeWalletAddress } from "./graphql/CreateNodeWalletAddress.js";
 import { CreateTestModeInvoice } from "./graphql/CreateTestModeInvoice.js";
 import { CreateTestModePayment } from "./graphql/CreateTestModePayment.js";
+import { CreateUmaInvitation } from "./graphql/CreateUmaInvitation.js";
+import { CreateUmaInvitationWithIncentives } from "./graphql/CreateUmaInvitationWithIncentives.js";
 import { CreateUmaInvoice } from "./graphql/CreateUmaInvoice.js";
 import { DecodeInvoice } from "./graphql/DecodeInvoice.js";
 import { DeleteApiToken } from "./graphql/DeleteApiToken.js";
+import { FetchUmaInvitation } from "./graphql/FetchUmaInvitation.js";
 import { FundNode } from "./graphql/FundNode.js";
 import { LightningFeeEstimateForInvoice } from "./graphql/LightningFeeEstimateForInvoice.js";
 import { LightningFeeEstimateForNode } from "./graphql/LightningFeeEstimateForNode.js";
@@ -47,7 +52,6 @@ import { SendPayment } from "./graphql/SendPayment.js";
 import { SingleNodeDashboard as SingleNodeDashboardQuery } from "./graphql/SingleNodeDashboard.js";
 import { TransactionsForNode } from "./graphql/TransactionsForNode.js";
 import { TransactionSubscription } from "./graphql/TransactionSubscription.js";
-import { TransactionStatus } from "./index.js";
 import NodeKeyLoaderCache from "./NodeKeyLoaderCache.js";
 import Account from "./objects/Account.js";
 import { ApiTokenFromJson } from "./objects/ApiToken.js";
@@ -68,14 +72,18 @@ import type OutgoingPayment from "./objects/OutgoingPayment.js";
 import { OutgoingPaymentFromJson } from "./objects/OutgoingPayment.js";
 import { PaymentRequestFromJson } from "./objects/PaymentRequest.js";
 import Permission from "./objects/Permission.js";
+import type RegionCode from "./objects/RegionCode.js";
 import type SingleNodeDashboard from "./objects/SingleNodeDashboard.js";
 import type Transaction from "./objects/Transaction.js";
 import {
   getTransactionQuery,
   TransactionFromJson,
 } from "./objects/Transaction.js";
+import TransactionStatus from "./objects/TransactionStatus.js";
 import type TransactionUpdate from "./objects/TransactionUpdate.js";
 import { TransactionUpdateFromJson } from "./objects/TransactionUpdate.js";
+import type UmaInvitation from "./objects/UmaInvitation.js";
+import { UmaInvitationFromJson } from "./objects/UmaInvitation.js";
 import type WithdrawalMode from "./objects/WithdrawalMode.js";
 import type WithdrawalRequest from "./objects/WithdrawalRequest.js";
 import { WithdrawalRequestFromJson } from "./objects/WithdrawalRequest.js";
@@ -1070,6 +1078,191 @@ class LightsparkClient {
     });
   }
 
+  /**
+   * Creates an UMA invitation. If you are part of the incentive program, you should use
+   * [createUmaInvitationWithIncentives].
+   *
+   * @param inviterUma The UMA of the inviter.
+   * @returns The invitation that was created.
+   */
+  public async createUmaInvitation(
+    inviterUma: string,
+  ): Promise<UmaInvitation | null> {
+    return await this.executeRawQuery({
+      queryPayload: CreateUmaInvitation,
+      variables: {
+        inviterUma,
+      },
+      constructObject: (responseJson: {
+        create_uma_invitation: {
+          invitation: any; // eslint-disable-line @typescript-eslint/no-explicit-any
+        } | null;
+      }) => {
+        if (!responseJson.create_uma_invitation?.invitation) {
+          throw new LightsparkException(
+            "CreateUmaInvitationError",
+            "Unable to create UMA invitation",
+          );
+        }
+        return UmaInvitationFromJson(
+          responseJson.create_uma_invitation?.invitation,
+        );
+      },
+    });
+  }
+
+  /**
+   * Creates an UMA invitation as part of the incentive program.
+   * @param inviterUma The UMA of the inviter.
+   * @param inviterPhoneNumber The phone number of the inviter in E164 format.
+   * @param inviterRegion The region of the inviter.
+   * @returns The invitation that was created.
+   */
+  public async createUmaInvitationWithIncentives(
+    inviterUma: string,
+    inviterPhoneNumber: string,
+    inviterRegion: RegionCode,
+  ): Promise<UmaInvitation | null> {
+    const inviterPhoneHash = await this.hashPhoneNumber(inviterPhoneNumber);
+    return await this.executeRawQuery({
+      queryPayload: CreateUmaInvitationWithIncentives,
+      variables: {
+        inviterUma,
+        inviterPhoneHash,
+        inviterRegion,
+      },
+      constructObject: (responseJson: {
+        create_uma_invitation_with_incentives: {
+          invitation: any; // eslint-disable-line @typescript-eslint/no-explicit-any
+        } | null;
+      }) => {
+        if (!responseJson.create_uma_invitation_with_incentives?.invitation) {
+          throw new LightsparkException(
+            "CreateUmaInvitationError",
+            "Unable to create UMA invitation",
+          );
+        }
+        return UmaInvitationFromJson(
+          responseJson.create_uma_invitation_with_incentives?.invitation,
+        );
+      },
+    });
+  }
+
+  /**
+   * Claims an UMA invitation. If you are part of the incentive program, you should use
+   * [claimUmaInvitationWithIncentives].
+   *
+   * @param invitationCode The invitation code to claim.
+   * @param inviteeUma The UMA of the invitee.
+   * @returns The invitation that was claimed.
+   */
+  public async claimUmaInvitation(
+    invitationCode: string,
+    inviteeUma: string,
+  ): Promise<UmaInvitation | null> {
+    return await this.executeRawQuery({
+      queryPayload: ClaimUmaInvitation,
+      variables: {
+        invitationCode,
+        inviteeUma,
+      },
+      constructObject: (responseJson: {
+        claim_uma_invitation: {
+          invitation: any; // eslint-disable-line @typescript-eslint/no-explicit-any
+        } | null;
+      }) => {
+        if (!responseJson.claim_uma_invitation?.invitation) {
+          throw new LightsparkException(
+            "ClaimUmaInvitationError",
+            "Unable to claim UMA invitation",
+          );
+        }
+        return UmaInvitationFromJson(
+          responseJson.claim_uma_invitation?.invitation,
+        );
+      },
+    });
+  }
+
+  /**
+   * Claims an UMA invitation as part of the incentive program.
+   *
+   * @param invitationCode The invitation code to claim.
+   * @param inviteeUma The UMA of the invitee.
+   * @param inviteePhoneNumber The phone number of the invitee in E164 format.
+   * @param inviteeRegion The region of the invitee.
+   * @returns The invitation that was claimed.
+   */
+  public async claimUmaInvitationWithIncentives(
+    invitationCode: string,
+    inviteeUma: string,
+    inviteePhoneNumber: string,
+    inviteeRegion: RegionCode,
+  ): Promise<UmaInvitation | null> {
+    const inviteePhoneHash = await this.hashPhoneNumber(inviteePhoneNumber);
+    return await this.executeRawQuery({
+      queryPayload: ClaimUmaInvitationWithIncentives,
+      variables: {
+        invitationCode,
+        inviteeUma,
+        inviteePhoneHash,
+        inviteeRegion,
+      },
+      constructObject: (responseJson: {
+        claim_uma_invitation_with_incentives: {
+          invitation: any; // eslint-disable-line @typescript-eslint/no-explicit-any
+        } | null;
+      }) => {
+        if (!responseJson.claim_uma_invitation_with_incentives?.invitation) {
+          throw new LightsparkException(
+            "ClaimUmaInvitationError",
+            "Unable to claim UMA invitation",
+          );
+        }
+        return UmaInvitationFromJson(
+          responseJson.claim_uma_invitation_with_incentives?.invitation,
+        );
+      },
+    });
+  }
+
+  /**
+   * Fetches an UMA invitation by its invitation code.
+   *
+   * @param invitationCode The code of the invitation to fetch.
+   * @returns The invitation with the given code, or null if no invitation exists with that code.
+   */
+  public async fetchUmaInvitation(
+    invitationCode: string,
+  ): Promise<UmaInvitation | null> {
+    return await this.executeRawQuery({
+      queryPayload: FetchUmaInvitation,
+      variables: {
+        invitationCode,
+      },
+      constructObject: (responseJson: {
+        uma_invitation_by_code: any; // eslint-disable-line @typescript-eslint/no-explicit-any
+      }) => {
+        if (!responseJson.uma_invitation_by_code) {
+          return null;
+        }
+        return UmaInvitationFromJson(responseJson.uma_invitation_by_code);
+      },
+    });
+  }
+
+  private async hashPhoneNumber(e164PhoneNumber: string): Promise<string> {
+    const e164PhoneRegex = /^\+[1-9]\d{1,14}$/;
+    if (!e164PhoneRegex.test(e164PhoneNumber)) {
+      throw new LightsparkException(
+        "InvalidPhoneNumber",
+        "Invalid phone number. Phone number must be in E164 format.",
+      );
+    }
+    return await createSha256Hash(e164PhoneNumber, true);
+  }
+
   /**
    * Executes a raw `Query` against the Lightspark API.
    *

package/src/graphql/ClaimUmaInvitation.ts

@@ -0,0 +1,21 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+import { FRAGMENT as UmaInvitationFragment } from "../objects/UmaInvitation.js";
+
+export const ClaimUmaInvitation = `
+    mutation ClaimUmaInvitation(
+        $invitationCode: String!
+        $inviteeUma: String!
+    ) {
+        claim_uma_invitation(input: {
+            invitation_code: $invitationCode
+            invitee_uma: $inviteeUma
+        }) {
+            invitation {
+                ...UmaInvitationFragment
+            }
+        }
+    }
+
+${UmaInvitationFragment}
+`;

package/src/graphql/ClaimUmaInvitationWithIncentives.ts

@@ -0,0 +1,25 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+import { FRAGMENT as UmaInvitationFragment } from "../objects/UmaInvitation.js";
+
+export const ClaimUmaInvitationWithIncentives = `
+    mutation ClaimUmaInvitationWithIncentives(
+        $invitationCode: String!
+        $inviteeUma: String!
+        $inviteePhoneHash: String!
+        $inviteeRegion: RegionCode!
+    ) {
+        claim_uma_invitation_with_incentives(input: {
+            invitation_code: $invitationCode
+            invitee_uma: $inviteeUma
+            invitee_phone_hash: $inviteePhoneHash
+            invitee_region: $inviteeRegion
+        }) {
+            invitation {
+                ...UmaInvitationFragment
+            }
+        }
+    }
+
+${UmaInvitationFragment}
+`;

package/src/graphql/CreateUmaInvitation.ts

@@ -0,0 +1,19 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+import { FRAGMENT as UmaInvitationFragment } from "../objects/UmaInvitation.js";
+
+export const CreateUmaInvitation = `
+    mutation CreateUmaInvitation(
+        $inviterUma: String!
+    ) {
+        create_uma_invitation(input: {
+            inviter_uma: $inviterUma
+        }) {
+            invitation {
+                ...UmaInvitationFragment
+            }
+        }
+    }
+
+${UmaInvitationFragment}
+`;

package/src/graphql/CreateUmaInvitationWithIncentives.ts

@@ -0,0 +1,23 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+import { FRAGMENT as UmaInvitationFragment } from "../objects/UmaInvitation.js";
+
+export const CreateUmaInvitationWithIncentives = `
+    mutation CreateUmaInvitationWithIncentives(
+        $inviterUma: String!
+        $inviterPhoneHash: String!
+        $inviterRegion: RegionCode!
+    ) {
+        create_uma_invitation_with_incentives(input: {
+            inviter_uma: $inviterUma
+            inviter_phone_hash: $inviterPhoneHash
+            inviter_region: $inviterRegion
+        }) {
+            invitation {
+                ...UmaInvitationFragment
+            }
+        }
+    }
+
+${UmaInvitationFragment}
+`;

package/src/graphql/FetchUmaInvitation.ts

@@ -0,0 +1,15 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+import { FRAGMENT as UmaInvitationFragment } from "../objects/UmaInvitation.js";
+
+export const FetchUmaInvitation = `
+    query FetchUmaInvitation(
+        $invitationCode: String!
+    ) {
+        uma_invitation_by_code(code: $invitationCode) {
+            ...UmaInvitationFragment
+        }
+    }
+
+${UmaInvitationFragment}
+`;

package/src/objects/ClaimUmaInvitationInput.ts

@@ -0,0 +1,26 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+interface ClaimUmaInvitationInput {
+  invitationCode: string;
+
+  inviteeUma: string;
+}
+
+export const ClaimUmaInvitationInputFromJson = (
+  obj: any,
+): ClaimUmaInvitationInput => {
+  return {
+    invitationCode: obj["claim_uma_invitation_input_invitation_code"],
+    inviteeUma: obj["claim_uma_invitation_input_invitee_uma"],
+  } as ClaimUmaInvitationInput;
+};
+export const ClaimUmaInvitationInputToJson = (
+  obj: ClaimUmaInvitationInput,
+): any => {
+  return {
+    claim_uma_invitation_input_invitation_code: obj.invitationCode,
+    claim_uma_invitation_input_invitee_uma: obj.inviteeUma,
+  };
+};
+
+export default ClaimUmaInvitationInput;

package/src/objects/ClaimUmaInvitationOutput.ts

@@ -0,0 +1,30 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+interface ClaimUmaInvitationOutput {
+  invitationId: string;
+}
+
+export const ClaimUmaInvitationOutputFromJson = (
+  obj: any,
+): ClaimUmaInvitationOutput => {
+  return {
+    invitationId: obj["claim_uma_invitation_output_invitation"].id,
+  } as ClaimUmaInvitationOutput;
+};
+export const ClaimUmaInvitationOutputToJson = (
+  obj: ClaimUmaInvitationOutput,
+): any => {
+  return {
+    claim_uma_invitation_output_invitation: { id: obj.invitationId },
+  };
+};
+
+export const FRAGMENT = `
+fragment ClaimUmaInvitationOutputFragment on ClaimUmaInvitationOutput {
+    __typename
+    claim_uma_invitation_output_invitation: invitation {
+        id
+    }
+}`;
+
+export default ClaimUmaInvitationOutput;

package/src/objects/ClaimUmaInvitationWithIncentivesInput.ts

@@ -0,0 +1,44 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+import RegionCode from "./RegionCode.js";
+
+interface ClaimUmaInvitationWithIncentivesInput {
+  invitationCode: string;
+
+  inviteeUma: string;
+
+  inviteePhoneHash: string;
+
+  inviteeRegion: RegionCode;
+}
+
+export const ClaimUmaInvitationWithIncentivesInputFromJson = (
+  obj: any,
+): ClaimUmaInvitationWithIncentivesInput => {
+  return {
+    invitationCode:
+      obj["claim_uma_invitation_with_incentives_input_invitation_code"],
+    inviteeUma: obj["claim_uma_invitation_with_incentives_input_invitee_uma"],
+    inviteePhoneHash:
+      obj["claim_uma_invitation_with_incentives_input_invitee_phone_hash"],
+    inviteeRegion:
+      RegionCode[
+        obj["claim_uma_invitation_with_incentives_input_invitee_region"]
+      ] ?? RegionCode.FUTURE_VALUE,
+  } as ClaimUmaInvitationWithIncentivesInput;
+};
+export const ClaimUmaInvitationWithIncentivesInputToJson = (
+  obj: ClaimUmaInvitationWithIncentivesInput,
+): any => {
+  return {
+    claim_uma_invitation_with_incentives_input_invitation_code:
+      obj.invitationCode,
+    claim_uma_invitation_with_incentives_input_invitee_uma: obj.inviteeUma,
+    claim_uma_invitation_with_incentives_input_invitee_phone_hash:
+      obj.inviteePhoneHash,
+    claim_uma_invitation_with_incentives_input_invitee_region:
+      obj.inviteeRegion,
+  };
+};
+
+export default ClaimUmaInvitationWithIncentivesInput;

package/src/objects/ClaimUmaInvitationWithIncentivesOutput.ts

@@ -0,0 +1,33 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+interface ClaimUmaInvitationWithIncentivesOutput {
+  invitationId: string;
+}
+
+export const ClaimUmaInvitationWithIncentivesOutputFromJson = (
+  obj: any,
+): ClaimUmaInvitationWithIncentivesOutput => {
+  return {
+    invitationId:
+      obj["claim_uma_invitation_with_incentives_output_invitation"].id,
+  } as ClaimUmaInvitationWithIncentivesOutput;
+};
+export const ClaimUmaInvitationWithIncentivesOutputToJson = (
+  obj: ClaimUmaInvitationWithIncentivesOutput,
+): any => {
+  return {
+    claim_uma_invitation_with_incentives_output_invitation: {
+      id: obj.invitationId,
+    },
+  };
+};
+
+export const FRAGMENT = `
+fragment ClaimUmaInvitationWithIncentivesOutputFragment on ClaimUmaInvitationWithIncentivesOutput {
+    __typename
+    claim_uma_invitation_with_incentives_output_invitation: invitation {
+        id
+    }
+}`;
+
+export default ClaimUmaInvitationWithIncentivesOutput;

package/src/objects/CreateInvitationWithIncentivesInput.ts

@@ -0,0 +1,37 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+import RegionCode from "./RegionCode.js";
+
+interface CreateInvitationWithIncentivesInput {
+  inviterUma: string;
+
+  inviterPhoneHash: string;
+
+  inviterRegion: RegionCode;
+}
+
+export const CreateInvitationWithIncentivesInputFromJson = (
+  obj: any,
+): CreateInvitationWithIncentivesInput => {
+  return {
+    inviterUma: obj["create_invitation_with_incentives_input_inviter_uma"],
+    inviterPhoneHash:
+      obj["create_invitation_with_incentives_input_inviter_phone_hash"],
+    inviterRegion:
+      RegionCode[
+        obj["create_invitation_with_incentives_input_inviter_region"]
+      ] ?? RegionCode.FUTURE_VALUE,
+  } as CreateInvitationWithIncentivesInput;
+};
+export const CreateInvitationWithIncentivesInputToJson = (
+  obj: CreateInvitationWithIncentivesInput,
+): any => {
+  return {
+    create_invitation_with_incentives_input_inviter_uma: obj.inviterUma,
+    create_invitation_with_incentives_input_inviter_phone_hash:
+      obj.inviterPhoneHash,
+    create_invitation_with_incentives_input_inviter_region: obj.inviterRegion,
+  };
+};
+
+export default CreateInvitationWithIncentivesInput;

package/src/objects/CreateInvitationWithIncentivesOutput.ts

@@ -0,0 +1,32 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+interface CreateInvitationWithIncentivesOutput {
+  invitationId: string;
+}
+
+export const CreateInvitationWithIncentivesOutputFromJson = (
+  obj: any,
+): CreateInvitationWithIncentivesOutput => {
+  return {
+    invitationId: obj["create_invitation_with_incentives_output_invitation"].id,
+  } as CreateInvitationWithIncentivesOutput;
+};
+export const CreateInvitationWithIncentivesOutputToJson = (
+  obj: CreateInvitationWithIncentivesOutput,
+): any => {
+  return {
+    create_invitation_with_incentives_output_invitation: {
+      id: obj.invitationId,
+    },
+  };
+};
+
+export const FRAGMENT = `
+fragment CreateInvitationWithIncentivesOutputFragment on CreateInvitationWithIncentivesOutput {
+    __typename
+    create_invitation_with_incentives_output_invitation: invitation {
+        id
+    }
+}`;
+
+export default CreateInvitationWithIncentivesOutput;

package/src/objects/CreateUmaInvitationInput.ts

@@ -0,0 +1,22 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+interface CreateUmaInvitationInput {
+  inviterUma: string;
+}
+
+export const CreateUmaInvitationInputFromJson = (
+  obj: any,
+): CreateUmaInvitationInput => {
+  return {
+    inviterUma: obj["create_uma_invitation_input_inviter_uma"],
+  } as CreateUmaInvitationInput;
+};
+export const CreateUmaInvitationInputToJson = (
+  obj: CreateUmaInvitationInput,
+): any => {
+  return {
+    create_uma_invitation_input_inviter_uma: obj.inviterUma,
+  };
+};
+
+export default CreateUmaInvitationInput;

package/src/objects/CreateUmaInvitationOutput.ts

@@ -0,0 +1,30 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+interface CreateUmaInvitationOutput {
+  invitationId: string;
+}
+
+export const CreateUmaInvitationOutputFromJson = (
+  obj: any,
+): CreateUmaInvitationOutput => {
+  return {
+    invitationId: obj["create_uma_invitation_output_invitation"].id,
+  } as CreateUmaInvitationOutput;
+};
+export const CreateUmaInvitationOutputToJson = (
+  obj: CreateUmaInvitationOutput,
+): any => {
+  return {
+    create_uma_invitation_output_invitation: { id: obj.invitationId },
+  };
+};
+
+export const FRAGMENT = `
+fragment CreateUmaInvitationOutputFragment on CreateUmaInvitationOutput {
+    __typename
+    create_uma_invitation_output_invitation: invitation {
+        id
+    }
+}`;
+
+export default CreateUmaInvitationOutput;

package/src/objects/Entity.ts

@@ -1237,6 +1237,7 @@ fragment EntityFragment on Entity {
         outgoing_payment_attempt_status: status
         outgoing_payment_attempt_failure_code: failure_code
         outgoing_payment_attempt_failure_source_index: failure_source_index
+        outgoing_payment_attempt_attempted_at: attempted_at
         outgoing_payment_attempt_resolved_at: resolved_at
         outgoing_payment_attempt_amount: amount {
             __typename
@@ -1361,6 +1362,18 @@ fragment EntityFragment on Entity {
             id
         }
     }
+    ... on UmaInvitation {
+        __typename
+        uma_invitation_id: id
+        uma_invitation_created_at: created_at
+        uma_invitation_updated_at: updated_at
+        uma_invitation_code: code
+        uma_invitation_url: url
+        uma_invitation_inviter_uma: inviter_uma
+        uma_invitation_invitee_uma: invitee_uma
+        uma_invitation_incentives_status: incentives_status
+        uma_invitation_incentives_ineligibility_reason: incentives_ineligibility_reason
+    }
     ... on Wallet {
         __typename
         wallet_id: id

package/src/objects/IncentivesIneligibilityReason.ts

@@ -0,0 +1,24 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+/** Describes the reason for an invitation to not be eligible for incentives. **/
+export enum IncentivesIneligibilityReason {
+  /**
+   * This is an enum value that represents values that could be added in the future.
+   * Clients should support unknown values as more of them could be added without notice.
+   */
+  FUTURE_VALUE = "FUTURE_VALUE",
+  /** This invitation is not eligible for incentives because it has been created outside of the incentives flow. **/
+  DISABLED = "DISABLED",
+  /** This invitation is not eligible for incentives because the sender is not eligible. **/
+  SENDER_NOT_ELIGIBLE = "SENDER_NOT_ELIGIBLE",
+  /** This invitation is not eligible for incentives because the receiver is not eligible. **/
+  RECEIVER_NOT_ELIGIBLE = "RECEIVER_NOT_ELIGIBLE",
+  /** This invitation is not eligible for incentives because the sending VASP is not part of the incentives program. **/
+  SENDING_VASP_NOT_ELIGIBLE = "SENDING_VASP_NOT_ELIGIBLE",
+  /** This invitation is not eligible for incentives because the receiving VASP is not part of the incentives program. **/
+  RECEIVING_VASP_NOT_ELIGIBLE = "RECEIVING_VASP_NOT_ELIGIBLE",
+  /** This invitation is not eligible for incentives because the sender and receiver are in the same region. **/
+  NOT_CROSS_BORDER = "NOT_CROSS_BORDER",
+}
+
+export default IncentivesIneligibilityReason;

package/src/objects/IncentivesStatus.ts

@@ -0,0 +1,18 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+/** Describes the status of the incentives for this invitation. **/
+export enum IncentivesStatus {
+  /**
+   * This is an enum value that represents values that could be added in the future.
+   * Clients should support unknown values as more of them could be added without notice.
+   */
+  FUTURE_VALUE = "FUTURE_VALUE",
+  /** The invitation is eligible for incentives in its current state. When it is claimed, we will reassess. **/
+  PENDING = "PENDING",
+  /** The incentives have been validated. **/
+  VALIDATED = "VALIDATED",
+  /** This invitation is not eligible for incentives. A more detailed reason can be found in the `incentives_ineligibility_reason` field. **/
+  INELIGIBLE = "INELIGIBLE",
+}
+
+export default IncentivesStatus;