Class DepositQuoteAdminQueryService

Owns deposit-quote-search. A quote write also busts deposit-search, held as a writer-only instance because single inheritance rules out extending both.

Hierarchy (View Summary)

DepositQuoteCache
- DepositQuoteAdminQueryService
  - DepositQuoteAdminService

Index

Constructors

constructor

new DepositQuoteAdminQueryService(
args: { db: B2bDatabase; valkeyClient: ValkeyClient | null },
): DepositQuoteAdminQueryService
Parameters
- args: { db: B2bDatabase; valkeyClient: ValkeyClient | null }
Returns DepositQuoteAdminQueryService
Overrides DepositQuoteCache.constructor
- Defined in packages/deposit-services/src/DepositQuoteAdminService.ts:98

Properties

`Protected` `Readonly`cache

cache: ServiceCache<CachedSearchPage<DepositQuote>>

`Protected` `Readonly`db

db: B2bDatabase

`Static`instance

instance: (...args: []) => DepositQuoteAdminQueryService = ...

The process default: built from each dependency's own instance().

Methods

findCashByBarcode

findCashByBarcode(
    __namedParameters: { barcodeNumber: string },
): Promise<
    {
        ok: true;
        value: | {
            aggregateQuote?: {
                fees: (
                    {
                        amount: BigNumber;
                        receiver: (...)
                        | (...)
                        | (...);
                        type: (...) | (...);
                    } & { currency: string }
                )[];
                sourceAmount: BigNumber;
                sourceAmountAfterFees: BigNumber;
                sourceCurrency: string;
                targetAmount: BigNumber;
                targetAmountAfterFees: BigNumber;
                targetCurrency: string;
            };
            createdAt: Date;
            customerId: string;
            data?: | {
                address?: string;
                barcodeNumber: string;
                barcodeStatus: | "EXPIRED"
                | "PENDING"
                | "DECLINED"
                | "CANCELLED"
                | "CONSUMED"
                | "CREATED"
                | "VOIDED";
                expiresAt: string;
                firstName: string;
                greendotId: string
                | null;
                lastName: string;
                phone?: string;
                retailerId: string;
                retailerName: string;
                targetCurrency?: "MOVEUSD" | "USDC";
                zipcode: string;
            }
            | {
                ffc_memo?: string;
                imad?: string;
                omad?: string;
                originating_fi?: string;
                originator_address_line1?: string;
                originator_address_line2?: string;
                originator_address_line3?: string;
                originator_info?: string;
                sender_name?: string;
                sending_fi?: { code: string; name: string };
            }
            | {
                achBatchId?: string;
                achId: string;
                bankId?: string;
                routeFusionIncomingTransferId?: string;
                sourcePaymentInstrumentId: string;
                speed?: string;
                vendorId?: string;
                victorTransactionId?: string;
            }
            | { providerId?: string; providerTransactionId?: string }
            | { ffcMemo?: string }
            | {
                achId?: string;
                achTraceId?: string;
                addenda?: string;
                companyDiscretionaryData?: string;
                companyEntryDescription?: string;
                companyId?: string;
                companyName?: string;
                effectiveEntryDate?: string;
                ffcMemo?: string;
                secCode?: string;
                senderName?: string;
                settlementDate?: string;
                vendorId?: string;
            }
            | { ffcMemo?: string; senderName?: string; tchInstitutionId?: string }
            | { ffcMemo?: string; institutionId?: string; senderName?: string }
            | null;
            depositId?: string;
            deviceIpAddress: string | null;
            deviceLocation?: { lat: number; long: number; source: "ip" };
            entityId: string;
            id: string;
            metadata: {
                brand?: string;
                marketing?:
                    | EmptyObject
                    | {
                        fbp?: string;
                        gclid?: string;
                        sub1?: string;
                        sub2?: string;
                        sub3?: string;
                        userAgent?: string;
                        utmCampaign?: string;
                        utmContent?: string;
                        utmMedium?: string;
                        utmSource?: string;
                    };
            };
            productQuoteId: string;
            quote?: {
                fees: (
                    {
                        amount: BigNumber;
                        receiver: (...)
                        | (...)
                        | (...);
                        type: (...) | (...);
                    } & { currency: string }
                )[];
                sourceAmount: BigNumber;
                sourceAmountAfterFees: BigNumber;
                sourceCurrency: string;
                targetAmount: BigNumber;
                targetAmountAfterFees: BigNumber;
                targetCurrency: string;
            };
            reference: string;
            status: "ACTIVE"
            | "EXPIRED"
            | "ACCEPTED"
            | "REJECTED";
            updatedAt: Date;
            walletAddress: Address;
            walletBlockchain: string;
        } & { type: "CASH" } & {
            address?: string;
            barcodeNumber: string;
            barcodeStatus:
                | "EXPIRED"
                | "PENDING"
                | "DECLINED"
                | "CANCELLED"
                | "CONSUMED"
                | "CREATED"
                | "VOIDED";
            expiresAt: Date;
            firstName: string;
            greendotId?: string
            | null;
            lastName: string;
            phone?: string;
            retailerId: string;
            retailerName: string;
            zipcode: string;
        }
        | null;
    },
