Class EntityProductBlockAdminService

Manages blocking an entity from using a product

This is scoped to the admin. Use EntityProductBlockService to act as a customer.

Hierarchy (View Summary)

EntityProductBlockService
- EntityProductBlockAdminService

Index

Constructors

constructor

new EntityProductBlockAdminService(
__namedParameters: { sqlClient: Sql },
): EntityProductBlockAdminService
Parameters
- __namedParameters: { sqlClient: Sql }
Returns EntityProductBlockAdminService
Inherited from EntityProductBlockService.constructor
- Defined in entity-product-services/src/EntityProductBlockService.ts:36

Properties

`Protected` `Readonly`db

db: B2bDatabase

`Protected` `Readonly`dbHelper

dbHelper: DbHelper

Methods

create

create(
    input: Omit<EntityProductBlock, "type" | "createdAt" | "updatedAt"> & {
        customerId: string;
    },
): Promise<
    Promise<
        | { ok: true; value: EntityProductBlock }
        | { error: ServiceError; ok: false },
    >,
>
Parameters
- input: Omit<EntityProductBlock, "type" | "createdAt" | "updatedAt"> & {
  customerId: string;
  }
Returns Promise<
    Promise<
        | { ok: true; value: EntityProductBlock }
        | { error: ServiceError; ok: false },
    >,
>
Overrides EntityProductBlockService.create
- Defined in entity-product-services/src/EntityProductBlockAdminService.ts:11

`Protected`doCreate

doCreate(
    __namedParameters: Omit<EntityProductBlock, "createdAt" | "updatedAt"> & {
        customerId: string;
    },
): Promise<
    | { ok: true; value: EntityProductBlock }
    | { error: ServiceError; ok: false },
>
Parameters
- __namedParameters: Omit<EntityProductBlock, "createdAt" | "updatedAt"> & { customerId: string }
Returns Promise<
| { ok: true; value: EntityProductBlock }
| { error: ServiceError; ok: false },
>
Inherited from EntityProductBlockService.doCreate
- Defined in entity-product-services/src/EntityProductBlockService.ts:171

`Protected`doUpdate

doUpdate(
    __namedParameters: Pick<
        EntityProductBlock,
        "type"
        | "entityId"
        | "productName",
    > & {
        customerId: string;
        data: Partial<Pick<EntityProductBlock, "status" | "note">>;
    },
): Promise<
    | { ok: true; value: EntityProductBlock }
    | { error: ServiceError; ok: false },
>
Parameters
- __namedParameters: Pick<EntityProductBlock, "type" | "entityId" | "productName"> & {
  customerId: string;
  data: Partial<Pick<EntityProductBlock, "status" | "note">>;
  }
Returns Promise<
| { ok: true; value: EntityProductBlock }
| { error: ServiceError; ok: false },
>
Inherited from EntityProductBlockService.doUpdate
- Defined in entity-product-services/src/EntityProductBlockService.ts:214

isBlocked

isBlocked(
    __namedParameters: Pick<EntityProductBlock, "entityId" | "productName"> & {
        customerId: string;
    },
): Promise<
    {
        ok: true;
        value: | { status: "UNBLOCKED" }
        | {
            note: string;
            reason: "BLOCKED_BY_CUSTOMER" | "BLOCKED_BY_ADMIN";
            status: "BLOCKED";
        };
    },
>
Parameters
- __namedParameters: Pick<EntityProductBlock, "entityId" | "productName"> & { customerId: string }
Returns Promise<
    {
        ok: true;
        value: | { status: "UNBLOCKED" }
        | {
            note: string;
            reason: "BLOCKED_BY_CUSTOMER" | "BLOCKED_BY_ADMIN";
            status: "BLOCKED";
        };
    },
>
Whether an admin or the customer has blocked an entity from using a product
Inherited from EntityProductBlockService.isBlocked
- Defined in entity-product-services/src/EntityProductBlockService.ts:111

search

