Parameters
- __namedParameters: {
apiKey?: string;
createdAt?: DbTimestampCriteria;
customerId?: string;
orderBy?: DbOrderByCriterion<
Omit<
PgTableWithColumns<
{
columns: {
apiKey: PgColumn<
{
baseColumn: never;
columnType: "PgText";
data: string;
dataType: "string";
driverParam: string;
enumValues: [(...), ...(...)[]];
generated: undefined;
hasDefault: false;
hasRuntimeDefault: false;
identity: undefined;
isAutoincrement: false;
isPrimaryKey: false;
name: "apiKey";
notNull: true;
tableName: "customer_api_key";
},
{},
{},
>;
apiSecret: PgColumn<
{
baseColumn: never;
columnType: "PgText";
data: string;
dataType: "string";
driverParam: string;
enumValues: [(...), ...(...)[]];
generated: undefined;
hasDefault: false;
hasRuntimeDefault: false;
identity: undefined;
isAutoincrement: false;
isPrimaryKey: false;
name: "apiSecret";
notNull: true;
tableName: "customer_api_key";
},
{},
{},
>;
awsApiKeyId: PgColumn<
{
baseColumn: never;
columnType: "PgText";
data: string;
dataType: "string";
driverParam: string;
enumValues: [(...), ...(...)[]];
generated: undefined;
hasDefault: false;
hasRuntimeDefault: false;
identity: undefined;
isAutoincrement: false;
isPrimaryKey: false;
name: "awsApiKeyId";
notNull: true;
tableName: "customer_api_key";
},
{},
{},
>;
createdAt: PgColumn<
{
baseColumn: never;
columnType: "PgTimestamp";
data: Date;
dataType: "date";
driverParam: string;
enumValues: undefined;
generated: undefined;
hasDefault: true;
hasRuntimeDefault: false;
identity: undefined;
isAutoincrement: false;
isPrimaryKey: false;
name: "createdAt";
notNull: true;
tableName: "customer_api_key";
},
{},
{},
>;
customerId: PgColumn<
{
baseColumn: never;
columnType: "PgInteger";
data: number;
dataType: "number";
driverParam: (...)
| (...);
enumValues: undefined;
generated: undefined;
hasDefault: false;
hasRuntimeDefault: false;
identity: undefined;
isAutoincrement: false;
isPrimaryKey: false;
name: "customerId";
notNull: true;
tableName: "customer_api_key";
},
{},
{},
>;
externalId: PgColumn<
{
baseColumn: never;
columnType: "PgText";
data: string;
dataType: "string";
driverParam: string;
enumValues: [(...), ...(...)[]];
generated: undefined;
hasDefault: true;
hasRuntimeDefault: true;
identity: undefined;
isAutoincrement: false;
isPrimaryKey: false;
name: "externalId";
notNull: true;
tableName: "customer_api_key";
},
{},
{},
>;
id: PgColumn<
{
baseColumn: never;
columnType: "PgInteger";
data: number;
dataType: "number";
driverParam: (...)
| (...);
enumValues: undefined;
generated: undefined;
hasDefault: true;
hasRuntimeDefault: false;
identity: "byDefault";
isAutoincrement: false;
isPrimaryKey: true;
name: "id";
notNull: true;
tableName: "customer_api_key";
},
{},
{},
>;
name: PgColumn<
{
baseColumn: never;
columnType: "PgText";
data: string;
dataType: "string";
driverParam: string;
enumValues: [(...), ...(...)[]];
generated: undefined;
hasDefault: false;
hasRuntimeDefault: false;
identity: undefined;
isAutoincrement: false;
isPrimaryKey: false;
name: "name";
notNull: true;
tableName: "customer_api_key";
},
{},
{},
>;
updatedAt: PgColumn<
{
baseColumn: never;
columnType: "PgTimestamp";
data: Date;
dataType: "date";
driverParam: string;
enumValues: undefined;
generated: undefined;
hasDefault: true;
hasRuntimeDefault: false;
identity: undefined;
isAutoincrement: false;
isPrimaryKey: false;
name: "updatedAt";
notNull: true;
tableName: "customer_api_key";
},
{},
{},
>;
};
dialect: "pg";
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: PgColumn<
{
baseColumn: never;
columnType: "PgText";
data: string;
dataType: "string";
driverParam: string;
enumValues: [(...), ...(...)[]];
generated: undefined;
hasDefault: false;
hasRuntimeDefault: false;
identity: undefined;
isAutoincrement: false;
isPrimaryKey: false;
name: "apiKey";
notNull: true;
tableName: "customer_api_key";
},
{},
{},
>;
apiSecret: PgColumn<
{
baseColumn: never;
columnType: "PgText";
data: string;
dataType: "string";
driverParam: string;
enumValues: [(...), ...(...)[]];
generated: undefined;
hasDefault: false;
hasRuntimeDefault: false;
identity: undefined;
isAutoincrement: false;
isPrimaryKey: false;
name: "apiSecret";
notNull: true;
tableName: "customer_api_key";
},
{},
{},
>;
awsApiKeyId: PgColumn<
{
baseColumn: never;
columnType: "PgText";
data: string;
dataType: "string";
driverParam: string;
enumValues: [(...), ...(...)[]];
generated: undefined;
hasDefault: false;
hasRuntimeDefault: false;
identity: undefined;
isAutoincrement: false;
isPrimaryKey: false;
name: "awsApiKeyId";
notNull: true;
tableName: "customer_api_key";
},
{},
{},
>;
createdAt: PgColumn<
{
baseColumn: never;
columnType: "PgTimestamp";
data: Date;
dataType: "date";
driverParam: string;
enumValues: undefined;
generated: undefined;
hasDefault: true;
hasRuntimeDefault: false;
identity: undefined;
isAutoincrement: false;
isPrimaryKey: false;
name: "createdAt";
notNull: true;
tableName: "customer_api_key";
},
{},
{},
>;
customerId: PgColumn<
{
baseColumn: never;
columnType: "PgInteger";
data: number;
dataType: "number";
driverParam: (...)
| (...);
enumValues: undefined;
generated: undefined;
hasDefault: false;
hasRuntimeDefault: false;
identity: undefined;
isAutoincrement: false;
isPrimaryKey: false;
name: "customerId";
notNull: true;
tableName: "customer_api_key";
},
{},
{},
>;
externalId: PgColumn<
{
baseColumn: never;
columnType: "PgText";
data: string;
dataType: "string";
driverParam: string;
enumValues: [(...), ...(...)[]];
generated: undefined;
hasDefault: true;
hasRuntimeDefault: true;
identity: undefined;
isAutoincrement: false;
isPrimaryKey: false;
name: "externalId";
notNull: true;
tableName: "customer_api_key";
},
{},
{},
>;
id: PgColumn<
{
baseColumn: never;
columnType: "PgInteger";
data: number;
dataType: "number";
driverParam: (...)
| (...);
enumValues: undefined;
generated: undefined;
hasDefault: true;
hasRuntimeDefault: false;
identity: "byDefault";
isAutoincrement: false;
isPrimaryKey: true;
name: "id";
notNull: true;
tableName: "customer_api_key";
},
{},
{},
>;
name: PgColumn<
{
baseColumn: never;
columnType: "PgText";
data: string;
dataType: "string";
driverParam: string;
enumValues: [(...), ...(...)[]];
generated: undefined;
hasDefault: false;
hasRuntimeDefault: false;
identity: undefined;
isAutoincrement: false;
isPrimaryKey: false;
name: "name";
notNull: true;
tableName: "customer_api_key";
},
{},
{},
>;
updatedAt: PgColumn<
{
baseColumn: never;
columnType: "PgTimestamp";
data: Date;
dataType: "date";
driverParam: string;
enumValues: undefined;
generated: undefined;
hasDefault: true;
hasRuntimeDefault: false;
identity: undefined;
isAutoincrement: false;
isPrimaryKey: false;
name: "updatedAt";
notNull: true;
tableName: "customer_api_key";
},
{},
{},
>;
};
dialect: "pg";
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;
awsApiKeyId: string;
createdAt: Date;
customerId: number;
externalId: string;
id: number;
name: string;
updatedAt: Date;
},
"id"
| "externalId"
| "customerId"
| "apiSecret",
> & { id: string } & { customerId: string; hashedApiSecret: string }
)[];
};
},
>
List of API keys with their associated customers
Read-only interactions with API credentials belonging to customers