@emilgroup/partner-sdk 1.13.0 → 1.13.1-beta.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.0 --save
20
+ npm install @emilgroup/partner-sdk@1.13.1-beta.0 --save
21
21
  ```
22
22
  or
23
23
  ```
24
- yarn add @emilgroup/partner-sdk@1.13.0
24
+ yarn add @emilgroup/partner-sdk@1.13.1-beta.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,7 +225,7 @@ 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
231
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
@@ -301,7 +301,7 @@ 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
307
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
@@ -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,7 +486,7 @@ 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
492
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
@@ -504,7 +504,7 @@ export const PartnerRelationsApiFp = function(configuration?: Configuration) {
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
510
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
@@ -522,7 +522,7 @@ export const PartnerRelationsApiFp = function(configuration?: Configuration) {
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,7 +589,7 @@ 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
595
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
@@ -606,7 +606,7 @@ export const PartnerRelationsApiFactory = function (configuration?: Configuratio
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
612
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
@@ -623,7 +623,7 @@ export const PartnerRelationsApiFactory = function (configuration?: Configuratio
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
@@ -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.
@@ -39,7 +39,7 @@ import { UpdateTagResponseClass } from '../models';
39
39
  export const PartnerTagsApiAxiosParamCreator = function (configuration?: Configuration) {
40
40
  return {
41
41
  /**
42
- * This will create a tag that can be used tag partners. Tags can be used to categorize partners and to apply specific rules to them.
42
+ * This will create a tag that can be used tag partners. Tags can be used to categorize partners and to apply specific rules to them. **Required Permissions** \"partner-management.partners.create\"
43
43
  * @summary Create the partner tag
44
44
  * @param {CreateTagRequestDto} createTagRequestDto
45
45
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -86,9 +86,9 @@ export const PartnerTagsApiAxiosParamCreator = function (configuration?: Configu
86
86
  };
87
87
  },
88
88
  /**
89
- * Permanently deletes the partner tag. Supply the unique code that was returned when you created the partner tag and this will delete it.
89
+ * Permanently deletes the partner tag. Supply the unique code that was returned when you created the partner tag and this will delete it. **Required Permissions** \"partner-management.partners.delete\"
90
90
  * @summary Delete the partner tag
91
- * @param {string} code
91
+ * @param {string} code Unique identifier for the object.
92
92
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
93
93
  * @param {*} [options] Override http request option.
94
94
  * @throws {RequiredError}
@@ -131,7 +131,7 @@ export const PartnerTagsApiAxiosParamCreator = function (configuration?: Configu
131
131
  };
132
132
  },
133
133
  /**
134
- * Retrieves the details of the partner tag that was previously created. Supply the unique partner tag code that was returned when you created it and Emil Api will return the corresponding partner tag information.
134
+ * Retrieves the details of the partner tag that was previously created. Supply the unique partner tag code that was returned when you created it and Emil Api will return the corresponding partner tag information. **Required Permissions** \"partner-management.partners.view\"
135
135
  * @summary Retrieve the partner tag
136
136
  * @param {string} code Unique identifier for the object.
137
137
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -176,7 +176,7 @@ export const PartnerTagsApiAxiosParamCreator = function (configuration?: Configu
176
176
  };
177
177
  },
178
178
  /**
179
- * Returns a list of partner tags you have previously created. The partner tags are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
179
+ * Returns a list of partner tags you have previously created. The partner tags are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"partner-management.partners.view\"
180
180
  * @summary List partner tags
181
181
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
182
182
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
@@ -252,7 +252,7 @@ export const PartnerTagsApiAxiosParamCreator = function (configuration?: Configu
252
252
  };
253
253
  },
254
254
  /**
255
- * Updates the specified partner tag by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
255
+ * Updates the specified partner tag by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"partner-management.partners.update\"
256
256
  * @summary Update the partner tag
257
257
  * @param {string} code
258
258
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -307,7 +307,7 @@ export const PartnerTagsApiFp = function(configuration?: Configuration) {
307
307
  const localVarAxiosParamCreator = PartnerTagsApiAxiosParamCreator(configuration)
308
308
  return {
309
309
  /**
310
- * This will create a tag that can be used tag partners. Tags can be used to categorize partners and to apply specific rules to them.
310
+ * This will create a tag that can be used tag partners. Tags can be used to categorize partners and to apply specific rules to them. **Required Permissions** \"partner-management.partners.create\"
311
311
  * @summary Create the partner tag
312
312
  * @param {CreateTagRequestDto} createTagRequestDto
313
313
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -319,9 +319,9 @@ export const PartnerTagsApiFp = function(configuration?: Configuration) {
319
319
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
320
320
  },
321
321
  /**
322
- * Permanently deletes the partner tag. Supply the unique code that was returned when you created the partner tag and this will delete it.
322
+ * Permanently deletes the partner tag. Supply the unique code that was returned when you created the partner tag and this will delete it. **Required Permissions** \"partner-management.partners.delete\"
323
323
  * @summary Delete the partner tag
324
- * @param {string} code
324
+ * @param {string} code Unique identifier for the object.
325
325
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
326
326
  * @param {*} [options] Override http request option.
327
327
  * @throws {RequiredError}
@@ -331,7 +331,7 @@ export const PartnerTagsApiFp = function(configuration?: Configuration) {
331
331
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
332
332
  },
333
333
  /**
334
- * Retrieves the details of the partner tag that was previously created. Supply the unique partner tag code that was returned when you created it and Emil Api will return the corresponding partner tag information.
334
+ * Retrieves the details of the partner tag that was previously created. Supply the unique partner tag code that was returned when you created it and Emil Api will return the corresponding partner tag information. **Required Permissions** \"partner-management.partners.view\"
335
335
  * @summary Retrieve the partner tag
336
336
  * @param {string} code Unique identifier for the object.
337
337
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -343,7 +343,7 @@ export const PartnerTagsApiFp = function(configuration?: Configuration) {
343
343
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
344
344
  },
345
345
  /**
346
- * Returns a list of partner tags you have previously created. The partner tags are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
346
+ * Returns a list of partner tags you have previously created. The partner tags are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"partner-management.partners.view\"
347
347
  * @summary List partner tags
348
348
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
349
349
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
@@ -361,7 +361,7 @@ export const PartnerTagsApiFp = function(configuration?: Configuration) {
361
361
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
362
362
  },
363
363
  /**
364
- * Updates the specified partner tag by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
364
+ * Updates the specified partner tag by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"partner-management.partners.update\"
365
365
  * @summary Update the partner tag
366
366
  * @param {string} code
367
367
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -383,7 +383,7 @@ export const PartnerTagsApiFactory = function (configuration?: Configuration, ba
383
383
  const localVarFp = PartnerTagsApiFp(configuration)
384
384
  return {
385
385
  /**
386
- * This will create a tag that can be used tag partners. Tags can be used to categorize partners and to apply specific rules to them.
386
+ * This will create a tag that can be used tag partners. Tags can be used to categorize partners and to apply specific rules to them. **Required Permissions** \"partner-management.partners.create\"
387
387
  * @summary Create the partner tag
388
388
  * @param {CreateTagRequestDto} createTagRequestDto
389
389
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -394,9 +394,9 @@ export const PartnerTagsApiFactory = function (configuration?: Configuration, ba
394
394
  return localVarFp.createTag(createTagRequestDto, authorization, options).then((request) => request(axios, basePath));
395
395
  },
396
396
  /**
397
- * Permanently deletes the partner tag. Supply the unique code that was returned when you created the partner tag and this will delete it.
397
+ * Permanently deletes the partner tag. Supply the unique code that was returned when you created the partner tag and this will delete it. **Required Permissions** \"partner-management.partners.delete\"
398
398
  * @summary Delete the partner tag
399
- * @param {string} code
399
+ * @param {string} code Unique identifier for the object.
400
400
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
401
401
  * @param {*} [options] Override http request option.
402
402
  * @throws {RequiredError}
@@ -405,7 +405,7 @@ export const PartnerTagsApiFactory = function (configuration?: Configuration, ba
405
405
  return localVarFp.deleteTag(code, authorization, options).then((request) => request(axios, basePath));
406
406
  },
407
407
  /**
408
- * Retrieves the details of the partner tag that was previously created. Supply the unique partner tag code that was returned when you created it and Emil Api will return the corresponding partner tag information.
408
+ * Retrieves the details of the partner tag that was previously created. Supply the unique partner tag code that was returned when you created it and Emil Api will return the corresponding partner tag information. **Required Permissions** \"partner-management.partners.view\"
409
409
  * @summary Retrieve the partner tag
410
410
  * @param {string} code Unique identifier for the object.
411
411
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -416,7 +416,7 @@ export const PartnerTagsApiFactory = function (configuration?: Configuration, ba
416
416
  return localVarFp.getTag(code, authorization, options).then((request) => request(axios, basePath));
417
417
  },
418
418
  /**
419
- * Returns a list of partner tags you have previously created. The partner tags are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
419
+ * Returns a list of partner tags you have previously created. The partner tags are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"partner-management.partners.view\"
420
420
  * @summary List partner tags
421
421
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
422
422
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
@@ -433,7 +433,7 @@ export const PartnerTagsApiFactory = function (configuration?: Configuration, ba
433
433
  return localVarFp.listTags(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
434
434
  },
435
435
  /**
436
- * Updates the specified partner tag by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
436
+ * Updates the specified partner tag by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"partner-management.partners.update\"
437
437
  * @summary Update the partner tag
438
438
  * @param {string} code
439
439
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -474,7 +474,7 @@ export interface PartnerTagsApiCreateTagRequest {
474
474
  */
475
475
  export interface PartnerTagsApiDeleteTagRequest {
476
476
  /**
477
- *
477
+ * Unique identifier for the object.
478
478
  * @type {string}
479
479
  * @memberof PartnerTagsApiDeleteTag
480
480
  */
@@ -601,7 +601,7 @@ export interface PartnerTagsApiUpdateTagRequest {
601
601
  */
602
602
  export class PartnerTagsApi extends BaseAPI {
603
603
  /**
604
- * This will create a tag that can be used tag partners. Tags can be used to categorize partners and to apply specific rules to them.
604
+ * This will create a tag that can be used tag partners. Tags can be used to categorize partners and to apply specific rules to them. **Required Permissions** \"partner-management.partners.create\"
605
605
  * @summary Create the partner tag
606
606
  * @param {PartnerTagsApiCreateTagRequest} requestParameters Request parameters.
607
607
  * @param {*} [options] Override http request option.
@@ -613,7 +613,7 @@ export class PartnerTagsApi extends BaseAPI {
613
613
  }
614
614
 
615
615
  /**
616
- * Permanently deletes the partner tag. Supply the unique code that was returned when you created the partner tag and this will delete it.
616
+ * Permanently deletes the partner tag. Supply the unique code that was returned when you created the partner tag and this will delete it. **Required Permissions** \"partner-management.partners.delete\"
617
617
  * @summary Delete the partner tag
618
618
  * @param {PartnerTagsApiDeleteTagRequest} requestParameters Request parameters.
619
619
  * @param {*} [options] Override http request option.
@@ -625,7 +625,7 @@ export class PartnerTagsApi extends BaseAPI {
625
625
  }
626
626
 
627
627
  /**
628
- * Retrieves the details of the partner tag that was previously created. Supply the unique partner tag code that was returned when you created it and Emil Api will return the corresponding partner tag information.
628
+ * Retrieves the details of the partner tag that was previously created. Supply the unique partner tag code that was returned when you created it and Emil Api will return the corresponding partner tag information. **Required Permissions** \"partner-management.partners.view\"
629
629
  * @summary Retrieve the partner tag
630
630
  * @param {PartnerTagsApiGetTagRequest} requestParameters Request parameters.
631
631
  * @param {*} [options] Override http request option.
@@ -637,7 +637,7 @@ export class PartnerTagsApi extends BaseAPI {
637
637
  }
638
638
 
639
639
  /**
640
- * Returns a list of partner tags you have previously created. The partner tags are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
640
+ * Returns a list of partner tags you have previously created. The partner tags are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"partner-management.partners.view\"
641
641
  * @summary List partner tags
642
642
  * @param {PartnerTagsApiListTagsRequest} requestParameters Request parameters.
643
643
  * @param {*} [options] Override http request option.
@@ -649,7 +649,7 @@ export class PartnerTagsApi extends BaseAPI {
649
649
  }
650
650
 
651
651
  /**
652
- * Updates the specified partner tag by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
652
+ * Updates the specified partner tag by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"partner-management.partners.update\"
653
653
  * @summary Update the partner tag
654
654
  * @param {PartnerTagsApiUpdateTagRequest} requestParameters Request parameters.
655
655
  * @param {*} [options] Override http request option.