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

    Manage Quiltt connections for entities.

    Index

    Constructors

    Properties

    Methods

    Constructors

    Properties

    Methods

    • Parameters

      • __namedParameters: {
            connectionData?: {
                accounts: Omit<QuilttAccountData, "institution">[];
                connectionId: string;
                institution: { logo?: { url?: string }; name: string };
                userProfileId: string;
            };
            connectorId: string;
            customerId: string;
            entityId: string;
        }

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

    • Parameters

      • __namedParameters: {
            createdAt?: DbTimestampCriteria;
            customerId: string;
            entityIds?: string[];
            ids?: string[];
            orderBy?: DbOrderByCriterion<
                Omit<
                    PgTableWithColumns<
                        {
                            columns: {
                                createdAt: PgBuildColumn<
                                    "quiltt_connection",
                                    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: "quiltt_connection";
                                    },
                                >;
                                customerId: PgBuildColumn<
                                    "quiltt_connection",
                                    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: "quiltt_connection";
                                    },
                                >;
                                data: PgBuildColumn<
                                    "quiltt_connection",
                                    Set$Type<
                                        SetHasDefault<(...)>,
                                        { connectionData?: ...; connectorId: ... },
                                    >,
                                    {
                                        data: { connectionData?: ...; connectorId: ... };
                                        dataType: "object json";
                                        driverParam: unknown;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: true;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: true;
                                        tableName: "quiltt_connection";
                                    },
                                >;
                                deletedAt: PgBuildColumn<
                                    "quiltt_connection",
                                    PgTimestampBuilder,
                                    {
                                        data: Date;
                                        dataType: "object date";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: false;
                                        tableName: "quiltt_connection";
                                    },
                                >;
                                externalId: PgBuildColumn<
                                    "quiltt_connection",
                                    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: "quiltt_connection";
                                    },
                                >;
                                id: PgBuildColumn<
                                    "quiltt_connection",
                                    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: "quiltt_connection";
                                    },
                                >;
                                identityId: PgBuildColumn<
                                    "quiltt_connection",
                                    PgIntegerBuilder,
                                    {
                                        data: number;
                                        dataType: "number int32";
                                        driverParam: (...)
                                        | (...);
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: false;
                                        tableName: "quiltt_connection";
                                    },
                                >;
                                organizationId: PgBuildColumn<
                                    "quiltt_connection",
                                    PgIntegerBuilder,
                                    {
                                        data: number;
                                        dataType: "number int32";
                                        driverParam: (...)
                                        | (...);
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: false;
                                        tableName: "quiltt_connection";
                                    },
                                >;
                                status: PgBuildColumn<
                                    "quiltt_connection",
                                    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: "quiltt_connection";
                                    },
                                >;
                                updatedAt: PgBuildColumn<
                                    "quiltt_connection",
                                    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: "quiltt_connection";
                                    },
                                >;
                            };
                            dialect: "pg";
                            name: "quiltt_connection";
                            schema: "b2b";
                        },
                    >,
                    "enableRLS",
                >,
                "createdAt"
                | "updatedAt",
            >[];
            page?: number;
            pageSize?: number;
            quilttConnectionId?: string;
            statuses?: ("ACTIVE" | "DELETED" | "NEEDS_REPAIR")[];
            updatedAt?: DbTimestampCriteria;
        }
        • OptionalcreatedAt?: DbTimestampCriteria
        • customerId: string
        • OptionalentityIds?: string[]
        • Optionalids?: string[]
        • OptionalorderBy?: DbOrderByCriterion<
              Omit<
                  PgTableWithColumns<
                      {
                          columns: {
                              createdAt: PgBuildColumn<
                                  "quiltt_connection",
                                  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: "quiltt_connection";
                                  },
                              >;
                              customerId: PgBuildColumn<
                                  "quiltt_connection",
                                  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: "quiltt_connection";
                                  },
                              >;
                              data: PgBuildColumn<
                                  "quiltt_connection",
                                  Set$Type<
                                      SetHasDefault<(...)>,
                                      { connectionData?: ...; connectorId: ... },
                                  >,
                                  {
                                      data: { connectionData?: ...; connectorId: ... };
                                      dataType: "object json";
                                      driverParam: unknown;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: true;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: true;
                                      tableName: "quiltt_connection";
                                  },
                              >;
                              deletedAt: PgBuildColumn<
                                  "quiltt_connection",
                                  PgTimestampBuilder,
                                  {
                                      data: Date;
                                      dataType: "object date";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: false;
                                      tableName: "quiltt_connection";
                                  },
                              >;
                              externalId: PgBuildColumn<
                                  "quiltt_connection",
                                  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: "quiltt_connection";
                                  },
                              >;
                              id: PgBuildColumn<
                                  "quiltt_connection",
                                  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: "quiltt_connection";
                                  },
                              >;
                              identityId: PgBuildColumn<
                                  "quiltt_connection",
                                  PgIntegerBuilder,
                                  {
                                      data: number;
                                      dataType: "number int32";
                                      driverParam: (...)
                                      | (...);
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: false;
                                      tableName: "quiltt_connection";
                                  },
                              >;
                              organizationId: PgBuildColumn<
                                  "quiltt_connection",
                                  PgIntegerBuilder,
                                  {
                                      data: number;
                                      dataType: "number int32";
                                      driverParam: (...)
                                      | (...);
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: false;
                                      tableName: "quiltt_connection";
                                  },
                              >;
                              status: PgBuildColumn<
                                  "quiltt_connection",
                                  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: "quiltt_connection";
                                  },
                              >;
                              updatedAt: PgBuildColumn<
                                  "quiltt_connection",
                                  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: "quiltt_connection";
                                  },
                              >;
                          };
                          dialect: "pg";
                          name: "quiltt_connection";
                          schema: "b2b";
                      },
                  >,
                  "enableRLS",
              >,
              "createdAt"
              | "updatedAt",
          >[]
        • Optionalpage?: number
        • OptionalpageSize?: number
        • OptionalquilttConnectionId?: string

          The Quiltt-assigned connection ID stored in data.connectionData.connectionId.

        • Optionalstatuses?: ("ACTIVE" | "DELETED" | "NEEDS_REPAIR")[]
        • OptionalupdatedAt?: DbTimestampCriteria

      Returns Promise<{ ok: true; value: { hasNext: boolean; items: QuilttConnection[] } }>

    • Parameters

      • __namedParameters: {
            customerId: string;
            data: {
                connectionData?: {
                    accounts: Omit<QuilttAccountData, "institution">[];
                    connectionId: string;
                    institution: { logo?: { url?: string }; name: string };
                    userProfileId: string;
                };
                status?: "ACTIVE"
                | "DELETED"
                | "NEEDS_REPAIR";
            };
            id: string;
        }

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