@emilgroup/partner-sdk 1.0.1 → 1.2.1-beta.1

package/api/partners-api.ts

@@ -31,6 +31,8 @@ import { GetPartnerResponseClass } from '../models';
 // @ts-ignore
 import { ListPartnersResponseClass } from '../models';
 // @ts-ignore
+import { TagPartnerRequestDtoRest } from '../models';
+// @ts-ignore
 import { UpdatePartnerRequestDto } from '../models';
 // @ts-ignore
 import { UpdatePartnerResponseClass } from '../models';
@@ -133,7 +135,7 @@ export const PartnersApiAxiosParamCreator = function (configuration?: Configurat
             };
         },
         /**
-         * Retrieves the details of the partner that was previously created. Supply the unique partner code that was returned when you created it and Emil Api will return the corresponding partner information.
+         * Retrieves the details of the partner that was previously created. Supply the unique partner code        that was returned when you created it and Emil Api will return the corresponding partner information.
          * @summary Retrieve the partner
          * @param {string} code Unique identifier for the object.
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -183,19 +185,20 @@ export const PartnersApiAxiosParamCreator = function (configuration?: Configurat
             };
         },
         /**
-         * Returns a list of partners you have previously created. The partners are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+         * Returns a list of partners you have previously created.        The partners are returned in sorted order, with the oldest one appearing first.        For more information about pagination, read the Pagination documentation.
          * @summary List partners
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
-         * @param {any} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 100. Default: 10.
+         * @param {any} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
          * @param {any} [pageToken] A cursor for use in pagination.     pageToken is an ID that defines your place in the list.     For instance, if you make a list request and receive 100 objects and pageToken=1,     your subsequent call can include pageToken=2 in order to fetch the next page of the list.
          * @param {any} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
-         * @param {any} [search] Search the list by any field. For instance, if you want to search by code     add code=xxx in order to fetch the result.
+         * @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
          * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field.     It functions similarly to an SQL ORDER BY.     Sorting can be performed in either ascending (ASC) or descending (DESC) order.     Default: ASC.
          * @param {any} [expand] Use this parameter to fetch additional information about the list items.     The expand query parameter increases the set of fields that appear in the response in     addition to the default ones.     Expanding resources can reduce the number of API calls required to accomplish a task.     However, use this with parsimony as some expanded fields can drastically increase payload size.
+         * @param {any} [filters] Filters the response by one or multiple fields.          Advanced filter functionality allows you to perform more complex filtering operations.          In general, fetching filtered responses conserves bandwidth and reduces response time.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listPartners: async (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+        listPartners: async (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
             const localVarPath = `/partnerservice/v1/partners`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -238,15 +241,70 @@ export const PartnersApiAxiosParamCreator = function (configuration?: Configurat
                 localVarQueryParameter['expand'] = expand;
             }
 
+            if (filters !== undefined) {
+                localVarQueryParameter['filters'] = filters;
+            }
+
+            if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
+                localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
+            }
+
+
+    
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Updates the specified partner by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+         * @summary Update the partner
+         * @param {string} code 
+         * @param {TagPartnerRequestDtoRest} tagPartnerRequestDtoRest 
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        tagPartner: async (code: string, tagPartnerRequestDtoRest: TagPartnerRequestDtoRest, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'code' is not null or undefined
+            assertParamExists('tagPartner', 'code', code)
+            // verify required parameter 'tagPartnerRequestDtoRest' is not null or undefined
+            assertParamExists('tagPartner', 'tagPartnerRequestDtoRest', tagPartnerRequestDtoRest)
+            const localVarPath = `/partnerservice/v1/partners/{code}/tag`
+                .replace(`{${"code"}}`, encodeURIComponent(String(code)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            let baseAccessToken;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+                baseAccessToken = configuration.accessToken;
+            }
+
+            const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication bearer required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
             if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
                 localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
             }
 
 
     
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+
             setSearchParams(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(tagPartnerRequestDtoRest, localVarRequestOptions, configuration)
 
             return {
                 url: toPathString(localVarUrlObj),
@@ -339,7 +397,7 @@ export const PartnersApiFp = function(configuration?: Configuration) {
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
         /**
-         * Retrieves the details of the partner that was previously created. Supply the unique partner code that was returned when you created it and Emil Api will return the corresponding partner information.
+         * Retrieves the details of the partner that was previously created. Supply the unique partner code        that was returned when you created it and Emil Api will return the corresponding partner information.
          * @summary Retrieve the partner
          * @param {string} code Unique identifier for the object.
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -352,20 +410,34 @@ export const PartnersApiFp = function(configuration?: Configuration) {
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
         /**
-         * Returns a list of partners you have previously created. The partners are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+         * Returns a list of partners you have previously created.        The partners are returned in sorted order, with the oldest one appearing first.        For more information about pagination, read the Pagination documentation.
          * @summary List partners
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
-         * @param {any} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 100. Default: 10.
+         * @param {any} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
          * @param {any} [pageToken] A cursor for use in pagination.     pageToken is an ID that defines your place in the list.     For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1,     your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
          * @param {any} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
-         * @param {any} [search] Search the list by any field. For instance, if you want to search by code     add code&#x3D;xxx in order to fetch the result.
+         * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
          * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field.     It functions similarly to an SQL ORDER BY.     Sorting can be performed in either ascending (ASC) or descending (DESC) order.     Default: ASC.
          * @param {any} [expand] Use this parameter to fetch additional information about the list items.     The expand query parameter increases the set of fields that appear in the response in     addition to the default ones.     Expanding resources can reduce the number of API calls required to accomplish a task.     However, use this with parsimony as some expanded fields can drastically increase payload size.
+         * @param {any} [filters] Filters the response by one or multiple fields.          Advanced filter functionality allows you to perform more complex filtering operations.          In general, fetching filtered responses conserves bandwidth and reduces response time.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async listPartners(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPartnersResponseClass>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.listPartners(authorization, pageSize, pageToken, filter, search, order, expand, options);
+        async listPartners(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPartnersResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listPartners(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+        /**
+         * Updates the specified partner by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+         * @summary Update the partner
+         * @param {string} code 
+         * @param {TagPartnerRequestDtoRest} tagPartnerRequestDtoRest 
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async tagPartner(code: string, tagPartnerRequestDtoRest: TagPartnerRequestDtoRest, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPartnerResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.tagPartner(code, tagPartnerRequestDtoRest, authorization, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
         /**
@@ -414,7 +486,7 @@ export const PartnersApiFactory = function (configuration?: Configuration, baseP
             return localVarFp.deletePartner(code, authorization, options).then((request) => request(axios, basePath));
         },
         /**
-         * Retrieves the details of the partner that was previously created. Supply the unique partner code that was returned when you created it and Emil Api will return the corresponding partner information.
+         * Retrieves the details of the partner that was previously created. Supply the unique partner code        that was returned when you created it and Emil Api will return the corresponding partner information.
          * @summary Retrieve the partner
          * @param {string} code Unique identifier for the object.
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -426,20 +498,33 @@ export const PartnersApiFactory = function (configuration?: Configuration, baseP
             return localVarFp.getPartner(code, authorization, expand, options).then((request) => request(axios, basePath));
         },
         /**
-         * Returns a list of partners you have previously created. The partners are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+         * Returns a list of partners you have previously created.        The partners are returned in sorted order, with the oldest one appearing first.        For more information about pagination, read the Pagination documentation.
          * @summary List partners
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
-         * @param {any} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 100. Default: 10.
+         * @param {any} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
          * @param {any} [pageToken] A cursor for use in pagination.     pageToken is an ID that defines your place in the list.     For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1,     your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
          * @param {any} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
-         * @param {any} [search] Search the list by any field. For instance, if you want to search by code     add code&#x3D;xxx in order to fetch the result.
+         * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
          * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field.     It functions similarly to an SQL ORDER BY.     Sorting can be performed in either ascending (ASC) or descending (DESC) order.     Default: ASC.
          * @param {any} [expand] Use this parameter to fetch additional information about the list items.     The expand query parameter increases the set of fields that appear in the response in     addition to the default ones.     Expanding resources can reduce the number of API calls required to accomplish a task.     However, use this with parsimony as some expanded fields can drastically increase payload size.
+         * @param {any} [filters] Filters the response by one or multiple fields.          Advanced filter functionality allows you to perform more complex filtering operations.          In general, fetching filtered responses conserves bandwidth and reduces response time.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listPartners(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: any): AxiosPromise<ListPartnersResponseClass> {
-            return localVarFp.listPartners(authorization, pageSize, pageToken, filter, search, order, expand, options).then((request) => request(axios, basePath));
+        listPartners(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: any): AxiosPromise<ListPartnersResponseClass> {
+            return localVarFp.listPartners(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Updates the specified partner by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+         * @summary Update the partner
+         * @param {string} code 
+         * @param {TagPartnerRequestDtoRest} tagPartnerRequestDtoRest 
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        tagPartner(code: string, tagPartnerRequestDtoRest: TagPartnerRequestDtoRest, authorization?: string, options?: any): AxiosPromise<GetPartnerResponseClass> {
+            return localVarFp.tagPartner(code, tagPartnerRequestDtoRest, authorization, options).then((request) => request(axios, basePath));
         },
         /**
          * Updates the specified partner by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
@@ -540,7 +625,7 @@ export interface PartnersApiListPartnersRequest {
     readonly authorization?: string
 
     /**
-     * A limit on the number of objects to be returned.     Limit ranges between 1 and 100. Default: 10.
+     * A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
      * @type {any}
      * @memberof PartnersApiListPartners
      */
