@emilgroup/partner-sdk-node 1.13.1-beta.2 → 1.13.1-beta.3

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.
@@ -97,7 +97,7 @@ var PartnerTagsApiAxiosParamCreator = function (configuration) {
97
97
  var _this = this;
98
98
  return {
99
99
  /**
100
- * 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.
100
+ * 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\"
101
101
  * @summary Create the partner tag
102
102
  * @param {CreateTagRequestDto} createTagRequestDto
103
103
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -146,9 +146,9 @@ var PartnerTagsApiAxiosParamCreator = function (configuration) {
146
146
  });
147
147
  },
148
148
  /**
149
- * Permanently deletes the partner tag. Supply the unique code that was returned when you created the partner tag and this will delete it.
149
+ * 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\"
150
150
  * @summary Delete the partner tag
151
- * @param {string} code
151
+ * @param {string} code Unique identifier for the object.
152
152
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
153
153
  * @param {*} [options] Override http request option.
154
154
  * @throws {RequiredError}
@@ -194,7 +194,7 @@ var PartnerTagsApiAxiosParamCreator = function (configuration) {
194
194
  });
195
195
  },
196
196
  /**
197
- * 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.
197
+ * 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\"
198
198
  * @summary Retrieve the partner tag
199
199
  * @param {string} code Unique identifier for the object.
200
200
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -242,13 +242,13 @@ var PartnerTagsApiAxiosParamCreator = function (configuration) {
242
242
  });
243
243
  },
244
244
  /**
245
- * 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.
245
+ * 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\"
246
246
  * @summary List partner tags
247
247
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
248
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
249
- * @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
248
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
249
+ * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
250
250
  * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, slug, label</i>
251
- * @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
251
+ * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
252
252
  * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: code, slug, label, createdAt, updatedAt</i>
253
253
  * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
254
254
  * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, slug, label</i>
@@ -314,7 +314,7 @@ var PartnerTagsApiAxiosParamCreator = function (configuration) {
314
314
  });
315
315
  },
316
316
  /**
317
- * Updates the specified partner tag by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
317
+ * 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\"
318
318
  * @summary Update the partner tag
319
319
  * @param {string} code
320
320
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -372,7 +372,7 @@ var PartnerTagsApiFp = function (configuration) {
372
372
  var localVarAxiosParamCreator = (0, exports.PartnerTagsApiAxiosParamCreator)(configuration);
373
373
  return {
374
374
  /**
375
- * 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.
375
+ * 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\"
376
376
  * @summary Create the partner tag
377
377
  * @param {CreateTagRequestDto} createTagRequestDto
378
378
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -393,9 +393,9 @@ var PartnerTagsApiFp = function (configuration) {
393
393
  });
394
394
  },
395
395
  /**
396
- * Permanently deletes the partner tag. Supply the unique code that was returned when you created the partner tag and this will delete it.
396
+ * 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\"
397
397
  * @summary Delete the partner tag
398
- * @param {string} code
398
+ * @param {string} code Unique identifier for the object.
399
399
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
400
400
  * @param {*} [options] Override http request option.
401
401
  * @throws {RequiredError}
@@ -414,7 +414,7 @@ var PartnerTagsApiFp = function (configuration) {
414
414
  });
415
415
  },
416
416
  /**
417
- * 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.
417
+ * 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\"
418
418
  * @summary Retrieve the partner tag
419
419
  * @param {string} code Unique identifier for the object.
420
420
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -435,13 +435,13 @@ var PartnerTagsApiFp = function (configuration) {
435
435
  });
436
436
  },
437
437
  /**
438
- * 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.
438
+ * 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\"
439
439
  * @summary List partner tags
440
440
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
441
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
442
- * @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
441
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
442
+ * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
443
443
  * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, slug, label</i>
444
- * @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
444
+ * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
445
445
  * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: code, slug, label, createdAt, updatedAt</i>
446
446
  * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
447
447
  * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, slug, label</i>
@@ -462,7 +462,7 @@ var PartnerTagsApiFp = function (configuration) {
462
462
  });
463
463
  },
464
464
  /**
465
- * Updates the specified partner tag by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
465
+ * 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\"
466
466
  * @summary Update the partner tag
467
467
  * @param {string} code
468
468
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -493,7 +493,7 @@ var PartnerTagsApiFactory = function (configuration, basePath, axios) {
493
493
  var localVarFp = (0, exports.PartnerTagsApiFp)(configuration);
494
494
  return {
495
495
  /**
496
- * 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.
496
+ * 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\"
497
497
  * @summary Create the partner tag
498
498
  * @param {CreateTagRequestDto} createTagRequestDto
499
499
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -504,9 +504,9 @@ var PartnerTagsApiFactory = function (configuration, basePath, axios) {
504
504
  return localVarFp.createTag(createTagRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
505
505
  },
506
506
  /**
507
- * Permanently deletes the partner tag. Supply the unique code that was returned when you created the partner tag and this will delete it.
507
+ * 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\"
508
508
  * @summary Delete the partner tag
509
- * @param {string} code
509
+ * @param {string} code Unique identifier for the object.
510
510
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
511
511
  * @param {*} [options] Override http request option.
512
512
  * @throws {RequiredError}
@@ -515,7 +515,7 @@ var PartnerTagsApiFactory = function (configuration, basePath, axios) {
515
515
  return localVarFp.deleteTag(code, authorization, options).then(function (request) { return request(axios, basePath); });
516
516
  },
517
517
  /**
518
- * 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.
518
+ * 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\"
519
519
  * @summary Retrieve the partner tag
520
520
  * @param {string} code Unique identifier for the object.
521
521
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -526,13 +526,13 @@ var PartnerTagsApiFactory = function (configuration, basePath, axios) {
526
526
  return localVarFp.getTag(code, authorization, options).then(function (request) { return request(axios, basePath); });
527
527
  },
528
528
  /**
529
- * 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.
529
+ * 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\"
530
530
  * @summary List partner tags
531
531
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
532
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
533
- * @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
532
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
533
+ * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
534
534
  * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, slug, label</i>
535
- * @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
535
+ * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
536
536
  * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: code, slug, label, createdAt, updatedAt</i>
537
537
  * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
538
538
  * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, slug, label</i>
@@ -543,7 +543,7 @@ var PartnerTagsApiFactory = function (configuration, basePath, axios) {
543
543
  return localVarFp.listTags(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
544
544
  },
545
545
  /**
546
- * Updates the specified partner tag by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
546
+ * 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\"
547
547
  * @summary Update the partner tag
548
548
  * @param {string} code
549
549
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -568,7 +568,7 @@ var PartnerTagsApi = /** @class */ (function (_super) {
568
568
  return _super !== null && _super.apply(this, arguments) || this;
569
569
  }
570
570
  /**
571
- * 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.
571
+ * 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\"
572
572
  * @summary Create the partner tag
573
573
  * @param {PartnerTagsApiCreateTagRequest} requestParameters Request parameters.
574
574
  * @param {*} [options] Override http request option.
@@ -580,7 +580,7 @@ var PartnerTagsApi = /** @class */ (function (_super) {
580
580
  return (0, exports.PartnerTagsApiFp)(this.configuration).createTag(requestParameters.createTagRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
581
581
  };
582
582
  /**
583
- * Permanently deletes the partner tag. Supply the unique code that was returned when you created the partner tag and this will delete it.
583
+ * 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\"
584
584
  * @summary Delete the partner tag
585
585
  * @param {PartnerTagsApiDeleteTagRequest} requestParameters Request parameters.
586
586
  * @param {*} [options] Override http request option.
@@ -592,7 +592,7 @@ var PartnerTagsApi = /** @class */ (function (_super) {
592
592
  return (0, exports.PartnerTagsApiFp)(this.configuration).deleteTag(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
593
593
  };
594
594
  /**
595
- * 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.
595
+ * 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\"
596
596
  * @summary Retrieve the partner tag
597
597
  * @param {PartnerTagsApiGetTagRequest} requestParameters Request parameters.
598
598
  * @param {*} [options] Override http request option.
@@ -604,7 +604,7 @@ var PartnerTagsApi = /** @class */ (function (_super) {
604
604
  return (0, exports.PartnerTagsApiFp)(this.configuration).getTag(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
605
605
  };
606
606
  /**
607
- * 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.
607
+ * 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\"
608
608
  * @summary List partner tags
609
609
  * @param {PartnerTagsApiListTagsRequest} requestParameters Request parameters.
610
610
  * @param {*} [options] Override http request option.
@@ -617,7 +617,7 @@ var PartnerTagsApi = /** @class */ (function (_super) {
617
617
  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); });
618
618
  };
619
619
  /**
620
- * Updates the specified partner tag by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
620
+ * 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\"
621
621
  * @summary Update the partner tag
622
622
  * @param {PartnerTagsApiUpdateTagRequest} requestParameters Request parameters.
623
623
  * @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,22 +53,22 @@ 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
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
60
- * @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
61
- * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
62
- * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
63
- * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
64
- * @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
65
- * @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
59
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
60
+ * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
61
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
62
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
63
+ * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
64
+ * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
65
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
66
66
  * @param {*} [options] Override http request option.
67
67
  * @throws {RequiredError}
68
68
  */
69
- listPartnerTypes: (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
69
+ listPartnerTypes: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, 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,22 +112,22 @@ 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
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
119
- * @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
120
- * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
121
- * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
122
- * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
123
- * @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
124
- * @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
118
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
119
+ * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
120
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
121
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
122
+ * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
123
+ * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
124
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
125
125
  * @param {*} [options] Override http request option.
126
126
  * @throws {RequiredError}
127
127
  */
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>>;
128
+ listPartnerTypes(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, 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,22 +171,22 @@ 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
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
178
- * @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
179
- * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
180
- * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
181
- * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
182
- * @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
183
- * @param {any} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
177
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
178
+ * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
179
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
180
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
181
+ * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
182
+ * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
183
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
184
184
  * @param {*} [options] Override http request option.
185
185
  * @throws {RequiredError}
186
186
  */
187
- listPartnerTypes(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: any): AxiosPromise<ListPartnerTypesResponseClass>;
187
+ listPartnerTypes(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, 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
@@ -273,46 +273,46 @@ export interface PartnerTypesApiListPartnerTypesRequest {
273
273
  readonly authorization?: string;
274
274
  /**
275
275
  * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
276
- * @type {any}
276
+ * @type {number}
277
277
  * @memberof PartnerTypesApiListPartnerTypes
278
278
  */
279
- readonly pageSize?: any;
279
+ readonly pageSize?: number;
280
280
  /**
281
- * A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
282
- * @type {any}
281
+ * A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
282
+ * @type {string}
283
283
  * @memberof PartnerTypesApiListPartnerTypes
284
284
  */
285
- readonly pageToken?: any;
285
+ readonly pageToken?: string;
286
286
  /**
287
287
  * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
288
- * @type {any}
288
+ * @type {string}
289
289
  * @memberof PartnerTypesApiListPartnerTypes
290
290
  */
291
- readonly filter?: any;
291
+ readonly filter?: string;
292
292
  /**
293
293
  * To search the list by any field, pass search&#x3D;xxx to fetch the result.
294
- * @type {any}
294
+ * @type {string}
295
295
  * @memberof PartnerTypesApiListPartnerTypes
296
296
  */
297
- readonly search?: any;
297
+ readonly search?: string;
298
298
  /**
299
299
  * The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
300
- * @type {any}
300
+ * @type {string}
301
301
  * @memberof PartnerTypesApiListPartnerTypes
302
302
  */
303
- readonly order?: any;
303
+ readonly order?: string;
304
304
  /**
305
- * Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
306
- * @type {any}
305
+ * Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
306
+ * @type {string}
307
307
  * @memberof PartnerTypesApiListPartnerTypes
308
308
  */
309
- readonly expand?: any;
309
+ readonly expand?: string;
310
310
  /**
311
311
  * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
312
- * @type {any}
312
+ * @type {string}
313
313
  * @memberof PartnerTypesApiListPartnerTypes
314
314
  */
315
- readonly filters?: any;
315
+ readonly filters?: string;
316
316
  }
317
317
  /**
318
318
  * Request parameters for updatePartnerType operation in PartnerTypesApi.
@@ -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.