Class CashDepositRetailerAdminService

The operator surface over b2b.greendot_retailer, plus the sync that keeps it in step with Green Dot. Searches pass includeDelisted: true to see rows Green Dot no longer lists.

Hierarchy (View Summary)

CashDepositRetailerService
- CashDepositRetailerAdminService

Index

Constructors

constructor

new CashDepositRetailerAdminService(
    args: { db: B2bDatabase; valkeyClient: ValkeyClient | null } & {
        internalEventPublisher: Pick<InternalEventPublisher, "publish">;
    },
): CashDepositRetailerAdminService
Parameters
- args: { db: B2bDatabase; valkeyClient: ValkeyClient | null } & {
  internalEventPublisher: Pick<InternalEventPublisher, "publish">;
  }
Returns CashDepositRetailerAdminService
Overrides CashDepositRetailerService.constructor
- Defined in packages/deposit-services/src/cash/CashDepositRetailerAdminService.ts:59

Properties

`Protected` `Readonly`db

db: B2bDatabase

`Protected` `Readonly`retailerCache

retailerCache: ServiceCache<SearchPage<CashDepositRetailer>>

`Static`instance

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

The process default: the parent's graph plus the internal event publisher.

Methods

get

get(__namedParameters: { id: string }): Promise<CashDepositRetailer | null>
Parameters
- __namedParameters: { id: string }
Returns Promise<CashDepositRetailer | null>
Inherited from CashDepositRetailerService.get
- Defined in packages/deposit-services/src/cash/CashDepositRetailerService.ts:106

`Protected`mapFromDb

mapFromDb(
    row: {
        createdAt: Date;
        delistedAt: Date | null;
        description: string | null;
        displayName: string;
        displayPriority: string | null;
        enabled: boolean;
        enabledForTesting: boolean;
        greendotId: string;
        id: number;
        isOnboarding: string | null;
        lastSyncedAt: Date | null;
        purchaseFee: string | null;
        shortName: string | null;
        slug: string;
        updatedAt: Date;
    },
    staticAssetBaseUrl: string,
): CashDepositRetailer
Parameters
- row: {
      createdAt: Date;
      delistedAt: Date | null;
      description: string | null;
      displayName: string;
      displayPriority: string | null;
      enabled: boolean;
      enabledForTesting: boolean;
      greendotId: string;
      id: number;
      isOnboarding: string | null;
      lastSyncedAt: Date | null;
      purchaseFee: string | null;
      shortName: string | null;
      slug: string;
      updatedAt: Date;
  }
- staticAssetBaseUrl: string
Returns CashDepositRetailer
Inherited from CashDepositRetailerService.mapFromDb
- Defined in packages/deposit-services/src/cash/CashDepositRetailerService.ts:164

search

search(__namedParameters?: SearchArgs): Promise<{ ok: true; value: SearchPage }>
In table row order.
Parameters
- __namedParameters: SearchArgs = {}
Returns Promise<{ ok: true; value: SearchPage }>
Inherited from CashDepositRetailerService.search
- Defined in packages/deposit-services/src/cash/CashDepositRetailerService.ts:116

sync

sync(
    __namedParameters: { retailers: GreendotRetailer[] },
): Promise<
    { ok: true; value: SyncCounts }
    | { error: ServiceError; ok: false },
>
Applies one full Green Dot retailer list. Our own columns (display_name, slug, enabled, enabled_for_testing) are never overwritten; an id we have no row for gets one, enabled, named from Green Dot. Refuses a list that would delist more than MAX_DELIST_SHARE of the live ids. Clears the read cache once the transaction commits.
Parameters
- __namedParameters: { retailers: GreendotRetailer[] }
Returns Promise<{ ok: true; value: SyncCounts } | { error: ServiceError; ok: false }>
- Defined in packages/deposit-services/src/cash/CashDepositRetailerAdminService.ts:129

update

update(
    __namedParameters: { enabled: boolean; rowId: number },
): Promise<
    | { ok: true; value: CashDepositRetailer }
    | { error: ServiceError; ok: false },
>
Writes our own columns on one row. enabled: false hides the retailer: its stores leave the location search and barcode creation refuses it. The sync never overwrites enabled, so a hidden retailer stays hidden.
Parameters
- __namedParameters: { enabled: boolean; rowId: number }
Returns Promise<
| { ok: true; value: CashDepositRetailer }
| { error: ServiceError; ok: false },
>
- Defined in packages/deposit-services/src/cash/CashDepositRetailerAdminService.ts:73

Class CashDepositRetailerAdminService

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns CashDepositRetailerAdminService

Properties

`Protected` `Readonly`db

`Protected` `Readonly`retailerCache

`Static`instance

Methods

get

Parameters

Returns Promise<CashDepositRetailer | null>

`Protected`mapFromDb

Parameters

Returns CashDepositRetailer

search

Parameters

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

sync

Parameters

Returns Promise<{ ok: true; value: SyncCounts } | { error: ServiceError; ok: false }>

update

Parameters

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

Settings

On This Page

Class CashDepositRetailerAdminService

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns CashDepositRetailerAdminService

Properties

Protected Readonlydb

Protected ReadonlyretailerCache

Staticinstance

Methods

get

Parameters

Returns Promise<CashDepositRetailer | null>

ProtectedmapFromDb

Parameters

Returns CashDepositRetailer

search

Parameters

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

sync

Parameters

Returns Promise<{ ok: true; value: SyncCounts } | { error: ServiceError; ok: false }>

update

Parameters

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

Settings

On This Page

`Protected` `Readonly`db

`Protected` `Readonly`retailerCache

`Static`instance

`Protected`mapFromDb

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