/* tslint:disable */ /* eslint-disable */ /** * Identity Security Cloud API - Branding * Use these APIs to interact with the Identity Security Cloud platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs. * * The version of the OpenAPI document: v1 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import type { Configuration } from '../configuration'; import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; import globalAxios from 'axios'; // Some imports not used depending on template conditions // @ts-ignore import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common'; import type { RequestArgs } from './base'; // @ts-ignore import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, RequiredError, operationServerMap } from './base'; /** * * @export * @interface BrandingItem */ export interface BrandingItem { /** * name of branding item * @type {string} * @memberof BrandingItem */ 'name'?: string; /** * product name * @type {string} * @memberof BrandingItem */ 'productName'?: string | null; /** * hex value of color for action button * @type {string} * @memberof BrandingItem */ 'actionButtonColor'?: string | null; /** * hex value of color for link * @type {string} * @memberof BrandingItem */ 'activeLinkColor'?: string | null; /** * hex value of color for navigation bar * @type {string} * @memberof BrandingItem */ 'navigationColor'?: string | null; /** * email from address * @type {string} * @memberof BrandingItem */ 'emailFromAddress'?: string | null; /** * url to standard logo * @type {string} * @memberof BrandingItem */ 'standardLogoURL'?: string | null; /** * login information message * @type {string} * @memberof BrandingItem */ 'loginInformationalMessage'?: string | null; } /** * * @export * @interface BrandingItemCreate */ export interface BrandingItemCreate { /** * name of branding item * @type {string} * @memberof BrandingItemCreate */ 'name': string; /** * product name * @type {string} * @memberof BrandingItemCreate */ 'productName': string | null; /** * hex value of color for action button * @type {string} * @memberof BrandingItemCreate */ 'actionButtonColor'?: string; /** * hex value of color for link * @type {string} * @memberof BrandingItemCreate */ 'activeLinkColor'?: string; /** * hex value of color for navigation bar * @type {string} * @memberof BrandingItemCreate */ 'navigationColor'?: string; /** * email from address * @type {string} * @memberof BrandingItemCreate */ 'emailFromAddress'?: string; /** * login information message * @type {string} * @memberof BrandingItemCreate */ 'loginInformationalMessage'?: string; /** * png file with logo * @type {File} * @memberof BrandingItemCreate */ 'fileStandard'?: File; } /** * * @export * @interface ErrorMessageDto */ export interface ErrorMessageDto { /** * The locale for the message text, a BCP 47 language tag. * @type {string} * @memberof ErrorMessageDto */ 'locale'?: string | null; /** * * @type {LocaleOrigin} * @memberof ErrorMessageDto */ 'localeOrigin'?: LocaleOrigin | null; /** * Actual text of the error message in the indicated locale. * @type {string} * @memberof ErrorMessageDto */ 'text'?: string; } /** * * @export * @interface ErrorResponseDto */ export interface ErrorResponseDto { /** * Fine-grained error code providing more detail of the error. * @type {string} * @memberof ErrorResponseDto */ 'detailCode'?: string; /** * Unique tracking id for the error. * @type {string} * @memberof ErrorResponseDto */ 'trackingId'?: string; /** * Generic localized reason for error * @type {Array} * @memberof ErrorResponseDto */ 'messages'?: Array; /** * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field * @type {Array} * @memberof ErrorResponseDto */ 'causes'?: Array; } /** * * @export * @interface GetBrandingListV1401Response */ export interface GetBrandingListV1401Response { /** * A message describing the error * @type {any} * @memberof GetBrandingListV1401Response */ 'error'?: any; } /** * * @export * @interface GetBrandingListV1429Response */ export interface GetBrandingListV1429Response { /** * A message describing the error * @type {any} * @memberof GetBrandingListV1429Response */ 'message'?: any; } /** * An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice. * @export * @enum {string} */ export const LocaleOrigin = { Default: 'DEFAULT', Request: 'REQUEST' } as const; export type LocaleOrigin = typeof LocaleOrigin[keyof typeof LocaleOrigin]; /** * BrandingApi - axios parameter creator * @export */ export const BrandingApiAxiosParamCreator = function (configuration?: Configuration) { return { /** * This API endpoint creates a branding item. * @summary Create a branding item * @param {string} name name of branding item * @param {string | null} productName product name * @param {string} [actionButtonColor] hex value of color for action button * @param {string} [activeLinkColor] hex value of color for link * @param {string} [navigationColor] hex value of color for navigation bar * @param {string} [emailFromAddress] email from address * @param {string} [loginInformationalMessage] login information message * @param {File} [fileStandard] png file with logo * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createBrandingItemV1: async (name: string, productName: string | null, actionButtonColor?: string, activeLinkColor?: string, navigationColor?: string, emailFromAddress?: string, loginInformationalMessage?: string, fileStandard?: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'name' is not null or undefined assertParamExists('createBrandingItemV1', 'name', name) // verify required parameter 'productName' is not null or undefined assertParamExists('createBrandingItemV1', 'productName', productName) const localVarPath = `/brandings/v1`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'POST', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); if (name !== undefined) { localVarFormParams.append('name', name as any); } if (productName !== undefined) { localVarFormParams.append('productName', productName as any); } if (actionButtonColor !== undefined) { localVarFormParams.append('actionButtonColor', actionButtonColor as any); } if (activeLinkColor !== undefined) { localVarFormParams.append('activeLinkColor', activeLinkColor as any); } if (navigationColor !== undefined) { localVarFormParams.append('navigationColor', navigationColor as any); } if (emailFromAddress !== undefined) { localVarFormParams.append('emailFromAddress', emailFromAddress as any); } if (loginInformationalMessage !== undefined) { localVarFormParams.append('loginInformationalMessage', loginInformationalMessage as any); } if (fileStandard !== undefined) { localVarFormParams.append('fileStandard', fileStandard as any); } localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; localVarRequestOptions.data = localVarFormParams; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This API endpoint delete information for an existing branding item by name. * @summary Delete a branding item * @param {string} name The name of the branding item to be deleted * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteBrandingV1: async (name: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'name' is not null or undefined assertParamExists('deleteBrandingV1', 'name', name) const localVarPath = `/brandings/v1/{name}` .replace(`{${"name"}}`, encodeURIComponent(String(name))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This API endpoint returns a list of branding items. * @summary List of branding items * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getBrandingListV1: async (axiosOptions: RawAxiosRequestConfig = {}): Promise => { const localVarPath = `/brandings/v1`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This API endpoint retrieves information for an existing branding item by name. * @summary Get a branding item * @param {string} name The name of the branding item to be retrieved * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getBrandingV1: async (name: string, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'name' is not null or undefined assertParamExists('getBrandingV1', 'name', name) const localVarPath = `/brandings/v1/{name}` .replace(`{${"name"}}`, encodeURIComponent(String(name))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'GET', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, /** * This API endpoint updates information for an existing branding item. * @summary Update a branding item * @param {string} name The name of the branding item to be retrieved * @param {string} name2 name of branding item * @param {string | null} productName product name * @param {string} [actionButtonColor] hex value of color for action button * @param {string} [activeLinkColor] hex value of color for link * @param {string} [navigationColor] hex value of color for navigation bar * @param {string} [emailFromAddress] email from address * @param {string} [loginInformationalMessage] login information message * @param {File} [fileStandard] png file with logo * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ setBrandingItemV1: async (name: string, name2: string, productName: string | null, actionButtonColor?: string, activeLinkColor?: string, navigationColor?: string, emailFromAddress?: string, loginInformationalMessage?: string, fileStandard?: File, axiosOptions: RawAxiosRequestConfig = {}): Promise => { // verify required parameter 'name' is not null or undefined assertParamExists('setBrandingItemV1', 'name', name) // verify required parameter 'name2' is not null or undefined assertParamExists('setBrandingItemV1', 'name2', name2) // verify required parameter 'productName' is not null or undefined assertParamExists('setBrandingItemV1', 'productName', productName) const localVarPath = `/brandings/v1/{name}` .replace(`{${"name"}}`, encodeURIComponent(String(name))); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; if (configuration) { baseOptions = configuration.baseOptions; } const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...axiosOptions}; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); if (name2 !== undefined) { localVarFormParams.append('name', name2 as any); } if (productName !== undefined) { localVarFormParams.append('productName', productName as any); } if (actionButtonColor !== undefined) { localVarFormParams.append('actionButtonColor', actionButtonColor as any); } if (activeLinkColor !== undefined) { localVarFormParams.append('activeLinkColor', activeLinkColor as any); } if (navigationColor !== undefined) { localVarFormParams.append('navigationColor', navigationColor as any); } if (emailFromAddress !== undefined) { localVarFormParams.append('emailFromAddress', emailFromAddress as any); } if (loginInformationalMessage !== undefined) { localVarFormParams.append('loginInformationalMessage', loginInformationalMessage as any); } if (fileStandard !== undefined) { localVarFormParams.append('fileStandard', fileStandard as any); } localVarHeaderParameter['Content-Type'] = 'multipart/form-data'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...axiosOptions.headers}; localVarRequestOptions.data = localVarFormParams; return { url: toPathString(localVarUrlObj), axiosOptions: localVarRequestOptions, }; }, } }; /** * BrandingApi - functional programming interface * @export */ export const BrandingApiFp = function(configuration?: Configuration) { const localVarAxiosParamCreator = BrandingApiAxiosParamCreator(configuration) return { /** * This API endpoint creates a branding item. * @summary Create a branding item * @param {string} name name of branding item * @param {string | null} productName product name * @param {string} [actionButtonColor] hex value of color for action button * @param {string} [activeLinkColor] hex value of color for link * @param {string} [navigationColor] hex value of color for navigation bar * @param {string} [emailFromAddress] email from address * @param {string} [loginInformationalMessage] login information message * @param {File} [fileStandard] png file with logo * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async createBrandingItemV1(name: string, productName: string | null, actionButtonColor?: string, activeLinkColor?: string, navigationColor?: string, emailFromAddress?: string, loginInformationalMessage?: string, fileStandard?: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.createBrandingItemV1(name, productName, actionButtonColor, activeLinkColor, navigationColor, emailFromAddress, loginInformationalMessage, fileStandard, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['BrandingApi.createBrandingItemV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This API endpoint delete information for an existing branding item by name. * @summary Delete a branding item * @param {string} name The name of the branding item to be deleted * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async deleteBrandingV1(name: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.deleteBrandingV1(name, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['BrandingApi.deleteBrandingV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This API endpoint returns a list of branding items. * @summary List of branding items * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async getBrandingListV1(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.getBrandingListV1(axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['BrandingApi.getBrandingListV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This API endpoint retrieves information for an existing branding item by name. * @summary Get a branding item * @param {string} name The name of the branding item to be retrieved * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async getBrandingV1(name: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getBrandingV1(name, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['BrandingApi.getBrandingV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, /** * This API endpoint updates information for an existing branding item. * @summary Update a branding item * @param {string} name The name of the branding item to be retrieved * @param {string} name2 name of branding item * @param {string | null} productName product name * @param {string} [actionButtonColor] hex value of color for action button * @param {string} [activeLinkColor] hex value of color for link * @param {string} [navigationColor] hex value of color for navigation bar * @param {string} [emailFromAddress] email from address * @param {string} [loginInformationalMessage] login information message * @param {File} [fileStandard] png file with logo * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ async setBrandingItemV1(name: string, name2: string, productName: string | null, actionButtonColor?: string, activeLinkColor?: string, navigationColor?: string, emailFromAddress?: string, loginInformationalMessage?: string, fileStandard?: File, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.setBrandingItemV1(name, name2, productName, actionButtonColor, activeLinkColor, navigationColor, emailFromAddress, loginInformationalMessage, fileStandard, axiosOptions); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['BrandingApi.setBrandingItemV1']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }, } }; /** * BrandingApi - factory interface * @export */ export const BrandingApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) { const localVarFp = BrandingApiFp(configuration) return { /** * This API endpoint creates a branding item. * @summary Create a branding item * @param {BrandingApiCreateBrandingItemV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createBrandingItemV1(requestParameters: BrandingApiCreateBrandingItemV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.createBrandingItemV1(requestParameters.name, requestParameters.productName, requestParameters.actionButtonColor, requestParameters.activeLinkColor, requestParameters.navigationColor, requestParameters.emailFromAddress, requestParameters.loginInformationalMessage, requestParameters.fileStandard, axiosOptions).then((request) => request(axios, basePath)); }, /** * This API endpoint delete information for an existing branding item by name. * @summary Delete a branding item * @param {BrandingApiDeleteBrandingV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ deleteBrandingV1(requestParameters: BrandingApiDeleteBrandingV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.deleteBrandingV1(requestParameters.name, axiosOptions).then((request) => request(axios, basePath)); }, /** * This API endpoint returns a list of branding items. * @summary List of branding items * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getBrandingListV1(axiosOptions?: RawAxiosRequestConfig): AxiosPromise> { return localVarFp.getBrandingListV1(axiosOptions).then((request) => request(axios, basePath)); }, /** * This API endpoint retrieves information for an existing branding item by name. * @summary Get a branding item * @param {BrandingApiGetBrandingV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getBrandingV1(requestParameters: BrandingApiGetBrandingV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.getBrandingV1(requestParameters.name, axiosOptions).then((request) => request(axios, basePath)); }, /** * This API endpoint updates information for an existing branding item. * @summary Update a branding item * @param {BrandingApiSetBrandingItemV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ setBrandingItemV1(requestParameters: BrandingApiSetBrandingItemV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise { return localVarFp.setBrandingItemV1(requestParameters.name, requestParameters.name2, requestParameters.productName, requestParameters.actionButtonColor, requestParameters.activeLinkColor, requestParameters.navigationColor, requestParameters.emailFromAddress, requestParameters.loginInformationalMessage, requestParameters.fileStandard, axiosOptions).then((request) => request(axios, basePath)); }, }; }; /** * Request parameters for createBrandingItemV1 operation in BrandingApi. * @export * @interface BrandingApiCreateBrandingItemV1Request */ export interface BrandingApiCreateBrandingItemV1Request { /** * name of branding item * @type {string} * @memberof BrandingApiCreateBrandingItemV1 */ readonly name: string /** * product name * @type {string} * @memberof BrandingApiCreateBrandingItemV1 */ readonly productName: string | null /** * hex value of color for action button * @type {string} * @memberof BrandingApiCreateBrandingItemV1 */ readonly actionButtonColor?: string /** * hex value of color for link * @type {string} * @memberof BrandingApiCreateBrandingItemV1 */ readonly activeLinkColor?: string /** * hex value of color for navigation bar * @type {string} * @memberof BrandingApiCreateBrandingItemV1 */ readonly navigationColor?: string /** * email from address * @type {string} * @memberof BrandingApiCreateBrandingItemV1 */ readonly emailFromAddress?: string /** * login information message * @type {string} * @memberof BrandingApiCreateBrandingItemV1 */ readonly loginInformationalMessage?: string /** * png file with logo * @type {File} * @memberof BrandingApiCreateBrandingItemV1 */ readonly fileStandard?: File } /** * Request parameters for deleteBrandingV1 operation in BrandingApi. * @export * @interface BrandingApiDeleteBrandingV1Request */ export interface BrandingApiDeleteBrandingV1Request { /** * The name of the branding item to be deleted * @type {string} * @memberof BrandingApiDeleteBrandingV1 */ readonly name: string } /** * Request parameters for getBrandingV1 operation in BrandingApi. * @export * @interface BrandingApiGetBrandingV1Request */ export interface BrandingApiGetBrandingV1Request { /** * The name of the branding item to be retrieved * @type {string} * @memberof BrandingApiGetBrandingV1 */ readonly name: string } /** * Request parameters for setBrandingItemV1 operation in BrandingApi. * @export * @interface BrandingApiSetBrandingItemV1Request */ export interface BrandingApiSetBrandingItemV1Request { /** * The name of the branding item to be retrieved * @type {string} * @memberof BrandingApiSetBrandingItemV1 */ readonly name: string /** * name of branding item * @type {string} * @memberof BrandingApiSetBrandingItemV1 */ readonly name2: string /** * product name * @type {string} * @memberof BrandingApiSetBrandingItemV1 */ readonly productName: string | null /** * hex value of color for action button * @type {string} * @memberof BrandingApiSetBrandingItemV1 */ readonly actionButtonColor?: string /** * hex value of color for link * @type {string} * @memberof BrandingApiSetBrandingItemV1 */ readonly activeLinkColor?: string /** * hex value of color for navigation bar * @type {string} * @memberof BrandingApiSetBrandingItemV1 */ readonly navigationColor?: string /** * email from address * @type {string} * @memberof BrandingApiSetBrandingItemV1 */ readonly emailFromAddress?: string /** * login information message * @type {string} * @memberof BrandingApiSetBrandingItemV1 */ readonly loginInformationalMessage?: string /** * png file with logo * @type {File} * @memberof BrandingApiSetBrandingItemV1 */ readonly fileStandard?: File } /** * BrandingApi - object-oriented interface * @export * @class BrandingApi * @extends {BaseAPI} */ export class BrandingApi extends BaseAPI { /** * This API endpoint creates a branding item. * @summary Create a branding item * @param {BrandingApiCreateBrandingItemV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof BrandingApi */ public createBrandingItemV1(requestParameters: BrandingApiCreateBrandingItemV1Request, axiosOptions?: RawAxiosRequestConfig) { return BrandingApiFp(this.configuration).createBrandingItemV1(requestParameters.name, requestParameters.productName, requestParameters.actionButtonColor, requestParameters.activeLinkColor, requestParameters.navigationColor, requestParameters.emailFromAddress, requestParameters.loginInformationalMessage, requestParameters.fileStandard, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This API endpoint delete information for an existing branding item by name. * @summary Delete a branding item * @param {BrandingApiDeleteBrandingV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof BrandingApi */ public deleteBrandingV1(requestParameters: BrandingApiDeleteBrandingV1Request, axiosOptions?: RawAxiosRequestConfig) { return BrandingApiFp(this.configuration).deleteBrandingV1(requestParameters.name, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This API endpoint returns a list of branding items. * @summary List of branding items * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof BrandingApi */ public getBrandingListV1(axiosOptions?: RawAxiosRequestConfig) { return BrandingApiFp(this.configuration).getBrandingListV1(axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This API endpoint retrieves information for an existing branding item by name. * @summary Get a branding item * @param {BrandingApiGetBrandingV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof BrandingApi */ public getBrandingV1(requestParameters: BrandingApiGetBrandingV1Request, axiosOptions?: RawAxiosRequestConfig) { return BrandingApiFp(this.configuration).getBrandingV1(requestParameters.name, axiosOptions).then((request) => request(this.axios, this.basePath)); } /** * This API endpoint updates information for an existing branding item. * @summary Update a branding item * @param {BrandingApiSetBrandingItemV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof BrandingApi */ public setBrandingItemV1(requestParameters: BrandingApiSetBrandingItemV1Request, axiosOptions?: RawAxiosRequestConfig) { return BrandingApiFp(this.configuration).setBrandingItemV1(requestParameters.name, requestParameters.name2, requestParameters.productName, requestParameters.actionButtonColor, requestParameters.activeLinkColor, requestParameters.navigationColor, requestParameters.emailFromAddress, requestParameters.loginInformationalMessage, requestParameters.fileStandard, axiosOptions).then((request) => request(this.axios, this.basePath)); } }