@emilgroup/commission-sdk-node 1.0.0-beta.9 → 2.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (170) hide show
  1. package/.openapi-generator/FILES +40 -0
  2. package/README.md +2 -2
  3. package/api/commission-agreement-products-api.ts +59 -17
  4. package/api/commission-agreement-rules-api.ts +804 -0
  5. package/api/commission-agreement-versions-api.ts +8 -8
  6. package/api/commission-agreements-api.ts +160 -27
  7. package/api/commission-candidates-api.ts +697 -0
  8. package/api/commission-recipients-api.ts +12 -12
  9. package/api/commission-settlements-api.ts +804 -0
  10. package/api/commissions-api.ts +125 -18
  11. package/api.ts +6 -0
  12. package/dist/api/commission-agreement-products-api.d.ts +39 -12
  13. package/dist/api/commission-agreement-products-api.js +32 -14
  14. package/dist/api/commission-agreement-rules-api.d.ts +450 -0
  15. package/dist/api/commission-agreement-rules-api.js +741 -0
  16. package/dist/api/commission-agreement-versions-api.d.ts +8 -8
  17. package/dist/api/commission-agreement-versions-api.js +6 -6
  18. package/dist/api/commission-agreements-api.d.ts +98 -23
  19. package/dist/api/commission-agreements-api.js +127 -22
  20. package/dist/api/commission-candidates-api.d.ts +393 -0
  21. package/dist/api/commission-candidates-api.js +648 -0
  22. package/dist/api/commission-recipients-api.d.ts +12 -12
  23. package/dist/api/commission-recipients-api.js +9 -9
  24. package/dist/api/commission-settlements-api.d.ts +450 -0
  25. package/dist/api/commission-settlements-api.js +741 -0
  26. package/dist/api/commissions-api.d.ts +75 -18
  27. package/dist/api/commissions-api.js +102 -9
  28. package/dist/api.d.ts +3 -0
  29. package/dist/api.js +3 -0
  30. package/dist/models/commission-agreement-class.d.ts +27 -3
  31. package/dist/models/commission-agreement-class.js +5 -1
  32. package/dist/models/commission-agreement-metadata-dto.d.ts +25 -0
  33. package/dist/models/commission-agreement-metadata-dto.js +15 -0
  34. package/dist/models/commission-agreement-metadata-partner-dto.d.ts +30 -0
  35. package/dist/models/commission-agreement-metadata-partner-dto.js +15 -0
  36. package/dist/models/commission-agreement-product-class.d.ts +6 -7
  37. package/dist/models/commission-agreement-rule-class.d.ts +99 -0
  38. package/dist/models/commission-agreement-rule-class.js +21 -0
  39. package/dist/models/commission-agreement-rule-config-dto.d.ts +25 -0
  40. package/dist/models/commission-agreement-rule-config-dto.js +15 -0
  41. package/dist/models/commission-agreement-rule-evaluation-class.d.ts +31 -0
  42. package/dist/models/commission-agreement-rule-evaluation-class.js +15 -0
  43. package/dist/models/commission-agreement-version-class.d.ts +7 -0
  44. package/dist/models/commission-candidate-class.d.ts +95 -0
  45. package/dist/models/commission-candidate-class.js +20 -0
  46. package/dist/models/commission-class.d.ts +37 -6
  47. package/dist/models/commission-conditions-dto.d.ts +24 -0
  48. package/dist/models/commission-conditions-dto.js +15 -0
  49. package/dist/models/commission-config-dto.d.ts +63 -0
  50. package/dist/models/commission-config-dto.js +34 -0
  51. package/dist/models/commission-estimate-class.d.ts +59 -0
  52. package/dist/models/commission-estimate-class.js +25 -0
  53. package/dist/models/commission-recipient-class.d.ts +6 -6
  54. package/dist/models/commission-settlement-class.d.ts +124 -0
  55. package/dist/models/commission-settlement-class.js +35 -0
  56. package/dist/models/create-commission-agreement-request-dto.d.ts +14 -3
  57. package/dist/models/create-commission-agreement-request-dto.js +5 -1
  58. package/dist/models/create-commission-agreement-rule-request-dto.d.ts +37 -0
  59. package/dist/models/create-commission-agreement-rule-request-dto.js +15 -0
  60. package/dist/models/create-commission-agreement-rule-response-class.d.ts +25 -0
  61. package/dist/models/create-commission-agreement-rule-response-class.js +15 -0
  62. package/dist/models/create-commission-agreement-version-request-dto.d.ts +1 -1
  63. package/dist/models/create-commission-candidate-request-dto.d.ts +65 -0
  64. package/dist/models/create-commission-candidate-request-dto.js +25 -0
  65. package/dist/models/create-commission-candidate-response-class.d.ts +25 -0
  66. package/dist/models/create-commission-candidate-response-class.js +15 -0
  67. package/dist/models/create-commission-recipient-request-dto.d.ts +2 -2
  68. package/dist/models/create-commission-request-dto.d.ts +3 -9
  69. package/dist/models/create-commission-settlement-request-dto.d.ts +57 -0
  70. package/dist/models/create-commission-settlement-request-dto.js +35 -0
  71. package/dist/models/create-commission-settlement-response-class.d.ts +25 -0
  72. package/dist/models/create-commission-settlement-response-class.js +15 -0
  73. package/dist/models/estimate-commissions-request-dto.d.ts +30 -0
  74. package/dist/models/estimate-commissions-request-dto.js +15 -0
  75. package/dist/models/estimate-commissions-response-class.d.ts +73 -0
  76. package/dist/models/estimate-commissions-response-class.js +15 -0
  77. package/dist/models/evaluate-commission-agreement-rule-request-dto.d.ts +31 -0
  78. package/dist/models/evaluate-commission-agreement-rule-request-dto.js +15 -0
  79. package/dist/models/evaluate-commission-agreement-rule-response-class.d.ts +25 -0
  80. package/dist/models/evaluate-commission-agreement-rule-response-class.js +15 -0
  81. package/dist/models/evaluated-commission-class.d.ts +54 -0
  82. package/dist/models/evaluated-commission-class.js +21 -0
  83. package/dist/models/get-commission-agreement-rule-response-class.d.ts +25 -0
  84. package/dist/models/get-commission-agreement-rule-response-class.js +15 -0
  85. package/dist/models/get-commission-candidate-response-class.d.ts +25 -0
  86. package/dist/models/get-commission-candidate-response-class.js +15 -0
  87. package/dist/models/get-commission-settlement-response-class.d.ts +25 -0
  88. package/dist/models/get-commission-settlement-response-class.js +15 -0
  89. package/dist/models/index.d.ts +37 -0
  90. package/dist/models/index.js +37 -0
  91. package/dist/models/list-commission-agreement-rules-response-class.d.ts +43 -0
  92. package/dist/models/list-commission-agreement-rules-response-class.js +15 -0
  93. package/dist/models/list-commission-candidates-response-class.d.ts +43 -0
  94. package/dist/models/list-commission-candidates-response-class.js +15 -0
  95. package/dist/models/list-commission-settlements-response-class.d.ts +43 -0
  96. package/dist/models/list-commission-settlements-response-class.js +15 -0
  97. package/dist/models/patch-commission-agreement-status-request-dto.d.ts +37 -0
  98. package/dist/models/patch-commission-agreement-status-request-dto.js +22 -0
  99. package/dist/models/patch-commission-agreement-status-response-class.d.ts +25 -0
  100. package/dist/models/patch-commission-agreement-status-response-class.js +15 -0
  101. package/dist/models/publish-commission-settlements-request-dto.d.ts +24 -0
  102. package/dist/models/publish-commission-settlements-request-dto.js +15 -0
  103. package/dist/models/publish-commission-settlements-response-class.d.ts +25 -0
  104. package/dist/models/publish-commission-settlements-response-class.js +15 -0
  105. package/dist/models/update-commission-agreement-request-dto.d.ts +3 -1
  106. package/dist/models/update-commission-agreement-request-dto.js +2 -0
  107. package/dist/models/update-commission-agreement-rule-request-dto.d.ts +49 -0
  108. package/dist/models/update-commission-agreement-rule-request-dto.js +21 -0
  109. package/dist/models/update-commission-agreement-rule-response-class.d.ts +25 -0
  110. package/dist/models/update-commission-agreement-rule-response-class.js +15 -0
  111. package/dist/models/update-commission-candidate-request-dto.d.ts +71 -0
  112. package/dist/models/update-commission-candidate-request-dto.js +25 -0
  113. package/dist/models/update-commission-candidate-response-class.d.ts +25 -0
  114. package/dist/models/update-commission-candidate-response-class.js +15 -0
  115. package/dist/models/update-commission-request-dto.d.ts +5 -3
  116. package/dist/models/update-commission-request-dto.js +4 -2
  117. package/dist/models/update-commission-settlement-request-dto.d.ts +43 -0
  118. package/dist/models/update-commission-settlement-request-dto.js +22 -0
  119. package/dist/models/update-commission-settlement-response-class.d.ts +25 -0
  120. package/dist/models/update-commission-settlement-response-class.js +15 -0
  121. package/models/commission-agreement-class.ts +27 -3
  122. package/models/commission-agreement-metadata-dto.ts +31 -0
  123. package/models/commission-agreement-metadata-partner-dto.ts +36 -0
  124. package/models/commission-agreement-product-class.ts +6 -7
  125. package/models/commission-agreement-rule-class.ts +108 -0
  126. package/models/commission-agreement-rule-config-dto.ts +31 -0
  127. package/models/commission-agreement-rule-evaluation-class.ts +37 -0
  128. package/models/commission-agreement-version-class.ts +7 -0
  129. package/models/commission-candidate-class.ts +104 -0
  130. package/models/commission-class.ts +37 -6
  131. package/models/commission-conditions-dto.ts +30 -0
  132. package/models/commission-config-dto.ts +73 -0
  133. package/models/commission-estimate-class.ts +69 -0
  134. package/models/commission-recipient-class.ts +6 -6
  135. package/models/commission-settlement-class.ts +134 -0
  136. package/models/create-commission-agreement-request-dto.ts +14 -3
  137. package/models/create-commission-agreement-rule-request-dto.ts +43 -0
  138. package/models/create-commission-agreement-rule-response-class.ts +31 -0
  139. package/models/create-commission-agreement-version-request-dto.ts +1 -1
  140. package/models/create-commission-candidate-request-dto.ts +75 -0
  141. package/models/create-commission-candidate-response-class.ts +31 -0
  142. package/models/create-commission-recipient-request-dto.ts +2 -2
  143. package/models/create-commission-request-dto.ts +3 -9
  144. package/models/create-commission-settlement-request-dto.ts +67 -0
  145. package/models/create-commission-settlement-response-class.ts +31 -0
  146. package/models/estimate-commissions-request-dto.ts +36 -0
  147. package/models/estimate-commissions-response-class.ts +79 -0
  148. package/models/evaluate-commission-agreement-rule-request-dto.ts +37 -0
  149. package/models/evaluate-commission-agreement-rule-response-class.ts +31 -0
  150. package/models/evaluated-commission-class.ts +63 -0
  151. package/models/get-commission-agreement-rule-response-class.ts +31 -0
  152. package/models/get-commission-candidate-response-class.ts +31 -0
  153. package/models/get-commission-settlement-response-class.ts +31 -0
  154. package/models/index.ts +37 -0
  155. package/models/list-commission-agreement-rules-response-class.ts +49 -0
  156. package/models/list-commission-candidates-response-class.ts +49 -0
  157. package/models/list-commission-settlements-response-class.ts +49 -0
  158. package/models/patch-commission-agreement-status-request-dto.ts +46 -0
  159. package/models/patch-commission-agreement-status-response-class.ts +31 -0
  160. package/models/publish-commission-settlements-request-dto.ts +30 -0
  161. package/models/publish-commission-settlements-response-class.ts +31 -0
  162. package/models/update-commission-agreement-request-dto.ts +3 -1
  163. package/models/update-commission-agreement-rule-request-dto.ts +58 -0
  164. package/models/update-commission-agreement-rule-response-class.ts +31 -0
  165. package/models/update-commission-candidate-request-dto.ts +81 -0
  166. package/models/update-commission-candidate-response-class.ts +31 -0
  167. package/models/update-commission-request-dto.ts +5 -3
  168. package/models/update-commission-settlement-request-dto.ts +52 -0
  169. package/models/update-commission-settlement-response-class.ts +31 -0
  170. package/package.json +2 -2