>
The cash quote a barcode names, read from the database. The Green Dot drain settles, voids or revives on its barcodeStatus and depositId, and a settle mints.
Parameters
- __namedParameters: { barcodeNumber: string }
Returns Promise<
    {
        ok: true;
        value: | {
            aggregateQuote?: {
                fees: (
                    {
                        amount: BigNumber;
                        receiver: (...)
                        | (...)
                        | (...);
                        type: (...) | (...);
                    } & { currency: string }
                )[];
                sourceAmount: BigNumber;
                sourceAmountAfterFees: BigNumber;
                sourceCurrency: string;
                targetAmount: BigNumber;
                targetAmountAfterFees: BigNumber;
                targetCurrency: string;
            };
            createdAt: Date;
            customerId: string;
            data?: | {
                address?: string;
                barcodeNumber: string;
                barcodeStatus: | "EXPIRED"
                | "PENDING"
                | "DECLINED"
                | "CANCELLED"
                | "CONSUMED"
                | "CREATED"
                | "VOIDED";
                expiresAt: string;
                firstName: string;
                greendotId: string
                | null;
                lastName: string;
                phone?: string;
                retailerId: string;
                retailerName: string;
                targetCurrency?: "MOVEUSD" | "USDC";
                zipcode: string;
            }
            | {
                ffc_memo?: string;
                imad?: string;
                omad?: string;
                originating_fi?: string;
                originator_address_line1?: string;
                originator_address_line2?: string;
                originator_address_line3?: string;
                originator_info?: string;
                sender_name?: string;
                sending_fi?: { code: string; name: string };
            }
            | {
                achBatchId?: string;
                achId: string;
                bankId?: string;
                routeFusionIncomingTransferId?: string;
                sourcePaymentInstrumentId: string;
                speed?: string;
                vendorId?: string;
                victorTransactionId?: string;
            }
            | { providerId?: string; providerTransactionId?: string }
            | { ffcMemo?: string }
            | {
                achId?: string;
                achTraceId?: string;
                addenda?: string;
                companyDiscretionaryData?: string;
                companyEntryDescription?: string;
                companyId?: string;
                companyName?: string;
                effectiveEntryDate?: string;
                ffcMemo?: string;
                secCode?: string;
                senderName?: string;
                settlementDate?: string;
                vendorId?: string;
            }
            | { ffcMemo?: string; senderName?: string; tchInstitutionId?: string }
            | { ffcMemo?: string; institutionId?: string; senderName?: string }
            | null;
            depositId?: string;
            deviceIpAddress: string | null;
            deviceLocation?: { lat: number; long: number; source: "ip" };
            entityId: string;
            id: string;
            metadata: {
                brand?: string;
                marketing?:
                    | EmptyObject
                    | {
                        fbp?: string;
                        gclid?: string;
                        sub1?: string;
                        sub2?: string;
                        sub3?: string;
                        userAgent?: string;
                        utmCampaign?: string;
                        utmContent?: string;
                        utmMedium?: string;
                        utmSource?: string;
                    };
            };
            productQuoteId: string;
            quote?: {
                fees: (
                    {
                        amount: BigNumber;
                        receiver: (...)
                        | (...)
                        | (...);
                        type: (...) | (...);
                    } & { currency: string }
                )[];
                sourceAmount: BigNumber;
                sourceAmountAfterFees: BigNumber;
                sourceCurrency: string;
                targetAmount: BigNumber;
                targetAmountAfterFees: BigNumber;
                targetCurrency: string;
            };
            reference: string;
            status: "ACTIVE"
            | "EXPIRED"
            | "ACCEPTED"
            | "REJECTED";
            updatedAt: Date;
            walletAddress: Address;
            walletBlockchain: string;
        } & { type: "CASH" } & {
            address?: string;
            barcodeNumber: string;
            barcodeStatus:
                | "EXPIRED"
                | "PENDING"
                | "DECLINED"
                | "CANCELLED"
                | "CONSUMED"
                | "CREATED"
                | "VOIDED";
            expiresAt: Date;
            firstName: string;
            greendotId?: string
            | null;
            lastName: string;
            phone?: string;
            retailerId: string;
            retailerName: string;
            zipcode: string;
        }
        | null;
    },
