StyleGuideApi
extends AbstractApi
in package
Table of Contents
Methods
- create() : StyleGuide|null
- Add Style Guide
- delete() : mixed
- Delete Style Guide
- get() : StyleGuide|null
- Get Style Guide
- list() : ModelCollection
- List Style Guides
- update() : StyleGuide|null
- Edit Style Guide
Methods
create()
Add Style Guide
public
create(array<string|int, mixed> $params) : StyleGuide|null
Parameters
- $params : array<string|int, mixed>
-
string $params[name] required
int $params[storageId] required
string|null $params[aiInstructions]
string[] $params[languageIds]
int[] $params[projectIds]
bool $params[isShared]
Tags
Return values
StyleGuide|nulldelete()
Delete Style Guide
public
delete(int $styleGuideId) : mixed
Parameters
- $styleGuideId : int
Tags
get()
Get Style Guide
public
get(int $styleGuideId) : StyleGuide|null
Parameters
- $styleGuideId : int
Tags
Return values
StyleGuide|nulllist()
List Style Guides
public
list([array<string|int, mixed> $params = [] ]) : ModelCollection
Parameters
- $params : array<string|int, mixed> = []
-
integer $params[limit]
integer $params[offset]
string $params[orderBy]
integer $params[userId]
Tags
Return values
ModelCollectionupdate()
Edit Style Guide
public
update(StyleGuide $styleGuide) : StyleGuide|null
Parameters
- $styleGuide : StyleGuide