Class ProjectKeyAndNameValidation

Index

Constructors

Methods

getValidProjectKey getValidProjectName validateProjectKey

Constructors

constructor

new ProjectKeyAndNameValidation(
client: Client,
): Version3.ProjectKeyAndNameValidation
Parameters
- client: Client
Returns Version3.ProjectKeyAndNameValidation
- Defined in src/version3/projectKeyAndNameValidation.ts:8

Methods

getValidProjectKey

getValidProjectKey<T = string>(
parameters: undefined | string | Version3Parameters.GetValidProjectKey,
callback: Callback<T>,
): Promise<void>
Validates a project key and, if the key is invalid or in use, generates a valid random string for the project key.

Permissions required: None.
Type Parameters
- T = string
Parameters
- parameters: undefined | string | Version3Parameters.GetValidProjectKey
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/projectKeyAndNameValidation.ts:50
getValidProjectKey<T = string>(
parameters?: string | Version3Parameters.GetValidProjectKey,
callback?: undefined,
): Promise<T>
Validates a project key and, if the key is invalid or in use, generates a valid random string for the project key.

Permissions required: None.
Type Parameters
- T = string
Parameters
- Optionalparameters: string | Version3Parameters.GetValidProjectKey
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/projectKeyAndNameValidation.ts:59

getValidProjectName

getValidProjectName<T = string>(
parameters: string | Version3Parameters.GetValidProjectName,
callback: Callback<T>,
): Promise<void>
Checks that a project name isn't in use. If the name isn't in use, the passed string is returned. If the name is in use, this operation attempts to generate a valid project name based on the one supplied, usually by adding a sequence number. If a valid project name cannot be generated, a 404 response is returned.

Permissions required: None.
Type Parameters
- T = string
Parameters
- parameters: string | Version3Parameters.GetValidProjectName
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/projectKeyAndNameValidation.ts:87
getValidProjectName<T = string>(
parameters: string | Version3Parameters.GetValidProjectName,
callback?: undefined,
): Promise<T>
Checks that a project name isn't in use. If the name isn't in use, the passed string is returned. If the name is in use, this operation attempts to generate a valid project name based on the one supplied, usually by adding a sequence number. If a valid project name cannot be generated, a 404 response is returned.

Permissions required: None.
Type Parameters
- T = string
Parameters
- parameters: string | Version3Parameters.GetValidProjectName
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/projectKeyAndNameValidation.ts:98

validateProjectKey

validateProjectKey<T = Version3Models.ErrorCollection>(
parameters: undefined | string | Version3Parameters.ValidateProjectKey,
callback: Callback<T>,
): Promise<void>
Validates a project key by confirming the key is a valid string and not in use.

Permissions required: None.
Type Parameters
- T = Version3Models.ErrorCollection
Parameters
- parameters: undefined | string | Version3Parameters.ValidateProjectKey
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/projectKeyAndNameValidation.ts:15
validateProjectKey<T = Version3Models.ErrorCollection>(
parameters?: string | Version3Parameters.ValidateProjectKey,
callback?: undefined,
): Promise<T>
Validates a project key by confirming the key is a valid string and not in use.

Permissions required: None.
Type Parameters
- T = Version3Models.ErrorCollection
Parameters
- Optionalparameters: string | Version3Parameters.ValidateProjectKey
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/projectKeyAndNameValidation.ts:24