>
- Defined in packages/deposit-services/src/DepositQuoteAdminService.ts:170

findCashInBarcodeStatus

findCashInBarcodeStatus(
    __namedParameters: {
        barcodeStatuses: (
            | "EXPIRED"
            | "PENDING"
            | "DECLINED"
            | "CANCELLED"
            | "CONSUMED"
            | "CREATED"
            | "VOIDED"
        )[];
        id: string;
    },
): Promise<
    {
        ok: true;
        value: | {
            aggregateQuote?: {
                fees: (
                    {
                        amount: BigNumber;
                        receiver: (...)
                        | (...)
                        | (...);
                        type: (...) | (...);
                    } & { currency: string }
                )[];
                sourceAmount: BigNumber;
                sourceAmountAfterFees: BigNumber;
                sourceCurrency: string;
                targetAmount: BigNumber;
                targetAmountAfterFees: BigNumber;
                targetCurrency: string;
            };
            createdAt: Date;
            customerId: string;
            data?: | {
                address?: string;
                barcodeNumber: string;
                barcodeStatus: | "EXPIRED"
                | "PENDING"
                | "DECLINED"
                | "CANCELLED"
                | "CONSUMED"
                | "CREATED"
                | "VOIDED";
                expiresAt: string;
                firstName: string;
                greendotId: string
                | null;
                lastName: string;
                phone?: string;
                retailerId: string;
                retailerName: string;
                targetCurrency?: "MOVEUSD" | "USDC";
                zipcode: string;
            }
            | {
                ffc_memo?: string;
                imad?: string;
                omad?: string;
                originating_fi?: string;
                originator_address_line1?: string;
                originator_address_line2?: string;
                originator_address_line3?: string;
                originator_info?: string;
                sender_name?: string;
                sending_fi?: { code: string; name: string };
            }
            | {
                achBatchId?: string;
                achId: string;
                bankId?: string;
                routeFusionIncomingTransferId?: string;
                sourcePaymentInstrumentId: string;
                speed?: string;
                vendorId?: string;
                victorTransactionId?: string;
            }
            | { providerId?: string; providerTransactionId?: string }
            | { ffcMemo?: string }
            | {
                achId?: string;
                achTraceId?: string;
                addenda?: string;
                companyDiscretionaryData?: string;
                companyEntryDescription?: string;
                companyId?: string;
                companyName?: string;
                effectiveEntryDate?: string;
                ffcMemo?: string;
                secCode?: string;
                senderName?: string;
                settlementDate?: string;
                vendorId?: string;
            }
            | { ffcMemo?: string; senderName?: string; tchInstitutionId?: string }
            | { ffcMemo?: string; institutionId?: string; senderName?: string }
            | null;
            depositId?: string;
            deviceIpAddress: string | null;
            deviceLocation?: { lat: number; long: number; source: "ip" };
            entityId: string;
            id: string;
            metadata: {
                brand?: string;
                marketing?:
                    | EmptyObject
                    | {
                        fbp?: string;
                        gclid?: string;
                        sub1?: string;
                        sub2?: string;
                        sub3?: string;
                        userAgent?: string;
                        utmCampaign?: string;
                        utmContent?: string;
                        utmMedium?: string;
                        utmSource?: string;
                    };
            };
            productQuoteId: string;
            quote?: {
                fees: (
                    {
                        amount: BigNumber;
                        receiver: (...)
                        | (...)
                        | (...);
                        type: (...) | (...);
                    } & { currency: string }
                )[];
                sourceAmount: BigNumber;
                sourceAmountAfterFees: BigNumber;
                sourceCurrency: string;
                targetAmount: BigNumber;
                targetAmountAfterFees: BigNumber;
                targetCurrency: string;
            };
            reference: string;
            status: "ACTIVE"
            | "EXPIRED"
            | "ACCEPTED"
            | "REJECTED";
            updatedAt: Date;
            walletAddress: Address;
            walletBlockchain: string;
        } & { type: "CASH" } & {
            address?: string;
            barcodeNumber: string;
            barcodeStatus:
                | "EXPIRED"
                | "PENDING"
                | "DECLINED"
                | "CANCELLED"
                | "CONSUMED"
                | "CREATED"
                | "VOIDED";
            expiresAt: Date;
            firstName: string;
            greendotId?: string
            | null;
            lastName: string;
            phone?: string;
            retailerId: string;
            retailerName: string;
            zipcode: string;
        }
        | null;
    },
