Class SmsTemplateService

The cached read of stored SMS templates (SLACK_TEMPLATES.md §7). A few dozen rows at most, so every row is one cache entry and search filters the registry in memory; SmsTemplateAdminService deletes the entry on every write.

Hierarchy (View Summary)

SmsTemplateService
- SmsTemplateAdminService

Index

Constructors

constructor

new SmsTemplateService(
    __namedParameters: {
        db: B2bDatabase;
        valkeyClient: ValkeyClient | null;
    },
): SmsTemplateService
Parameters
- __namedParameters: { db: B2bDatabase; valkeyClient: ValkeyClient | null }
Returns SmsTemplateService
- Defined in packages/notification-services/src/sms-services/SmsTemplateService.ts:103

Properties

`Protected` `Readonly`cache

cache: ServiceCache<StoredSmsTemplateRow[]>

`Protected` `Readonly`db

db: B2bDatabase

`Static`instance

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

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

Methods

get

get(
    __namedParameters: {
        templateKey:
            | "CUSTOMER_DEPOSIT_PENDING"
            | "CUSTOMER_DEPOSIT_COMPLETED"
            | "CUSTOMER_DEPOSIT_CANCELLED"
            | "CUSTOMER_WITHDRAWAL_PENDING"
            | "CUSTOMER_WITHDRAWAL_COMPLETED"
            | "CUSTOMER_WITHDRAWAL_RETURNED"
            | "CUSTOMER_TRANSFER_PENDING"
            | "CUSTOMER_TRANSFER_COMPLETED"
            | "CUSTOMER_TRANSFER_CANCELLED"
            | "CUSTOMER_CARD_TRANSACTION_PENDING"
            | "CUSTOMER_CARD_TRANSACTION_AUTHORIZED"
            | "CUSTOMER_CARD_TRANSACTION_COMPLETED"
            | "CUSTOMER_CARD_TRANSACTION_DECLINED"
            | "CUSTOMER_IDENTITY_PENDING_VERIFICATION"
            | "CUSTOMER_IDENTITY_ACTIVE"
            | "CUSTOMER_IDENTITY_REVIEW"
            | "CUSTOMER_IDENTITY_DISABLED"
            | "CUSTOMER_IDENTITY_BLOCKED"
            | "CUSTOMER_ORGANIZATION_PENDING_VERIFICATION"
            | "CUSTOMER_ORGANIZATION_ACTIVE"
            | "CUSTOMER_ORGANIZATION_DISABLED"
            | "CUSTOMER_LEDGER_ACCOUNT_CREATED"
            | "CUSTOMER_PAYMENT_INSTRUMENT_PENDING_VERIFICATION"
            | "CUSTOMER_PAYMENT_INSTRUMENT_ACTIVE"
            | "CUSTOMER_PAYMENT_INSTRUMENT_BLOCKED"
            | "ESCROW_RECIPIENT_NOTIFIED"
            | "ESCROW_CLAIMED"
            | "ESCROW_CANCELLED"
            | "ESCROW_REJECTED"
            | "ESCROW_REQUEST_CREATED"
            | "ESCROW_REQUEST_PAID"
            | "ESCROW_REQUEST_DECLINED"
            | "ESCROW_REQUEST_CANCELLED";
    },
): Promise<SmsTemplate | null>
Parameters
- __namedParameters: {
      templateKey:
          | "CUSTOMER_DEPOSIT_PENDING"
          | "CUSTOMER_DEPOSIT_COMPLETED"
          | "CUSTOMER_DEPOSIT_CANCELLED"
          | "CUSTOMER_WITHDRAWAL_PENDING"
          | "CUSTOMER_WITHDRAWAL_COMPLETED"
          | "CUSTOMER_WITHDRAWAL_RETURNED"
          | "CUSTOMER_TRANSFER_PENDING"
          | "CUSTOMER_TRANSFER_COMPLETED"
          | "CUSTOMER_TRANSFER_CANCELLED"
          | "CUSTOMER_CARD_TRANSACTION_PENDING"
          | "CUSTOMER_CARD_TRANSACTION_AUTHORIZED"
          | "CUSTOMER_CARD_TRANSACTION_COMPLETED"
          | "CUSTOMER_CARD_TRANSACTION_DECLINED"
          | "CUSTOMER_IDENTITY_PENDING_VERIFICATION"
          | "CUSTOMER_IDENTITY_ACTIVE"
          | "CUSTOMER_IDENTITY_REVIEW"
          | "CUSTOMER_IDENTITY_DISABLED"
          | "CUSTOMER_IDENTITY_BLOCKED"
          | "CUSTOMER_ORGANIZATION_PENDING_VERIFICATION"
          | "CUSTOMER_ORGANIZATION_ACTIVE"
          | "CUSTOMER_ORGANIZATION_DISABLED"
          | "CUSTOMER_LEDGER_ACCOUNT_CREATED"
          | "CUSTOMER_PAYMENT_INSTRUMENT_PENDING_VERIFICATION"
          | "CUSTOMER_PAYMENT_INSTRUMENT_ACTIVE"
          | "CUSTOMER_PAYMENT_INSTRUMENT_BLOCKED"
          | "ESCROW_RECIPIENT_NOTIFIED"
          | "ESCROW_CLAIMED"
          | "ESCROW_CANCELLED"
          | "ESCROW_REJECTED"
          | "ESCROW_REQUEST_CREATED"
          | "ESCROW_REQUEST_PAID"
          | "ESCROW_REQUEST_DECLINED"
          | "ESCROW_REQUEST_CANCELLED";
  }
