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

package/dist/api/partner-relations-api.d.ts

@@ -0,0 +1,550 @@
+/**
+ * EMIL PartnerService
+ * The EMIL PartnerService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
+import { Configuration } from '../configuration';
+import { RequestArgs, BaseAPI } from '../base';
+import { CreatePartnerRelationRequestDtoRest } from '../models';
+import { CreatePartnerRelationResponseClass } from '../models';
+import { DeleteResponseClass } from '../models';
+import { GetPartnerRelationClass } from '../models';
+import { GetPartnerRelationTypeClass } from '../models';
+import { ListPartnerRelationClass } from '../models';
+import { ListPartnerRelationTypesClass } from '../models';
+import { UpdatePartnerRelationRequestDtoRest } from '../models';
+/**
+ * PartnerRelationsApi - axios parameter creator
+ * @export
+ */
+export declare const PartnerRelationsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * This will create a relationship between two partners. For example a parent-child relationship, or a partnership agreement.
+     * @summary Create the partner relation
+     * @param {CreatePartnerRelationRequestDtoRest} createPartnerRelationRequestDtoRest
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createPartnerRelation: (createPartnerRelationRequestDtoRest: CreatePartnerRelationRequestDtoRest, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Permanently deletes the partner-relation. Supply the unique code that was returned when you created the partner-relation and this will delete it.
+     * @summary Delete the partner-relation
+     * @param {number} id
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deletePartnerRelation: (id: number, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieve a single partner relation identified by its id
+     * @summary Retrieve the partner relation
+     * @param {number} id Id of the partner relation
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPartnerRelation: (id: number, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieve a single partner relation type identified with a slug - can be used to create partner relations
+     * @summary Retrieve the partner relation type
+     * @param {string} slug Identifying slug of the partner relation type
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPartnerRelationType: (slug: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * List all partner relation types - is used to create partner relations
+     * @summary List partner relation types
+     * @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 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 {string} [filter] Filter the response by one or multiple fields.            In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, slug, relationName, maxCardinality, inverseMaxCardinality&lt;/i&gt;
+     * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, slug, maxCardinality, inverseMaxCardinality, createdAt, updatedAt&lt;/i&gt;
+     * @param {string} [expand] Expand to fetch additional information about the list items.           Expanding resources can reduce the number of API calls required to accomplish a task.           Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: .&lt;i&gt;
+     * @param {string} [filters] Filters the response by one or multiple fields.            Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, slug, relationName, maxCardinality, inverseMaxCardinality&lt;/i&gt;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listPartnerRelationTypes: (authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * List all partner relations
+     * @summary List partner relations
+     * @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 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 {string} [filter] Filter the response by one or multiple fields.            In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId&lt;/i&gt;
+     * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, partnerRelationTypeId, startDate, endDate, createdAt, updatedAt&lt;/i&gt;
+     * @param {string} [expand] Expand to fetch additional information about the list items.           Expanding resources can reduce the number of API calls required to accomplish a task.           Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: partnerRelationType.&lt;i&gt;
+     * @param {string} [filters] Filters the response by one or multiple fields.            Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId&lt;/i&gt;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listPartnerRelations: (authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Update a partner relation identified by its id
+     * @summary Update the partner relation
+     * @param {number} id Id of the partner relation
+     * @param {UpdatePartnerRelationRequestDtoRest} updatePartnerRelationRequestDtoRest
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updatePartnerRelation: (id: number, updatePartnerRelationRequestDtoRest: UpdatePartnerRelationRequestDtoRest, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * PartnerRelationsApi - functional programming interface
+ * @export
+ */
+export declare const PartnerRelationsApiFp: (configuration?: Configuration) => {
+    /**
+     * This will create a relationship between two partners. For example a parent-child relationship, or a partnership agreement.
+     * @summary Create the partner relation
+     * @param {CreatePartnerRelationRequestDtoRest} createPartnerRelationRequestDtoRest
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createPartnerRelation(createPartnerRelationRequestDtoRest: CreatePartnerRelationRequestDtoRest, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePartnerRelationResponseClass>>;
+    /**
+     * Permanently deletes the partner-relation. Supply the unique code that was returned when you created the partner-relation and this will delete it.
+     * @summary Delete the partner-relation
+     * @param {number} id
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deletePartnerRelation(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponseClass>>;
+    /**
+     * Retrieve a single partner relation identified by its id
+     * @summary Retrieve the partner relation
+     * @param {number} id Id of the partner relation
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPartnerRelation(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPartnerRelationClass>>;
+    /**
+     * Retrieve a single partner relation type identified with a slug - can be used to create partner relations
+     * @summary Retrieve the partner relation type
+     * @param {string} slug Identifying slug of the partner relation type
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPartnerRelationType(slug: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPartnerRelationTypeClass>>;
+    /**
+     * List all partner relation types - is used to create partner relations
+     * @summary List partner relation types
+     * @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 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 {string} [filter] Filter the response by one or multiple fields.            In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, slug, relationName, maxCardinality, inverseMaxCardinality&lt;/i&gt;
+     * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, slug, maxCardinality, inverseMaxCardinality, createdAt, updatedAt&lt;/i&gt;
+     * @param {string} [expand] Expand to fetch additional information about the list items.           Expanding resources can reduce the number of API calls required to accomplish a task.           Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: .&lt;i&gt;
+     * @param {string} [filters] Filters the response by one or multiple fields.            Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, slug, relationName, maxCardinality, inverseMaxCardinality&lt;/i&gt;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listPartnerRelationTypes(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPartnerRelationTypesClass>>;
+    /**
+     * List all partner relations
+     * @summary List partner relations
+     * @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 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 {string} [filter] Filter the response by one or multiple fields.            In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId&lt;/i&gt;
+     * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, partnerRelationTypeId, startDate, endDate, createdAt, updatedAt&lt;/i&gt;
+     * @param {string} [expand] Expand to fetch additional information about the list items.           Expanding resources can reduce the number of API calls required to accomplish a task.           Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: partnerRelationType.&lt;i&gt;
+     * @param {string} [filters] Filters the response by one or multiple fields.            Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId&lt;/i&gt;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listPartnerRelations(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPartnerRelationClass>>;
+    /**
+     * Update a partner relation identified by its id
+     * @summary Update the partner relation
+     * @param {number} id Id of the partner relation
+     * @param {UpdatePartnerRelationRequestDtoRest} updatePartnerRelationRequestDtoRest
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updatePartnerRelation(id: number, updatePartnerRelationRequestDtoRest: UpdatePartnerRelationRequestDtoRest, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPartnerRelationClass>>;
+};
+/**
+ * PartnerRelationsApi - factory interface
+ * @export
+ */
+export declare const PartnerRelationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * This will create a relationship between two partners. For example a parent-child relationship, or a partnership agreement.
+     * @summary Create the partner relation
+     * @param {CreatePartnerRelationRequestDtoRest} createPartnerRelationRequestDtoRest
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createPartnerRelation(createPartnerRelationRequestDtoRest: CreatePartnerRelationRequestDtoRest, authorization?: string, options?: any): AxiosPromise<CreatePartnerRelationResponseClass>;
+    /**
+     * Permanently deletes the partner-relation. Supply the unique code that was returned when you created the partner-relation and this will delete it.
+     * @summary Delete the partner-relation
+     * @param {number} id
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deletePartnerRelation(id: number, authorization?: string, options?: any): AxiosPromise<DeleteResponseClass>;
+    /**
+     * Retrieve a single partner relation identified by its id
+     * @summary Retrieve the partner relation
+     * @param {number} id Id of the partner relation
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPartnerRelation(id: number, authorization?: string, options?: any): AxiosPromise<GetPartnerRelationClass>;
+    /**
+     * Retrieve a single partner relation type identified with a slug - can be used to create partner relations
+     * @summary Retrieve the partner relation type
+     * @param {string} slug Identifying slug of the partner relation type
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPartnerRelationType(slug: string, authorization?: string, options?: any): AxiosPromise<GetPartnerRelationTypeClass>;
+    /**
+     * List all partner relation types - is used to create partner relations
+     * @summary List partner relation types
+     * @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 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 {string} [filter] Filter the response by one or multiple fields.            In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, slug, relationName, maxCardinality, inverseMaxCardinality&lt;/i&gt;
+     * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, slug, maxCardinality, inverseMaxCardinality, createdAt, updatedAt&lt;/i&gt;
+     * @param {string} [expand] Expand to fetch additional information about the list items.           Expanding resources can reduce the number of API calls required to accomplish a task.           Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: .&lt;i&gt;
+     * @param {string} [filters] Filters the response by one or multiple fields.            Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, slug, relationName, maxCardinality, inverseMaxCardinality&lt;/i&gt;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listPartnerRelationTypes(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPartnerRelationTypesClass>;
+    /**
+     * List all partner relations
+     * @summary List partner relations
+     * @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 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 {string} [filter] Filter the response by one or multiple fields.            In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId&lt;/i&gt;
+     * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, partnerRelationTypeId, startDate, endDate, createdAt, updatedAt&lt;/i&gt;
+     * @param {string} [expand] Expand to fetch additional information about the list items.           Expanding resources can reduce the number of API calls required to accomplish a task.           Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: partnerRelationType.&lt;i&gt;
+     * @param {string} [filters] Filters the response by one or multiple fields.            Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId&lt;/i&gt;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listPartnerRelations(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPartnerRelationClass>;
+    /**
+     * Update a partner relation identified by its id
+     * @summary Update the partner relation
+     * @param {number} id Id of the partner relation
+     * @param {UpdatePartnerRelationRequestDtoRest} updatePartnerRelationRequestDtoRest
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updatePartnerRelation(id: number, updatePartnerRelationRequestDtoRest: UpdatePartnerRelationRequestDtoRest, authorization?: string, options?: any): AxiosPromise<GetPartnerRelationClass>;
+};
+/**
+ * Request parameters for createPartnerRelation operation in PartnerRelationsApi.
+ * @export
+ * @interface PartnerRelationsApiCreatePartnerRelationRequest
+ */
+export interface PartnerRelationsApiCreatePartnerRelationRequest {
+    /**
+     *
+     * @type {CreatePartnerRelationRequestDtoRest}
+     * @memberof PartnerRelationsApiCreatePartnerRelation
+     */
+    readonly createPartnerRelationRequestDtoRest: CreatePartnerRelationRequestDtoRest;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof PartnerRelationsApiCreatePartnerRelation
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for deletePartnerRelation operation in PartnerRelationsApi.
+ * @export
+ * @interface PartnerRelationsApiDeletePartnerRelationRequest
+ */
+export interface PartnerRelationsApiDeletePartnerRelationRequest {
+    /**
+     *
+     * @type {number}
+     * @memberof PartnerRelationsApiDeletePartnerRelation
+     */
+    readonly id: number;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof PartnerRelationsApiDeletePartnerRelation
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for getPartnerRelation operation in PartnerRelationsApi.
+ * @export
+ * @interface PartnerRelationsApiGetPartnerRelationRequest
+ */
+export interface PartnerRelationsApiGetPartnerRelationRequest {
+    /**
+     * Id of the partner relation
+     * @type {number}
+     * @memberof PartnerRelationsApiGetPartnerRelation
+     */
+    readonly id: number;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof PartnerRelationsApiGetPartnerRelation
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for getPartnerRelationType operation in PartnerRelationsApi.
+ * @export
+ * @interface PartnerRelationsApiGetPartnerRelationTypeRequest
+ */
+export interface PartnerRelationsApiGetPartnerRelationTypeRequest {
+    /**
+     * Identifying slug of the partner relation type
+     * @type {string}
+     * @memberof PartnerRelationsApiGetPartnerRelationType
+     */
+    readonly slug: string;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof PartnerRelationsApiGetPartnerRelationType
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for listPartnerRelationTypes operation in PartnerRelationsApi.
+ * @export
+ * @interface PartnerRelationsApiListPartnerRelationTypesRequest
+ */
+export interface PartnerRelationsApiListPartnerRelationTypesRequest {
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof PartnerRelationsApiListPartnerRelationTypes
+     */
+    readonly authorization?: string;
+    /**
+     * A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @type {any}
+     * @memberof PartnerRelationsApiListPartnerRelationTypes
+     */
+    readonly pageSize?: any;
+    /**
+     * 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.
+     * @type {any}
+     * @memberof PartnerRelationsApiListPartnerRelationTypes
+     */
+    readonly pageToken?: any;
+    /**
+     * Filter the response by one or multiple fields.            In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, slug, relationName, maxCardinality, inverseMaxCardinality&lt;/i&gt;
+     * @type {string}
+     * @memberof PartnerRelationsApiListPartnerRelationTypes
+     */
+    readonly filter?: string;
+    /**
+     * To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @type {any}
+     * @memberof PartnerRelationsApiListPartnerRelationTypes
+     */
+    readonly search?: any;
+    /**
+     * Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, slug, maxCardinality, inverseMaxCardinality, createdAt, updatedAt&lt;/i&gt;
+     * @type {string}
+     * @memberof PartnerRelationsApiListPartnerRelationTypes
+     */
+    readonly order?: string;
+    /**
+     * Expand to fetch additional information about the list items.           Expanding resources can reduce the number of API calls required to accomplish a task.           Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: .&lt;i&gt;
+     * @type {string}
+     * @memberof PartnerRelationsApiListPartnerRelationTypes
+     */
+    readonly expand?: string;
+    /**
+     * Filters the response by one or multiple fields.            Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, slug, relationName, maxCardinality, inverseMaxCardinality&lt;/i&gt;
+     * @type {string}
+     * @memberof PartnerRelationsApiListPartnerRelationTypes
+     */
+    readonly filters?: string;
+}
+/**
+ * Request parameters for listPartnerRelations operation in PartnerRelationsApi.
+ * @export
+ * @interface PartnerRelationsApiListPartnerRelationsRequest
+ */
+export interface PartnerRelationsApiListPartnerRelationsRequest {
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof PartnerRelationsApiListPartnerRelations
+     */
+    readonly authorization?: string;
+    /**
+     * A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @type {any}
+     * @memberof PartnerRelationsApiListPartnerRelations
+     */
+    readonly pageSize?: any;
+    /**
+     * 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.
+     * @type {any}
+     * @memberof PartnerRelationsApiListPartnerRelations
+     */
+    readonly pageToken?: any;
+    /**
+     * Filter the response by one or multiple fields.            In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId&lt;/i&gt;
+     * @type {string}
+     * @memberof PartnerRelationsApiListPartnerRelations
+     */
+    readonly filter?: string;
+    /**
+     * To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @type {any}
+     * @memberof PartnerRelationsApiListPartnerRelations
+     */
+    readonly search?: any;
+    /**
+     * Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, partnerRelationTypeId, startDate, endDate, createdAt, updatedAt&lt;/i&gt;
+     * @type {string}
+     * @memberof PartnerRelationsApiListPartnerRelations
+     */
+    readonly order?: string;
+    /**
+     * Expand to fetch additional information about the list items.           Expanding resources can reduce the number of API calls required to accomplish a task.           Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: partnerRelationType.&lt;i&gt;
+     * @type {string}
+     * @memberof PartnerRelationsApiListPartnerRelations
+     */
+    readonly expand?: string;
+    /**
+     * Filters the response by one or multiple fields.            Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, partner1Id, partner2Id, partnerRelationTypeSlug, partnerRelationTypeId&lt;/i&gt;
+     * @type {string}
+     * @memberof PartnerRelationsApiListPartnerRelations
+     */
+    readonly filters?: string;
+}
+/**
+ * Request parameters for updatePartnerRelation operation in PartnerRelationsApi.
+ * @export
+ * @interface PartnerRelationsApiUpdatePartnerRelationRequest
+ */
+export interface PartnerRelationsApiUpdatePartnerRelationRequest {
+    /**
+     * Id of the partner relation
+     * @type {number}
+     * @memberof PartnerRelationsApiUpdatePartnerRelation
+     */
+    readonly id: number;
+    /**
+     *
+     * @type {UpdatePartnerRelationRequestDtoRest}
+     * @memberof PartnerRelationsApiUpdatePartnerRelation
+     */
+    readonly updatePartnerRelationRequestDtoRest: UpdatePartnerRelationRequestDtoRest;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof PartnerRelationsApiUpdatePartnerRelation
+     */
+    readonly authorization?: string;
+}
+/**
+ * PartnerRelationsApi - object-oriented interface
+ * @export
+ * @class PartnerRelationsApi
+ * @extends {BaseAPI}
+ */
+export declare class PartnerRelationsApi extends BaseAPI {
+    /**
+     * This will create a relationship between two partners. For example a parent-child relationship, or a partnership agreement.
+     * @summary Create the partner relation
+     * @param {PartnerRelationsApiCreatePartnerRelationRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PartnerRelationsApi
+     */
+    createPartnerRelation(requestParameters: PartnerRelationsApiCreatePartnerRelationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePartnerRelationResponseClass, any>>;
+    /**
+     * Permanently deletes the partner-relation. Supply the unique code that was returned when you created the partner-relation and this will delete it.
+     * @summary Delete the partner-relation
+     * @param {PartnerRelationsApiDeletePartnerRelationRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PartnerRelationsApi
+     */
+    deletePartnerRelation(requestParameters: PartnerRelationsApiDeletePartnerRelationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteResponseClass, any>>;
+    /**
+     * Retrieve a single partner relation identified by its id
+     * @summary Retrieve the partner relation
+     * @param {PartnerRelationsApiGetPartnerRelationRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PartnerRelationsApi
+     */
+    getPartnerRelation(requestParameters: PartnerRelationsApiGetPartnerRelationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPartnerRelationClass, any>>;
+    /**
+     * Retrieve a single partner relation type identified with a slug - can be used to create partner relations
+     * @summary Retrieve the partner relation type
+     * @param {PartnerRelationsApiGetPartnerRelationTypeRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PartnerRelationsApi
+     */
+    getPartnerRelationType(requestParameters: PartnerRelationsApiGetPartnerRelationTypeRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPartnerRelationTypeClass, any>>;
+    /**
+     * List all partner relation types - is used to create partner relations
+     * @summary List partner relation types
+     * @param {PartnerRelationsApiListPartnerRelationTypesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PartnerRelationsApi
+     */
+    listPartnerRelationTypes(requestParameters?: PartnerRelationsApiListPartnerRelationTypesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPartnerRelationTypesClass, any>>;
+    /**
+     * List all partner relations
+     * @summary List partner relations
+     * @param {PartnerRelationsApiListPartnerRelationsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PartnerRelationsApi
+     */
+    listPartnerRelations(requestParameters?: PartnerRelationsApiListPartnerRelationsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPartnerRelationClass, any>>;
+    /**
+     * Update a partner relation identified by its id
+     * @summary Update the partner relation
+     * @param {PartnerRelationsApiUpdatePartnerRelationRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PartnerRelationsApi
+     */
+    updatePartnerRelation(requestParameters: PartnerRelationsApiUpdatePartnerRelationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPartnerRelationClass, any>>;
+}