Parameters
- __namedParameters: {
apiStages?: string[];
customerId: string;
orderBy?: DbOrderByCriterion<
Omit<
PgTableWithColumns<
{
columns: {
apiStage: PgBuildColumn<
"customer_api_plan",
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_plan";
},
>;
createdAt: PgBuildColumn<
"customer_api_plan",
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_plan";
},
>;
customerId: PgBuildColumn<
"customer_api_plan",
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_plan";
},
>;
deletedAt: PgBuildColumn<
"customer_api_plan",
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_plan";
},
>;
externalId: PgBuildColumn<
"customer_api_plan",
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_plan";
},
>;
id: PgBuildColumn<
"customer_api_plan",
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_plan";
},
>;
note: PgBuildColumn<
"customer_api_plan",
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_plan";
},
>;
updatedAt: PgBuildColumn<
"customer_api_plan",
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_plan";
},
>;
};
dialect: "pg";
name: "customer_api_plan";
schema: "b2b";
},
>,
"enableRLS",
>,
"createdAt"
| "updatedAt",
>[];
page?: number;
pageSize?: number;
}OptionalapiStages?: string[]
customerId: string
OptionalorderBy?: DbOrderByCriterion<
Omit<
PgTableWithColumns<
{
columns: {
apiStage: PgBuildColumn<
"customer_api_plan",
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_plan";
},
>;
createdAt: PgBuildColumn<
"customer_api_plan",
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_plan";
},
>;
customerId: PgBuildColumn<
"customer_api_plan",
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_plan";
},
>;
deletedAt: PgBuildColumn<
"customer_api_plan",
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_plan";
},
>;
externalId: PgBuildColumn<
"customer_api_plan",
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_plan";
},
>;
id: PgBuildColumn<
"customer_api_plan",
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_plan";
},
>;
note: PgBuildColumn<
"customer_api_plan",
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_plan";
},
>;
updatedAt: PgBuildColumn<
"customer_api_plan",
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_plan";
},
>;
};
dialect: "pg";
name: "customer_api_plan";
schema: "b2b";
},
>,
"enableRLS",
>,
"createdAt"
| "updatedAt",
>[]
Optionalpage?: number
OptionalpageSize?: number
Returns Promise<
{
ok: true;
value: { hasNext: boolean; items: CustomerApiPlan[]; total: number };
},
>
Live grants belonging to the customer, paginated.
Read-only interactions with API-plan grants belonging to customers.