@emilgroup/partner-sdk-node 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-node@1.13.0 --save
20
+ npm install @emilgroup/partner-sdk-node@1.13.1-beta.0 --save
21
21
  ```
22
22
  or
23
23
  ```
24
- yarn add @emilgroup/partner-sdk-node@1.13.0
24
+ yarn add @emilgroup/partner-sdk-node@1.13.1-beta.0
25
25
  ```
26
26
 
27
27
  And then you can import `PartnersApi`.
@@ -35,7 +35,7 @@ const FormData = require('form-data');
35
35
  export const PartnerInvitationsApiAxiosParamCreator = function (configuration?: Configuration) {
36
36
  return {
37
37
  /**
38
- * Invites a partner to EIS Platform - partner must have one of vermittler,intermediary to be eligible for invitation.
38
+ * Invites a partner to EIS Platform - partner must have one of vermittler,intermediary to be eligible for invitation. **Required Permissions** \"partner-management.partners.create\"
39
39
  * @summary Create the Partner Invitation
40
40
  * @param {InvitePartnerToEISRequestDto} invitePartnerToEISRequestDto
41
41
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -92,7 +92,7 @@ export const PartnerInvitationsApiFp = function(configuration?: Configuration) {
92
92
  const localVarAxiosParamCreator = PartnerInvitationsApiAxiosParamCreator(configuration)
93
93
  return {
94
94
  /**
95
- * Invites a partner to EIS Platform - partner must have one of vermittler,intermediary to be eligible for invitation.
95
+ * Invites a partner to EIS Platform - partner must have one of vermittler,intermediary to be eligible for invitation. **Required Permissions** \"partner-management.partners.create\"
96
96
  * @summary Create the Partner Invitation
97
97
  * @param {InvitePartnerToEISRequestDto} invitePartnerToEISRequestDto
98
98
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -114,7 +114,7 @@ export const PartnerInvitationsApiFactory = function (configuration?: Configurat
114
114
  const localVarFp = PartnerInvitationsApiFp(configuration)
115
115
  return {
116
116
  /**
117
- * Invites a partner to EIS Platform - partner must have one of vermittler,intermediary to be eligible for invitation.
117
+ * Invites a partner to EIS Platform - partner must have one of vermittler,intermediary to be eligible for invitation. **Required Permissions** \"partner-management.partners.create\"
118
118
  * @summary Create the Partner Invitation
119
119
  * @param {InvitePartnerToEISRequestDto} invitePartnerToEISRequestDto
120
120
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -156,7 +156,7 @@ export interface PartnerInvitationsApiInvitePartnerToEISRequest {
156
156
  */
157
157
  export class PartnerInvitationsApi extends BaseAPI {
158
158
  /**
159
- * Invites a partner to EIS Platform - partner must have one of vermittler,intermediary to be eligible for invitation.
159
+ * Invites a partner to EIS Platform - partner must have one of vermittler,intermediary to be eligible for invitation. **Required Permissions** \"partner-management.partners.create\"
160
160
  * @summary Create the Partner Invitation
161
161
  * @param {PartnerInvitationsApiInvitePartnerToEISRequest} requestParameters Request parameters.
162
162
  * @param {*} [options] Override http request option.
@@ -47,7 +47,7 @@ const FormData = require('form-data');
47
47
  export const PartnerRelationsApiAxiosParamCreator = function (configuration?: Configuration) {
48
48
  return {
49
49
  /**
50
- * This will create a relationship between two partners. For example a parent-child relationship, or a partnership agreement.
50
+ * This will create a relationship between two partners. For example a parent-child relationship, or a partnership agreement. **Required Permissions** \"partner-management.partners.create\"
51
51
  * @summary Create the partner relation
52
52
  * @param {CreatePartnerRelationRequestDtoRest} createPartnerRelationRequestDtoRest
53
53
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -94,7 +94,7 @@ export const PartnerRelationsApiAxiosParamCreator = function (configuration?: Co
94
94
  };
95
95
  },
96
96
  /**
97
- * Permanently deletes the partner-relation. Supply the unique code that was returned when you created the partner-relation and this will delete it.
97
+ * 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\"
98
98
  * @summary Delete the partner-relation
99
99
  * @param {number} id
100
100
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -139,7 +139,7 @@ export const PartnerRelationsApiAxiosParamCreator = function (configuration?: Co
139
139
  };
140
140
  },
141
141
  /**
142
- * Retrieve a single partner relation identified by its id
142
+ * Retrieve a single partner relation identified by its id **Required Permissions** \"partner-management.partners.view\"
143
143
  * @summary Retrieve the partner relation
144
144
  * @param {number} id Id of the partner relation
145
145
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -184,7 +184,7 @@ export const PartnerRelationsApiAxiosParamCreator = function (configuration?: Co
184
184
  };
185
185
  },
186
186
  /**
187
- * Retrieve a single partner relation type identified with a slug - can be used to create partner relations
187
+ * Retrieve a single partner relation type identified with a slug - can be used to create partner relations **Required Permissions** \"partner-management.partners.view\"
188
188
  * @summary Retrieve the partner relation type
189
189
  * @param {string} slug Identifying slug of the partner relation type
190
190
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -229,7 +229,7 @@ export const PartnerRelationsApiAxiosParamCreator = function (configuration?: Co
229
229
  };
230
230
  },
231
231
  /**
232
- * List all partner relation types - is used to create partner relations
232
+ * List all partner relation types - is used to create partner relations **Required Permissions** \"partner-management.partners.view\"
233
233
  * @summary List partner relation types
234
234
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
235
235
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
@@ -305,7 +305,7 @@ export const PartnerRelationsApiAxiosParamCreator = function (configuration?: Co
305
305
  };
306
306
  },
307
307
  /**
308
- * List all partner relations
308
+ * List all partner relations **Required Permissions** \"partner-management.partners.view\"
309
309
  * @summary List partner relations
310
310
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
311
311
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
@@ -381,7 +381,7 @@ export const PartnerRelationsApiAxiosParamCreator = function (configuration?: Co
381
381
  };
382
382
  },
383
383
  /**
384
- * Update a partner relation identified by its id
384
+ * Update a partner relation identified by its id **Required Permissions** \"partner-management.partners.update\"
385
385
  * @summary Update the partner relation
386
386
  * @param {number} id Id of the partner relation
387
387
  * @param {UpdatePartnerRelationRequestDtoRest} updatePartnerRelationRequestDtoRest
@@ -442,7 +442,7 @@ export const PartnerRelationsApiFp = function(configuration?: Configuration) {
442
442
  const localVarAxiosParamCreator = PartnerRelationsApiAxiosParamCreator(configuration)
443
443
  return {
444
444
  /**
445
- * This will create a relationship between two partners. For example a parent-child relationship, or a partnership agreement.
445
+ * This will create a relationship between two partners. For example a parent-child relationship, or a partnership agreement. **Required Permissions** \"partner-management.partners.create\"
446
446
  * @summary Create the partner relation
447
447
  * @param {CreatePartnerRelationRequestDtoRest} createPartnerRelationRequestDtoRest
448
448
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -454,7 +454,7 @@ export const PartnerRelationsApiFp = function(configuration?: Configuration) {
454
454
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
455
455
  },
456
456
  /**
457
- * Permanently deletes the partner-relation. Supply the unique code that was returned when you created the partner-relation and this will delete it.
457
+ * 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\"
458
458
  * @summary Delete the partner-relation
459
459
  * @param {number} id
460
460
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -466,7 +466,7 @@ export const PartnerRelationsApiFp = function(configuration?: Configuration) {
466
466
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
467
467
  },
468
468
  /**
469
- * Retrieve a single partner relation identified by its id
469
+ * Retrieve a single partner relation identified by its id **Required Permissions** \"partner-management.partners.view\"
470
470
  * @summary Retrieve the partner relation
471
471
  * @param {number} id Id of the partner relation
472
472
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -478,7 +478,7 @@ export const PartnerRelationsApiFp = function(configuration?: Configuration) {
478
478
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
479
479
  },
480
480
  /**
481
- * Retrieve a single partner relation type identified with a slug - can be used to create partner relations
481
+ * Retrieve a single partner relation type identified with a slug - can be used to create partner relations **Required Permissions** \"partner-management.partners.view\"
482
482
  * @summary Retrieve the partner relation type
483
483
  * @param {string} slug Identifying slug of the partner relation type
484
484
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -490,7 +490,7 @@ export const PartnerRelationsApiFp = function(configuration?: Configuration) {
490
490
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
491
491
  },
492
492
  /**
493
- * List all partner relation types - is used to create partner relations
493
+ * List all partner relation types - is used to create partner relations **Required Permissions** \"partner-management.partners.view\"
494
494
  * @summary List partner relation types
495
495
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
496
496
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
@@ -508,7 +508,7 @@ export const PartnerRelationsApiFp = function(configuration?: Configuration) {
508
508
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
509
509
  },
510
510
  /**
511
- * List all partner relations
511
+ * List all partner relations **Required Permissions** \"partner-management.partners.view\"
512
512
  * @summary List partner relations
513
513
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
514
514
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
@@ -526,7 +526,7 @@ export const PartnerRelationsApiFp = function(configuration?: Configuration) {
526
526
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
527
527
  },
528
528
  /**
529
- * Update a partner relation identified by its id
529
+ * Update a partner relation identified by its id **Required Permissions** \"partner-management.partners.update\"
530
530
  * @summary Update the partner relation
531
531
  * @param {number} id Id of the partner relation
532
532
  * @param {UpdatePartnerRelationRequestDtoRest} updatePartnerRelationRequestDtoRest
@@ -549,7 +549,7 @@ export const PartnerRelationsApiFactory = function (configuration?: Configuratio
549
549
  const localVarFp = PartnerRelationsApiFp(configuration)
550
550
  return {
551
551
  /**
552
- * This will create a relationship between two partners. For example a parent-child relationship, or a partnership agreement.
552
+ * This will create a relationship between two partners. For example a parent-child relationship, or a partnership agreement. **Required Permissions** \"partner-management.partners.create\"
553
553
  * @summary Create the partner relation
554
554
  * @param {CreatePartnerRelationRequestDtoRest} createPartnerRelationRequestDtoRest
555
555
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -560,7 +560,7 @@ export const PartnerRelationsApiFactory = function (configuration?: Configuratio
560
560
  return localVarFp.createPartnerRelation(createPartnerRelationRequestDtoRest, authorization, options).then((request) => request(axios, basePath));
561
561
  },
562
562
  /**
563
- * Permanently deletes the partner-relation. Supply the unique code that was returned when you created the partner-relation and this will delete it.
563
+ * 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\"
564
564
  * @summary Delete the partner-relation
565
565
  * @param {number} id
566
566
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -571,7 +571,7 @@ export const PartnerRelationsApiFactory = function (configuration?: Configuratio
571
571
  return localVarFp.deletePartnerRelation(id, authorization, options).then((request) => request(axios, basePath));
572
572
  },
573
573
  /**
574
- * Retrieve a single partner relation identified by its id
574
+ * Retrieve a single partner relation identified by its id **Required Permissions** \"partner-management.partners.view\"
575
575
  * @summary Retrieve the partner relation
576
576
  * @param {number} id Id of the partner relation
577
577
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -582,7 +582,7 @@ export const PartnerRelationsApiFactory = function (configuration?: Configuratio
582
582
  return localVarFp.getPartnerRelation(id, authorization, options).then((request) => request(axios, basePath));
583
583
  },
584
584
  /**
585
- * Retrieve a single partner relation type identified with a slug - can be used to create partner relations
585
+ * Retrieve a single partner relation type identified with a slug - can be used to create partner relations **Required Permissions** \"partner-management.partners.view\"
586
586
  * @summary Retrieve the partner relation type
587
587
  * @param {string} slug Identifying slug of the partner relation type
588
588
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -593,7 +593,7 @@ export const PartnerRelationsApiFactory = function (configuration?: Configuratio
593
593
  return localVarFp.getPartnerRelationType(slug, authorization, options).then((request) => request(axios, basePath));
594
594
  },
595
595
  /**
596
- * List all partner relation types - is used to create partner relations
596
+ * List all partner relation types - is used to create partner relations **Required Permissions** \"partner-management.partners.view\"
597
597
  * @summary List partner relation types
598
598
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
599
599
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
@@ -610,7 +610,7 @@ export const PartnerRelationsApiFactory = function (configuration?: Configuratio
610
610
  return localVarFp.listPartnerRelationTypes(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
611
611
  },
612
612
  /**
613
- * List all partner relations
613
+ * List all partner relations **Required Permissions** \"partner-management.partners.view\"
614
614
  * @summary List partner relations
615
615
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
616
616
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
@@ -627,7 +627,7 @@ export const PartnerRelationsApiFactory = function (configuration?: Configuratio
627
627
  return localVarFp.listPartnerRelations(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
628
628
  },
629
629
  /**
630
- * Update a partner relation identified by its id
630
+ * Update a partner relation identified by its id **Required Permissions** \"partner-management.partners.update\"
631
631
  * @summary Update the partner relation
632
632
  * @param {number} id Id of the partner relation
633
633
  * @param {UpdatePartnerRelationRequestDtoRest} updatePartnerRelationRequestDtoRest
@@ -887,7 +887,7 @@ export interface PartnerRelationsApiUpdatePartnerRelationRequest {
887
887
  */
888
888
  export class PartnerRelationsApi extends BaseAPI {
889
889
  /**
890
- * This will create a relationship between two partners. For example a parent-child relationship, or a partnership agreement.
890
+ * This will create a relationship between two partners. For example a parent-child relationship, or a partnership agreement. **Required Permissions** \"partner-management.partners.create\"
891
891
  * @summary Create the partner relation
892
892
  * @param {PartnerRelationsApiCreatePartnerRelationRequest} requestParameters Request parameters.
893
893
  * @param {*} [options] Override http request option.
@@ -899,7 +899,7 @@ export class PartnerRelationsApi extends BaseAPI {
899
899
  }
900
900
 
901
901
  /**
902
- * Permanently deletes the partner-relation. Supply the unique code that was returned when you created the partner-relation and this will delete it.
902
+ * 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\"
903
903
  * @summary Delete the partner-relation
904
904
  * @param {PartnerRelationsApiDeletePartnerRelationRequest} requestParameters Request parameters.
905
905
  * @param {*} [options] Override http request option.
@@ -911,7 +911,7 @@ export class PartnerRelationsApi extends BaseAPI {
911
911
  }
912
912
 
913
913
  /**
914
- * Retrieve a single partner relation identified by its id
914
+ * Retrieve a single partner relation identified by its id **Required Permissions** \"partner-management.partners.view\"
915
915
  * @summary Retrieve the partner relation
916
916
  * @param {PartnerRelationsApiGetPartnerRelationRequest} requestParameters Request parameters.
917
917
  * @param {*} [options] Override http request option.
@@ -923,7 +923,7 @@ export class PartnerRelationsApi extends BaseAPI {
923
923
  }
924
924
 
925
925
  /**
926
- * Retrieve a single partner relation type identified with a slug - can be used to create partner relations
926
+ * Retrieve a single partner relation type identified with a slug - can be used to create partner relations **Required Permissions** \"partner-management.partners.view\"
927
927
  * @summary Retrieve the partner relation type
928
928
  * @param {PartnerRelationsApiGetPartnerRelationTypeRequest} requestParameters Request parameters.
929
929
  * @param {*} [options] Override http request option.
@@ -935,7 +935,7 @@ export class PartnerRelationsApi extends BaseAPI {
935
935
  }
936
936
 
937
937
  /**
938
- * List all partner relation types - is used to create partner relations
938
+ * List all partner relation types - is used to create partner relations **Required Permissions** \"partner-management.partners.view\"
939
939
  * @summary List partner relation types
940
940
  * @param {PartnerRelationsApiListPartnerRelationTypesRequest} requestParameters Request parameters.
941
941
  * @param {*} [options] Override http request option.
@@ -947,7 +947,7 @@ export class PartnerRelationsApi extends BaseAPI {
947
947
  }
948
948
 
949
949
  /**
950
- * List all partner relations
950
+ * List all partner relations **Required Permissions** \"partner-management.partners.view\"
951
951
  * @summary List partner relations
952
952
  * @param {PartnerRelationsApiListPartnerRelationsRequest} requestParameters Request parameters.
953
953
  * @param {*} [options] Override http request option.
@@ -959,7 +959,7 @@ export class PartnerRelationsApi extends BaseAPI {
959
959
  }
960
960
 
961
961
  /**
962
- * Update a partner relation identified by its id
962
+ * Update a partner relation identified by its id **Required Permissions** \"partner-management.partners.update\"
963
963
  * @summary Update the partner relation
964
964
  * @param {PartnerRelationsApiUpdatePartnerRelationRequest} requestParameters Request parameters.
965
965
  * @param {*} [options] Override http request option.
@@ -43,7 +43,7 @@ const FormData = require('form-data');
43
43
  export const PartnerTagsApiAxiosParamCreator = function (configuration?: Configuration) {
44
44
  return {
45
45
  /**
46
- * 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.
46
+ * 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\"
47
47
  * @summary Create the partner tag
48
48
  * @param {CreateTagRequestDto} createTagRequestDto
49
49
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -90,9 +90,9 @@ export const PartnerTagsApiAxiosParamCreator = function (configuration?: Configu
90
90
  };
91
91
  },
92
92
  /**
93
- * Permanently deletes the partner tag. Supply the unique code that was returned when you created the partner tag and this will delete it.
93
+ * 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\"
94
94
  * @summary Delete the partner tag
95
- * @param {string} code
95
+ * @param {string} code Unique identifier for the object.
96
96
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
97
97
  * @param {*} [options] Override http request option.
98
98
  * @throws {RequiredError}
@@ -135,7 +135,7 @@ export const PartnerTagsApiAxiosParamCreator = function (configuration?: Configu
135
135
  };
136
136
  },
137
137
  /**
138
- * 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.
138
+ * 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\"
139
139
  * @summary Retrieve the partner tag
140
140
  * @param {string} code Unique identifier for the object.
141
141
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -180,7 +180,7 @@ export const PartnerTagsApiAxiosParamCreator = function (configuration?: Configu
180
180
  };
181
181
  },
182
182
  /**
183
- * 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.
183
+ * 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\"
184
184
  * @summary List partner tags
185
185
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
186
186
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
@@ -256,7 +256,7 @@ export const PartnerTagsApiAxiosParamCreator = function (configuration?: Configu
256
256
  };
257
257
  },
258
258
  /**
259
- * Updates the specified partner tag by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
259
+ * 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\"
260
260
  * @summary Update the partner tag
261
261
  * @param {string} code
262
262
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -311,7 +311,7 @@ export const PartnerTagsApiFp = function(configuration?: Configuration) {
311
311
  const localVarAxiosParamCreator = PartnerTagsApiAxiosParamCreator(configuration)
312
312
  return {
313
313
  /**
314
- * 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.
314
+ * 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\"
315
315
  * @summary Create the partner tag
316
316
  * @param {CreateTagRequestDto} createTagRequestDto
317
317
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -323,9 +323,9 @@ export const PartnerTagsApiFp = function(configuration?: Configuration) {
323
323
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
324
324
  },
325
325
  /**
326
- * Permanently deletes the partner tag. Supply the unique code that was returned when you created the partner tag and this will delete it.
326
+ * 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\"
327
327
  * @summary Delete the partner tag
328
- * @param {string} code
328
+ * @param {string} code Unique identifier for the object.
329
329
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
330
330
  * @param {*} [options] Override http request option.
331
331
  * @throws {RequiredError}
@@ -335,7 +335,7 @@ export const PartnerTagsApiFp = function(configuration?: Configuration) {
335
335
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
336
336
  },
337
337
  /**
338
- * 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.
338
+ * 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\"
339
339
  * @summary Retrieve the partner tag
340
340
  * @param {string} code Unique identifier for the object.
341
341
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -347,7 +347,7 @@ export const PartnerTagsApiFp = function(configuration?: Configuration) {
347
347
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
348
348
  },
349
349
  /**
350
- * 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.
350
+ * 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\"
351
351
  * @summary List partner tags
352
352
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
353
353
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
@@ -365,7 +365,7 @@ export const PartnerTagsApiFp = function(configuration?: Configuration) {
365
365
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
366
366
  },
367
367
  /**
368
- * Updates the specified partner tag by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
368
+ * 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\"
369
369
  * @summary Update the partner tag
370
370
  * @param {string} code
371
371
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -387,7 +387,7 @@ export const PartnerTagsApiFactory = function (configuration?: Configuration, ba
387
387
  const localVarFp = PartnerTagsApiFp(configuration)
388
388
  return {
389
389
  /**
390
- * 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.
390
+ * 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\"
391
391
  * @summary Create the partner tag
392
392
  * @param {CreateTagRequestDto} createTagRequestDto
393
393
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -398,9 +398,9 @@ export const PartnerTagsApiFactory = function (configuration?: Configuration, ba
398
398
  return localVarFp.createTag(createTagRequestDto, authorization, options).then((request) => request(axios, basePath));
399
399
  },
400
400
  /**
401
- * Permanently deletes the partner tag. Supply the unique code that was returned when you created the partner tag and this will delete it.
401
+ * 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\"
402
402
  * @summary Delete the partner tag
403
- * @param {string} code
403
+ * @param {string} code Unique identifier for the object.
404
404
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
405
405
  * @param {*} [options] Override http request option.
406
406
  * @throws {RequiredError}
@@ -409,7 +409,7 @@ export const PartnerTagsApiFactory = function (configuration?: Configuration, ba
409
409
  return localVarFp.deleteTag(code, authorization, options).then((request) => request(axios, basePath));
410
410
  },
411
411
  /**
412
- * 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.
412
+ * 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\"
413
413
  * @summary Retrieve the partner tag
414
414
  * @param {string} code Unique identifier for the object.
415
415
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -420,7 +420,7 @@ export const PartnerTagsApiFactory = function (configuration?: Configuration, ba
420
420
  return localVarFp.getTag(code, authorization, options).then((request) => request(axios, basePath));
421
421
  },
422
422
  /**
423
- * 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.
423
+ * 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\"
424
424
  * @summary List partner tags
425
425
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
426
426
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
@@ -437,7 +437,7 @@ export const PartnerTagsApiFactory = function (configuration?: Configuration, ba
437
437
  return localVarFp.listTags(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
438
438
  },
439
439
  /**
440
- * Updates the specified partner tag by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
440
+ * 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\"
441
441
  * @summary Update the partner tag
442
442
  * @param {string} code
443
443
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -478,7 +478,7 @@ export interface PartnerTagsApiCreateTagRequest {
478
478
  */
479
479
  export interface PartnerTagsApiDeleteTagRequest {
480
480
  /**
481
- *
481
+ * Unique identifier for the object.
482
482
  * @type {string}
483
483
  * @memberof PartnerTagsApiDeleteTag
484
484
  */
@@ -605,7 +605,7 @@ export interface PartnerTagsApiUpdateTagRequest {
605
605
  */
606
606
  export class PartnerTagsApi extends BaseAPI {
607
607
  /**
608
- * 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.
608
+ * 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\"
609
609
  * @summary Create the partner tag
610
610
  * @param {PartnerTagsApiCreateTagRequest} requestParameters Request parameters.
611
611
  * @param {*} [options] Override http request option.
@@ -617,7 +617,7 @@ export class PartnerTagsApi extends BaseAPI {
617
617
  }
618
618
 
619
619
  /**
620
- * Permanently deletes the partner tag. Supply the unique code that was returned when you created the partner tag and this will delete it.
620
+ * 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\"
621
621
  * @summary Delete the partner tag
622
622
  * @param {PartnerTagsApiDeleteTagRequest} requestParameters Request parameters.
623
623
  * @param {*} [options] Override http request option.
@@ -629,7 +629,7 @@ export class PartnerTagsApi extends BaseAPI {
629
629
  }
630
630
 
631
631
  /**
632
- * 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.
632
+ * 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\"
633
633
  * @summary Retrieve the partner tag
634
634
  * @param {PartnerTagsApiGetTagRequest} requestParameters Request parameters.
635
635
  * @param {*} [options] Override http request option.
@@ -641,7 +641,7 @@ export class PartnerTagsApi extends BaseAPI {
641
641
  }
642
642
 
643
643
  /**
644
- * 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.
644
+ * 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\"
645
645
  * @summary List partner tags
646
646
  * @param {PartnerTagsApiListTagsRequest} requestParameters Request parameters.
647
647
  * @param {*} [options] Override http request option.
@@ -653,7 +653,7 @@ export class PartnerTagsApi extends BaseAPI {
653
653
  }
654
654
 
655
655
  /**
656
- * Updates the specified partner tag by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
656
+ * 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\"
657
657
  * @summary Update the partner tag
658
658
  * @param {PartnerTagsApiUpdateTagRequest} requestParameters Request parameters.
659
659
  * @param {*} [options] Override http request option.