Returns Promise<SmsTemplate | null>
- Defined in packages/notification-services/src/sms-services/SmsTemplateService.ts:153

`Protected`getUncached

getUncached(
    templateKey:
        | "CUSTOMER_DEPOSIT_PENDING"
        | "CUSTOMER_DEPOSIT_COMPLETED"
        | "CUSTOMER_DEPOSIT_CANCELLED"
        | "CUSTOMER_WITHDRAWAL_PENDING"
        | "CUSTOMER_WITHDRAWAL_COMPLETED"
        | "CUSTOMER_WITHDRAWAL_RETURNED"
        | "CUSTOMER_TRANSFER_PENDING"
        | "CUSTOMER_TRANSFER_COMPLETED"
        | "CUSTOMER_TRANSFER_CANCELLED"
        | "CUSTOMER_CARD_TRANSACTION_PENDING"
        | "CUSTOMER_CARD_TRANSACTION_AUTHORIZED"
        | "CUSTOMER_CARD_TRANSACTION_COMPLETED"
        | "CUSTOMER_CARD_TRANSACTION_DECLINED"
        | "CUSTOMER_IDENTITY_PENDING_VERIFICATION"
        | "CUSTOMER_IDENTITY_ACTIVE"
        | "CUSTOMER_IDENTITY_REVIEW"
        | "CUSTOMER_IDENTITY_DISABLED"
        | "CUSTOMER_IDENTITY_BLOCKED"
        | "CUSTOMER_ORGANIZATION_PENDING_VERIFICATION"
        | "CUSTOMER_ORGANIZATION_ACTIVE"
        | "CUSTOMER_ORGANIZATION_DISABLED"
        | "CUSTOMER_LEDGER_ACCOUNT_CREATED"
        | "CUSTOMER_PAYMENT_INSTRUMENT_PENDING_VERIFICATION"
        | "CUSTOMER_PAYMENT_INSTRUMENT_ACTIVE"
        | "CUSTOMER_PAYMENT_INSTRUMENT_BLOCKED"
        | "ESCROW_RECIPIENT_NOTIFIED"
        | "ESCROW_CLAIMED"
        | "ESCROW_CANCELLED"
        | "ESCROW_REJECTED"
        | "ESCROW_REQUEST_CREATED"
        | "ESCROW_REQUEST_PAID"
        | "ESCROW_REQUEST_DECLINED"
        | "ESCROW_REQUEST_CANCELLED",
): Promise<SmsTemplate>
One template read past the cache, so a write's re-read sees its commit.
Parameters
- templateKey:
      | "CUSTOMER_DEPOSIT_PENDING"
      | "CUSTOMER_DEPOSIT_COMPLETED"
      | "CUSTOMER_DEPOSIT_CANCELLED"
      | "CUSTOMER_WITHDRAWAL_PENDING"
      | "CUSTOMER_WITHDRAWAL_COMPLETED"
      | "CUSTOMER_WITHDRAWAL_RETURNED"
      | "CUSTOMER_TRANSFER_PENDING"
      | "CUSTOMER_TRANSFER_COMPLETED"
      | "CUSTOMER_TRANSFER_CANCELLED"
      | "CUSTOMER_CARD_TRANSACTION_PENDING"
      | "CUSTOMER_CARD_TRANSACTION_AUTHORIZED"
      | "CUSTOMER_CARD_TRANSACTION_COMPLETED"
      | "CUSTOMER_CARD_TRANSACTION_DECLINED"
      | "CUSTOMER_IDENTITY_PENDING_VERIFICATION"
      | "CUSTOMER_IDENTITY_ACTIVE"
      | "CUSTOMER_IDENTITY_REVIEW"
      | "CUSTOMER_IDENTITY_DISABLED"
      | "CUSTOMER_IDENTITY_BLOCKED"
      | "CUSTOMER_ORGANIZATION_PENDING_VERIFICATION"
      | "CUSTOMER_ORGANIZATION_ACTIVE"
      | "CUSTOMER_ORGANIZATION_DISABLED"
      | "CUSTOMER_LEDGER_ACCOUNT_CREATED"
      | "CUSTOMER_PAYMENT_INSTRUMENT_PENDING_VERIFICATION"
      | "CUSTOMER_PAYMENT_INSTRUMENT_ACTIVE"
      | "CUSTOMER_PAYMENT_INSTRUMENT_BLOCKED"
      | "ESCROW_RECIPIENT_NOTIFIED"
      | "ESCROW_CLAIMED"
      | "ESCROW_CANCELLED"
      | "ESCROW_REJECTED"
      | "ESCROW_REQUEST_CREATED"
      | "ESCROW_REQUEST_PAID"
      | "ESCROW_REQUEST_DECLINED"
      | "ESCROW_REQUEST_CANCELLED"
