@emilgroup/partner-sdk 1.13.1-beta.2 → 1.14.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
17
17
  Navigate to the folder of your consuming project and run one of the following commands:
18
18
 
19
19
  ```
20
- npm install @emilgroup/partner-sdk@1.13.1-beta.2 --save
20
+ npm install @emilgroup/partner-sdk@1.14.0 --save
21
21
  ```
22
22
  or
23
23
  ```
24
- yarn add @emilgroup/partner-sdk@1.13.1-beta.2
24
+ yarn add @emilgroup/partner-sdk@1.14.0
25
25
  ```
26
26
 
27
27
  And then you can import `PartnersApi`.
@@ -31,7 +31,7 @@ import { InvitePartnerToEisResponseClass } from '../models';
31
31
  export const PartnerInvitationsApiAxiosParamCreator = function (configuration?: Configuration) {
32
32
  return {
33
33
  /**
34
- * Invites a partner to EIS Platform - partner must have one of vermittler,intermediary to be eligible for invitation.
34
+ * Invites a partner to EIS Platform - partner must have one of vermittler,intermediary to be eligible for invitation. **Required Permissions** \"partner-management.partners.create\"
35
35
  * @summary Create the Partner Invitation
36
36
  * @param {InvitePartnerToEISRequestDto} invitePartnerToEISRequestDto
37
37
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -88,7 +88,7 @@ export const PartnerInvitationsApiFp = function(configuration?: Configuration) {
88
88
  const localVarAxiosParamCreator = PartnerInvitationsApiAxiosParamCreator(configuration)
89
89
  return {
90
90
  /**
91
- * Invites a partner to EIS Platform - partner must have one of vermittler,intermediary to be eligible for invitation.
91
+ * Invites a partner to EIS Platform - partner must have one of vermittler,intermediary to be eligible for invitation. **Required Permissions** \"partner-management.partners.create\"
92
92
  * @summary Create the Partner Invitation
93
93
  * @param {InvitePartnerToEISRequestDto} invitePartnerToEISRequestDto
94
94
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -110,7 +110,7 @@ export const PartnerInvitationsApiFactory = function (configuration?: Configurat
110
110
  const localVarFp = PartnerInvitationsApiFp(configuration)
111
111
  return {
112
112
  /**
113
- * Invites a partner to EIS Platform - partner must have one of vermittler,intermediary to be eligible for invitation.
113
+ * Invites a partner to EIS Platform - partner must have one of vermittler,intermediary to be eligible for invitation. **Required Permissions** \"partner-management.partners.create\"
114
114
  * @summary Create the Partner Invitation
115
115
  * @param {InvitePartnerToEISRequestDto} invitePartnerToEISRequestDto
116
116
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -152,7 +152,7 @@ export interface PartnerInvitationsApiInvitePartnerToEISRequest {
152
152
  */
153
153
  export class PartnerInvitationsApi extends BaseAPI {
154
154
  /**
155
- * Invites a partner to EIS Platform - partner must have one of vermittler,intermediary to be eligible for invitation.
155
+ * Invites a partner to EIS Platform - partner must have one of vermittler,intermediary to be eligible for invitation. **Required Permissions** \"partner-management.partners.create\"
156
156
  * @summary Create the Partner Invitation
157
157
  * @param {PartnerInvitationsApiInvitePartnerToEISRequest} requestParameters Request parameters.
158
158
  * @param {*} [options] Override http request option.
@@ -43,7 +43,7 @@ import { UpdatePartnerRelationRequestDtoRest } from '../models';
43
43
  export const PartnerRelationsApiAxiosParamCreator = function (configuration?: Configuration) {
44
44
  return {
45
45
  /**
46
- * This will create a relationship between two partners. For example a parent-child relationship, or a partnership agreement.
46
+ * This will create a relationship between two partners. For example a parent-child relationship, or a partnership agreement. **Required Permissions** \"partner-management.partners.create\"
47
47
  * @summary Create the partner relation
48
48
  * @param {CreatePartnerRelationRequestDtoRest} createPartnerRelationRequestDtoRest
49
49
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -90,7 +90,7 @@ export const PartnerRelationsApiAxiosParamCreator = function (configuration?: Co
90
90
  };
91
91
  },
92
92
  /**
93
- * Permanently deletes the partner-relation. Supply the unique code that was returned when you created the partner-relation and this will delete it.
93
+ * Permanently deletes the partner-relation. Supply the unique code that was returned when you created the partner-relation and this will delete it. **Required Permissions** \"partner-management.partners.delete\"
94
94
  * @summary Delete the partner-relation
95
95
  * @param {number} id
96
96
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -135,7 +135,7 @@ export const PartnerRelationsApiAxiosParamCreator = function (configuration?: Co
135
135
  };
136
136
  },
137
137
  /**
138
- * Retrieve a single partner relation identified by its id
138
+ * Retrieve a single partner relation identified by its id **Required Permissions** \"partner-management.partners.view\"
139
139
  * @summary Retrieve the partner relation
140
140
  * @param {number} id Id of the partner relation
141
141
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -180,7 +180,7 @@ export const PartnerRelationsApiAxiosParamCreator = function (configuration?: Co
180
180
  };
181
181
  },
182
182
  /**
183
- * Retrieve a single partner relation type identified with a slug - can be used to create partner relations
183
+ * Retrieve a single partner relation type identified with a slug - can be used to create partner relations **Required Permissions** \"partner-management.partners.view\"
184
184
  * @summary Retrieve the partner relation type
185
185
  * @param {string} slug Identifying slug of the partner relation type
186
186
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -225,20 +225,20 @@ export const PartnerRelationsApiAxiosParamCreator = function (configuration?: Co
225
225
  };
226
226
  },
227
227
  /**
228
- * List all partner relation types - is used to create partner relations
228
+ * List all partner relation types - is used to create partner relations **Required Permissions** \"partner-management.partners.view\"
229
229
  * @summary List partner relation types
230
230
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
231
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
232
- * @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.
231
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
232
+ * @param {string} [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.
233
233
  * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, slug, relationName, maxCardinality, inverseMaxCardinality, partnerName</i>
234
- * @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
234
+ * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
235
235
  * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, slug, maxCardinality, inverseMaxCardinality, createdAt, updatedAt</i>
236
236
  * @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.<br/> <br/>
237
237
  * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, slug, relationName, maxCardinality, inverseMaxCardinality, partnerName</i>
238
238
  * @param {*} [options] Override http request option.
239
239
  * @throws {RequiredError}
240
240
  */
241
- listPartnerRelationTypes: async (authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
241
+ listPartnerRelationTypes: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
242
242
  const localVarPath = `/partnerservice/v1/partners/relations/types`;
243
243
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
244
244
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -301,20 +301,20 @@ export const PartnerRelationsApiAxiosParamCreator = function (configuration?: Co
301
301
  };
302
302
  },
303
303
  /**
304
- * List all partner relations
304
+ * List all partner relations **Required Permissions** \"partner-management.partners.view\"
305
305
  * @summary List partner relations
306
306
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
307
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
308
- * @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.
307
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
308
+ * @param {string} [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.
309
309
  * @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;
310
- * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
310
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
311
311
  * @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;
312
312
  * @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: partner1, partner2, partnerRelationType&lt;i&gt;
313
313
  * @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;
314
314
  * @param {*} [options] Override http request option.
315
315
  * @throws {RequiredError}
316
316
  */
317
- listPartnerRelations: async (authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
317
+ listPartnerRelations: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
318
318
  const localVarPath = `/partnerservice/v1/partners/relations`;
319
319
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
320
320
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -377,7 +377,7 @@ export const PartnerRelationsApiAxiosParamCreator = function (configuration?: Co
377
377
  };
378
378
  },
379
379
  /**
380
- * Update a partner relation identified by its id
380
+ * Update a partner relation identified by its id **Required Permissions** \"partner-management.partners.update\"
381
381
  * @summary Update the partner relation
382
382
  * @param {number} id Id of the partner relation
383
383
  * @param {UpdatePartnerRelationRequestDtoRest} updatePartnerRelationRequestDtoRest
@@ -438,7 +438,7 @@ export const PartnerRelationsApiFp = function(configuration?: Configuration) {
438
438
  const localVarAxiosParamCreator = PartnerRelationsApiAxiosParamCreator(configuration)
439
439
  return {
440
440
  /**
441
- * This will create a relationship between two partners. For example a parent-child relationship, or a partnership agreement.
441
+ * This will create a relationship between two partners. For example a parent-child relationship, or a partnership agreement. **Required Permissions** \"partner-management.partners.create\"
442
442
  * @summary Create the partner relation
443
443
  * @param {CreatePartnerRelationRequestDtoRest} createPartnerRelationRequestDtoRest
444
444
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -450,7 +450,7 @@ export const PartnerRelationsApiFp = function(configuration?: Configuration) {
450
450
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
451
451
  },
452
452
  /**
453
- * Permanently deletes the partner-relation. Supply the unique code that was returned when you created the partner-relation and this will delete it.
453
+ * Permanently deletes the partner-relation. Supply the unique code that was returned when you created the partner-relation and this will delete it. **Required Permissions** \"partner-management.partners.delete\"
454
454
  * @summary Delete the partner-relation
455
455
  * @param {number} id
456
456
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -462,7 +462,7 @@ export const PartnerRelationsApiFp = function(configuration?: Configuration) {
462
462
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
463
463
  },
464
464
  /**
465
- * Retrieve a single partner relation identified by its id
465
+ * Retrieve a single partner relation identified by its id **Required Permissions** \"partner-management.partners.view\"
466
466
  * @summary Retrieve the partner relation
467
467
  * @param {number} id Id of the partner relation
468
468
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -474,7 +474,7 @@ export const PartnerRelationsApiFp = function(configuration?: Configuration) {
474
474
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
475
475
  },
476
476
  /**
477
- * Retrieve a single partner relation type identified with a slug - can be used to create partner relations
477
+ * Retrieve a single partner relation type identified with a slug - can be used to create partner relations **Required Permissions** \"partner-management.partners.view\"
478
478
  * @summary Retrieve the partner relation type
479
479
  * @param {string} slug Identifying slug of the partner relation type
480
480
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -486,43 +486,43 @@ export const PartnerRelationsApiFp = function(configuration?: Configuration) {
486
486
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
487
487
  },
488
488
  /**
489
- * List all partner relation types - is used to create partner relations
489
+ * List all partner relation types - is used to create partner relations **Required Permissions** \"partner-management.partners.view\"
490
490
  * @summary List partner relation types
491
491
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
492
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
493
- * @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.
492
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
493
+ * @param {string} [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.
494
494
  * @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, partnerName&lt;/i&gt;
495
- * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
495
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
496
496
  * @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;
497
497
  * @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;
498
498
  * @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, partnerName&lt;/i&gt;
499
499
  * @param {*} [options] Override http request option.
500
500
  * @throws {RequiredError}
501
501
  */
502
- async 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>> {
502
+ async listPartnerRelationTypes(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPartnerRelationTypesClass>> {
503
503
  const localVarAxiosArgs = await localVarAxiosParamCreator.listPartnerRelationTypes(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
504
504
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
505
505
  },
506
506
  /**
507
- * List all partner relations
507
+ * List all partner relations **Required Permissions** \"partner-management.partners.view\"
508
508
  * @summary List partner relations
509
509
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
510
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
511
- * @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.
510
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
511
+ * @param {string} [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.
512
512
  * @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;
513
- * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
513
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
514
514
  * @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;
515
515
  * @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: partner1, partner2, partnerRelationType&lt;i&gt;
516
516
  * @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;
517
517
  * @param {*} [options] Override http request option.
518
518
  * @throws {RequiredError}
519
519
  */
520
- async 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>> {
520
+ async listPartnerRelations(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPartnerRelationClass>> {
521
521
  const localVarAxiosArgs = await localVarAxiosParamCreator.listPartnerRelations(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
522
522
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
523
523
  },
524
524
  /**
525
- * Update a partner relation identified by its id
525
+ * Update a partner relation identified by its id **Required Permissions** \"partner-management.partners.update\"
526
526
  * @summary Update the partner relation
527
527
  * @param {number} id Id of the partner relation
528
528
  * @param {UpdatePartnerRelationRequestDtoRest} updatePartnerRelationRequestDtoRest
@@ -545,7 +545,7 @@ export const PartnerRelationsApiFactory = function (configuration?: Configuratio
545
545
  const localVarFp = PartnerRelationsApiFp(configuration)
546
546
  return {
547
547
  /**
548
- * This will create a relationship between two partners. For example a parent-child relationship, or a partnership agreement.
548
+ * This will create a relationship between two partners. For example a parent-child relationship, or a partnership agreement. **Required Permissions** \"partner-management.partners.create\"
549
549
  * @summary Create the partner relation
550
550
  * @param {CreatePartnerRelationRequestDtoRest} createPartnerRelationRequestDtoRest
551
551
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -556,7 +556,7 @@ export const PartnerRelationsApiFactory = function (configuration?: Configuratio
556
556
  return localVarFp.createPartnerRelation(createPartnerRelationRequestDtoRest, authorization, options).then((request) => request(axios, basePath));
557
557
  },
558
558
  /**
559
- * Permanently deletes the partner-relation. Supply the unique code that was returned when you created the partner-relation and this will delete it.
559
+ * Permanently deletes the partner-relation. Supply the unique code that was returned when you created the partner-relation and this will delete it. **Required Permissions** \"partner-management.partners.delete\"
560
560
  * @summary Delete the partner-relation
561
561
  * @param {number} id
562
562
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -567,7 +567,7 @@ export const PartnerRelationsApiFactory = function (configuration?: Configuratio
567
567
  return localVarFp.deletePartnerRelation(id, authorization, options).then((request) => request(axios, basePath));
568
568
  },
569
569
  /**
570
- * Retrieve a single partner relation identified by its id
570
+ * Retrieve a single partner relation identified by its id **Required Permissions** \"partner-management.partners.view\"
571
571
  * @summary Retrieve the partner relation
572
572
  * @param {number} id Id of the partner relation
573
573
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -578,7 +578,7 @@ export const PartnerRelationsApiFactory = function (configuration?: Configuratio
578
578
  return localVarFp.getPartnerRelation(id, authorization, options).then((request) => request(axios, basePath));
579
579
  },
580
580
  /**
581
- * Retrieve a single partner relation type identified with a slug - can be used to create partner relations
581
+ * Retrieve a single partner relation type identified with a slug - can be used to create partner relations **Required Permissions** \"partner-management.partners.view\"
582
582
  * @summary Retrieve the partner relation type
583
583
  * @param {string} slug Identifying slug of the partner relation type
584
584
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -589,41 +589,41 @@ export const PartnerRelationsApiFactory = function (configuration?: Configuratio
589
589
  return localVarFp.getPartnerRelationType(slug, authorization, options).then((request) => request(axios, basePath));
590
590
  },
591
591
  /**
592
- * List all partner relation types - is used to create partner relations
592
+ * List all partner relation types - is used to create partner relations **Required Permissions** \"partner-management.partners.view\"
593
593
  * @summary List partner relation types
594
594
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
595
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
596
- * @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.
595
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
596
+ * @param {string} [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.
597
597
  * @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, partnerName&lt;/i&gt;
598
- * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
598
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
599
599
  * @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;
600
600
  * @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;
601
601
  * @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, partnerName&lt;/i&gt;
602
602
  * @param {*} [options] Override http request option.
603
603
  * @throws {RequiredError}
604
604
  */
605
- listPartnerRelationTypes(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPartnerRelationTypesClass> {
605
+ listPartnerRelationTypes(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPartnerRelationTypesClass> {
606
606
  return localVarFp.listPartnerRelationTypes(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
607
607
  },
608
608
  /**
609
- * List all partner relations
609
+ * List all partner relations **Required Permissions** \"partner-management.partners.view\"
610
610
  * @summary List partner relations
611
611
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
612
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
613
- * @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.
612
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
613
+ * @param {string} [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.
614
614
  * @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;
615
- * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
615
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
616
616
  * @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;
617
617
  * @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: partner1, partner2, partnerRelationType&lt;i&gt;
618
618
  * @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;
619
619
  * @param {*} [options] Override http request option.
620
620
  * @throws {RequiredError}
621
621
  */
622
- listPartnerRelations(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPartnerRelationClass> {
622
+ listPartnerRelations(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPartnerRelationClass> {
623
623
  return localVarFp.listPartnerRelations(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
624
624
  },
625
625
  /**
626
- * Update a partner relation identified by its id
626
+ * Update a partner relation identified by its id **Required Permissions** \"partner-management.partners.update\"
627
627
  * @summary Update the partner relation
628
628
  * @param {number} id Id of the partner relation
629
629
  * @param {UpdatePartnerRelationRequestDtoRest} updatePartnerRelationRequestDtoRest
@@ -736,17 +736,17 @@ export interface PartnerRelationsApiListPartnerRelationTypesRequest {
736
736
 
737
737
  /**
738
738
  * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
739
- * @type {any}
739
+ * @type {number}
740
740
  * @memberof PartnerRelationsApiListPartnerRelationTypes
741
741
  */
742
- readonly pageSize?: any
742
+ readonly pageSize?: number
743
743
 
744
744
  /**
745
- * 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.
746
- * @type {any}
745
+ * 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.
746
+ * @type {string}
747
747
  * @memberof PartnerRelationsApiListPartnerRelationTypes
748
748
  */
749
- readonly pageToken?: any
749
+ readonly pageToken?: string
750
750
 
751
751
  /**
752
752
  * 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, partnerName&lt;/i&gt;
@@ -757,10 +757,10 @@ export interface PartnerRelationsApiListPartnerRelationTypesRequest {
757
757
 
758
758
  /**
759
759
  * To search the list by any field, pass search&#x3D;xxx to fetch the result.
760
- * @type {any}
760
+ * @type {string}
761
761
  * @memberof PartnerRelationsApiListPartnerRelationTypes
762
762
  */
763
- readonly search?: any
763
+ readonly search?: string
764
764
 
765
765
  /**
766
766
  * 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;
@@ -799,17 +799,17 @@ export interface PartnerRelationsApiListPartnerRelationsRequest {
799
799
 
800
800
  /**
801
801
  * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
802
- * @type {any}
802
+ * @type {number}
803
803
  * @memberof PartnerRelationsApiListPartnerRelations
804
804
  */
805
- readonly pageSize?: any
805
+ readonly pageSize?: number
806
806
 
807
807
  /**
808
- * 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.
809
- * @type {any}
808
+ * 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.
809
+ * @type {string}
810
810
  * @memberof PartnerRelationsApiListPartnerRelations
811
811
  */
812
- readonly pageToken?: any
812
+ readonly pageToken?: string
813
813
 
814
814
  /**
815
815
  * 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;
@@ -820,10 +820,10 @@ export interface PartnerRelationsApiListPartnerRelationsRequest {
820
820
 
821
821
  /**
822
822
  * To search the list by any field, pass search&#x3D;xxx to fetch the result.
823
- * @type {any}
823
+ * @type {string}
824
824
  * @memberof PartnerRelationsApiListPartnerRelations
825
825
  */
826
- readonly search?: any
826
+ readonly search?: string
827
827
 
828
828
  /**
829
829
  * 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;
@@ -883,7 +883,7 @@ export interface PartnerRelationsApiUpdatePartnerRelationRequest {
883
883
  */
884
884
  export class PartnerRelationsApi extends BaseAPI {
885
885
  /**
886
- * This will create a relationship between two partners. For example a parent-child relationship, or a partnership agreement.
886
+ * This will create a relationship between two partners. For example a parent-child relationship, or a partnership agreement. **Required Permissions** \"partner-management.partners.create\"
887
887
  * @summary Create the partner relation
888
888
  * @param {PartnerRelationsApiCreatePartnerRelationRequest} requestParameters Request parameters.
889
889
  * @param {*} [options] Override http request option.
@@ -895,7 +895,7 @@ export class PartnerRelationsApi extends BaseAPI {
895
895
  }
896
896
 
897
897
  /**
898
- * Permanently deletes the partner-relation. Supply the unique code that was returned when you created the partner-relation and this will delete it.
898
+ * Permanently deletes the partner-relation. Supply the unique code that was returned when you created the partner-relation and this will delete it. **Required Permissions** \"partner-management.partners.delete\"
899
899
  * @summary Delete the partner-relation
900
900
  * @param {PartnerRelationsApiDeletePartnerRelationRequest} requestParameters Request parameters.
901
901
  * @param {*} [options] Override http request option.
@@ -907,7 +907,7 @@ export class PartnerRelationsApi extends BaseAPI {
907
907
  }
908
908
 
909
909
  /**
910
- * Retrieve a single partner relation identified by its id
910
+ * Retrieve a single partner relation identified by its id **Required Permissions** \"partner-management.partners.view\"
911
911
  * @summary Retrieve the partner relation
912
912
  * @param {PartnerRelationsApiGetPartnerRelationRequest} requestParameters Request parameters.
913
913
  * @param {*} [options] Override http request option.
@@ -919,7 +919,7 @@ export class PartnerRelationsApi extends BaseAPI {
919
919
  }
920
920
 
921
921
  /**
922
- * Retrieve a single partner relation type identified with a slug - can be used to create partner relations
922
+ * Retrieve a single partner relation type identified with a slug - can be used to create partner relations **Required Permissions** \"partner-management.partners.view\"
923
923
  * @summary Retrieve the partner relation type
924
924
  * @param {PartnerRelationsApiGetPartnerRelationTypeRequest} requestParameters Request parameters.
925
925
  * @param {*} [options] Override http request option.
@@ -931,7 +931,7 @@ export class PartnerRelationsApi extends BaseAPI {
931
931
  }
932
932
 
933
933
  /**
934
- * List all partner relation types - is used to create partner relations
934
+ * List all partner relation types - is used to create partner relations **Required Permissions** \"partner-management.partners.view\"
935
935
  * @summary List partner relation types
936
936
  * @param {PartnerRelationsApiListPartnerRelationTypesRequest} requestParameters Request parameters.
937
937
  * @param {*} [options] Override http request option.
@@ -943,7 +943,7 @@ export class PartnerRelationsApi extends BaseAPI {
943
943
  }
944
944
 
945
945
  /**
946
- * List all partner relations
946
+ * List all partner relations **Required Permissions** \"partner-management.partners.view\"
947
947
  * @summary List partner relations
948
948
  * @param {PartnerRelationsApiListPartnerRelationsRequest} requestParameters Request parameters.
949
949
  * @param {*} [options] Override http request option.
@@ -955,7 +955,7 @@ export class PartnerRelationsApi extends BaseAPI {
955
955
  }
956
956
 
957
957
  /**
958
- * Update a partner relation identified by its id
958
+ * Update a partner relation identified by its id **Required Permissions** \"partner-management.partners.update\"
959
959
  * @summary Update the partner relation
960
960
  * @param {PartnerRelationsApiUpdatePartnerRelationRequest} requestParameters Request parameters.
961
961
  * @param {*} [options] Override http request option.