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

    Class CustomerApiPlanAdminService

    Cross-customer admin operations on API-plan grants. Reads project the external customerId (customerTable.externalId) so callers know which customer owns each grant. Grant/revoke share the exact semantics of CustomerApiPlanService via internal.ts.

    Index

    Constructors

    constructor

    Properties

    db

    Methods

    grant revoke search

    Constructors

    Properties

    db: B2bDatabase

    Methods

    • Grants customerId access to apiStage. Same idempotent grant/revive logic as the consumer service; returns the grant with its external customerId.

      Parameters

      • __namedParameters: { apiStage: string; customerId: string; note?: string | null }

      Returns Promise<
          {
              ok: true;
              value: Omit<
                  {
                      apiStage: string;
                      createdAt: Date;
                      customerId: number;
                      deletedAt: Date
                      | null;
                      externalId: string;
                      id: number;
                      note: string | null;
                      updatedAt: Date;
                  },
                  "id"
                  | "externalId"
                  | "customerId",
              > & { id: string } & { customerId: string };
          },
      >

    • Parameters

      • __namedParameters: {
            apiStages?: string[];
            customerIds?: 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[]
        • OptionalcustomerIds?: 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

          Defaults to 1

        • OptionalpageSize?: number

          Defaults to 50

      Returns Promise<
          {
              ok: true;
              value: {
                  hasNext: boolean;
                  items: (
                      Omit<
                          {
                              apiStage: string;
                              createdAt: Date;
                              customerId: number;
                              deletedAt: Date
                              | null;
                              externalId: string;
                              id: number;
                              note: string | null;
                              updatedAt: Date;
                          },
                          "id"
                          | "externalId"
                          | "customerId",
                      > & { id: string } & { customerId: string }
                  )[];
                  total: number;
              };
          },
      >

      Live grants across all customers (or the given customerIds), each carrying its owning external customerId.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods