Class GirasolCardClearingRecordAdminService

constructor

• new GirasolCardClearingRecordAdminService(
      args: {
          db: B2bDatabase;
          transactionCacheBuster: TransactionCacheBuster;
      },
  ): GirasolCardClearingRecordAdminService

  Parameters

  • args: { db: B2bDatabase; transactionCacheBuster: TransactionCacheBuster }

  Returns GirasolCardClearingRecordAdminService

Staticinstance

create

• create(
      input: Omit<
          {
              amount: BigNumber;
              clearedAt: Date
              | null;
              clearingDate: string;
              createdAt: Date;
              girasolClearingRef: string | null;
              occurrence: number;
              status: "PENDING" | "FAILED" | "COMPLETED";
              statusDescription: string;
              updatedAt: Date;
          },
          "createdAt"
          | "updatedAt"
          | "statusDescription"
          | "clearedAt",
      > & { cardTransactionId: string; customerId: string },
  ): Promise<
      {
          ok: true;
          value: {
              amount: BigNumber;
              clearedAt: Date
              | null;
              clearingDate: string;
              createdAt: Date;
              girasolClearingRef: string | null;
              occurrence: number;
              status: "PENDING" | "FAILED" | "COMPLETED";
              statusDescription: string;
              updatedAt: Date;
          };
      },
  >

  Creates one or more clearing records

  Parameters

  • input: Omit<
        {
            amount: BigNumber;
            clearedAt: Date
            | null;
            clearingDate: string;
            createdAt: Date;
            girasolClearingRef: string | null;
            occurrence: number;
            status: "PENDING" | "FAILED" | "COMPLETED";
            statusDescription: string;
            updatedAt: Date;
        },
        "createdAt"
        | "updatedAt"
        | "statusDescription"
        | "clearedAt",
    > & { cardTransactionId: string; customerId: string }

    Single clearing record or array of clearing records to create

  Returns Promise<
      {
          ok: true;
          value: {
              amount: BigNumber;
              clearedAt: Date
              | null;
              clearingDate: string;
              createdAt: Date;
              girasolClearingRef: string | null;
              occurrence: number;
              status: "PENDING" | "FAILED" | "COMPLETED";
              statusDescription: string;
              updatedAt: Date;
          };
      },
  >

  Result containing the created clearing records as an array

createMissing

• createMissing(
      inputs: (
          Pick<
              {
                  amount: BigNumber;
                  clearedAt: Date
                  | null;
                  clearingDate: string;
                  createdAt: Date;
                  girasolClearingRef: string | null;
                  occurrence: number;
                  status: "PENDING" | "FAILED" | "COMPLETED";
                  statusDescription: string;
                  updatedAt: Date;
              },
              "amount"
              | "clearingDate"
              | "girasolClearingRef"
              | "occurrence",
          > & { cardTransactionId: string; customerId: string }
      )[],
  ): Promise<{ ok: true; value: { created: number } }>

  Inserts the PENDING records not already stored and returns how many were new. A record matching a stored line (either unique index) is skipped, so re-reading a date's file never duplicates a record.

  Parameters

  • inputs: (
        Pick<
            {
                amount: BigNumber;
                clearedAt: Date
                | null;
                clearingDate: string;
                createdAt: Date;
                girasolClearingRef: string | null;
                occurrence: number;
                status: "PENDING" | "FAILED" | "COMPLETED";
                statusDescription: string;
                updatedAt: Date;
            },
            "amount"
            | "clearingDate"
            | "girasolClearingRef"
            | "occurrence",
        > & { cardTransactionId: string; customerId: string }
    )[]

  Returns Promise<{ ok: true; value: { created: number } }>

search

• search(
      __namedParameters: {
          cardTransactionIds?: string[];
          clearingDates?: string[];
          statuses?: ("PENDING" | "FAILED" | "COMPLETED")[];
      },
  ): Promise<
      {
          ok: true;
          value: (
              {
                  amount: BigNumber;
                  clearedAt: Date
                  | null;
                  clearingDate: string;
                  createdAt: Date;
                  girasolClearingRef: string | null;
                  occurrence: number;
                  status: "PENDING" | "FAILED" | "COMPLETED";
                  statusDescription: string;
                  updatedAt: Date;
              } & { cardTransactionId: string; customerId: string }
          )[];
      },
  >

  Parameters

  • __namedParameters: {
        cardTransactionIds?: string[];
        clearingDates?: string[];
        statuses?: ("PENDING" | "FAILED" | "COMPLETED")[];
    }

  Returns Promise<
      {
          ok: true;
          value: (
              {
                  amount: BigNumber;
                  clearedAt: Date
                  | null;
                  clearingDate: string;
                  createdAt: Date;
                  girasolClearingRef: string | null;
                  occurrence: number;
                  status: "PENDING" | "FAILED" | "COMPLETED";
                  statusDescription: string;
                  updatedAt: Date;
              } & { cardTransactionId: string; customerId: string }
          )[];
      },
  >

update

• update(
      __namedParameters: {
          cardTransactionId: string;
          status: "PENDING" | "FAILED" | "COMPLETED";
      },
  ): Promise<
      {
          ok: true;
          value: {
              amount: BigNumber;
              clearedAt: Date
              | null;
              clearingDate: string;
              createdAt: Date;
              girasolClearingRef: string | null;
              occurrence: number;
              status: "PENDING" | "FAILED" | "COMPLETED";
              statusDescription: string;
              updatedAt: Date;
          };
      },
  >

  Parameters

  • __namedParameters: { cardTransactionId: string; status: "PENDING" | "FAILED" | "COMPLETED" }

  Returns Promise<
      {
          ok: true;
          value: {
              amount: BigNumber;
              clearedAt: Date
              | null;
              clearingDate: string;
              createdAt: Date;
              girasolClearingRef: string | null;
              occurrence: number;
              status: "PENDING" | "FAILED" | "COMPLETED";
              statusDescription: string;
              updatedAt: Date;
          };
      },
  >