Skip to main content

Function: apiKeyService()

apiKeyService(client): object

Defined in: service/ApiKeyService.ts:21

Service for ApiKey-related GraphQL operations

Parameters​

client​

GraphQLClient

Returns​

getGqlApiKey()​

getGqlApiKey(variables): Promise<GqlApiKey>

Retrieves a specific GraphQL API key by its unique identifier.

Parameters​

variables​

GqlApiKeyVariables

Returns​

Promise<GqlApiKey>

getGqlApiKeys()​

getGqlApiKeys(variables): Promise<GqlApiKeyResponse>

Searches and retrieves GraphQL API keys based on filter criteria.

Parameters​

variables​

GqlApiKeysVariables

Returns​

Promise<GqlApiKeyResponse>

getRestApiKey()​

getRestApiKey(variables): Promise<RestApiKey>

Retrieves a specific REST API key by its unique identifier.

Parameters​

variables​

RestApiKeyVariables

Returns​

Promise<RestApiKey>

getRestApiKeys()​

getRestApiKeys(variables): Promise<RestApiKeyResponse>

Searches and retrieves REST API keys based on filter criteria.

Parameters​

variables​

RestApiKeysVariables

Returns​

Promise<RestApiKeyResponse>

gqlApiKeyCreate()​

gqlApiKeyCreate(variables): Promise<GqlApiKey>

Creates a new GraphQL API key.

Parameters​

variables​

GqlApiKeyCreateVariables

Returns​

Promise<GqlApiKey>

gqlApiKeyDelete()​

gqlApiKeyDelete(variables): Promise<boolean>

Permanently deletes a GraphQL API key from the system.

Parameters​

variables​

GqlApiKeyDeleteVariables

Returns​

Promise<boolean>

gqlApiKeyUpdate()​

gqlApiKeyUpdate(variables): Promise<GqlApiKey>

Updates an existing GraphQL API key.

Parameters​

variables​

GqlApiKeyUpdateVariables

Returns​

Promise<GqlApiKey>

restApiKeyCreate()​

restApiKeyCreate(variables): Promise<RestApiKey>

Creates a new REST API key.

Parameters​

variables​

RestApiKeyCreateVariables

Returns​

Promise<RestApiKey>

restApiKeyDelete()​

restApiKeyDelete(variables): Promise<boolean>

Permanently deletes a REST API key from the system.

Parameters​

variables​

RestApiKeyDeleteVariables

Returns​

Promise<boolean>

restApiKeyUpdate()​

restApiKeyUpdate(variables): Promise<RestApiKey>

Updates an existing REST API key.

Parameters​

variables​

RestApiKeyUpdateVariables

Returns​

Promise<RestApiKey>