Skip to content

Commit b71712f

Browse files
zeplin-devzeplin-dev
committed
v1.9.0
1 parent 8e6baba commit b71712f

File tree

1 file changed

+76
-17
lines changed

1 file changed

+76
-17
lines changed

‎src/apis/components-api.ts‎

Lines changed: 76 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -62,10 +62,11 @@ export const ComponentsApiAxiosParamCreator = function (configuration?: Configur
6262
* @param {string} projectId Project id
6363
* @param {string} componentId Component id
6464
* @param {boolean} [includeLatestVersion] Whether to include the latest version data in the Component object
65+
* @param {boolean} [includeLinkedStyleguides] Whether to include linked styleguides or not
6566
* @param {*} [options] Override http request option.
6667
* @throws {RequiredError}
6768
*/
68-
getProjectComponent: async (projectId: string, componentId: string, includeLatestVersion?: boolean, options: any = {}): Promise<RequestArgs> => {
69+
getProjectComponent: async (projectId: string, componentId: string, includeLatestVersion?: boolean, includeLinkedStyleguides?: boolean, options: any = {}): Promise<RequestArgs> => {
6970
// verify required parameter 'projectId' is not null or undefined
7071
assertParamExists('getProjectComponent', 'projectId', projectId)
7172
// verify required parameter 'componentId' is not null or undefined
@@ -96,6 +97,10 @@ export const ComponentsApiAxiosParamCreator = function (configuration?: Configur
9697
localVarQueryParameter['include_latest_version'] = includeLatestVersion;
9798
}
9899

100+
if (includeLinkedStyleguides !== undefined) {
101+
localVarQueryParameter['include_linked_styleguides'] = includeLinkedStyleguides;
102+
}
103+
99104

100105

101106
setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
@@ -112,10 +117,11 @@ export const ComponentsApiAxiosParamCreator = function (configuration?: Configur
112117
* @summary Get latest project component version
113118
* @param {string} projectId Project id
114119
* @param {string} componentId Component id
120+
* @param {boolean} [includeLinkedStyleguides] Whether to include linked styleguides or not
115121
* @param {*} [options] Override http request option.
116122
* @throws {RequiredError}
117123
*/
118-
getProjectComponentLatestVersion: async (projectId: string, componentId: string, options: any = {}): Promise<RequestArgs> => {
124+
getProjectComponentLatestVersion: async (projectId: string, componentId: string, includeLinkedStyleguides?: boolean, options: any = {}): Promise<RequestArgs> => {
119125
// verify required parameter 'projectId' is not null or undefined
120126
assertParamExists('getProjectComponentLatestVersion', 'projectId', projectId)
121127
// verify required parameter 'componentId' is not null or undefined
@@ -142,6 +148,10 @@ export const ComponentsApiAxiosParamCreator = function (configuration?: Configur
142148
// http bearer authentication required
143149
await setBearerAuthToObject(localVarHeaderParameter, configuration)
144150

151+
if (includeLinkedStyleguides !== undefined) {
152+
localVarQueryParameter['include_linked_styleguides'] = includeLinkedStyleguides;
153+
}
154+
145155

146156

147157
setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
@@ -285,10 +295,11 @@ export const ComponentsApiAxiosParamCreator = function (configuration?: Configur
285295
* @param {string} [linkedProject] Reference project id
286296
* @param {string} [linkedStyleguide] Reference styleguide id
287297
* @param {boolean} [includeLatestVersion] Whether to include the latest version data in the Component object
298+
* @param {boolean} [includeLinkedStyleguides] Whether to include linked styleguides or not
288299
* @param {*} [options] Override http request option.
289300
* @throws {RequiredError}
290301
*/
291-
getStyleguideComponent: async (styleguideId: string, componentId: string, linkedProject?: string, linkedStyleguide?: string, includeLatestVersion?: boolean, options: any = {}): Promise<RequestArgs> => {
302+
getStyleguideComponent: async (styleguideId: string, componentId: string, linkedProject?: string, linkedStyleguide?: string, includeLatestVersion?: boolean, includeLinkedStyleguides?: boolean, options: any = {}): Promise<RequestArgs> => {
292303
// verify required parameter 'styleguideId' is not null or undefined
293304
assertParamExists('getStyleguideComponent', 'styleguideId', styleguideId)
294305
// verify required parameter 'componentId' is not null or undefined
@@ -327,6 +338,10 @@ export const ComponentsApiAxiosParamCreator = function (configuration?: Configur
327338
localVarQueryParameter['include_latest_version'] = includeLatestVersion;
328339
}
329340

341+
if (includeLinkedStyleguides !== undefined) {
342+
localVarQueryParameter['include_linked_styleguides'] = includeLinkedStyleguides;
343+
}
344+
330345

331346

332347
setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
@@ -345,10 +360,11 @@ export const ComponentsApiAxiosParamCreator = function (configuration?: Configur
345360
* @param {string} componentId Component id
346361
* @param {string} [linkedProject] Reference project id
347362
* @param {string} [linkedStyleguide] Reference styleguide id
363+
* @param {boolean} [includeLinkedStyleguides] Whether to include linked styleguides or not
348364
* @param {*} [options] Override http request option.
349365
* @throws {RequiredError}
350366
*/
351-
getStyleguideComponentLatestVersion: async (styleguideId: string, componentId: string, linkedProject?: string, linkedStyleguide?: string, options: any = {}): Promise<RequestArgs> => {
367+
getStyleguideComponentLatestVersion: async (styleguideId: string, componentId: string, linkedProject?: string, linkedStyleguide?: string, includeLinkedStyleguides?: boolean, options: any = {}): Promise<RequestArgs> => {
352368
// verify required parameter 'styleguideId' is not null or undefined
353369
assertParamExists('getStyleguideComponentLatestVersion', 'styleguideId', styleguideId)
354370
// verify required parameter 'componentId' is not null or undefined
@@ -383,6 +399,10 @@ export const ComponentsApiAxiosParamCreator = function (configuration?: Configur
383399
localVarQueryParameter['linked_styleguide'] = linkedStyleguide;
384400
}
385401

402+
if (includeLinkedStyleguides !== undefined) {
403+
localVarQueryParameter['include_linked_styleguides'] = includeLinkedStyleguides;
404+
}
405+
386406

387407

388408
setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
@@ -658,23 +678,25 @@ export const ComponentsApiFp = function(configuration?: Configuration) {
658678
* @param {string} projectId Project id
659679
* @param {string} componentId Component id
660680
* @param {boolean} [includeLatestVersion] Whether to include the latest version data in the Component object
681+
* @param {boolean} [includeLinkedStyleguides] Whether to include linked styleguides or not
661682
* @param {*} [options] Override http request option.
662683
* @throws {RequiredError}
663684
*/
664-
async getProjectComponent(projectId: string, componentId: string, includeLatestVersion?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>> {
665-
const localVarAxiosArgs = await localVarAxiosParamCreator.getProjectComponent(projectId, componentId, includeLatestVersion, options);
685+
async getProjectComponent(projectId: string, componentId: string, includeLatestVersion?: boolean, includeLinkedStyleguides?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>> {
686+
const localVarAxiosArgs = await localVarAxiosParamCreator.getProjectComponent(projectId, componentId, includeLatestVersion, includeLinkedStyleguides, options);
666687
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
667688
},
668689
/**
669690
* Get latest version of the component in a project
670691
* @summary Get latest project component version
671692
* @param {string} projectId Project id
672693
* @param {string} componentId Component id
694+
* @param {boolean} [includeLinkedStyleguides] Whether to include linked styleguides or not
673695
* @param {*} [options] Override http request option.
674696
* @throws {RequiredError}
675697
*/
676-
async getProjectComponentLatestVersion(projectId: string, componentId: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>> {
677-
const localVarAxiosArgs = await localVarAxiosParamCreator.getProjectComponentLatestVersion(projectId, componentId, options);
698+
async getProjectComponentLatestVersion(projectId: string, componentId: string, includeLinkedStyleguides?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>> {
699+
const localVarAxiosArgs = await localVarAxiosParamCreator.getProjectComponentLatestVersion(projectId, componentId, includeLinkedStyleguides, options);
678700
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
679701
},
680702
/**
@@ -715,11 +737,12 @@ export const ComponentsApiFp = function(configuration?: Configuration) {
715737
* @param {string} [linkedProject] Reference project id
716738
* @param {string} [linkedStyleguide] Reference styleguide id
717739
* @param {boolean} [includeLatestVersion] Whether to include the latest version data in the Component object
740+
* @param {boolean} [includeLinkedStyleguides] Whether to include linked styleguides or not
718741
* @param {*} [options] Override http request option.
719742
* @throws {RequiredError}
720743
*/
721-
async getStyleguideComponent(styleguideId: string, componentId: string, linkedProject?: string, linkedStyleguide?: string, includeLatestVersion?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>> {
722-
const localVarAxiosArgs = await localVarAxiosParamCreator.getStyleguideComponent(styleguideId, componentId, linkedProject, linkedStyleguide, includeLatestVersion, options);
744+
async getStyleguideComponent(styleguideId: string, componentId: string, linkedProject?: string, linkedStyleguide?: string, includeLatestVersion?: boolean, includeLinkedStyleguides?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>> {
745+
const localVarAxiosArgs = await localVarAxiosParamCreator.getStyleguideComponent(styleguideId, componentId, linkedProject, linkedStyleguide, includeLatestVersion, includeLinkedStyleguides, options);
723746
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
724747
},
725748
/**
@@ -729,11 +752,12 @@ export const ComponentsApiFp = function(configuration?: Configuration) {
729752
* @param {string} componentId Component id
730753
* @param {string} [linkedProject] Reference project id
731754
* @param {string} [linkedStyleguide] Reference styleguide id
755+
* @param {boolean} [includeLinkedStyleguides] Whether to include linked styleguides or not
732756
* @param {*} [options] Override http request option.
733757
* @throws {RequiredError}
734758
*/
735-
async getStyleguideComponentLatestVersion(styleguideId: string, componentId: string, linkedProject?: string, linkedStyleguide?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>> {
736-
const localVarAxiosArgs = await localVarAxiosParamCreator.getStyleguideComponentLatestVersion(styleguideId, componentId, linkedProject, linkedStyleguide, options);
759+
async getStyleguideComponentLatestVersion(styleguideId: string, componentId: string, linkedProject?: string, linkedStyleguide?: string, includeLinkedStyleguides?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>> {
760+
const localVarAxiosArgs = await localVarAxiosParamCreator.getStyleguideComponentLatestVersion(styleguideId, componentId, linkedProject, linkedStyleguide, includeLinkedStyleguides, options);
737761
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
738762
},
739763
/**
@@ -812,8 +836,28 @@ export interface ComponentsApiGetProjectComponentSearchParams {
812836
* @memberof ComponentsApiGetProjectComponentSearchParams
813837
*/
814838
readonly includeLatestVersion?: boolean;
839+
840+
/**
841+
* Whether to include linked styleguides or not
842+
* @type {boolean}
843+
* @memberof ComponentsApiGetProjectComponentSearchParams
844+
*/
845+
readonly includeLinkedStyleguides?: boolean;
815846
}
816847

848+
/**
849+
* Search parameters for getProjectComponentLatestVersion operation in ComponentsApi.
850+
* @export
851+
* @interface ComponentsApiGetProjectComponentLatestVersionSearchParams
852+
*/
853+
export interface ComponentsApiGetProjectComponentLatestVersionSearchParams {
854+
/**
855+
* Whether to include linked styleguides or not
856+
* @type {boolean}
857+
* @memberof ComponentsApiGetProjectComponentLatestVersionSearchParams
858+
*/
859+
readonly includeLinkedStyleguides?: boolean;
860+
}
817861

818862
/**
819863
* Search parameters for getProjectComponentSections operation in ComponentsApi.
@@ -911,6 +955,13 @@ export interface ComponentsApiGetStyleguideComponentSearchParams {
911955
* @memberof ComponentsApiGetStyleguideComponentSearchParams
912956
*/
913957
readonly includeLatestVersion?: boolean;
958+
959+
/**
960+
* Whether to include linked styleguides or not
961+
* @type {boolean}
962+
* @memberof ComponentsApiGetStyleguideComponentSearchParams
963+
*/
964+
readonly includeLinkedStyleguides?: boolean;
914965
}
915966

916967
/**
@@ -932,6 +983,13 @@ export interface ComponentsApiGetStyleguideComponentLatestVersionSearchParams {
932983
* @memberof ComponentsApiGetStyleguideComponentLatestVersionSearchParams
933984
*/
934985
readonly linkedStyleguide?: string;
986+
987+
/**
988+
* Whether to include linked styleguides or not
989+
* @type {boolean}
990+
* @memberof ComponentsApiGetStyleguideComponentLatestVersionSearchParams
991+
*/
992+
readonly includeLinkedStyleguides?: boolean;
935993
}
936994

937995
/**
@@ -1054,7 +1112,7 @@ export class ComponentsApi extends BaseAPI {
10541112
*/
10551113
public async getProjectComponent(projectId: string, componentId: string, searchParams: ComponentsApiGetProjectComponentSearchParams = {}, options?: any) : Promise<AxiosResponse<Component>> {
10561114
const componentsApiFp = ComponentsApiFp(this.configuration);
1057-
const request = await componentsApiFp.getProjectComponent(projectId, componentId, searchParams.includeLatestVersion, options);
1115+
const request = await componentsApiFp.getProjectComponent(projectId, componentId, searchParams.includeLatestVersion, searchParams.includeLinkedStyleguides, options);
10581116
const response = await request(this.axios, this.basePath);
10591117
return {
10601118
...response,
@@ -1067,13 +1125,14 @@ export class ComponentsApi extends BaseAPI {
10671125
* @summary Get latest project component version
10681126
* @param {string} projectId Project id
10691127
* @param {string} componentId Component id
1128+
* @param {ComponentsApiGetProjectComponentLatestVersionSearchParams} [searchParams] Search parameters.
10701129
* @param {*} [options] Override http request option.
10711130
* @throws {RequiredError}
10721131
* @memberof ComponentsApi
10731132
*/
1074-
public async getProjectComponentLatestVersion(projectId: string, componentId: string, options?: any) : Promise<AxiosResponse<ComponentVersion>> {
1133+
public async getProjectComponentLatestVersion(projectId: string, componentId: string, searchParams: ComponentsApiGetProjectComponentLatestVersionSearchParams = {}, options?: any) : Promise<AxiosResponse<ComponentVersion>> {
10751134
const componentsApiFp = ComponentsApiFp(this.configuration);
1076-
const request = await componentsApiFp.getProjectComponentLatestVersion(projectId, componentId, options);
1135+
const request = await componentsApiFp.getProjectComponentLatestVersion(projectId, componentId, searchParams.includeLinkedStyleguides, options);
10771136
const response = await request(this.axios, this.basePath);
10781137
return {
10791138
...response,
@@ -1131,7 +1190,7 @@ export class ComponentsApi extends BaseAPI {
11311190
*/
11321191
public async getStyleguideComponent(styleguideId: string, componentId: string, searchParams: ComponentsApiGetStyleguideComponentSearchParams = {}, options?: any) : Promise<AxiosResponse<Component>> {
11331192
const componentsApiFp = ComponentsApiFp(this.configuration);
1134-
const request = await componentsApiFp.getStyleguideComponent(styleguideId, componentId, searchParams.linkedProject, searchParams.linkedStyleguide, searchParams.includeLatestVersion, options);
1193+
const request = await componentsApiFp.getStyleguideComponent(styleguideId, componentId, searchParams.linkedProject, searchParams.linkedStyleguide, searchParams.includeLatestVersion, searchParams.includeLinkedStyleguides, options);
11351194
const response = await request(this.axios, this.basePath);
11361195
return {
11371196
...response,
@@ -1151,7 +1210,7 @@ export class ComponentsApi extends BaseAPI {
11511210
*/
11521211
public async getStyleguideComponentLatestVersion(styleguideId: string, componentId: string, searchParams: ComponentsApiGetStyleguideComponentLatestVersionSearchParams = {}, options?: any) : Promise<AxiosResponse<ComponentVersion>> {
11531212
const componentsApiFp = ComponentsApiFp(this.configuration);
1154-
const request = await componentsApiFp.getStyleguideComponentLatestVersion(styleguideId, componentId, searchParams.linkedProject, searchParams.linkedStyleguide, options);
1213+
const request = await componentsApiFp.getStyleguideComponentLatestVersion(styleguideId, componentId, searchParams.linkedProject, searchParams.linkedStyleguide, searchParams.includeLinkedStyleguides, options);
11551214
const response = await request(this.axios, this.basePath);
11561215
return {
11571216
...response,

0 commit comments

Comments
 (0)