search(
    __namedParameters: {
        customerId: string;
        productNames?: (
            | "organization.v1"
            | "identity.v1"
            | "card.physical_card.v1"
            | "card.virtual_card.v1"
            | "deposit.us_cash.v1"
            | "deposit.rtp.v1"
            | "deposit.us_bank_ach.v1"
            | "deposit.ach_credit.v1"
            | "deposit.us_wire.v1"
            | "deposit.swift_wire.v1"
            | "transfer.redemption.v1"
            | "swap.v1"
            | "withdraw.blockchain.v1"
            | "withdraw.ke_bank.v1"
            | "withdraw.ke_momo.v1"
            | "withdraw.mx_bank_spei.v1"
            | "withdraw.swift_wire.v1"
            | "withdraw.tg_momo.v1"
            | "withdraw.us_bank_ach.v1"
            | "withdraw.us_instant.v1"
            | "withdraw.us_wire.v1"
            | "withdraw.ach_pull.v1"
            | "withdraw.us_wire_drawdown.v1"
            | "account.virtual-account.v1"
        )[];
        statuses?: ("BLOCKED" | "UNBLOCKED")[];
        types?: ("ADMIN" | "CUSTOMER")[];
    },
): Promise<{ ok: true; value: EntityProductBlock[] }>
Parameters
- __namedParameters: {
      customerId: string;
      productNames?: (
          | "organization.v1"
          | "identity.v1"
          | "card.physical_card.v1"
          | "card.virtual_card.v1"
          | "deposit.us_cash.v1"
          | "deposit.rtp.v1"
          | "deposit.us_bank_ach.v1"
          | "deposit.ach_credit.v1"
          | "deposit.us_wire.v1"
          | "deposit.swift_wire.v1"
          | "transfer.redemption.v1"
          | "swap.v1"
          | "withdraw.blockchain.v1"
          | "withdraw.ke_bank.v1"
          | "withdraw.ke_momo.v1"
          | "withdraw.mx_bank_spei.v1"
          | "withdraw.swift_wire.v1"
          | "withdraw.tg_momo.v1"
          | "withdraw.us_bank_ach.v1"
          | "withdraw.us_instant.v1"
          | "withdraw.us_wire.v1"
          | "withdraw.ach_pull.v1"
          | "withdraw.us_wire_drawdown.v1"
          | "account.virtual-account.v1"
      )[];
      statuses?: ("BLOCKED" | "UNBLOCKED")[];
      types?: ("ADMIN" | "CUSTOMER")[];
  }
Returns Promise<{ ok: true; value: EntityProductBlock[] }>
Inherited from EntityProductBlockService.search
- Defined in entity-product-services/src/EntityProductBlockService.ts:58

update

update(
    input: Pick<EntityProductBlock, "entityId" | "productName"> & {
        customerId: string;
        data: Partial<Pick<EntityProductBlock, "status" | "note">>;
    },
): Promise<
    Promise<
        | { ok: true; value: EntityProductBlock }
        | { error: ServiceError; ok: false },
    >,
>
Parameters
- input: Pick<EntityProductBlock, "entityId" | "productName"> & {
  customerId: string;
  data: Partial<Pick<EntityProductBlock, "status" | "note">>;
  }
Returns Promise<
    Promise<
        | { ok: true; value: EntityProductBlock }
        | { error: ServiceError; ok: false },
    >,
>
Overrides EntityProductBlockService.update
- Defined in entity-product-services/src/EntityProductBlockAdminService.ts:19

`Protected` `Static`mapFromDb