Returns Promise<SmsTemplate>
- Defined in packages/notification-services/src/sms-services/SmsTemplateService.ts:207

getVersion

getVersion(
__namedParameters: { id: string },
): Promise<SmsTemplateVersionBody | null>
One saved version by its smstv_… id, whichever pointer (if any) names it.
Parameters
- __namedParameters: { id: string }
Returns Promise<SmsTemplateVersionBody | null>
- Defined in packages/notification-services/src/sms-services/SmsTemplateService.ts:126

`Protected`invalidate

invalidate(): Promise<void>
Clears the cached rows; every write calls it after commit. A delete Valkey drops is logged by the store and the rows age out within the TTL.

Returns Promise<void>
- Defined in packages/notification-services/src/sms-services/SmsTemplateService.ts:202

search

search(
    input?: {
        ids?: readonly string[];
        keys?: readonly (
            | "CUSTOMER_DEPOSIT_PENDING"
            | "CUSTOMER_DEPOSIT_COMPLETED"
            | "CUSTOMER_DEPOSIT_CANCELLED"
            | "CUSTOMER_WITHDRAWAL_PENDING"
            | "CUSTOMER_WITHDRAWAL_COMPLETED"
            | "CUSTOMER_WITHDRAWAL_RETURNED"
            | "CUSTOMER_TRANSFER_PENDING"
            | "CUSTOMER_TRANSFER_COMPLETED"
            | "CUSTOMER_TRANSFER_CANCELLED"
            | "CUSTOMER_CARD_TRANSACTION_PENDING"
            | "CUSTOMER_CARD_TRANSACTION_AUTHORIZED"
            | "CUSTOMER_CARD_TRANSACTION_COMPLETED"
            | "CUSTOMER_CARD_TRANSACTION_DECLINED"
            | "CUSTOMER_IDENTITY_PENDING_VERIFICATION"
            | "CUSTOMER_IDENTITY_ACTIVE"
            | "CUSTOMER_IDENTITY_REVIEW"
            | "CUSTOMER_IDENTITY_DISABLED"
            | "CUSTOMER_IDENTITY_BLOCKED"
            | "CUSTOMER_ORGANIZATION_PENDING_VERIFICATION"
            | "CUSTOMER_ORGANIZATION_ACTIVE"
            | "CUSTOMER_ORGANIZATION_DISABLED"
            | "CUSTOMER_LEDGER_ACCOUNT_CREATED"
            | "CUSTOMER_PAYMENT_INSTRUMENT_PENDING_VERIFICATION"
            | "CUSTOMER_PAYMENT_INSTRUMENT_ACTIVE"
            | "CUSTOMER_PAYMENT_INSTRUMENT_BLOCKED"
            | "ESCROW_RECIPIENT_NOTIFIED"
            | "ESCROW_CLAIMED"
            | "ESCROW_CANCELLED"
            | "ESCROW_REJECTED"
            | "ESCROW_REQUEST_CREATED"
            | "ESCROW_REQUEST_PAID"
            | "ESCROW_REQUEST_DECLINED"
            | "ESCROW_REQUEST_CANCELLED"
        )[];
        page?: number;
        pageSize?: number;
        statuses?: readonly ("DISABLED" | "ACTIVE")[];
    },
): Promise<
    {
        ok: true;
        value: { hasNext: boolean; items: SmsTemplate[]; total: number };
    },
