Class GirasolPhysicalCardService

Hierarchy

GirasolCardService
- GirasolPhysicalCardService

Index

Constructors

constructor

new GirasolPhysicalCardService(
    args: {
        entityProductService: EntityProductService;
        girasolCardQueryService: GirasolCardQueryService;
        girasolClient: GirasolClient;
        sqlClient: Sql;
    },
): GirasolPhysicalCardService
Parameters
- args: {
      entityProductService: EntityProductService;
      girasolCardQueryService: GirasolCardQueryService;
      girasolClient: GirasolClient;
      sqlClient: Sql;
  }
Returns GirasolPhysicalCardService
Overrides GirasolCardService.constructor
- Defined in packages/girasol-card-services/src/GirasolPhysicalCardService.ts:33

Properties

`Protected` `Readonly`db

db: B2bDatabase

`Protected` `Readonly`dbHelper

dbHelper: DbHelper

`Protected` `Readonly`girasolCardQueryService

girasolCardQueryService: GirasolCardQueryService

`Protected` `Readonly`girasolClient

girasolClient: GirasolClient

Methods

block

block(
    __namedParameters: { customerId: string; id: string },
): Promise<
    | { ok: true; value: GirasolCardStatus }
    | { error: ServiceError; ok: false },
>
Parameters
- __namedParameters: { customerId: string; id: string }
Returns Promise<
| { ok: true; value: GirasolCardStatus }
| { error: ServiceError; ok: false },
>
Inherited from GirasolCardService.block
- Defined in packages/girasol-card-services/src/internal/GirasolCardService.ts:150

create

create(
    input: Input,
): Promise<
    | {
        error: | ServiceError<"INVALID_ENTITY">
        | ServiceError<"ENTITY_NOT_FOUND">
        | ServiceError<"CARD_ACCOUNT_NOT_FOUND" | "CARD_ACCOUNT_NOT_ACTIVE">;
        ok: false;
    }
    | {
        ok: true;
        value: {
            createdAt: Date;
            displayName: string;
            expiryMonth?: string;
            expiryYear?: string;
            firstName: string;
            girasolCardId: string;
            id: string;
            lastFourDigits?: string;
            lastName: string;
            phone: string;
            shippingAddress?: {
                city: string;
                countryCode: string;
                line1: string;
                line2?: string;
                postalCode: string;
                region?: string;
            };
            status: GirasolCardStatus;
            type: "VIRTUAL"
            | "PHYSICAL";
            updatedAt: Date;
        };
    },
>
Parameters
- input: Input
Returns Promise<
    | {
        error: | ServiceError<"INVALID_ENTITY">
        | ServiceError<"ENTITY_NOT_FOUND">
        | ServiceError<"CARD_ACCOUNT_NOT_FOUND" | "CARD_ACCOUNT_NOT_ACTIVE">;
        ok: false;
    }
    | {
        ok: true;
        value: {
            createdAt: Date;
            displayName: string;
            expiryMonth?: string;
            expiryYear?: string;
            firstName: string;
            girasolCardId: string;
            id: string;
            lastFourDigits?: string;
            lastName: string;
            phone: string;
            shippingAddress?: {
                city: string;
                countryCode: string;
                line1: string;
                line2?: string;
                postalCode: string;
                region?: string;
            };
            status: GirasolCardStatus;
            type: "VIRTUAL"
            | "PHYSICAL";
            updatedAt: Date;
        };
    },
>
- Defined in packages/girasol-card-services/src/GirasolPhysicalCardService.ts:43

freeze

freeze(
    __namedParameters: { customerId: string; id: string },
): Promise<
    | { ok: true; value: GirasolCardStatus }
    | { error: ServiceError; ok: false },
>
Freezes a card by its card ID via GirasolClient and updates the local DB status to 'FREEZED'.
Parameters
- __namedParameters: { customerId: string; id: string }
Returns Promise<
| { ok: true; value: GirasolCardStatus }
| { error: ServiceError; ok: false },
>
Inherited from GirasolCardService.freeze
- Defined in packages/girasol-card-services/src/internal/GirasolCardService.ts:85

`Protected`getActiveCardAccount

