Class CustomerApiKeyService

Read-only interactions with API credentials belonging to customers

Hierarchy (View Summary)

CustomerApiKeyQueryService
- CustomerApiKeyService

Index

Constructors

constructor

Properties

Methods

create delete get search update

Constructors

constructor

new CustomerApiKeyService(
    __namedParameters: {
        apiGatewayClient: APIGatewayClient;
        sqlClient: Sql;
    },
): CustomerApiKeyService
Parameters
- __namedParameters: { apiGatewayClient: APIGatewayClient; sqlClient: Sql }
Returns CustomerApiKeyService
Overrides CustomerApiKeyQueryService.constructor
- Defined in packages/customer-services/src/CustomerApiKeyService.ts:141

Properties

`Protected` `Readonly`db

db: B2bDatabase

Methods

create

create(
    __namedParameters: {
        apiKeyName: string;
        apiUsagePlanIds: string[];
        customerId: string;
    },
): Promise<
    {
        ok: true;
        value: 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 } & { apiSecret: string };
    },
>
Parameters
- __namedParameters: { apiKeyName: string; apiUsagePlanIds: string[]; customerId: string }
Returns Promise<
    {
        ok: true;
        value: 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 } & { apiSecret: string };
    },
>
- Defined in packages/customer-services/src/CustomerApiKeyService.ts:152

delete

delete(
    __namedParameters: { customerId: string; id: string },
): Promise<
    { error: ServiceError; ok: false }
    | { ok: true; value: CustomerApiKey },
>
Parameters
- __namedParameters: { customerId: string; id: string }
Returns Promise<
{ error: ServiceError; ok: false }
| { ok: true; value: CustomerApiKey },
>
- Defined in packages/customer-services/src/CustomerApiKeyService.ts:299

get

get(
__namedParameters: { customerId: string; id: string },
): Promise<{ ok: true; value: CustomerApiKey | null }>
Parameters
- __namedParameters: { customerId: string; id: string }
Returns Promise<{ ok: true; value: CustomerApiKey | null }>
List of API keys with their associated customers
Inherited from CustomerApiKeyQueryService.get
- Defined in packages/customer-services/src/CustomerApiKeyService.ts:52

search

search(
    __namedParameters: {
        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;
    },
): Promise<
    { ok: true; value: { hasNext: boolean; items: CustomerApiKey[] } },
>
Parameters
- __namedParameters: {
      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;
  }
  - OptionalcreatedAt?: DbTimestampCriteria
  - customerId: 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
    Defaults to 1
  - OptionalpageSize?: number
    Defaults to 50
  - OptionalupdatedAt?: DbTimestampCriteria
Returns Promise<{ ok: true; value: { hasNext: boolean; items: CustomerApiKey[] } }>
List of API keys with their associated customers
Inherited from CustomerApiKeyQueryService.search
- Defined in packages/customer-services/src/CustomerApiKeyService.ts:85

update

update(
    __namedParameters: {
        customerId: string;
        data: { apiUsagePlanIds: string[]; name: string };
        id: string;
    },
): Promise<
    { ok: true; value: undefined }
    | { error: ServiceError; ok: false },
>
Parameters
- __namedParameters: {
      customerId: string;
      data: { apiUsagePlanIds: string[]; name: string };
      id: string;
  }
Returns Promise<{ ok: true; value: undefined } | { error: ServiceError; ok: false }>
- Defined in packages/customer-services/src/CustomerApiKeyService.ts:225

Class CustomerApiKeyService

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns CustomerApiKeyService

Properties

`Protected` `Readonly`db

Methods

create

Parameters

delete

Parameters

Returns Promise<
{ error: ServiceError; ok: false }
| { ok: true; value: CustomerApiKey },
>

get

Parameters

Returns Promise<{ ok: true; value: CustomerApiKey | null }>

search

Parameters

`Optional`createdAt?: DbTimestampCriteria

customerId: string

`Optional`page?: number

`Optional`pageSize?: number

`Optional`updatedAt?: DbTimestampCriteria

Returns Promise<{ ok: true; value: { hasNext: boolean; items: CustomerApiKey[] } }>

update

Parameters

Returns Promise<{ ok: true; value: undefined } | { error: ServiceError; ok: false }>

Settings

On This Page

Class CustomerApiKeyService

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns CustomerApiKeyService

Properties

Protected Readonlydb

Methods

create

Parameters

delete

Parameters

Returns Promise< { error: ServiceError; ok: false } | { ok: true; value: CustomerApiKey },>

get

Parameters

Returns Promise<{ ok: true; value: CustomerApiKey | null }>

search

Parameters

OptionalcreatedAt?: DbTimestampCriteria

customerId: string

Optionalpage?: number

OptionalpageSize?: number

OptionalupdatedAt?: DbTimestampCriteria

Returns Promise<{ ok: true; value: { hasNext: boolean; items: CustomerApiKey[] } }>

update

Parameters

Returns Promise<{ ok: true; value: undefined } | { error: ServiceError; ok: false }>

Settings

On This Page

`Protected` `Readonly`db

Returns Promise<
{ error: ServiceError; ok: false }
| { ok: true; value: CustomerApiKey },
>

`Optional`createdAt?: DbTimestampCriteria

`Optional`page?: number

`Optional`pageSize?: number

`Optional`updatedAt?: DbTimestampCriteria