@@ -0,0 +1,450 @@
1
+ /**
2
+ * EMIL CommissionService
3
+ * The EMIL CommissionService API description
4
+ *
5
+ * The version of the OpenAPI document: 1.0
6
+ * Contact: kontakt@emil.de
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
13
+ import { Configuration } from '../configuration';
14
+ import { RequestArgs, BaseAPI } from '../base';
15
+ import { CreateCommissionAgreementRuleRequestDto } from '../models';
16
+ import { CreateCommissionAgreementRuleResponseClass } from '../models';
17
+ import { EvaluateCommissionAgreementRuleRequestDto } from '../models';
18
+ import { EvaluateCommissionAgreementRuleResponseClass } from '../models';
19
+ import { GetCommissionAgreementRuleResponseClass } from '../models';
20
+ import { ListCommissionAgreementRulesResponseClass } from '../models';
21
+ import { UpdateCommissionAgreementRuleRequestDto } from '../models';
22
+ import { UpdateCommissionAgreementRuleResponseClass } from '../models';
23
+ /**
24
+ * CommissionAgreementRulesApi - axios parameter creator
25
+ * @export
26
+ */
27
+ export declare const CommissionAgreementRulesApiAxiosParamCreator: (configuration?: Configuration) => {
28
+ /**
29
+ * This will create commission agreement rule.
30
+ * @summary Create the commission agreement rule
31
+ * @param {CreateCommissionAgreementRuleRequestDto} createCommissionAgreementRuleRequestDto
32
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
33
+ * @param {*} [options] Override http request option.
34
+ * @throws {RequiredError}
35
+ */
36
+ createCommissionAgreementRule: (createCommissionAgreementRuleRequestDto: CreateCommissionAgreementRuleRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
37
+ /**
38
+ * This will delete commission agreement rule.
39
+ * @summary Delete the commission agreement rule
40
+ * @param {string} code Unique identifier for the object.
41
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
42
+ * @param {*} [options] Override http request option.
43
+ * @throws {RequiredError}
44
+ */
45
+ deleteCommissionAgreementRule: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
46
+ /**
47
+ * Evaluates commission agreement rule expressions with mock data and returns calculated commission values for first year and following years.
48
+ * @summary Create the commission agreement rule evaluation
49
+ * @param {EvaluateCommissionAgreementRuleRequestDto} evaluateCommissionAgreementRuleRequestDto
50
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
51
+ * @param {*} [options] Override http request option.
52
+ * @throws {RequiredError}
53
+ */
54
+ evaluateCommissionAgreementRule: (evaluateCommissionAgreementRuleRequestDto: EvaluateCommissionAgreementRuleRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
55
+ /**
56
+ * This will get commission agreement rule.
57
+ * @summary Retrieve the commission agreement rule
58
+ * @param {string} code
59
+ * @param {string} expand
60
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
61
+ * @param {*} [options] Override http request option.
62
+ * @throws {RequiredError}
63
+ */
64
+ getCommissionAgreementRule: (code: string, expand: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
65
+ /**
66
+ * Retrieves a list of commission agreement rules.
67
+ * @summary List commission agreement rules
68
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
69
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
70
+ * @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.
71
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, commissionAgreementVersionId, commissionAgreementProductCode, status, createdAt&lt;/i&gt;
72
+ * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: code, commissionAgreementProductCode&lt;/i&gt;
73
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, createdAt, updatedAt, status&lt;/i&gt;
74
+ * @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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: version, commissionAgreementProduct&lt;i&gt;
75
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, commissionAgreementVersionId, commissionAgreementProductCode, status, createdAt&lt;/i&gt;
76
+ * @param {*} [options] Override http request option.
77
+ * @throws {RequiredError}
78
+ */
79
+ listCommissionAgreementRules: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
80
+ /**
81
+ * This will update commission agreement rule.
82
+ * @summary Update the commission agreement rule
83
+ * @param {string} code Unique identifier for the object.
84
+ * @param {UpdateCommissionAgreementRuleRequestDto} updateCommissionAgreementRuleRequestDto
85
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
86
+ * @param {*} [options] Override http request option.
87
+ * @throws {RequiredError}
88
+ */
89
+ updateCommissionAgreementRule: (code: string, updateCommissionAgreementRuleRequestDto: UpdateCommissionAgreementRuleRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
90
+ };
91
+ /**
92
+ * CommissionAgreementRulesApi - functional programming interface
93
+ * @export
94
+ */
95
+ export declare const CommissionAgreementRulesApiFp: (configuration?: Configuration) => {
96
+ /**
97
+ * This will create commission agreement rule.
98
+ * @summary Create the commission agreement rule
99
+ * @param {CreateCommissionAgreementRuleRequestDto} createCommissionAgreementRuleRequestDto
100
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
101
+ * @param {*} [options] Override http request option.
102
+ * @throws {RequiredError}
103
+ */
104
+ createCommissionAgreementRule(createCommissionAgreementRuleRequestDto: CreateCommissionAgreementRuleRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateCommissionAgreementRuleResponseClass>>;
105
+ /**
106
+ * This will delete commission agreement rule.
107
+ * @summary Delete the commission agreement rule
108
+ * @param {string} code Unique identifier for the object.
109
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
110
+ * @param {*} [options] Override http request option.
111
+ * @throws {RequiredError}
112
+ */
113
+ deleteCommissionAgreementRule(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
114
+ /**
115
+ * Evaluates commission agreement rule expressions with mock data and returns calculated commission values for first year and following years.
116
+ * @summary Create the commission agreement rule evaluation
117
+ * @param {EvaluateCommissionAgreementRuleRequestDto} evaluateCommissionAgreementRuleRequestDto
118
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
119
+ * @param {*} [options] Override http request option.
120
+ * @throws {RequiredError}
121
+ */
122
+ evaluateCommissionAgreementRule(evaluateCommissionAgreementRuleRequestDto: EvaluateCommissionAgreementRuleRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EvaluateCommissionAgreementRuleResponseClass>>;
123
+ /**
124
+ * This will get commission agreement rule.
125
+ * @summary Retrieve the commission agreement rule
126
+ * @param {string} code
127
+ * @param {string} expand
128
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
129
+ * @param {*} [options] Override http request option.
130
+ * @throws {RequiredError}
131
+ */
132
+ getCommissionAgreementRule(code: string, expand: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetCommissionAgreementRuleResponseClass>>;
133
+ /**
134
+ * Retrieves a list of commission agreement rules.
135
+ * @summary List commission agreement rules
136
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
137
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
138
+ * @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.
139
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, commissionAgreementVersionId, commissionAgreementProductCode, status, createdAt&lt;/i&gt;
140
+ * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: code, commissionAgreementProductCode&lt;/i&gt;
141
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, createdAt, updatedAt, status&lt;/i&gt;
142
+ * @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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: version, commissionAgreementProduct&lt;i&gt;
143
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, commissionAgreementVersionId, commissionAgreementProductCode, status, createdAt&lt;/i&gt;
144
+ * @param {*} [options] Override http request option.
145
+ * @throws {RequiredError}
146
+ */
147
+ listCommissionAgreementRules(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionAgreementRulesResponseClass>>;
148
+ /**
149
+ * This will update commission agreement rule.
150
+ * @summary Update the commission agreement rule
151
+ * @param {string} code Unique identifier for the object.
152
+ * @param {UpdateCommissionAgreementRuleRequestDto} updateCommissionAgreementRuleRequestDto
153
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
154
+ * @param {*} [options] Override http request option.
155
+ * @throws {RequiredError}
156
+ */
157
+ updateCommissionAgreementRule(code: string, updateCommissionAgreementRuleRequestDto: UpdateCommissionAgreementRuleRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateCommissionAgreementRuleResponseClass>>;
158
+ };
159
+ /**
160
+ * CommissionAgreementRulesApi - factory interface
161
+ * @export
162
+ */
163
+ export declare const CommissionAgreementRulesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
164
+ /**
165
+ * This will create commission agreement rule.
166
+ * @summary Create the commission agreement rule
167
+ * @param {CreateCommissionAgreementRuleRequestDto} createCommissionAgreementRuleRequestDto
168
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
169
+ * @param {*} [options] Override http request option.
170
+ * @throws {RequiredError}
171
+ */
172
+ createCommissionAgreementRule(createCommissionAgreementRuleRequestDto: CreateCommissionAgreementRuleRequestDto, authorization?: string, options?: any): AxiosPromise<CreateCommissionAgreementRuleResponseClass>;
173
+ /**
174
+ * This will delete commission agreement rule.
175
+ * @summary Delete the commission agreement rule
176
+ * @param {string} code Unique identifier for the object.
177
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
178
+ * @param {*} [options] Override http request option.
179
+ * @throws {RequiredError}
180
+ */
181
+ deleteCommissionAgreementRule(code: string, authorization?: string, options?: any): AxiosPromise<void>;
182
+ /**
183
+ * Evaluates commission agreement rule expressions with mock data and returns calculated commission values for first year and following years.
184
+ * @summary Create the commission agreement rule evaluation
185
+ * @param {EvaluateCommissionAgreementRuleRequestDto} evaluateCommissionAgreementRuleRequestDto
186
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
187
+ * @param {*} [options] Override http request option.
188
+ * @throws {RequiredError}
189
+ */
190
+ evaluateCommissionAgreementRule(evaluateCommissionAgreementRuleRequestDto: EvaluateCommissionAgreementRuleRequestDto, authorization?: string, options?: any): AxiosPromise<EvaluateCommissionAgreementRuleResponseClass>;
191
+ /**
192
+ * This will get commission agreement rule.
193
+ * @summary Retrieve the commission agreement rule
194
+ * @param {string} code
195
+ * @param {string} expand
196
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
197
+ * @param {*} [options] Override http request option.
198
+ * @throws {RequiredError}
199
+ */
200
+ getCommissionAgreementRule(code: string, expand: string, authorization?: string, options?: any): AxiosPromise<GetCommissionAgreementRuleResponseClass>;
201
+ /**
202
+ * Retrieves a list of commission agreement rules.
203
+ * @summary List commission agreement rules
204
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
205
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
206
+ * @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.
207
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, commissionAgreementVersionId, commissionAgreementProductCode, status, createdAt&lt;/i&gt;
208
+ * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: code, commissionAgreementProductCode&lt;/i&gt;
209
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, createdAt, updatedAt, status&lt;/i&gt;
210
+ * @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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: version, commissionAgreementProduct&lt;i&gt;
211
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, commissionAgreementVersionId, commissionAgreementProductCode, status, createdAt&lt;/i&gt;
212
+ * @param {*} [options] Override http request option.
213
+ * @throws {RequiredError}
214
+ */
215
+ listCommissionAgreementRules(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListCommissionAgreementRulesResponseClass>;
216
+ /**
217
+ * This will update commission agreement rule.
218
+ * @summary Update the commission agreement rule
219
+ * @param {string} code Unique identifier for the object.
220
+ * @param {UpdateCommissionAgreementRuleRequestDto} updateCommissionAgreementRuleRequestDto
221
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
222
+ * @param {*} [options] Override http request option.
223
+ * @throws {RequiredError}
224
+ */
225
+ updateCommissionAgreementRule(code: string, updateCommissionAgreementRuleRequestDto: UpdateCommissionAgreementRuleRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateCommissionAgreementRuleResponseClass>;
226
+ };
227
+ /**
228
+ * Request parameters for createCommissionAgreementRule operation in CommissionAgreementRulesApi.
229
+ * @export
230
+ * @interface CommissionAgreementRulesApiCreateCommissionAgreementRuleRequest
231
+ */
232
+ export interface CommissionAgreementRulesApiCreateCommissionAgreementRuleRequest {
233
+ /**
234
+ *
235
+ * @type {CreateCommissionAgreementRuleRequestDto}
236
+ * @memberof CommissionAgreementRulesApiCreateCommissionAgreementRule
237
+ */
238
+ readonly createCommissionAgreementRuleRequestDto: CreateCommissionAgreementRuleRequestDto;
239
+ /**
240
+ * Bearer Token: provided by the login endpoint under the name accessToken.
241
+ * @type {string}
242
+ * @memberof CommissionAgreementRulesApiCreateCommissionAgreementRule
243
+ */
244
+ readonly authorization?: string;
245
+ }
246
+ /**
247
+ * Request parameters for deleteCommissionAgreementRule operation in CommissionAgreementRulesApi.
248
+ * @export
249
+ * @interface CommissionAgreementRulesApiDeleteCommissionAgreementRuleRequest
250
+ */
251
+ export interface CommissionAgreementRulesApiDeleteCommissionAgreementRuleRequest {
252
+ /**
253
+ * Unique identifier for the object.
254
+ * @type {string}
255
+ * @memberof CommissionAgreementRulesApiDeleteCommissionAgreementRule
256
+ */
257
+ readonly code: string;
258
+ /**
259
+ * Bearer Token: provided by the login endpoint under the name accessToken.
260
+ * @type {string}
261
+ * @memberof CommissionAgreementRulesApiDeleteCommissionAgreementRule
262
+ */
263
+ readonly authorization?: string;
264
+ }
265
+ /**
266
+ * Request parameters for evaluateCommissionAgreementRule operation in CommissionAgreementRulesApi.
267
+ * @export
268
+ * @interface CommissionAgreementRulesApiEvaluateCommissionAgreementRuleRequest
269
+ */
270
+ export interface CommissionAgreementRulesApiEvaluateCommissionAgreementRuleRequest {
271
+ /**
272
+ *
273
+ * @type {EvaluateCommissionAgreementRuleRequestDto}
274
+ * @memberof CommissionAgreementRulesApiEvaluateCommissionAgreementRule
275
+ */
276
+ readonly evaluateCommissionAgreementRuleRequestDto: EvaluateCommissionAgreementRuleRequestDto;
277
+ /**
278
+ * Bearer Token: provided by the login endpoint under the name accessToken.
279
+ * @type {string}
280
+ * @memberof CommissionAgreementRulesApiEvaluateCommissionAgreementRule
281
+ */
282
+ readonly authorization?: string;
283
+ }
284
+ /**
285
+ * Request parameters for getCommissionAgreementRule operation in CommissionAgreementRulesApi.
286
+ * @export
287
+ * @interface CommissionAgreementRulesApiGetCommissionAgreementRuleRequest
288
+ */
289
+ export interface CommissionAgreementRulesApiGetCommissionAgreementRuleRequest {
290
+ /**
291
+ *
292
+ * @type {string}
293
+ * @memberof CommissionAgreementRulesApiGetCommissionAgreementRule
294
+ */
295
+ readonly code: string;
296
+ /**
297
+ *
298
+ * @type {string}
299
+ * @memberof CommissionAgreementRulesApiGetCommissionAgreementRule
300
+ */
301
+ readonly expand: string;
302
+ /**
303
+ * Bearer Token: provided by the login endpoint under the name accessToken.
304
+ * @type {string}
305
+ * @memberof CommissionAgreementRulesApiGetCommissionAgreementRule
306
+ */
307
+ readonly authorization?: string;
308
+ }
309
+ /**
310
+ * Request parameters for listCommissionAgreementRules operation in CommissionAgreementRulesApi.
311
+ * @export
312
+ * @interface CommissionAgreementRulesApiListCommissionAgreementRulesRequest
313
+ */
314
+ export interface CommissionAgreementRulesApiListCommissionAgreementRulesRequest {
315
+ /**
316
+ * Bearer Token: provided by the login endpoint under the name accessToken.
317
+ * @type {string}
318
+ * @memberof CommissionAgreementRulesApiListCommissionAgreementRules
319
+ */
320
+ readonly authorization?: string;
321
+ /**
322
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
323
+ * @type {number}
324
+ * @memberof CommissionAgreementRulesApiListCommissionAgreementRules
325
+ */
326
+ readonly pageSize?: number;
327
+ /**
328
+ * 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.
329
+ * @type {string}
330
+ * @memberof CommissionAgreementRulesApiListCommissionAgreementRules
331
+ */
332
+ readonly pageToken?: string;
333
+ /**
334
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, commissionAgreementVersionId, commissionAgreementProductCode, status, createdAt&lt;/i&gt;
335
+ * @type {string}
336
+ * @memberof CommissionAgreementRulesApiListCommissionAgreementRules
337
+ */
338
+ readonly filter?: string;
339
+ /**
340
+ * Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: code, commissionAgreementProductCode&lt;/i&gt;
341
+ * @type {string}
342
+ * @memberof CommissionAgreementRulesApiListCommissionAgreementRules
343
+ */
344
+ readonly search?: string;
345
+ /**
346
+ * Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code, createdAt, updatedAt, status&lt;/i&gt;
347
+ * @type {string}
348
+ * @memberof CommissionAgreementRulesApiListCommissionAgreementRules
349
+ */
350
+ readonly order?: string;
351
+ /**
352
+ * 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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: version, commissionAgreementProduct&lt;i&gt;
353
+ * @type {string}
354
+ * @memberof CommissionAgreementRulesApiListCommissionAgreementRules
355
+ */
356
+ readonly expand?: string;
357
+ /**
358
+ * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, commissionAgreementVersionId, commissionAgreementProductCode, status, createdAt&lt;/i&gt;
359
+ * @type {string}
360
+ * @memberof CommissionAgreementRulesApiListCommissionAgreementRules
361
+ */
362
+ readonly filters?: string;
363
+ }
364
+ /**
365
+ * Request parameters for updateCommissionAgreementRule operation in CommissionAgreementRulesApi.
366
+ * @export
367
+ * @interface CommissionAgreementRulesApiUpdateCommissionAgreementRuleRequest
368
+ */
369
+ export interface CommissionAgreementRulesApiUpdateCommissionAgreementRuleRequest {
370
+ /**
371
+ * Unique identifier for the object.
372
+ * @type {string}
373
+ * @memberof CommissionAgreementRulesApiUpdateCommissionAgreementRule
374
+ */
375
+ readonly code: string;
376
+ /**
377
+ *
378
+ * @type {UpdateCommissionAgreementRuleRequestDto}
379
+ * @memberof CommissionAgreementRulesApiUpdateCommissionAgreementRule
380
+ */
381
+ readonly updateCommissionAgreementRuleRequestDto: UpdateCommissionAgreementRuleRequestDto;
382
+ /**
383
+ * Bearer Token: provided by the login endpoint under the name accessToken.
384
+ * @type {string}
385
+ * @memberof CommissionAgreementRulesApiUpdateCommissionAgreementRule
386
+ */
387
+ readonly authorization?: string;
388
+ }
389
+ /**
390
+ * CommissionAgreementRulesApi - object-oriented interface
391
+ * @export
392
+ * @class CommissionAgreementRulesApi
393
+ * @extends {BaseAPI}
394
+ */
395
+ export declare class CommissionAgreementRulesApi extends BaseAPI {
396
+ /**
397
+ * This will create commission agreement rule.
398
+ * @summary Create the commission agreement rule
399
+ * @param {CommissionAgreementRulesApiCreateCommissionAgreementRuleRequest} requestParameters Request parameters.
400
+ * @param {*} [options] Override http request option.
401
+ * @throws {RequiredError}
402
+ * @memberof CommissionAgreementRulesApi
403
+ */
404
+ createCommissionAgreementRule(requestParameters: CommissionAgreementRulesApiCreateCommissionAgreementRuleRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateCommissionAgreementRuleResponseClass, any, {}>>;
405
+ /**
406
+ * This will delete commission agreement rule.
407
+ * @summary Delete the commission agreement rule
408
+ * @param {CommissionAgreementRulesApiDeleteCommissionAgreementRuleRequest} requestParameters Request parameters.
409
+ * @param {*} [options] Override http request option.
410
+ * @throws {RequiredError}
411
+ * @memberof CommissionAgreementRulesApi
412
+ */
413
+ deleteCommissionAgreementRule(requestParameters: CommissionAgreementRulesApiDeleteCommissionAgreementRuleRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
414
+ /**
415
+ * Evaluates commission agreement rule expressions with mock data and returns calculated commission values for first year and following years.
416
+ * @summary Create the commission agreement rule evaluation
417
+ * @param {CommissionAgreementRulesApiEvaluateCommissionAgreementRuleRequest} requestParameters Request parameters.
418
+ * @param {*} [options] Override http request option.
419
+ * @throws {RequiredError}
420
+ * @memberof CommissionAgreementRulesApi
421
+ */
422
+ evaluateCommissionAgreementRule(requestParameters: CommissionAgreementRulesApiEvaluateCommissionAgreementRuleRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EvaluateCommissionAgreementRuleResponseClass, any, {}>>;
423
+ /**
424
+ * This will get commission agreement rule.
425
+ * @summary Retrieve the commission agreement rule
426
+ * @param {CommissionAgreementRulesApiGetCommissionAgreementRuleRequest} requestParameters Request parameters.
427
+ * @param {*} [options] Override http request option.
428
+ * @throws {RequiredError}
429
+ * @memberof CommissionAgreementRulesApi
430
+ */
431
+ getCommissionAgreementRule(requestParameters: CommissionAgreementRulesApiGetCommissionAgreementRuleRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetCommissionAgreementRuleResponseClass, any, {}>>;
432
+ /**
433
+ * Retrieves a list of commission agreement rules.
434
+ * @summary List commission agreement rules
435
+ * @param {CommissionAgreementRulesApiListCommissionAgreementRulesRequest} requestParameters Request parameters.
436
+ * @param {*} [options] Override http request option.
437
+ * @throws {RequiredError}
438
+ * @memberof CommissionAgreementRulesApi
439
+ */
440
+ listCommissionAgreementRules(requestParameters?: CommissionAgreementRulesApiListCommissionAgreementRulesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListCommissionAgreementRulesResponseClass, any, {}>>;
441
+ /**
442
+ * This will update commission agreement rule.
443
+ * @summary Update the commission agreement rule
444
+ * @param {CommissionAgreementRulesApiUpdateCommissionAgreementRuleRequest} requestParameters Request parameters.
445
+ * @param {*} [options] Override http request option.
446
+ * @throws {RequiredError}
447
+ * @memberof CommissionAgreementRulesApi
448
+ */
449
+ updateCommissionAgreementRule(requestParameters: CommissionAgreementRulesApiUpdateCommissionAgreementRuleRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateCommissionAgreementRuleResponseClass, any, {}>>;
450
+ }