@@ -561,7 +646,7 @@ export interface PartnersApiListPartnersRequest {
     readonly filter?: any
 
     /**
-     * Search the list by any field. For instance, if you want to search by code     add code&#x3D;xxx in order to fetch the result.
+     * To search the list by any field, pass search&#x3D;xxx to fetch the result.
      * @type {any}
      * @memberof PartnersApiListPartners
      */
@@ -580,6 +665,41 @@ export interface PartnersApiListPartnersRequest {
      * @memberof PartnersApiListPartners
      */
     readonly expand?: any
+
+    /**
+     * Filters the response by one or multiple fields.          Advanced filter functionality allows you to perform more complex filtering operations.          In general, fetching filtered responses conserves bandwidth and reduces response time.
+     * @type {any}
+     * @memberof PartnersApiListPartners
+     */
+    readonly filters?: any
+}
+
+/**
+ * Request parameters for tagPartner operation in PartnersApi.
+ * @export
+ * @interface PartnersApiTagPartnerRequest
+ */
+export interface PartnersApiTagPartnerRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof PartnersApiTagPartner
+     */
+    readonly code: string
+
+    /**
+     * 
+     * @type {TagPartnerRequestDtoRest}
+     * @memberof PartnersApiTagPartner
+     */
+    readonly tagPartnerRequestDtoRest: TagPartnerRequestDtoRest
+
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof PartnersApiTagPartner
+     */
+    readonly authorization?: string
 }
 
 /**
@@ -642,7 +762,7 @@ export class PartnersApi extends BaseAPI {
     }
 
     /**
-     * Retrieves the details of the partner that was previously created. Supply the unique partner code that was returned when you created it and Emil Api will return the corresponding partner information.
+     * Retrieves the details of the partner that was previously created. Supply the unique partner code        that was returned when you created it and Emil Api will return the corresponding partner information.
      * @summary Retrieve the partner
      * @param {PartnersApiGetPartnerRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -654,7 +774,7 @@ export class PartnersApi extends BaseAPI {
     }
 
     /**
-     * Returns a list of partners you have previously created. The partners are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * Returns a list of partners you have previously created.        The partners are returned in sorted order, with the oldest one appearing first.        For more information about pagination, read the Pagination documentation.
      * @summary List partners
      * @param {PartnersApiListPartnersRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -662,7 +782,19 @@ export class PartnersApi extends BaseAPI {
      * @memberof PartnersApi
      */
     public listPartners(requestParameters: PartnersApiListPartnersRequest = {}, options?: AxiosRequestConfig) {
-        return PartnersApiFp(this.configuration).listPartners(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
+        return PartnersApiFp(this.configuration).listPartners(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * Updates the specified partner by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the partner
+     * @param {PartnersApiTagPartnerRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PartnersApi
+     */
+    public tagPartner(requestParameters: PartnersApiTagPartnerRequest, options?: AxiosRequestConfig) {
+        return PartnersApiFp(this.configuration).tagPartner(requestParameters.code, requestParameters.tagPartnerRequestDtoRest, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
     }
 
     /**

package/api.ts

@@ -21,11 +21,17 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
 // @ts-ignore
 import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from './base';
 import { DefaultApi } from './api';
+import { PartnerRelationsApi } from './api';
+import { PartnerTagsApi } from './api';
 import { PartnerTypesApi } from './api';
+import { PartnerVersionApi } from './api';
 import { PartnersApi } from './api';
 
 
 export * from './api/default-api';
+export * from './api/partner-relations-api';
+export * from './api/partner-tags-api';
 export * from './api/partner-types-api';
+export * from './api/partner-version-api';
 export * from './api/partners-api';
 

package/base.ts

@@ -87,6 +87,7 @@ export class BaseAPI {
         if (configuration) {
             this.configuration = configuration;
             this.basePath = configuration.basePath || this.basePath;
+            this.configuration.accessToken = this.tokenData.accessToken ? `Bearer ${this.tokenData.accessToken}` : '';
         } else {
             const { accessToken, username } = this.tokenData;
 
@@ -101,7 +102,11 @@ export class BaseAPI {
     }
 
     selectEnvironment(env: Environment) {
-        this.configuration.basePath = env;
+        this.selectBasePath(env);
+    }
+
+    selectBasePath(path: string) {
+        this.configuration.basePath = path;
     }
 
     async authorize(username: string, password: string): Promise<void> {

package/dist/api/default-api.d.ts

@@ -19,7 +19,8 @@ import { InlineResponse200 } from '../models';
  */
 export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
-     *
+     * Returns the health status of the partner service.        This endpoint is used to monitor the operational status of the partner service.        It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
+     * @summary Health Check
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -31,7 +32,8 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
  */
 export declare const DefaultApiFp: (configuration?: Configuration) => {
     /**
-     *
+     * Returns the health status of the partner service.        This endpoint is used to monitor the operational status of the partner service.        It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
+     * @summary Health Check
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -43,7 +45,8 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
  */
 export declare const DefaultApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
-     *
+     * Returns the health status of the partner service.        This endpoint is used to monitor the operational status of the partner service.        It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
+     * @summary Health Check
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -57,7 +60,8 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
  */
 export declare class DefaultApi extends BaseAPI {
     /**
-     *
+     * Returns the health status of the partner service.        This endpoint is used to monitor the operational status of the partner service.        It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
+     * @summary Health Check
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof DefaultApi

package/dist/api/default-api.js

@@ -93,7 +93,8 @@ var DefaultApiAxiosParamCreator = function (configuration) {
     var _this = this;
     return {
         /**
-         *
+         * Returns the health status of the partner service.        This endpoint is used to monitor the operational status of the partner service.        It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
+         * @summary Health Check
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -132,7 +133,8 @@ var DefaultApiFp = function (configuration) {
     var localVarAxiosParamCreator = (0, exports.DefaultApiAxiosParamCreator)(configuration);
     return {
         /**
-         *
+         * Returns the health status of the partner service.        This endpoint is used to monitor the operational status of the partner service.        It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
+         * @summary Health Check
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -160,7 +162,8 @@ var DefaultApiFactory = function (configuration, basePath, axios) {
     var localVarFp = (0, exports.DefaultApiFp)(configuration);
     return {
         /**
-         *
+         * Returns the health status of the partner service.        This endpoint is used to monitor the operational status of the partner service.        It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
+         * @summary Health Check
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -182,7 +185,8 @@ var DefaultApi = /** @class */ (function (_super) {
         return _super !== null && _super.apply(this, arguments) || this;
     }
     /**
-     *
+     * Returns the health status of the partner service.        This endpoint is used to monitor the operational status of the partner service.        It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
+     * @summary Health Check
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof DefaultApi