>
The cash quote while its barcode is still in one of barcodeStatuses, read from the database. For the deadline checks, which expire or void it on that status.
Parameters
- __namedParameters: {
      barcodeStatuses: (
          | "EXPIRED"
          | "PENDING"
          | "DECLINED"
          | "CANCELLED"
          | "CONSUMED"
          | "CREATED"
          | "VOIDED"
      )[];
      id: string;
  }
Returns Promise<
    {
        ok: true;
        value: | {
            aggregateQuote?: {
                fees: (
                    {
                        amount: BigNumber;
                        receiver: (...)
                        | (...)
                        | (...);
                        type: (...) | (...);
                    } & { currency: string }
                )[];
                sourceAmount: BigNumber;
                sourceAmountAfterFees: BigNumber;
                sourceCurrency: string;
                targetAmount: BigNumber;
                targetAmountAfterFees: BigNumber;
                targetCurrency: string;
            };
            createdAt: Date;
            customerId: string;
            data?: | {
                address?: string;
                barcodeNumber: string;
                barcodeStatus: | "EXPIRED"
                | "PENDING"
                | "DECLINED"
                | "CANCELLED"
                | "CONSUMED"
                | "CREATED"
                | "VOIDED";
                expiresAt: string;
                firstName: string;
                greendotId: string
                | null;
                lastName: string;
                phone?: string;
                retailerId: string;
                retailerName: string;
                targetCurrency?: "MOVEUSD" | "USDC";
                zipcode: string;
            }
            | {
                ffc_memo?: string;
                imad?: string;
                omad?: string;
                originating_fi?: string;
                originator_address_line1?: string;
                originator_address_line2?: string;
                originator_address_line3?: string;
                originator_info?: string;
                sender_name?: string;
                sending_fi?: { code: string; name: string };
            }
            | {
                achBatchId?: string;
                achId: string;
                bankId?: string;
                routeFusionIncomingTransferId?: string;
                sourcePaymentInstrumentId: string;
                speed?: string;
                vendorId?: string;
                victorTransactionId?: string;
            }
            | { providerId?: string; providerTransactionId?: string }
            | { ffcMemo?: string }
            | {
                achId?: string;
                achTraceId?: string;
                addenda?: string;
                companyDiscretionaryData?: string;
                companyEntryDescription?: string;
                companyId?: string;
                companyName?: string;
                effectiveEntryDate?: string;
                ffcMemo?: string;
                secCode?: string;
                senderName?: string;
                settlementDate?: string;
                vendorId?: string;
            }
            | { ffcMemo?: string; senderName?: string; tchInstitutionId?: string }
            | { ffcMemo?: string; institutionId?: string; senderName?: string }
            | null;
            depositId?: string;
            deviceIpAddress: string | null;
            deviceLocation?: { lat: number; long: number; source: "ip" };
            entityId: string;
            id: string;
            metadata: {
                brand?: string;
                marketing?:
                    | EmptyObject
                    | {
                        fbp?: string;
                        gclid?: string;
                        sub1?: string;
                        sub2?: string;
                        sub3?: string;
                        userAgent?: string;
                        utmCampaign?: string;
                        utmContent?: string;
                        utmMedium?: string;
                        utmSource?: string;
                    };
            };
            productQuoteId: string;
            quote?: {
                fees: (
                    {
                        amount: BigNumber;
                        receiver: (...)
                        | (...)
                        | (...);
                        type: (...) | (...);
                    } & { currency: string }
                )[];
                sourceAmount: BigNumber;
                sourceAmountAfterFees: BigNumber;
                sourceCurrency: string;
                targetAmount: BigNumber;
                targetAmountAfterFees: BigNumber;
                targetCurrency: string;
            };
            reference: string;
            status: "ACTIVE"
            | "EXPIRED"
            | "ACCEPTED"
            | "REJECTED";
            updatedAt: Date;
            walletAddress: Address;
            walletBlockchain: string;
        } & { type: "CASH" } & {
            address?: string;
            barcodeNumber: string;
            barcodeStatus:
                | "EXPIRED"
                | "PENDING"
                | "DECLINED"
                | "CANCELLED"
                | "CONSUMED"
                | "CREATED"
                | "VOIDED";
            expiresAt: Date;
            firstName: string;
            greendotId?: string
            | null;
            lastName: string;
            phone?: string;
            retailerId: string;
            retailerName: string;
            zipcode: string;
        }
        | null;
    },
>
- Defined in packages/deposit-services/src/DepositQuoteAdminService.ts:189

get

