@emilgroup/partner-sdk 1.12.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.
@@ -24,7 +24,7 @@ import { UpdateTagResponseClass } from '../models';
24
24
  */
25
25
  export declare const PartnerTagsApiAxiosParamCreator: (configuration?: Configuration) => {
26
26
  /**
27
- * 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.
27
+ * 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\"
28
28
  * @summary Create the partner tag
29
29
  * @param {CreateTagRequestDto} createTagRequestDto
30
30
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -33,16 +33,16 @@ export declare const PartnerTagsApiAxiosParamCreator: (configuration?: Configura
33
33
  */
34
34
  createTag: (createTagRequestDto: CreateTagRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
35
35
  /**
36
- * Permanently deletes the partner tag. Supply the unique code that was returned when you created the partner tag and this will delete it.
36
+ * 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\"
37
37
  * @summary Delete the partner tag
38
- * @param {string} code
38
+ * @param {string} code Unique identifier for the object.
39
39
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
40
40
  * @param {*} [options] Override http request option.
41
41
  * @throws {RequiredError}
42
42
  */
43
43
  deleteTag: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
44
44
  /**
45
- * 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.
45
+ * 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\"
46
46
  * @summary Retrieve the partner tag
47
47
  * @param {string} code Unique identifier for the object.
48
48
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -51,7 +51,7 @@ export declare const PartnerTagsApiAxiosParamCreator: (configuration?: Configura
51
51
  */
52
52
  getTag: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
53
53
  /**
54
- * 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.
54
+ * 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\"
55
55
  * @summary List partner tags
56
56
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
57
57
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
@@ -66,7 +66,7 @@ export declare const PartnerTagsApiAxiosParamCreator: (configuration?: Configura
66
66
  */
67
67
  listTags: (authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
68
68
  /**
69
- * Updates the specified partner tag by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
69
+ * 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\"
70
70
  * @summary Update the partner tag
71
71
  * @param {string} code
72
72
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -81,7 +81,7 @@ export declare const PartnerTagsApiAxiosParamCreator: (configuration?: Configura
81
81
  */
82
82
  export declare const PartnerTagsApiFp: (configuration?: Configuration) => {
83
83
  /**
84
- * 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.
84
+ * 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\"
85
85
  * @summary Create the partner tag
86
86
  * @param {CreateTagRequestDto} createTagRequestDto
87
87
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -90,16 +90,16 @@ export declare const PartnerTagsApiFp: (configuration?: Configuration) => {
90
90
  */
91
91
  createTag(createTagRequestDto: CreateTagRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateTagResponseClass>>;
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}
99
99
  */
100
100
  deleteTag(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponseClass>>;
101
101
  /**
102
- * 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.
102
+ * 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\"
103
103
  * @summary Retrieve the partner tag
104
104
  * @param {string} code Unique identifier for the object.
105
105
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -108,7 +108,7 @@ export declare const PartnerTagsApiFp: (configuration?: Configuration) => {
108
108
  */
109
109
  getTag(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetTagResponseClass>>;
110
110
  /**
111
- * 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.
111
+ * 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\"
112
112
  * @summary List partner tags
113
113
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
114
114
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
@@ -123,7 +123,7 @@ export declare const PartnerTagsApiFp: (configuration?: Configuration) => {
123
123
  */
124
124
  listTags(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListTagsResponseClass>>;
125
125
  /**
126
- * Updates the specified partner tag by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
126
+ * 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\"
127
127
  * @summary Update the partner tag
128
128
  * @param {string} code
129
129
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -138,7 +138,7 @@ export declare const PartnerTagsApiFp: (configuration?: Configuration) => {
138
138
  */
139
139
  export declare const PartnerTagsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
140
140
  /**
141
- * 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.
141
+ * 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\"
142
142
  * @summary Create the partner tag
143
143
  * @param {CreateTagRequestDto} createTagRequestDto
144
144
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -147,16 +147,16 @@ export declare const PartnerTagsApiFactory: (configuration?: Configuration, base
147
147
  */
148
148
  createTag(createTagRequestDto: CreateTagRequestDto, authorization?: string, options?: any): AxiosPromise<CreateTagResponseClass>;
149
149
  /**
150
- * Permanently deletes the partner tag. Supply the unique code that was returned when you created the partner tag and this will delete it.
150
+ * 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\"
151
151
  * @summary Delete the partner tag
152
- * @param {string} code
152
+ * @param {string} code Unique identifier for the object.
153
153
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
154
154
  * @param {*} [options] Override http request option.
155
155
  * @throws {RequiredError}
156
156
  */
157
157
  deleteTag(code: string, authorization?: string, options?: any): AxiosPromise<DeleteResponseClass>;
158
158
  /**
159
- * 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.
159
+ * 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\"
160
160
  * @summary Retrieve the partner tag
161
161
  * @param {string} code Unique identifier for the object.
162
162
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -165,7 +165,7 @@ export declare const PartnerTagsApiFactory: (configuration?: Configuration, base
165
165
  */
166
166
  getTag(code: string, authorization?: string, options?: any): AxiosPromise<GetTagResponseClass>;
167
167
  /**
168
- * 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.
168
+ * 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\"
169
169
  * @summary List partner tags
170
170
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
171
171
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
@@ -180,7 +180,7 @@ export declare const PartnerTagsApiFactory: (configuration?: Configuration, base
180
180
  */
181
181
  listTags(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListTagsResponseClass>;
182
182
  /**
183
- * Updates the specified partner tag by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
183
+ * 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\"
184
184
  * @summary Update the partner tag
185
185
  * @param {string} code
186
186
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -215,7 +215,7 @@ export interface PartnerTagsApiCreateTagRequest {
215
215
  */
216
216
  export interface PartnerTagsApiDeleteTagRequest {
217
217
  /**
218
- *
218
+ * Unique identifier for the object.
219
219
  * @type {string}
220
220
  * @memberof PartnerTagsApiDeleteTag
221
221
  */
@@ -328,7 +328,7 @@ export interface PartnerTagsApiUpdateTagRequest {
328
328
  */
329
329
  export declare class PartnerTagsApi extends BaseAPI {
330
330
  /**
331
- * 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.
331
+ * 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\"
332
332
  * @summary Create the partner tag
333
333
  * @param {PartnerTagsApiCreateTagRequest} requestParameters Request parameters.
334
334
  * @param {*} [options] Override http request option.
@@ -337,7 +337,7 @@ export declare class PartnerTagsApi extends BaseAPI {
337
337
  */
338
338
  createTag(requestParameters: PartnerTagsApiCreateTagRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateTagResponseClass, any>>;
339
339
  /**
340
- * Permanently deletes the partner tag. Supply the unique code that was returned when you created the partner tag and this will delete it.
340
+ * 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\"
341
341
  * @summary Delete the partner tag
342
342
  * @param {PartnerTagsApiDeleteTagRequest} requestParameters Request parameters.
343
343
  * @param {*} [options] Override http request option.
@@ -346,7 +346,7 @@ export declare class PartnerTagsApi extends BaseAPI {
346
346
  */
347
347
  deleteTag(requestParameters: PartnerTagsApiDeleteTagRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteResponseClass, any>>;
348
348
  /**
349
- * 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.
349
+ * 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\"
350
350
  * @summary Retrieve the partner tag
351
351
  * @param {PartnerTagsApiGetTagRequest} requestParameters Request parameters.
352
352
  * @param {*} [options] Override http request option.
@@ -355,7 +355,7 @@ export declare class PartnerTagsApi extends BaseAPI {
355
355
  */
356
356
  getTag(requestParameters: PartnerTagsApiGetTagRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetTagResponseClass, any>>;
357
357
  /**
358
- * 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.
358
+ * 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\"
359
359
  * @summary List partner tags
360
360
  * @param {PartnerTagsApiListTagsRequest} requestParameters Request parameters.
361
361
  * @param {*} [options] Override http request option.
@@ -364,7 +364,7 @@ export declare class PartnerTagsApi extends BaseAPI {
364
364
  */
365
365
  listTags(requestParameters?: PartnerTagsApiListTagsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListTagsResponseClass, any>>;
366
366
  /**
367
- * Updates the specified partner tag by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
367
+ * 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\"
368
368
  * @summary Update the partner tag
369
369
  * @param {PartnerTagsApiUpdateTagRequest} requestParameters Request parameters.
370
370
  * @param {*} [options] Override http request option.
@@ -93,7 +93,7 @@ var PartnerTagsApiAxiosParamCreator = function (configuration) {
93
93
  var _this = this;
94
94
  return {
95
95
  /**
96
- * 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.
96
+ * 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\"
97
97
  * @summary Create the partner tag
98
98
  * @param {CreateTagRequestDto} createTagRequestDto
99
99
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -142,9 +142,9 @@ var PartnerTagsApiAxiosParamCreator = function (configuration) {
142
142
  });
143
143
  },
144
144
  /**
145
- * Permanently deletes the partner tag. Supply the unique code that was returned when you created the partner tag and this will delete it.
145
+ * 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\"
146
146
  * @summary Delete the partner tag
147
- * @param {string} code
147
+ * @param {string} code Unique identifier for the object.
148
148
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
149
149
  * @param {*} [options] Override http request option.
150
150
  * @throws {RequiredError}
@@ -190,7 +190,7 @@ var PartnerTagsApiAxiosParamCreator = function (configuration) {
190
190
  });
191
191
  },
192
192
  /**
193
- * 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.
193
+ * 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\"
194
194
  * @summary Retrieve the partner tag
195
195
  * @param {string} code Unique identifier for the object.
196
196
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -238,7 +238,7 @@ var PartnerTagsApiAxiosParamCreator = function (configuration) {
238
238
  });
239
239
  },
240
240
  /**
241
- * 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.
241
+ * 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\"
242
242
  * @summary List partner tags
243
243
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
244
244
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
@@ -310,7 +310,7 @@ var PartnerTagsApiAxiosParamCreator = function (configuration) {
310
310
  });
311
311
  },
312
312
  /**
313
- * Updates the specified partner tag by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
313
+ * 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\"
314
314
  * @summary Update the partner tag
315
315
  * @param {string} code
316
316
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -368,7 +368,7 @@ var PartnerTagsApiFp = function (configuration) {
368
368
  var localVarAxiosParamCreator = (0, exports.PartnerTagsApiAxiosParamCreator)(configuration);
369
369
  return {
370
370
  /**
371
- * 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.
371
+ * 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\"
372
372
  * @summary Create the partner tag
373
373
  * @param {CreateTagRequestDto} createTagRequestDto
374
374
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -389,9 +389,9 @@ var PartnerTagsApiFp = function (configuration) {
389
389
  });
390
390
  },
391
391
  /**
392
- * Permanently deletes the partner tag. Supply the unique code that was returned when you created the partner tag and this will delete it.
392
+ * 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\"
393
393
  * @summary Delete the partner tag
394
- * @param {string} code
394
+ * @param {string} code Unique identifier for the object.
395
395
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
396
396
  * @param {*} [options] Override http request option.
397
397
  * @throws {RequiredError}
@@ -410,7 +410,7 @@ var PartnerTagsApiFp = function (configuration) {
410
410
  });
411
411
  },
412
412
  /**
413
- * 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.
413
+ * 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\"
414
414
  * @summary Retrieve the partner tag
415
415
  * @param {string} code Unique identifier for the object.
416
416
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -431,7 +431,7 @@ var PartnerTagsApiFp = function (configuration) {
431
431
  });
432
432
  },
433
433
  /**
434
- * 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.
434
+ * 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\"
435
435
  * @summary List partner tags
436
436
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
437
437
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
@@ -458,7 +458,7 @@ var PartnerTagsApiFp = function (configuration) {
458
458
  });
459
459
  },
460
460
  /**
461
- * Updates the specified partner tag by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
461
+ * 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\"
462
462
  * @summary Update the partner tag
463
463
  * @param {string} code
464
464
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -489,7 +489,7 @@ var PartnerTagsApiFactory = function (configuration, basePath, axios) {
489
489
  var localVarFp = (0, exports.PartnerTagsApiFp)(configuration);
490
490
  return {
491
491
  /**
492
- * 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.
492
+ * 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\"
493
493
  * @summary Create the partner tag
494
494
  * @param {CreateTagRequestDto} createTagRequestDto
495
495
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -500,9 +500,9 @@ var PartnerTagsApiFactory = function (configuration, basePath, axios) {
500
500
  return localVarFp.createTag(createTagRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
501
501
  },
502
502
  /**
503
- * Permanently deletes the partner tag. Supply the unique code that was returned when you created the partner tag and this will delete it.
503
+ * 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\"
504
504
  * @summary Delete the partner tag
505
- * @param {string} code
505
+ * @param {string} code Unique identifier for the object.
506
506
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
507
507
  * @param {*} [options] Override http request option.
508
508
  * @throws {RequiredError}
@@ -511,7 +511,7 @@ var PartnerTagsApiFactory = function (configuration, basePath, axios) {
511
511
  return localVarFp.deleteTag(code, authorization, options).then(function (request) { return request(axios, basePath); });
512
512
  },
513
513
  /**
514
- * 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.
514
+ * 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\"
515
515
  * @summary Retrieve the partner tag
516
516
  * @param {string} code Unique identifier for the object.
517
517
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -522,7 +522,7 @@ var PartnerTagsApiFactory = function (configuration, basePath, axios) {
522
522
  return localVarFp.getTag(code, authorization, options).then(function (request) { return request(axios, basePath); });
523
523
  },
524
524
  /**
525
- * 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.
525
+ * 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\"
526
526
  * @summary List partner tags
527
527
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
528
528
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
@@ -539,7 +539,7 @@ var PartnerTagsApiFactory = function (configuration, basePath, axios) {
539
539
  return localVarFp.listTags(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
540
540
  },
541
541
  /**
542
- * Updates the specified partner tag by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
542
+ * 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\"
543
543
  * @summary Update the partner tag
544
544
  * @param {string} code
545
545
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -564,7 +564,7 @@ var PartnerTagsApi = /** @class */ (function (_super) {
564
564
  return _super !== null && _super.apply(this, arguments) || this;
565
565
  }
566
566
  /**
567
- * 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.
567
+ * 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\"
568
568
  * @summary Create the partner tag
569
569
  * @param {PartnerTagsApiCreateTagRequest} requestParameters Request parameters.
570
570
  * @param {*} [options] Override http request option.
@@ -576,7 +576,7 @@ var PartnerTagsApi = /** @class */ (function (_super) {
576
576
  return (0, exports.PartnerTagsApiFp)(this.configuration).createTag(requestParameters.createTagRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
577
577
  };
578
578
  /**
579
- * Permanently deletes the partner tag. Supply the unique code that was returned when you created the partner tag and this will delete it.
579
+ * 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\"
580
580
  * @summary Delete the partner tag
581
581
  * @param {PartnerTagsApiDeleteTagRequest} requestParameters Request parameters.
582
582
  * @param {*} [options] Override http request option.
@@ -588,7 +588,7 @@ var PartnerTagsApi = /** @class */ (function (_super) {
588
588
  return (0, exports.PartnerTagsApiFp)(this.configuration).deleteTag(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
589
589
  };
590
590
  /**
591
- * 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.
591
+ * 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\"
592
592
  * @summary Retrieve the partner tag
593
593
  * @param {PartnerTagsApiGetTagRequest} requestParameters Request parameters.
594
594
  * @param {*} [options] Override http request option.
@@ -600,7 +600,7 @@ var PartnerTagsApi = /** @class */ (function (_super) {
600
600
  return (0, exports.PartnerTagsApiFp)(this.configuration).getTag(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
601
601
  };
602
602
  /**
603
- * 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.
603
+ * 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\"
604
604
  * @summary List partner tags
605
605
  * @param {PartnerTagsApiListTagsRequest} requestParameters Request parameters.
606
606
  * @param {*} [options] Override http request option.
@@ -613,7 +613,7 @@ var PartnerTagsApi = /** @class */ (function (_super) {
613
613
  return (0, exports.PartnerTagsApiFp)(this.configuration).listTags(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then(function (request) { return request(_this.axios, _this.basePath); });
614
614
  };
615
615
  /**
616
- * Updates the specified partner tag by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
616
+ * 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\"
617
617
  * @summary Update the partner tag
618
618
  * @param {PartnerTagsApiUpdateTagRequest} requestParameters Request parameters.
619
619
  * @param {*} [options] Override http request option.
@@ -25,7 +25,7 @@ import { UpdatePartnerTypeResponseClass } from '../models';
25
25
  */
26
26
  export declare const PartnerTypesApiAxiosParamCreator: (configuration?: Configuration) => {
27
27
  /**
28
- * This will create a partner type.
28
+ * This will create a partner type. **Required Permissions** \"partner-management.partners.create\"
29
29
  * @summary Create the partner-types
30
30
  * @param {CreatePartnerTypeRequestDto} createPartnerTypeRequestDto
31
31
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -34,7 +34,7 @@ export declare const PartnerTypesApiAxiosParamCreator: (configuration?: Configur
34
34
  */
35
35
  createPartnerType: (createPartnerTypeRequestDto: CreatePartnerTypeRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
36
36
  /**
37
- * Permanently deletes the partner-types. Supply the unique code that was returned when you created the partner-types and this will delete it.
37
+ * Permanently deletes the partner-types. Supply the unique code that was returned when you created the partner-types and this will delete it. **Required Permissions** \"partner-management.partners.delete\"
38
38
  * @summary Delete the partner-types
39
39
  * @param {string} code
40
40
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -43,7 +43,7 @@ export declare const PartnerTypesApiAxiosParamCreator: (configuration?: Configur
43
43
  */
44
44
  deletePartnerType: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
45
45
  /**
46
- * Retrieves the details of the partner-types that was previously created. Supply the unique partner-types code that was returned when you created it and Emil Api will return the corresponding partner-types information.
46
+ * Retrieves the details of the partner-types that was previously created. Supply the unique partner-types code that was returned when you created it and Emil Api will return the corresponding partner-types information. **Required Permissions** \"partner-management.partners.view\"
47
47
  * @summary Retrieve the partner-types
48
48
  * @param {string} code Unique identifier for the object.
49
49
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -53,7 +53,7 @@ export declare const PartnerTypesApiAxiosParamCreator: (configuration?: Configur
53
53
  */
54
54
  getPartnerType: (code: string, authorization?: string, expand?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
55
55
  /**
56
- * Returns a list of partner-types you have previously created. The partner-types are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
56
+ * Returns a list of partner-types you have previously created. The partner-types 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\"
57
57
  * @summary List partner-types
58
58
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
59
59
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
@@ -68,7 +68,7 @@ export declare const PartnerTypesApiAxiosParamCreator: (configuration?: Configur
68
68
  */
69
69
  listPartnerTypes: (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
70
70
  /**
71
- * Updates the specified partner-types by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
71
+ * Updates the specified partner-types by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"partner-management.partners.update\"
72
72
  * @summary Update the partner-types
73
73
  * @param {string} code Unique identifier for the object.
74
74
  * @param {UpdatePartnerTypeRequestDto} updatePartnerTypeRequestDto
@@ -84,7 +84,7 @@ export declare const PartnerTypesApiAxiosParamCreator: (configuration?: Configur
84
84
  */
85
85
  export declare const PartnerTypesApiFp: (configuration?: Configuration) => {
86
86
  /**
87
- * This will create a partner type.
87
+ * This will create a partner type. **Required Permissions** \"partner-management.partners.create\"
88
88
  * @summary Create the partner-types
89
89
  * @param {CreatePartnerTypeRequestDto} createPartnerTypeRequestDto
90
90
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -93,7 +93,7 @@ export declare const PartnerTypesApiFp: (configuration?: Configuration) => {
93
93
  */
94
94
  createPartnerType(createPartnerTypeRequestDto: CreatePartnerTypeRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePartnerTypeResponseClass>>;
95
95
  /**
96
- * Permanently deletes the partner-types. Supply the unique code that was returned when you created the partner-types and this will delete it.
96
+ * Permanently deletes the partner-types. Supply the unique code that was returned when you created the partner-types and this will delete it. **Required Permissions** \"partner-management.partners.delete\"
97
97
  * @summary Delete the partner-types
98
98
  * @param {string} code
99
99
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -102,7 +102,7 @@ export declare const PartnerTypesApiFp: (configuration?: Configuration) => {
102
102
  */
103
103
  deletePartnerType(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponseClass>>;
104
104
  /**
105
- * Retrieves the details of the partner-types that was previously created. Supply the unique partner-types code that was returned when you created it and Emil Api will return the corresponding partner-types information.
105
+ * Retrieves the details of the partner-types that was previously created. Supply the unique partner-types code that was returned when you created it and Emil Api will return the corresponding partner-types information. **Required Permissions** \"partner-management.partners.view\"
106
106
  * @summary Retrieve the partner-types
107
107
  * @param {string} code Unique identifier for the object.
108
108
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -112,7 +112,7 @@ export declare const PartnerTypesApiFp: (configuration?: Configuration) => {
112
112
  */
113
113
  getPartnerType(code: string, authorization?: string, expand?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPartnerTypeResponseClass>>;
114
114
  /**
115
- * Returns a list of partner-types you have previously created. The partner-types are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
115
+ * Returns a list of partner-types you have previously created. The partner-types 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\"
116
116
  * @summary List partner-types
117
117
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
118
118
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
@@ -127,7 +127,7 @@ export declare const PartnerTypesApiFp: (configuration?: Configuration) => {
127
127
  */
128
128
  listPartnerTypes(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPartnerTypesResponseClass>>;
129
129
  /**
130
- * Updates the specified partner-types by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
130
+ * Updates the specified partner-types by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"partner-management.partners.update\"
131
131
  * @summary Update the partner-types
132
132
  * @param {string} code Unique identifier for the object.
133
133
  * @param {UpdatePartnerTypeRequestDto} updatePartnerTypeRequestDto
@@ -143,7 +143,7 @@ export declare const PartnerTypesApiFp: (configuration?: Configuration) => {
143
143
  */
144
144
  export declare const PartnerTypesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
145
145
  /**
146
- * This will create a partner type.
146
+ * This will create a partner type. **Required Permissions** \"partner-management.partners.create\"
147
147
  * @summary Create the partner-types
148
148
  * @param {CreatePartnerTypeRequestDto} createPartnerTypeRequestDto
149
149
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -152,7 +152,7 @@ export declare const PartnerTypesApiFactory: (configuration?: Configuration, bas
152
152
  */
153
153
  createPartnerType(createPartnerTypeRequestDto: CreatePartnerTypeRequestDto, authorization?: string, options?: any): AxiosPromise<CreatePartnerTypeResponseClass>;
154
154
  /**
155
- * Permanently deletes the partner-types. Supply the unique code that was returned when you created the partner-types and this will delete it.
155
+ * Permanently deletes the partner-types. Supply the unique code that was returned when you created the partner-types and this will delete it. **Required Permissions** \"partner-management.partners.delete\"
156
156
  * @summary Delete the partner-types
157
157
  * @param {string} code
158
158
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -161,7 +161,7 @@ export declare const PartnerTypesApiFactory: (configuration?: Configuration, bas
161
161
  */
162
162
  deletePartnerType(code: string, authorization?: string, options?: any): AxiosPromise<DeleteResponseClass>;
163
163
  /**
164
- * Retrieves the details of the partner-types that was previously created. Supply the unique partner-types code that was returned when you created it and Emil Api will return the corresponding partner-types information.
164
+ * Retrieves the details of the partner-types that was previously created. Supply the unique partner-types code that was returned when you created it and Emil Api will return the corresponding partner-types information. **Required Permissions** \"partner-management.partners.view\"
165
165
  * @summary Retrieve the partner-types
166
166
  * @param {string} code Unique identifier for the object.
167
167
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -171,7 +171,7 @@ export declare const PartnerTypesApiFactory: (configuration?: Configuration, bas
171
171
  */
172
172
  getPartnerType(code: string, authorization?: string, expand?: any, options?: any): AxiosPromise<GetPartnerTypeResponseClass>;
173
173
  /**
174
- * Returns a list of partner-types you have previously created. The partner-types are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
174
+ * Returns a list of partner-types you have previously created. The partner-types 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\"
175
175
  * @summary List partner-types
176
176
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
177
177
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
@@ -186,7 +186,7 @@ export declare const PartnerTypesApiFactory: (configuration?: Configuration, bas
186
186
  */
187
187
  listPartnerTypes(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: any): AxiosPromise<ListPartnerTypesResponseClass>;
188
188
  /**
189
- * Updates the specified partner-types by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
189
+ * Updates the specified partner-types by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"partner-management.partners.update\"
190
190
  * @summary Update the partner-types
191
191
  * @param {string} code Unique identifier for the object.
192
192
  * @param {UpdatePartnerTypeRequestDto} updatePartnerTypeRequestDto
@@ -347,7 +347,7 @@ export interface PartnerTypesApiUpdatePartnerTypeRequest {
347
347
  */
348
348
  export declare class PartnerTypesApi extends BaseAPI {
349
349
  /**
350
- * This will create a partner type.
350
+ * This will create a partner type. **Required Permissions** \"partner-management.partners.create\"
351
351
  * @summary Create the partner-types
352
352
  * @param {PartnerTypesApiCreatePartnerTypeRequest} requestParameters Request parameters.
353
353
  * @param {*} [options] Override http request option.
@@ -356,7 +356,7 @@ export declare class PartnerTypesApi extends BaseAPI {
356
356
  */
357
357
  createPartnerType(requestParameters: PartnerTypesApiCreatePartnerTypeRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePartnerTypeResponseClass, any>>;
358
358
  /**
359
- * Permanently deletes the partner-types. Supply the unique code that was returned when you created the partner-types and this will delete it.
359
+ * Permanently deletes the partner-types. Supply the unique code that was returned when you created the partner-types and this will delete it. **Required Permissions** \"partner-management.partners.delete\"
360
360
  * @summary Delete the partner-types
361
361
  * @param {PartnerTypesApiDeletePartnerTypeRequest} requestParameters Request parameters.
362
362
  * @param {*} [options] Override http request option.
@@ -365,7 +365,7 @@ export declare class PartnerTypesApi extends BaseAPI {
365
365
  */
366
366
  deletePartnerType(requestParameters: PartnerTypesApiDeletePartnerTypeRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteResponseClass, any>>;
367
367
  /**
368
- * Retrieves the details of the partner-types that was previously created. Supply the unique partner-types code that was returned when you created it and Emil Api will return the corresponding partner-types information.
368
+ * Retrieves the details of the partner-types that was previously created. Supply the unique partner-types code that was returned when you created it and Emil Api will return the corresponding partner-types information. **Required Permissions** \"partner-management.partners.view\"
369
369
  * @summary Retrieve the partner-types
370
370
  * @param {PartnerTypesApiGetPartnerTypeRequest} requestParameters Request parameters.
371
371
  * @param {*} [options] Override http request option.
@@ -374,7 +374,7 @@ export declare class PartnerTypesApi extends BaseAPI {
374
374
  */
375
375
  getPartnerType(requestParameters: PartnerTypesApiGetPartnerTypeRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPartnerTypeResponseClass, any>>;
376
376
  /**
377
- * Returns a list of partner-types you have previously created. The partner-types are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
377
+ * Returns a list of partner-types you have previously created. The partner-types 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\"
378
378
  * @summary List partner-types
379
379
  * @param {PartnerTypesApiListPartnerTypesRequest} requestParameters Request parameters.
380
380
  * @param {*} [options] Override http request option.
@@ -383,7 +383,7 @@ export declare class PartnerTypesApi extends BaseAPI {
383
383
  */
384
384
  listPartnerTypes(requestParameters?: PartnerTypesApiListPartnerTypesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPartnerTypesResponseClass, any>>;
385
385
  /**
386
- * Updates the specified partner-types by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
386
+ * Updates the specified partner-types by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"partner-management.partners.update\"
387
387
  * @summary Update the partner-types
388
388
  * @param {PartnerTypesApiUpdatePartnerTypeRequest} requestParameters Request parameters.
389
389
  * @param {*} [options] Override http request option.