@cfxlabsinc/b2b-services
    Preparing search index...
    Index

    Constructors

    Properties

    Methods

    Constructors

    Properties

    girasolClient: GirasolClient

    Methods

    • Get card by ID for the customer.

      Parameters

      • id: { customerId: string; id: string }

        The ID of the card. Example: card_1234567890.

      Returns Promise<
          {
              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;
              }
              | null;
          },
      >

      A promise that resolves to the card record.

    • Search cards for the customer.

      Parameters

      • customerId: {
            createdAt?: DbTimestampCriteria;
            customerId: string;
            girasolCardIds?: string[];
            ids?: string[];
            orderBy?: DbOrderByCriterion<
                Omit<
                    PgTableWithColumns<
                        {
                            columns: {
                                createdAt: PgBuildColumn<
                                    "girasol_card",
                                    SetHasDefault<SetNotNull<(...)>>,
                                    {
                                        data: Date;
                                        dataType: "object date";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: true;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: true;
                                        tableName: "girasol_card";
                                    },
                                >;
                                customerId: PgBuildColumn<
                                    "girasol_card",
                                    SetNotNull<PgIntegerBuilder>,
                                    {
                                        data: number;
                                        dataType: "number int32";
                                        driverParam: (...) | (...);
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: true;
                                        tableName: "girasol_card";
                                    },
                                >;
                                data: PgBuildColumn<
                                    "girasol_card",
                                    Set$Type<
                                        SetNotNull<(...)>,
                                        {
                                            displayName: ...;
                                            expiryMonth?: ...;
                                            expiryYear?: ...;
                                            firstName: ...;
                                            lastFourDigits?: ...;
                                            lastName: ...;
                                            phone: ...;
                                            shippingAddress?: ...;
                                        },
                                    >,
                                    {
                                        data: {
                                            displayName: ...;
                                            expiryMonth?: ...;
                                            expiryYear?: ...;
                                            firstName: ...;
                                            lastFourDigits?: ...;
                                            lastName: ...;
                                            phone: ...;
                                            shippingAddress?: ...;
                                        };
                                        dataType: "object json";
                                        driverParam: unknown;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: true;
                                        tableName: "girasol_card";
                                    },
                                >;
                                externalId: PgBuildColumn<
                                    "girasol_card",
                                    SetHasRuntimeDefault<SetNotNull<(...)>>,
                                    {
                                        data: string;
                                        dataType: "string";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: true;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: true;
                                        tableName: "girasol_card";
                                    },
                                >;
                                girasolAccountId: PgBuildColumn<
                                    "girasol_card",
                                    SetNotNull<PgIntegerBuilder>,
                                    {
                                        data: number;
                                        dataType: "number int32";
                                        driverParam: (...) | (...);
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: true;
                                        tableName: "girasol_card";
                                    },
                                >;
                                girasolCardId: PgBuildColumn<
                                    "girasol_card",
                                    SetNotNull<PgTextBuilder<(...)>>,
                                    {
                                        data: string;
                                        dataType: "string";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: true;
                                        tableName: "girasol_card";
                                    },
                                >;
                                id: PgBuildColumn<
                                    "girasol_card",
                                    HasIdentity<SetIsPrimaryKey<(...)>, "byDefault">,
                                    {
                                        data: number;
                                        dataType: "number int32";
                                        driverParam: (...) | (...);
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: true;
                                        hasRuntimeDefault: false;
                                        identity: "byDefault";
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: true;
                                        tableName: "girasol_card";
                                    },
                                >;
                                type: PgBuildColumn<
                                    "girasol_card",
                                    Set$Type<SetNotNull<(...)>, (...) | (...)>,
                                    {
                                        data: (...) | (...);
                                        dataType: "string";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: true;
                                        tableName: "girasol_card";
                                    },
                                >;
                                updatedAt: PgBuildColumn<
                                    "girasol_card",
                                    SetHasDefault<SetHasDefault<(...)>>,
                                    {
                                        data: Date;
                                        dataType: "object date";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: true;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: true;
                                        tableName: "girasol_card";
                                    },
                                >;
                            };
                            dialect: "pg";
                            name: "girasol_card";
                            schema: "b2b";
                        },
                    >,
                    "enableRLS",
                >,
                "createdAt"
                | "updatedAt",
            >[];
            page?: number;
            pageSize?: number;
            types?: ("VIRTUAL" | "PHYSICAL")[];
            updatedAt?: DbTimestampCriteria;
        }

        The ID of the customer.

        • OptionalcreatedAt?: DbTimestampCriteria
        • customerId: string
        • OptionalgirasolCardIds?: string[]
        • Optionalids?: string[]
        • OptionalorderBy?: DbOrderByCriterion<
              Omit<
                  PgTableWithColumns<
                      {
                          columns: {
                              createdAt: PgBuildColumn<
                                  "girasol_card",
                                  SetHasDefault<SetNotNull<(...)>>,
                                  {
                                      data: Date;
                                      dataType: "object date";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: true;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: true;
                                      tableName: "girasol_card";
                                  },
                              >;
                              customerId: PgBuildColumn<
                                  "girasol_card",
                                  SetNotNull<PgIntegerBuilder>,
                                  {
                                      data: number;
                                      dataType: "number int32";
                                      driverParam: (...) | (...);
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: true;
                                      tableName: "girasol_card";
                                  },
                              >;
                              data: PgBuildColumn<
                                  "girasol_card",
                                  Set$Type<
                                      SetNotNull<(...)>,
                                      {
                                          displayName: ...;
                                          expiryMonth?: ...;
                                          expiryYear?: ...;
                                          firstName: ...;
                                          lastFourDigits?: ...;
                                          lastName: ...;
                                          phone: ...;
                                          shippingAddress?: ...;
                                      },
                                  >,
                                  {
                                      data: {
                                          displayName: ...;
                                          expiryMonth?: ...;
                                          expiryYear?: ...;
                                          firstName: ...;
                                          lastFourDigits?: ...;
                                          lastName: ...;
                                          phone: ...;
                                          shippingAddress?: ...;
                                      };
                                      dataType: "object json";
                                      driverParam: unknown;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: true;
                                      tableName: "girasol_card";
                                  },
                              >;
                              externalId: PgBuildColumn<
                                  "girasol_card",
                                  SetHasRuntimeDefault<SetNotNull<(...)>>,
                                  {
                                      data: string;
                                      dataType: "string";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: true;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: true;
                                      tableName: "girasol_card";
                                  },
                              >;
                              girasolAccountId: PgBuildColumn<
                                  "girasol_card",
                                  SetNotNull<PgIntegerBuilder>,
                                  {
                                      data: number;
                                      dataType: "number int32";
                                      driverParam: (...) | (...);
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: true;
                                      tableName: "girasol_card";
                                  },
                              >;
                              girasolCardId: PgBuildColumn<
                                  "girasol_card",
                                  SetNotNull<PgTextBuilder<(...)>>,
                                  {
                                      data: string;
                                      dataType: "string";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: true;
                                      tableName: "girasol_card";
                                  },
                              >;
                              id: PgBuildColumn<
                                  "girasol_card",
                                  HasIdentity<SetIsPrimaryKey<(...)>, "byDefault">,
                                  {
                                      data: number;
                                      dataType: "number int32";
                                      driverParam: (...) | (...);
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: true;
                                      hasRuntimeDefault: false;
                                      identity: "byDefault";
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: true;
                                      tableName: "girasol_card";
                                  },
                              >;
                              type: PgBuildColumn<
                                  "girasol_card",
                                  Set$Type<SetNotNull<(...)>, (...) | (...)>,
                                  {
                                      data: (...) | (...);
                                      dataType: "string";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: true;
                                      tableName: "girasol_card";
                                  },
                              >;
                              updatedAt: PgBuildColumn<
                                  "girasol_card",
                                  SetHasDefault<SetHasDefault<(...)>>,
                                  {
                                      data: Date;
                                      dataType: "object date";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: true;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: true;
                                      tableName: "girasol_card";
                                  },
                              >;
                          };
                          dialect: "pg";
                          name: "girasol_card";
                          schema: "b2b";
                      },
                  >,
                  "enableRLS",
              >,
              "createdAt"
              | "updatedAt",
          >[]
        • Optionalpage?: number

          Defaults to 1

        • OptionalpageSize?: number

          Defaults to 10

        • Optionaltypes?: ("VIRTUAL" | "PHYSICAL")[]
        • OptionalupdatedAt?: DbTimestampCriteria

      Returns Promise<
          {
              ok: true;
              value: {
                  hasNext: boolean;
                  items: {
                      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;
                  }[];
              };
          },
      >

      A promise that resolves to the card records.