get(
    args: {
        id: string;
        tx?: PgAsyncTransaction<NodePgQueryResultHKT, EmptyRelations>;
    },
): Promise<{ ok: true; value: DepositQuote | null }>
Parameters
- args: { id: string; tx?: PgAsyncTransaction<NodePgQueryResultHKT, EmptyRelations> }
Returns Promise<{ ok: true; value: DepositQuote | null }>
- Defined in packages/deposit-services/src/DepositQuoteAdminService.ts:103

invalidateCache

invalidateCache(
    __namedParameters: {
        customerIds: readonly string[];
        keys?: readonly CacheKey[];
        records?: readonly string[];
    },
): Promise<void>
Clear each customer's membership tag and each record tag wherever cached, and always this namespace's collection tag. keys are exact deletes in this instance's key space: the only bust a null client honours.
Parameters
- __namedParameters: {
      customerIds: readonly string[];
      keys?: readonly CacheKey[];
      records?: readonly string[];
  }
Returns Promise<void>
Inherited from DepositQuoteCache.invalidateCache
- Defined in packages/db/src/valkey/service-cache.ts:543

`Protected`invalidateQuoteWrite

invalidateQuoteWrite(
__namedParameters: { customerId: string; keys: readonly CacheKey[] },
): Promise<void>
Bust after a write to an existing quote: its pages and its deposit's.
Parameters
- __namedParameters: { customerId: string; keys: readonly CacheKey[] }
Returns Promise<void>
Inherited from DepositQuoteCache.invalidateQuoteWrite
- Defined in packages/deposit-services/src/DepositCache.ts:81

search

search(
__namedParameters: DepositQuoteAdminSearchArgs,
): Promise<{ ok: true; value: DepositQuoteAdminSearchPage }>
Parameters
- __namedParameters: DepositQuoteAdminSearchArgs
Returns Promise<{ ok: true; value: DepositQuoteAdminSearchPage }>
- Defined in packages/deposit-services/src/DepositQuoteAdminService.ts:115

searchIterator

searchIterator(
    params: Omit<
        Parameters<DepositQuoteAdminQueryService["search"]>[0],
        "page",
    >,
): AsyncGenerator<DepositQuote>
Parameters
- params: Omit<Parameters<DepositQuoteAdminQueryService["search"]>[0], "page">
Returns AsyncGenerator<DepositQuote>
- Defined in packages/deposit-services/src/DepositQuoteAdminService.ts:322

`Protected`searchTags

searchTags(
    __namedParameters: {
        customerIds: readonly string[] | undefined;
        fields?: readonly string[];
        records?: readonly string[];
    },
): string[]
Tags for a page: the scope its query searched (each customer's membership tag, else the collection tag), so an empty page is bustable too, plus the records it projects and the fields that chose or ordered its rows.
Parameters
- __namedParameters: {
      customerIds: readonly string[] | undefined;
      fields?: readonly string[];
      records?: readonly string[];
  }
Returns string[]
Inherited from DepositQuoteCache.searchTags
- Defined in packages/db/src/valkey/service-cache.ts:519

`Static`adminGetCacheKey

adminGetCacheKey(__namedParameters: { id: string }): CacheKey
The key DepositQuoteAdminQueryService.get reads through.
Parameters
- __namedParameters: { id: string }
Returns CacheKey
Inherited from DepositQuoteCache.adminGetCacheKey
- Defined in packages/deposit-services/src/DepositCache.ts:106

`Static`customerGetCacheKey

customerGetCacheKey(
__namedParameters: { customerId: string; id: string },
): CacheKey
The key DepositQuoteService.get reads through (search's page default included).
Parameters
- __namedParameters: { customerId: string; id: string }
Returns CacheKey
Inherited from DepositQuoteCache.customerGetCacheKey
- Defined in packages/deposit-services/src/DepositCache.ts:95

Class DepositQuoteAdminQueryService

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns DepositQuoteAdminQueryService

Properties

Protected Readonlycache

Protected Readonlydb

Staticinstance

Methods

findCashByBarcode

Parameters

findCashInBarcodeStatus

Parameters

get

Parameters

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

invalidateCache

Parameters

Returns Promise<void>

ProtectedinvalidateQuoteWrite

Parameters

Returns Promise<void>

search

Parameters

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

searchIterator

Parameters

Returns AsyncGenerator<DepositQuote>

ProtectedsearchTags

Parameters

Returns string[]

StaticadminGetCacheKey

Parameters

Returns CacheKey

StaticcustomerGetCacheKey

Parameters

Returns CacheKey

Settings

On This Page

`Protected` `Readonly`cache

`Protected` `Readonly`db

`Static`instance

`Protected`invalidateQuoteWrite

`Protected`searchTags

`Static`adminGetCacheKey

`Static`customerGetCacheKey