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

    Constructors

    Properties

    Methods

    Constructors

    Properties

    Methods

    • Parameters

      • args: Pick<
            {
                amount: BigNumber;
                commitId?: string;
                commitTargets?: { address: Address; amount: BigNumber; owner?: Address }[];
                commitTxId?: string;
                createdAt: Date;
                id: string;
                idempotencyKey: string;
                initiateTxId?: string;
                ledgerAccountId: string;
                status: "CREATED" | "PENDING" | "VOIDED" | "COMMITTED";
                updatedAt: Date;
                voidTxId?: string;
            },
            "id",
        > & { customerId: string }

      Returns Promise<
          {
              ok: true;
              value: | {
                  amount: BigNumber;
                  commitId?: string;
                  commitTargets?: { address: Address; amount: BigNumber; owner?: Address }[];
                  commitTxId?: string;
                  createdAt: Date;
                  id: string;
                  idempotencyKey: string;
                  initiateTxId?: string;
                  ledgerAccountId: string;
                  status: "CREATED" | "PENDING" | "VOIDED" | "COMMITTED";
                  updatedAt: Date;
                  voidTxId?: string;
              }
              | null;
          },
      >

    • Parameters

      • __namedParameters: {
            amount?: BigNumber;
            createdAt?: DbTimestampCriteria;
            customerId: string;
            orderBy?: DbOrderByCriterion<
                Omit<
                    PgTableWithColumns<
                        {
                            columns: {
                                amount: PgBuildColumn<
                                    "ledger_account_withdrawal",
                                    SetNotNull<PgNumericBuilder>,
                                    {
                                        data: string;
                                        dataType: "string numeric";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: true;
                                        tableName: "ledger_account_withdrawal";
                                    },
                                >;
                                commitExternalId: PgBuildColumn<
                                    "ledger_account_withdrawal",
                                    PgTextBuilder<[(...), ...(...)[]]>,
                                    {
                                        data: string;
                                        dataType: "string";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: false;
                                        tableName: "ledger_account_withdrawal";
                                    },
                                >;
                                commitTargets: PgBuildColumn<
                                    "ledger_account_withdrawal",
                                    Set$Type<PgJsonbBuilder, (...) | (...)>,
                                    {
                                        data: (...) | (...);
                                        dataType: "object json";
                                        driverParam: unknown;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: false;
                                        tableName: "ledger_account_withdrawal";
                                    },
                                >;
                                commitTxId: PgBuildColumn<
                                    "ledger_account_withdrawal",
                                    PgTextBuilder<[(...), ...(...)[]]>,
                                    {
                                        data: string;
                                        dataType: "string";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: false;
                                        tableName: "ledger_account_withdrawal";
                                    },
                                >;
                                createdAt: PgBuildColumn<
                                    "ledger_account_withdrawal",
                                    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: "ledger_account_withdrawal";
                                    },
                                >;
                                customerId: PgBuildColumn<
                                    "ledger_account_withdrawal",
                                    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: "ledger_account_withdrawal";
                                    },
                                >;
                                data: PgBuildColumn<
                                    "ledger_account_withdrawal",
                                    SetNotNull<PgJsonbBuilder>,
                                    {
                                        data: unknown;
                                        dataType: "object json";
                                        driverParam: unknown;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: true;
                                        tableName: "ledger_account_withdrawal";
                                    },
                                >;
                                externalId: PgBuildColumn<
                                    "ledger_account_withdrawal",
                                    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: "ledger_account_withdrawal";
                                    },
                                >;
                                id: PgBuildColumn<
                                    "ledger_account_withdrawal",
                                    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: "ledger_account_withdrawal";
                                    },
                                >;
                                idempotencyKey: PgBuildColumn<
                                    "ledger_account_withdrawal",
                                    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: "ledger_account_withdrawal";
                                    },
                                >;
                                initiateTxId: PgBuildColumn<
                                    "ledger_account_withdrawal",
                                    PgTextBuilder<[(...), ...(...)[]]>,
                                    {
                                        data: string;
                                        dataType: "string";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: false;
                                        tableName: "ledger_account_withdrawal";
                                    },
                                >;
                                ledgerAccountId: PgBuildColumn<
                                    "ledger_account_withdrawal",
                                    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: "ledger_account_withdrawal";
                                    },
                                >;
                                status: PgBuildColumn<
                                    "ledger_account_withdrawal",
                                    SetNotNull<Set$Type<(...), (...)>>,
                                    {
                                        data: (...) | (...) | (...) | (...);
                                        dataType: "string";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: true;
                                        tableName: "ledger_account_withdrawal";
                                    },
                                >;
                                updatedAt: PgBuildColumn<
                                    "ledger_account_withdrawal",
                                    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: "ledger_account_withdrawal";
                                    },
                                >;
                                voidTxId: PgBuildColumn<
                                    "ledger_account_withdrawal",
                                    PgTextBuilder<[(...), ...(...)[]]>,
                                    {
                                        data: string;
                                        dataType: "string";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: false;
                                        tableName: "ledger_account_withdrawal";
                                    },
                                >;
                            };
                            dialect: "pg";
                            name: "ledger_account_withdrawal";
                            schema: "b2b";
                        },
                    >,
                    "enableRLS",
                >,
                "createdAt"
                | "updatedAt",
            >[];
            page?: number;
            pageSize?: number;
            status?: "CREATED" | "PENDING" | "VOIDED" | "COMMITTED";
            updatedAt?: DbTimestampCriteria;
        }
        • Optionalamount?: BigNumber
        • OptionalcreatedAt?: DbTimestampCriteria
        • customerId: string
        • OptionalorderBy?: DbOrderByCriterion<
              Omit<
                  PgTableWithColumns<
                      {
                          columns: {
                              amount: PgBuildColumn<
                                  "ledger_account_withdrawal",
                                  SetNotNull<PgNumericBuilder>,
                                  {
                                      data: string;
                                      dataType: "string numeric";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: true;
                                      tableName: "ledger_account_withdrawal";
                                  },
                              >;
                              commitExternalId: PgBuildColumn<
                                  "ledger_account_withdrawal",
                                  PgTextBuilder<[(...), ...(...)[]]>,
                                  {
                                      data: string;
                                      dataType: "string";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: false;
                                      tableName: "ledger_account_withdrawal";
                                  },
                              >;
                              commitTargets: PgBuildColumn<
                                  "ledger_account_withdrawal",
                                  Set$Type<PgJsonbBuilder, (...) | (...)>,
                                  {
                                      data: (...) | (...);
                                      dataType: "object json";
                                      driverParam: unknown;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: false;
                                      tableName: "ledger_account_withdrawal";
                                  },
                              >;
                              commitTxId: PgBuildColumn<
                                  "ledger_account_withdrawal",
                                  PgTextBuilder<[(...), ...(...)[]]>,
                                  {
                                      data: string;
                                      dataType: "string";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: false;
                                      tableName: "ledger_account_withdrawal";
                                  },
                              >;
                              createdAt: PgBuildColumn<
                                  "ledger_account_withdrawal",
                                  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: "ledger_account_withdrawal";
                                  },
                              >;
                              customerId: PgBuildColumn<
                                  "ledger_account_withdrawal",
                                  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: "ledger_account_withdrawal";
                                  },
                              >;
                              data: PgBuildColumn<
                                  "ledger_account_withdrawal",
                                  SetNotNull<PgJsonbBuilder>,
                                  {
                                      data: unknown;
                                      dataType: "object json";
                                      driverParam: unknown;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: true;
                                      tableName: "ledger_account_withdrawal";
                                  },
                              >;
                              externalId: PgBuildColumn<
                                  "ledger_account_withdrawal",
                                  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: "ledger_account_withdrawal";
                                  },
                              >;
                              id: PgBuildColumn<
                                  "ledger_account_withdrawal",
                                  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: "ledger_account_withdrawal";
                                  },
                              >;
                              idempotencyKey: PgBuildColumn<
                                  "ledger_account_withdrawal",
                                  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: "ledger_account_withdrawal";
                                  },
                              >;
                              initiateTxId: PgBuildColumn<
                                  "ledger_account_withdrawal",
                                  PgTextBuilder<[(...), ...(...)[]]>,
                                  {
                                      data: string;
                                      dataType: "string";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: false;
                                      tableName: "ledger_account_withdrawal";
                                  },
                              >;
                              ledgerAccountId: PgBuildColumn<
                                  "ledger_account_withdrawal",
                                  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: "ledger_account_withdrawal";
                                  },
                              >;
                              status: PgBuildColumn<
                                  "ledger_account_withdrawal",
                                  SetNotNull<Set$Type<(...), (...)>>,
                                  {
                                      data: (...) | (...) | (...) | (...);
                                      dataType: "string";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: true;
                                      tableName: "ledger_account_withdrawal";
                                  },
                              >;
                              updatedAt: PgBuildColumn<
                                  "ledger_account_withdrawal",
                                  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: "ledger_account_withdrawal";
                                  },
                              >;
                              voidTxId: PgBuildColumn<
                                  "ledger_account_withdrawal",
                                  PgTextBuilder<[(...), ...(...)[]]>,
                                  {
                                      data: string;
                                      dataType: "string";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: false;
                                      tableName: "ledger_account_withdrawal";
                                  },
                              >;
                          };
                          dialect: "pg";
                          name: "ledger_account_withdrawal";
                          schema: "b2b";
                      },
                  >,
                  "enableRLS",
              >,
              "createdAt"
              | "updatedAt",
          >[]
        • Optionalpage?: number

          Defaults to 1

        • OptionalpageSize?: number

          Defaults to 50

        • Optionalstatus?: "CREATED" | "PENDING" | "VOIDED" | "COMMITTED"
        • OptionalupdatedAt?: DbTimestampCriteria

      Returns Promise<
          {
              ok: true;
              value: {
                  hasNext: boolean;
                  items: {
                      amount: BigNumber;
                      commitId?: string;
                      commitTargets?: { address: Address; amount: BigNumber; owner?: Address }[];
                      commitTxId?: string;
                      createdAt: Date;
                      id: string;
                      idempotencyKey: string;
                      initiateTxId?: string;
                      ledgerAccountId: string;
                      status: "CREATED" | "PENDING" | "VOIDED" | "COMMITTED";
                      updatedAt: Date;
                      voidTxId?: string;
                  }[];
              };
          },
      >

      customer ledger account withdrawal records