mapFromDb(
    input: {
        createdAt: Date;
        customerId: number;
        id: number;
        identityId: number | null;
        note: string;
        organizationId: number | null;
        productName:
            | "organization.v1"
            | "identity.v1"
            | "card.physical_card.v1"
            | "card.virtual_card.v1"
            | "deposit.us_cash.v1"
            | "deposit.rtp.v1"
            | "deposit.us_bank_ach.v1"
            | "deposit.ach_credit.v1"
            | "deposit.us_wire.v1"
            | "deposit.swift_wire.v1"
            | "transfer.redemption.v1"
            | "swap.v1"
            | "withdraw.blockchain.v1"
            | "withdraw.ke_bank.v1"
            | "withdraw.ke_momo.v1"
            | "withdraw.mx_bank_spei.v1"
            | "withdraw.swift_wire.v1"
            | "withdraw.tg_momo.v1"
            | "withdraw.us_bank_ach.v1"
            | "withdraw.us_instant.v1"
            | "withdraw.us_wire.v1"
            | "withdraw.ach_pull.v1"
            | "withdraw.us_wire_drawdown.v1"
            | "account.virtual-account.v1";
        status: "BLOCKED"
        | "UNBLOCKED";
        type: "ADMIN" | "CUSTOMER";
        updatedAt: Date;
    } & { entityId: string },
): EntityProductBlock
Parameters
- input: {
      createdAt: Date;
      customerId: number;
      id: number;
      identityId: number | null;
      note: string;
      organizationId: number | null;
      productName:
          | "organization.v1"
          | "identity.v1"
          | "card.physical_card.v1"
          | "card.virtual_card.v1"
          | "deposit.us_cash.v1"
          | "deposit.rtp.v1"
          | "deposit.us_bank_ach.v1"
          | "deposit.ach_credit.v1"
          | "deposit.us_wire.v1"
          | "deposit.swift_wire.v1"
          | "transfer.redemption.v1"
          | "swap.v1"
          | "withdraw.blockchain.v1"
          | "withdraw.ke_bank.v1"
          | "withdraw.ke_momo.v1"
          | "withdraw.mx_bank_spei.v1"
          | "withdraw.swift_wire.v1"
          | "withdraw.tg_momo.v1"
          | "withdraw.us_bank_ach.v1"
          | "withdraw.us_instant.v1"
          | "withdraw.us_wire.v1"
          | "withdraw.ach_pull.v1"
          | "withdraw.us_wire_drawdown.v1"
          | "account.virtual-account.v1";
      status: "BLOCKED"
      | "UNBLOCKED";
      type: "ADMIN" | "CUSTOMER";
      updatedAt: Date;
  } & { entityId: string }
Returns EntityProductBlock
Inherited from EntityProductBlockService.mapFromDb
- Defined in entity-product-services/src/EntityProductBlockService.ts:262

Class EntityProductBlockAdminService

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns EntityProductBlockAdminService

Properties

`Protected` `Readonly`db

`Protected` `Readonly`dbHelper

Methods

create

Parameters

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

`Protected`doCreate

Parameters

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

`Protected`doUpdate

Parameters

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

isBlocked

Parameters

Returns Promise<
    {
        ok: true;
        value: | { status: "UNBLOCKED" }
        | {
            note: string;
            reason: "BLOCKED_BY_CUSTOMER" | "BLOCKED_BY_ADMIN";
            status: "BLOCKED";
        };
    },
>

search

Parameters

Returns Promise<{ ok: true; value: EntityProductBlock[] }>

update

Parameters

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

`Protected` `Static`mapFromDb

Parameters

Returns EntityProductBlock

Settings

On This Page

Class EntityProductBlockAdminService

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns EntityProductBlockAdminService

Properties

Protected Readonlydb

Protected ReadonlydbHelper

Methods

create

Parameters

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

ProtecteddoCreate

Parameters

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

ProtecteddoUpdate

Parameters

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

isBlocked

Parameters

Returns Promise< { ok: true; value: | { status: "UNBLOCKED" } | { note: string; reason: "BLOCKED_BY_CUSTOMER" | "BLOCKED_BY_ADMIN"; status: "BLOCKED"; }; },>

search

Parameters

Returns Promise<{ ok: true; value: EntityProductBlock[] }>

update

Parameters

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

Protected StaticmapFromDb

Parameters

Returns EntityProductBlock

Settings

On This Page

`Protected` `Readonly`db

`Protected` `Readonly`dbHelper

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

`Protected`doCreate

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

`Protected`doUpdate

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

Returns Promise<
{
ok: true;
value: | { status: "UNBLOCKED" }
| {
note: string;
reason: "BLOCKED_BY_CUSTOMER" | "BLOCKED_BY_ADMIN";
status: "BLOCKED";
};
},
>

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

`Protected` `Static`mapFromDb