@emilgroup/partner-sdk 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.
@@ -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,13 +238,13 @@ 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
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
245
- * @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.
244
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
245
+ * @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.
246
246
  * @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>
247
- * @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
247
+ * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
248
248
  * @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>
249
249
  * @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/>
250
250
  * @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>
@@ -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,13 +431,13 @@ 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
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
438
- * @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.
437
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
438
+ * @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.
439
439
  * @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>
440
- * @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
440
+ * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
441
441
  * @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>
442
442
  * @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/>
443
443
  * @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>
@@ -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,13 +522,13 @@ 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
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
529
- * @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.
528
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
529
+ * @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.
530
530
  * @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>
531
- * @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
531
+ * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
532
532
  * @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>
533
533
  * @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/>
534
534
  * @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>
@@ -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,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.