>
Every registry template, in registry order, merged with its row.
Parameters
- input: {
      ids?: readonly string[];
      keys?: readonly (
          | "CUSTOMER_DEPOSIT_PENDING"
          | "CUSTOMER_DEPOSIT_COMPLETED"
          | "CUSTOMER_DEPOSIT_CANCELLED"
          | "CUSTOMER_WITHDRAWAL_PENDING"
          | "CUSTOMER_WITHDRAWAL_COMPLETED"
          | "CUSTOMER_WITHDRAWAL_RETURNED"
          | "CUSTOMER_TRANSFER_PENDING"
          | "CUSTOMER_TRANSFER_COMPLETED"
          | "CUSTOMER_TRANSFER_CANCELLED"
          | "CUSTOMER_CARD_TRANSACTION_PENDING"
          | "CUSTOMER_CARD_TRANSACTION_AUTHORIZED"
          | "CUSTOMER_CARD_TRANSACTION_COMPLETED"
          | "CUSTOMER_CARD_TRANSACTION_DECLINED"
          | "CUSTOMER_IDENTITY_PENDING_VERIFICATION"
          | "CUSTOMER_IDENTITY_ACTIVE"
          | "CUSTOMER_IDENTITY_REVIEW"
          | "CUSTOMER_IDENTITY_DISABLED"
          | "CUSTOMER_IDENTITY_BLOCKED"
          | "CUSTOMER_ORGANIZATION_PENDING_VERIFICATION"
          | "CUSTOMER_ORGANIZATION_ACTIVE"
          | "CUSTOMER_ORGANIZATION_DISABLED"
          | "CUSTOMER_LEDGER_ACCOUNT_CREATED"
          | "CUSTOMER_PAYMENT_INSTRUMENT_PENDING_VERIFICATION"
          | "CUSTOMER_PAYMENT_INSTRUMENT_ACTIVE"
          | "CUSTOMER_PAYMENT_INSTRUMENT_BLOCKED"
          | "ESCROW_RECIPIENT_NOTIFIED"
          | "ESCROW_CLAIMED"
          | "ESCROW_CANCELLED"
          | "ESCROW_REJECTED"
          | "ESCROW_REQUEST_CREATED"
          | "ESCROW_REQUEST_PAID"
          | "ESCROW_REQUEST_DECLINED"
          | "ESCROW_REQUEST_CANCELLED"
      )[];
      page?: number;
      pageSize?: number;
      statuses?: readonly ("DISABLED" | "ACTIVE")[];
  } = {}
Returns Promise<
    {
        ok: true;
        value: { hasNext: boolean; items: SmsTemplate[]; total: number };
    },
>
- Defined in packages/notification-services/src/sms-services/SmsTemplateService.ts:163

Class SmsTemplateService

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns SmsTemplateService

Properties

`Protected` `Readonly`cache

`Protected` `Readonly`db

`Static`instance

Methods

get

Parameters

Returns Promise<SmsTemplate | null>

`Protected`getUncached

Parameters

Returns Promise<SmsTemplate>

getVersion

Parameters

Returns Promise<SmsTemplateVersionBody | null>

`Protected`invalidate

Returns Promise<void>

search

Parameters

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

Settings

On This Page

Class SmsTemplateService

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns SmsTemplateService

Properties

Protected Readonlycache

Protected Readonlydb

Staticinstance

Methods

get

Parameters

Returns Promise<SmsTemplate | null>

ProtectedgetUncached

Parameters

Returns Promise<SmsTemplate>

getVersion

Parameters

Returns Promise<SmsTemplateVersionBody | null>

Protectedinvalidate

Returns Promise<void>

search

Parameters

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

Settings

On This Page

`Protected` `Readonly`cache

`Protected` `Readonly`db

`Static`instance

`Protected`getUncached

`Protected`invalidate

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