/* tslint:disable */ /* eslint-disable */ /** * Fabric API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 1.0.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import * as runtime from '../runtime'; import type { CreateSmartCollection400Response, CreateSmartCollectionRequest, GetSmartCollection200Response, PatchSmartCollectionRequest, SmartCollection, UpdateSmartCollectionRequest, } from '../models/index'; import { CreateSmartCollection400ResponseFromJSON, CreateSmartCollection400ResponseToJSON, CreateSmartCollectionRequestFromJSON, CreateSmartCollectionRequestToJSON, GetSmartCollection200ResponseFromJSON, GetSmartCollection200ResponseToJSON, PatchSmartCollectionRequestFromJSON, PatchSmartCollectionRequestToJSON, SmartCollectionFromJSON, SmartCollectionToJSON, UpdateSmartCollectionRequestFromJSON, UpdateSmartCollectionRequestToJSON, } from '../models/index'; export type CreateSmartCollectionOperationRequest = Omit; export type DeleteSmartCollectionRequest = Omit<{ id: string; baseId?: string; }, 'baseId'>; export type GetSmartCollectionRequest = Omit<{ id: string; baseId?: string; }, 'baseId'>; export type ListSmartCollectionsRequest = Omit<{ baseId?: string; }, 'baseId'>; export type PatchSmartCollectionOperationRequest = Omit; export type UpdateSmartCollectionOperationRequest = Omit; /** * */ export class SmartCollectionsApi extends runtime.BaseAPI { /** * Create a new smart collection with optional name, description, and search queries. * Create smart collection */ async createRaw(requestParameters: CreateSmartCollectionOperationRequest, initOverrides?: runtime.InitOverrides | runtime.InitOverrideFunction): Promise> { const queryParameters: any = {}; if (requestParameters['onlySuggest'] != null) { queryParameters['onlySuggest'] = requestParameters['onlySuggest']; } const headerParameters: runtime.HTTPHeaders = {}; headerParameters['Content-Type'] = 'application/json'; if (requestParameters['baseId'] != null) { headerParameters['X-Fabric-Base-Id'] = String(requestParameters['baseId']); } if (this.configuration && this.configuration.accessToken) { // oauth required headerParameters["Authorization"] = await this.configuration.accessToken("OAuth2", []); } if (this.configuration && this.configuration.apiKey) { headerParameters["X-Api-Key"] = await this.configuration.apiKey("X-Api-Key"); // ApiKey authentication } let urlPath = `/v2/smart-collections`; const response = await this.request({ path: urlPath, method: 'POST', headers: headerParameters, query: queryParameters, body: CreateSmartCollectionRequestToJSON(requestParameters), }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => SmartCollectionFromJSON(jsonValue)); } /** * Create a new smart collection with optional name, description, and search queries. * Create smart collection */ async create(requestParameters: CreateSmartCollectionOperationRequest, initOverrides?: runtime.InitOverrides | runtime.InitOverrideFunction): Promise { const response = await this.createRaw(requestParameters, initOverrides); return await response.value(); } /** * Permanently delete a smart collection. * Delete smart collection */ async deleteRaw(requestParameters: DeleteSmartCollectionRequest, initOverrides?: runtime.InitOverrides | runtime.InitOverrideFunction): Promise> { if (requestParameters['id'] == null) { throw new runtime.RequiredError( 'id', 'Required parameter "id" was null or undefined when calling ().' ); } const queryParameters: any = {}; const headerParameters: runtime.HTTPHeaders = {}; if (requestParameters['baseId'] != null) { headerParameters['X-Fabric-Base-Id'] = String(requestParameters['baseId']); } if (this.configuration && this.configuration.accessToken) { // oauth required headerParameters["Authorization"] = await this.configuration.accessToken("OAuth2", []); } if (this.configuration && this.configuration.apiKey) { headerParameters["X-Api-Key"] = await this.configuration.apiKey("X-Api-Key"); // ApiKey authentication } let urlPath = `/v2/smart-collections/{id}`; urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))); const response = await this.request({ path: urlPath, method: 'DELETE', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.VoidApiResponse(response); } /** * Permanently delete a smart collection. * Delete smart collection */ async delete(requestParameters: DeleteSmartCollectionRequest, initOverrides?: runtime.InitOverrides | runtime.InitOverrideFunction): Promise { await this.deleteRaw(requestParameters, initOverrides); } /** * Retrieve details and preferences of a specific smart collection. * Get smart collection */ async getRaw(requestParameters: GetSmartCollectionRequest, initOverrides?: runtime.InitOverrides | runtime.InitOverrideFunction): Promise> { if (requestParameters['id'] == null) { throw new runtime.RequiredError( 'id', 'Required parameter "id" was null or undefined when calling ().' ); } const queryParameters: any = {}; const headerParameters: runtime.HTTPHeaders = {}; if (requestParameters['baseId'] != null) { headerParameters['X-Fabric-Base-Id'] = String(requestParameters['baseId']); } if (this.configuration && this.configuration.accessToken) { // oauth required headerParameters["Authorization"] = await this.configuration.accessToken("OAuth2", []); } if (this.configuration && this.configuration.apiKey) { headerParameters["X-Api-Key"] = await this.configuration.apiKey("X-Api-Key"); // ApiKey authentication } let urlPath = `/v2/smart-collections/{id}`; urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))); const response = await this.request({ path: urlPath, method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => GetSmartCollection200ResponseFromJSON(jsonValue)); } /** * Retrieve details and preferences of a specific smart collection. * Get smart collection */ async get(requestParameters: GetSmartCollectionRequest, initOverrides?: runtime.InitOverrides | runtime.InitOverrideFunction): Promise { const response = await this.getRaw(requestParameters, initOverrides); return await response.value(); } /** * Retrieve all smart collections in the workspace. * List smart collections */ async listRaw(requestParameters: ListSmartCollectionsRequest = {}, initOverrides?: runtime.InitOverrides | runtime.InitOverrideFunction): Promise>> { const queryParameters: any = {}; const headerParameters: runtime.HTTPHeaders = {}; if (requestParameters['baseId'] != null) { headerParameters['X-Fabric-Base-Id'] = String(requestParameters['baseId']); } if (this.configuration && this.configuration.accessToken) { // oauth required headerParameters["Authorization"] = await this.configuration.accessToken("OAuth2", []); } if (this.configuration && this.configuration.apiKey) { headerParameters["X-Api-Key"] = await this.configuration.apiKey("X-Api-Key"); // ApiKey authentication } let urlPath = `/v2/smart-collections`; const response = await this.request({ path: urlPath, method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(SmartCollectionFromJSON)); } /** * Retrieve all smart collections in the workspace. * List smart collections */ async list(requestParameters: ListSmartCollectionsRequest = {}, initOverrides?: runtime.InitOverrides | runtime.InitOverrideFunction): Promise> { const response = await this.listRaw(requestParameters, initOverrides); return await response.value(); } /** * Partially update a smart collection\'s description. * Patch smart collection */ async patchRaw(requestParameters: PatchSmartCollectionOperationRequest, initOverrides?: runtime.InitOverrides | runtime.InitOverrideFunction): Promise> { if (requestParameters['id'] == null) { throw new runtime.RequiredError( 'id', 'Required parameter "id" was null or undefined when calling ().' ); } const queryParameters: any = {}; const headerParameters: runtime.HTTPHeaders = {}; headerParameters['Content-Type'] = 'application/json'; if (requestParameters['baseId'] != null) { headerParameters['X-Fabric-Base-Id'] = String(requestParameters['baseId']); } if (this.configuration && this.configuration.accessToken) { // oauth required headerParameters["Authorization"] = await this.configuration.accessToken("OAuth2", []); } if (this.configuration && this.configuration.apiKey) { headerParameters["X-Api-Key"] = await this.configuration.apiKey("X-Api-Key"); // ApiKey authentication } let urlPath = `/v2/smart-collections/{id}`; urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))); const response = await this.request({ path: urlPath, method: 'PATCH', headers: headerParameters, query: queryParameters, body: PatchSmartCollectionRequestToJSON(requestParameters), }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => SmartCollectionFromJSON(jsonValue)); } /** * Partially update a smart collection\'s description. * Patch smart collection */ async patch(requestParameters: PatchSmartCollectionOperationRequest, initOverrides?: runtime.InitOverrides | runtime.InitOverrideFunction): Promise { const response = await this.patchRaw(requestParameters, initOverrides); return await response.value(); } /** * Replace all properties of an existing smart collection. * Update smart collection */ async updateRaw(requestParameters: UpdateSmartCollectionOperationRequest, initOverrides?: runtime.InitOverrides | runtime.InitOverrideFunction): Promise> { if (requestParameters['id'] == null) { throw new runtime.RequiredError( 'id', 'Required parameter "id" was null or undefined when calling ().' ); } const queryParameters: any = {}; const headerParameters: runtime.HTTPHeaders = {}; headerParameters['Content-Type'] = 'application/json'; if (requestParameters['baseId'] != null) { headerParameters['X-Fabric-Base-Id'] = String(requestParameters['baseId']); } if (this.configuration && this.configuration.accessToken) { // oauth required headerParameters["Authorization"] = await this.configuration.accessToken("OAuth2", []); } if (this.configuration && this.configuration.apiKey) { headerParameters["X-Api-Key"] = await this.configuration.apiKey("X-Api-Key"); // ApiKey authentication } let urlPath = `/v2/smart-collections/{id}`; urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))); const response = await this.request({ path: urlPath, method: 'PUT', headers: headerParameters, query: queryParameters, body: UpdateSmartCollectionRequestToJSON(requestParameters), }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => SmartCollectionFromJSON(jsonValue)); } /** * Replace all properties of an existing smart collection. * Update smart collection */ async update(requestParameters: UpdateSmartCollectionOperationRequest, initOverrides?: runtime.InitOverrides | runtime.InitOverrideFunction): Promise { const response = await this.updateRaw(requestParameters, initOverrides); return await response.value(); } }