Skip to content

fix(style-guides): simplify dual-platform models with optional groupId #639

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
andrii-bodnar merged 1 commit into from
Mar 19, 2026
Merged

fix(style-guides): simplify dual-platform models with optional groupId #639

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 8 additions & 14 deletions src/styleGuides/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ export class StyleGuides extends CrowdinApi {
*/
listStyleGuides(
options?: StyleGuidesModel.ListStyleGuidesOptions,
): Promise<ResponseList<StyleGuidesModel.StyleGuide | StyleGuidesModel.StyleGuideEnterprise>> {
): Promise<ResponseList<StyleGuidesModel.StyleGuide>> {
let url = `${this.url}/style-guides`;
url = this.addQueryParam(url, 'orderBy', options?.orderBy);
url = this.addQueryParam(url, 'userId', options?.userId);
Expand All @@ -19,8 +19,8 @@ export class StyleGuides extends CrowdinApi {
* @see https://developer.crowdin.com/api/v2/#operation/api.style-guides.post
*/
createStyleGuide(
request: StyleGuidesModel.CreateStyleGuideRequest | StyleGuidesModel.CreateStyleGuideEnterpriseRequest,
): Promise<ResponseObject<StyleGuidesModel.StyleGuide | StyleGuidesModel.StyleGuideEnterprise>> {
request: StyleGuidesModel.CreateStyleGuideRequest,
): Promise<ResponseObject<StyleGuidesModel.StyleGuide>> {
const url = `${this.url}/style-guides`;
return this.post(url, request, this.defaultConfig());
}
Expand All @@ -29,9 +29,7 @@ export class StyleGuides extends CrowdinApi {
* @param styleGuideId style guide identifier
* @see https://developer.crowdin.com/api/v2/#operation/api.style-guides.get
*/
getStyleGuide(
styleGuideId: number,
): Promise<ResponseObject<StyleGuidesModel.StyleGuide | StyleGuidesModel.StyleGuideEnterprise>> {
getStyleGuide(styleGuideId: number): Promise<ResponseObject<StyleGuidesModel.StyleGuide>> {
const url = `${this.url}/style-guides/${styleGuideId}`;
return this.get(url, this.defaultConfig());
}
Expand All @@ -53,7 +51,7 @@ export class StyleGuides extends CrowdinApi {
editStyleGuide(
styleGuideId: number,
request: PatchRequest[],
): Promise<ResponseObject<StyleGuidesModel.StyleGuide | StyleGuidesModel.StyleGuideEnterprise>> {
): Promise<ResponseObject<StyleGuidesModel.StyleGuide>> {
const url = `${this.url}/style-guides/${styleGuideId}`;
return this.patch(url, request, this.defaultConfig());
}
Expand All @@ -72,10 +70,8 @@ export namespace StyleGuidesModel {
downloadLink: string;
createdAt: string;
updatedAt: string;
}

export interface StyleGuideEnterprise extends StyleGuide {
groupId: number;
/** Enterprise only */
groupId?: number;
}

export interface CreateStyleGuideRequest {
Expand All @@ -85,9 +81,7 @@ export namespace StyleGuidesModel {
languageIds?: string[];
projectIds?: number[];
isShared?: boolean;
}

export interface CreateStyleGuideEnterpriseRequest extends CreateStyleGuideRequest {
/** Enterprise only */
groupId?: number | null;
}

Expand Down
6 changes: 3 additions & 3 deletions tests/styleGuides/api.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,13 +108,13 @@ describe('Style Guides API', () => {
it('Create style guide', async () => {
const styleGuide = await api.createStyleGuide({ name, storageId });
expect(styleGuide.data.id).toBe(styleGuideId);
expect(styleGuide.data).toHaveProperty('groupId', groupId);
expect(styleGuide.data.groupId).toBe(groupId);
});

it('Get style guide', async () => {
const styleGuide = await api.getStyleGuide(styleGuideId);
expect(styleGuide.data.id).toBe(styleGuideId);
expect(styleGuide.data).toHaveProperty('groupId', groupId);
expect(styleGuide.data.groupId).toBe(groupId);
});

it('Delete style guide', async () => {
Expand All @@ -130,6 +130,6 @@ describe('Style Guides API', () => {
},
]);
expect(styleGuide.data.id).toBe(styleGuideId);
expect(styleGuide.data).toHaveProperty('groupId', groupId);
expect(styleGuide.data.groupId).toBe(groupId);
});
});
Loading