getActiveCardAccount(
    __namedParameters: { customerId: string },
): Promise<
    | {
        ok: true;
        value: {
            girasolAccountNumber: string;
            id: number;
            status: "ACTIVE"
            | "DELETED"
            | "INACTIVE"
            | "UNKNOWN";
        };
    }
    | { error: ServiceError; ok: false },
>
Fetches the active Girasol card account for the customer.
Parameters
- __namedParameters: { customerId: string }
Returns Promise<
    | {
        ok: true;
        value: {
            girasolAccountNumber: string;
            id: number;
            status: "ACTIVE"
            | "DELETED"
            | "INACTIVE"
            | "UNKNOWN";
        };
    }
    | { error: ServiceError; ok: false },
>
Inherited from GirasolCardService.getActiveCardAccount
- Defined in packages/girasol-card-services/src/internal/GirasolCardService.ts:184

getCardToken

getCardToken(
    customerId: { customerId: string; id: string },
): Promise<
    | { ok: true; value: { girasolCardId: string; token: string } }
    | { error: ServiceError; ok: false },
>
Returns auth token to fetch the card's data from Girasol. Consumer must implement their own logic to fetch the card data from Girasol using the token.
Parameters
- customerId: { customerId: string; id: string }
  The ID of the customer.
Returns Promise<
| { ok: true; value: { girasolCardId: string; token: string } }
| { error: ServiceError; ok: false },
>
A promise that resolves to the auth token and Girasol card ID.
Inherited from GirasolCardService.getCardToken
- Defined in packages/girasol-card-services/src/internal/GirasolCardService.ts:46

unfreeze

unfreeze(
    __namedParameters: { customerId: string; id: string },
): Promise<
    | { ok: true; value: GirasolCardStatus }
    | { error: ServiceError; ok: false },
>
Unfreezes a card by its card ID via GirasolClient and updates the local DB status from 'FREEZED' to "ACTIVE".
Parameters
- __namedParameters: { customerId: string; id: string }
Returns Promise<
| { ok: true; value: GirasolCardStatus }
| { error: ServiceError; ok: false },
>
Inherited from GirasolCardService.unfreeze
- Defined in packages/girasol-card-services/src/internal/GirasolCardService.ts:119

Class GirasolPhysicalCardService

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns GirasolPhysicalCardService

Properties

`Protected` `Readonly`db

`Protected` `Readonly`dbHelper

`Protected` `Readonly`girasolCardQueryService

`Protected` `Readonly`girasolClient

Methods

block

Parameters

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

create

Parameters

freeze

Parameters

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

`Protected`getActiveCardAccount

Parameters

Returns Promise<
    | {
        ok: true;
        value: {
            girasolAccountNumber: string;
            id: number;
            status: "ACTIVE"
            | "DELETED"
            | "INACTIVE"
            | "UNKNOWN";
        };
    }
    | { error: ServiceError; ok: false },
>

getCardToken

Parameters

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

unfreeze

Parameters

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

Settings

On This Page

Class GirasolPhysicalCardService

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns GirasolPhysicalCardService

Properties

Protected Readonlydb

Protected ReadonlydbHelper

Protected ReadonlygirasolCardQueryService

Protected ReadonlygirasolClient

Methods

block

Parameters

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

create

Parameters

freeze

Parameters

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

ProtectedgetActiveCardAccount

Parameters

Returns Promise< | { ok: true; value: { girasolAccountNumber: string; id: number; status: "ACTIVE" | "DELETED" | "INACTIVE" | "UNKNOWN"; }; } | { error: ServiceError; ok: false },>

getCardToken

Parameters

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

unfreeze

Parameters

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

Settings

On This Page

`Protected` `Readonly`db

`Protected` `Readonly`dbHelper

`Protected` `Readonly`girasolCardQueryService

`Protected` `Readonly`girasolClient

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

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

`Protected`getActiveCardAccount

Returns Promise<
| {
ok: true;
value: {
girasolAccountNumber: string;
id: number;
status: "ACTIVE"
| "DELETED"
| "INACTIVE"
| "UNKNOWN";
};
}
| { error: ServiceError; ok: false },
>

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

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