Parameters
- __namedParameters: {
apiKey?: string;
createdAt?: DbTimestampCriteria;
customerId?: string;
orderBy?: DbOrderByCriterion<
Omit<
PgTableWithColumns<
{
columns: {
apiKey: PgBuildColumn<
"customer_api_key",
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: "customer_api_key";
},
>;
apiSecret: PgBuildColumn<
"customer_api_key",
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: "customer_api_key";
},
>;
createdAt: PgBuildColumn<
"customer_api_key",
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: "customer_api_key";
},
>;
customerExternalId: PgBuildColumn<
"customer_api_key",
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: "customer_api_key";
},
>;
customerId: PgBuildColumn<
"customer_api_key",
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: "customer_api_key";
},
>;
externalId: PgBuildColumn<
"customer_api_key",
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: "customer_api_key";
},
>;
id: PgBuildColumn<
"customer_api_key",
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: "customer_api_key";
},
>;
name: PgBuildColumn<
"customer_api_key",
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: "customer_api_key";
},
>;
replacedByExternalId: PgBuildColumn<
"customer_api_key",
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: "customer_api_key";
},
>;
replacedById: PgBuildColumn<
"customer_api_key",
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: "customer_api_key";
},
>;
retireAt: PgBuildColumn<
"customer_api_key",
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: "customer_api_key";
},
>;
updatedAt: PgBuildColumn<
"customer_api_key",
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: "customer_api_key";
},
>;
};
dialect: "pg";
isAlias: false;
name: "customer_api_key";
schema: "b2b";
},
>,
"enableRLS",
>,
"createdAt"
| "updatedAt",
>[];
page?: number;
pageSize?: number;
updatedAt?: DbTimestampCriteria;
}
-
OptionalapiKey?: string
-
-
OptionalcustomerId?: string
-
OptionalorderBy?: DbOrderByCriterion<
Omit<
PgTableWithColumns<
{
columns: {
apiKey: PgBuildColumn<
"customer_api_key",
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: "customer_api_key";
},
>;
apiSecret: PgBuildColumn<
"customer_api_key",
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: "customer_api_key";
},
>;
createdAt: PgBuildColumn<
"customer_api_key",
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: "customer_api_key";
},
>;
customerExternalId: PgBuildColumn<
"customer_api_key",
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: "customer_api_key";
},
>;
customerId: PgBuildColumn<
"customer_api_key",
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: "customer_api_key";
},
>;
externalId: PgBuildColumn<
"customer_api_key",
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: "customer_api_key";
},
>;
id: PgBuildColumn<
"customer_api_key",
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: "customer_api_key";
},
>;
name: PgBuildColumn<
"customer_api_key",
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: "customer_api_key";
},
>;
replacedByExternalId: PgBuildColumn<
"customer_api_key",
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: "customer_api_key";
},
>;
replacedById: PgBuildColumn<
"customer_api_key",
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: "customer_api_key";
},
>;
retireAt: PgBuildColumn<
"customer_api_key",
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: "customer_api_key";
},
>;
updatedAt: PgBuildColumn<
"customer_api_key",
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: "customer_api_key";
},
>;
};
dialect: "pg";
isAlias: false;
name: "customer_api_key";
schema: "b2b";
},
>,
"enableRLS",
>,
"createdAt"
| "updatedAt",
>[]
-
Optionalpage?: number
-
OptionalpageSize?: number
-
Returns Promise<
{
ok: true;
value: {
hasNext: boolean;
items: (
Omit<
{
apiKey: string;
apiSecret: string;
createdAt: Date;
customerExternalId: string;
customerId: number;
externalId: string;
id: number;
name: string;
replacedByExternalId: string
| null;
replacedById: number | null;
retireAt: Date | null;
updatedAt: Date;
},
| "id"
| "externalId"
| "customerId"
| "customerExternalId"
| "apiSecret"
| "replacedById"
| "replacedByExternalId"
| "retireAt",
> & {
id: string;
supersededBy: { apiKeyId: string; retireAt: Date }
| null;
} & {
customerId: string;
customerName: string;
customerStatus: | "PENDING"
| "ACTIVE"
| "FAILED"
| "DISABLED"
| "DELETED";
hashedApiSecret: string;
}
)[];
};
},
>
List of API keys with their associated customers
Read-only interactions with API credentials belonging to customers