Class GirasolCardClearingBatchAdminService

constructor

• new GirasolCardClearingBatchAdminService(
      args: { db: B2bDatabase; girasolClient: GirasolClient },
  ): GirasolCardClearingBatchAdminService

  Parameters

  • args: { db: B2bDatabase; girasolClient: GirasolClient }

  Returns GirasolCardClearingBatchAdminService

Staticinstance

create

• create(
      __namedParameters: Omit<
          GirasolCardClearingBatch,
          "id"
          | "createdAt"
          | "fetchedAt"
          | "statusDescription",
      >,
  ): Promise<{ ok: true; value: GirasolCardClearingBatch }>

  Parameters

  • __namedParameters: Omit<
        GirasolCardClearingBatch,
        "id"
        | "createdAt"
        | "fetchedAt"
        | "statusDescription",
    >

  Returns Promise<{ ok: true; value: GirasolCardClearingBatch }>

get

• get(
      __namedParameters: { clearingDate: string },
  ): Promise<{ ok: true; value: GirasolCardClearingBatch | null }>

  The batch stored for this clearing date, or null when that date has no row.

  Parameters

  • __namedParameters: { clearingDate: string }

  Returns Promise<{ ok: true; value: GirasolCardClearingBatch | null }>

getGirasolClearingBatch

• getGirasolClearingBatch(
      __namedParameters: { date: string },
  ): Promise<
      | { ok: true; value: GirasolClearingTransaction[] }
      | { error: ServiceError; ok: false },
  >

  Parameters

  • __namedParameters: { date: string }

  Returns Promise<
      | { ok: true; value: GirasolClearingTransaction[] }
      | { error: ServiceError; ok: false },
  >

search

• search(
      __namedParameters: {
          clearingDates?: string[];
          fromClearingDate?: string;
          page?: number;
          pageSize?: number;
          statuses?: ("PENDING" | "FAILED" | "COMPLETED" | "PROCESSING")[];
          toClearingDate?: string;
      },
  ): Promise<
      {
          ok: true;
          value: {
              hasNext: boolean;
              items: GirasolCardClearingBatch[];
              total: number;
          };
      },
  >

  One page of clearing batches, ordered by clearing date. Every filter is optional.

  Parameters

  • __namedParameters: {
        clearingDates?: string[];
        fromClearingDate?: string;
        page?: number;
        pageSize?: number;
        statuses?: ("PENDING" | "FAILED" | "COMPLETED" | "PROCESSING")[];
        toClearingDate?: string;
    }

  Returns Promise<
      {
          ok: true;
          value: {
              hasNext: boolean;
              items: GirasolCardClearingBatch[];
              total: number;
          };
      },
  >

upsert

• upsert(
      __namedParameters: Pick<
          GirasolCardClearingBatch,
          "clearingDate"
          | "girasolClearingRecords",
      >,
  ): Promise<{ ok: true; value: GirasolCardClearingBatch }>

  Stores the date's clearing file as just read from Girasol, replacing any earlier read of the same date and stamping fetchedAt.

  Parameters

  • __namedParameters: Pick<GirasolCardClearingBatch, "clearingDate" | "girasolClearingRecords">

  Returns Promise<{ ok: true; value: GirasolCardClearingBatch }>