@emilgroup/commission-sdk-node 1.0.0-beta.4 → 1.0.0-beta.40

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 (155) hide show
  1. package/.openapi-generator/FILES +39 -0
  2. package/README.md +2 -2
  3. package/api/commission-agreement-products-api.ts +655 -0
  4. package/api/commission-agreement-rules-api.ts +762 -0
  5. package/api/commission-agreements-api.ts +160 -27
  6. package/api/commission-recipients-api.ts +92 -37
  7. package/api/commission-settlements-api.ts +804 -0
  8. package/api/commissions-api.ts +121 -18
  9. package/api.ts +6 -0
  10. package/dist/api/commission-agreement-products-api.d.ts +366 -0
  11. package/dist/api/commission-agreement-products-api.js +630 -0
  12. package/dist/api/commission-agreement-rules-api.d.ts +423 -0
  13. package/dist/api/commission-agreement-rules-api.js +723 -0
  14. package/dist/api/commission-agreements-api.d.ts +98 -23
  15. package/dist/api/commission-agreements-api.js +127 -22
  16. package/dist/api/commission-recipients-api.d.ts +63 -27
  17. package/dist/api/commission-recipients-api.js +53 -29
  18. package/dist/api/commission-settlements-api.d.ts +450 -0
  19. package/dist/api/commission-settlements-api.js +741 -0
  20. package/dist/api/commissions-api.d.ts +74 -18
  21. package/dist/api/commissions-api.js +101 -9
  22. package/dist/api.d.ts +3 -0
  23. package/dist/api.js +3 -0
  24. package/dist/models/commission-agreement-class.d.ts +27 -3
  25. package/dist/models/commission-agreement-class.js +5 -1
  26. package/dist/models/commission-agreement-metadata-dto.d.ts +25 -0
  27. package/dist/models/commission-agreement-metadata-dto.js +15 -0
  28. package/dist/models/commission-agreement-metadata-partner-dto.d.ts +30 -0
  29. package/dist/models/commission-agreement-metadata-partner-dto.js +15 -0
  30. package/dist/models/commission-agreement-product-class.d.ts +77 -0
  31. package/dist/models/commission-agreement-product-class.js +20 -0
  32. package/dist/models/commission-agreement-rule-class.d.ts +93 -0
  33. package/dist/models/commission-agreement-rule-class.js +21 -0
  34. package/dist/models/commission-agreement-rule-config-dto.d.ts +25 -0
  35. package/dist/models/commission-agreement-rule-config-dto.js +15 -0
  36. package/dist/models/commission-agreement-rule-evaluation-class.d.ts +31 -0
  37. package/dist/models/commission-agreement-rule-evaluation-class.js +15 -0
  38. package/dist/models/commission-agreement-version-class.d.ts +7 -0
  39. package/dist/models/commission-class.d.ts +37 -6
  40. package/dist/models/commission-conditions-dto.d.ts +24 -0
  41. package/dist/models/commission-conditions-dto.js +15 -0
  42. package/dist/models/commission-config-dto.d.ts +63 -0
  43. package/dist/models/commission-config-dto.js +34 -0
  44. package/dist/models/commission-estimate-class.d.ts +59 -0
  45. package/dist/models/commission-estimate-class.js +25 -0
  46. package/dist/models/commission-settlement-class.d.ts +124 -0
  47. package/dist/models/commission-settlement-class.js +35 -0
  48. package/dist/models/create-commission-agreement-product-request-dto.d.ts +30 -0
  49. package/dist/models/create-commission-agreement-product-request-dto.js +15 -0
  50. package/dist/models/create-commission-agreement-product-response-class.d.ts +25 -0
  51. package/dist/models/create-commission-agreement-product-response-class.js +15 -0
  52. package/dist/models/create-commission-agreement-request-dto.d.ts +14 -3
  53. package/dist/models/create-commission-agreement-request-dto.js +5 -1
  54. package/dist/models/create-commission-agreement-rule-request-dto.d.ts +37 -0
  55. package/dist/models/create-commission-agreement-rule-request-dto.js +15 -0
  56. package/dist/models/create-commission-agreement-rule-response-class.d.ts +25 -0
  57. package/dist/models/create-commission-agreement-rule-response-class.js +15 -0
  58. package/dist/models/create-commission-agreement-version-request-dto.d.ts +1 -1
  59. package/dist/models/create-commission-request-dto.d.ts +3 -9
  60. package/dist/models/create-commission-settlement-request-dto.d.ts +57 -0
  61. package/dist/models/create-commission-settlement-request-dto.js +35 -0
  62. package/dist/models/create-commission-settlement-response-class.d.ts +25 -0
  63. package/dist/models/create-commission-settlement-response-class.js +15 -0
  64. package/dist/models/estimate-commissions-response-class.d.ts +73 -0
  65. package/dist/models/estimate-commissions-response-class.js +15 -0
  66. package/dist/models/evaluate-commission-agreement-rule-request-dto.d.ts +31 -0
  67. package/dist/models/evaluate-commission-agreement-rule-request-dto.js +15 -0
  68. package/dist/models/evaluate-commission-agreement-rule-response-class.d.ts +25 -0
  69. package/dist/models/evaluate-commission-agreement-rule-response-class.js +15 -0
  70. package/dist/models/evaluated-commission-class.d.ts +54 -0
  71. package/dist/models/evaluated-commission-class.js +21 -0
  72. package/dist/models/get-commission-agreement-product-response-class.d.ts +25 -0
  73. package/dist/models/get-commission-agreement-product-response-class.js +15 -0
  74. package/dist/models/get-commission-agreement-rule-response-class.d.ts +25 -0
  75. package/dist/models/get-commission-agreement-rule-response-class.js +15 -0
  76. package/dist/models/get-commission-settlement-response-class.d.ts +25 -0
  77. package/dist/models/get-commission-settlement-response-class.js +15 -0
  78. package/dist/models/index.d.ts +36 -0
  79. package/dist/models/index.js +36 -0
  80. package/dist/models/list-commission-agreement-products-response-class.d.ts +43 -0
  81. package/dist/models/list-commission-agreement-products-response-class.js +15 -0
  82. package/dist/models/list-commission-agreement-rules-response-class.d.ts +43 -0
  83. package/dist/models/list-commission-agreement-rules-response-class.js +15 -0
  84. package/dist/models/list-commission-settlements-response-class.d.ts +43 -0
  85. package/dist/models/list-commission-settlements-response-class.js +15 -0
  86. package/dist/models/patch-commission-agreement-status-request-dto.d.ts +37 -0
  87. package/dist/models/patch-commission-agreement-status-request-dto.js +22 -0
  88. package/dist/models/patch-commission-agreement-status-response-class.d.ts +25 -0
  89. package/dist/models/patch-commission-agreement-status-response-class.js +15 -0
  90. package/dist/models/publish-commission-settlements-request-dto.d.ts +24 -0
  91. package/dist/models/publish-commission-settlements-request-dto.js +15 -0
  92. package/dist/models/publish-commission-settlements-response-class.d.ts +25 -0
  93. package/dist/models/publish-commission-settlements-response-class.js +15 -0
  94. package/dist/models/update-commission-agreement-product-request-dto.d.ts +41 -0
  95. package/dist/models/update-commission-agreement-product-request-dto.js +20 -0
  96. package/dist/models/update-commission-agreement-product-response-class.d.ts +25 -0
  97. package/dist/models/update-commission-agreement-product-response-class.js +15 -0
  98. package/dist/models/update-commission-agreement-request-dto.d.ts +3 -1
  99. package/dist/models/update-commission-agreement-request-dto.js +2 -0
  100. package/dist/models/update-commission-agreement-rule-request-dto.d.ts +49 -0
  101. package/dist/models/update-commission-agreement-rule-request-dto.js +21 -0
  102. package/dist/models/update-commission-agreement-rule-response-class.d.ts +25 -0
  103. package/dist/models/update-commission-agreement-rule-response-class.js +15 -0
  104. package/dist/models/update-commission-request-dto.d.ts +5 -3
  105. package/dist/models/update-commission-request-dto.js +4 -2
  106. package/dist/models/update-commission-settlement-request-dto.d.ts +43 -0
  107. package/dist/models/update-commission-settlement-request-dto.js +22 -0
  108. package/dist/models/update-commission-settlement-response-class.d.ts +25 -0
  109. package/dist/models/update-commission-settlement-response-class.js +15 -0
  110. package/models/commission-agreement-class.ts +27 -3
  111. package/models/commission-agreement-metadata-dto.ts +31 -0
  112. package/models/commission-agreement-metadata-partner-dto.ts +36 -0
  113. package/models/commission-agreement-product-class.ts +86 -0
  114. package/models/commission-agreement-rule-class.ts +102 -0
  115. package/models/commission-agreement-rule-config-dto.ts +31 -0
  116. package/models/commission-agreement-rule-evaluation-class.ts +37 -0
  117. package/models/commission-agreement-version-class.ts +7 -0
  118. package/models/commission-class.ts +37 -6
  119. package/models/commission-conditions-dto.ts +30 -0
  120. package/models/commission-config-dto.ts +73 -0
  121. package/models/commission-estimate-class.ts +69 -0
  122. package/models/commission-settlement-class.ts +134 -0
  123. package/models/create-commission-agreement-product-request-dto.ts +36 -0
  124. package/models/create-commission-agreement-product-response-class.ts +31 -0
  125. package/models/create-commission-agreement-request-dto.ts +14 -3
  126. package/models/create-commission-agreement-rule-request-dto.ts +43 -0
  127. package/models/create-commission-agreement-rule-response-class.ts +31 -0
  128. package/models/create-commission-agreement-version-request-dto.ts +1 -1
  129. package/models/create-commission-request-dto.ts +3 -9
  130. package/models/create-commission-settlement-request-dto.ts +67 -0
  131. package/models/create-commission-settlement-response-class.ts +31 -0
  132. package/models/estimate-commissions-response-class.ts +79 -0
  133. package/models/evaluate-commission-agreement-rule-request-dto.ts +37 -0
  134. package/models/evaluate-commission-agreement-rule-response-class.ts +31 -0
  135. package/models/evaluated-commission-class.ts +63 -0
  136. package/models/get-commission-agreement-product-response-class.ts +31 -0
  137. package/models/get-commission-agreement-rule-response-class.ts +31 -0
  138. package/models/get-commission-settlement-response-class.ts +31 -0
  139. package/models/index.ts +36 -0
  140. package/models/list-commission-agreement-products-response-class.ts +49 -0
  141. package/models/list-commission-agreement-rules-response-class.ts +49 -0
  142. package/models/list-commission-settlements-response-class.ts +49 -0
  143. package/models/patch-commission-agreement-status-request-dto.ts +46 -0
  144. package/models/patch-commission-agreement-status-response-class.ts +31 -0
  145. package/models/publish-commission-settlements-request-dto.ts +30 -0
  146. package/models/publish-commission-settlements-response-class.ts +31 -0
  147. package/models/update-commission-agreement-product-request-dto.ts +50 -0
  148. package/models/update-commission-agreement-product-response-class.ts +31 -0
  149. package/models/update-commission-agreement-request-dto.ts +3 -1
  150. package/models/update-commission-agreement-rule-request-dto.ts +58 -0
  151. package/models/update-commission-agreement-rule-response-class.ts +31 -0
  152. package/models/update-commission-request-dto.ts +5 -3
  153. package/models/update-commission-settlement-request-dto.ts +52 -0
  154. package/models/update-commission-settlement-response-class.ts +31 -0
  155. package/package.json +1 -1
@@ -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 { CreateCommissionSettlementRequestDto } from '../models';
16
+ import { CreateCommissionSettlementResponseClass } from '../models';
17
+ import { GetCommissionSettlementResponseClass } from '../models';
18
+ import { ListCommissionSettlementsResponseClass } from '../models';
19
+ import { PublishCommissionSettlementsRequestDto } from '../models';
20
+ import { PublishCommissionSettlementsResponseClass } from '../models';
21
+ import { UpdateCommissionSettlementRequestDto } from '../models';
22
+ import { UpdateCommissionSettlementResponseClass } from '../models';
23
+ /**
24
+ * CommissionSettlementsApi - axios parameter creator
25
+ * @export
26
+ */
27
+ export declare const CommissionSettlementsApiAxiosParamCreator: (configuration?: Configuration) => {
28
+ /**
29
+ * This will create commission settlement.
30
+ * @summary Create the commission settlement
31
+ * @param {CreateCommissionSettlementRequestDto} createCommissionSettlementRequestDto
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
+ createCommissionSettlement: (createCommissionSettlementRequestDto: CreateCommissionSettlementRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
37
+ /**
38
+ * This will delete commission settlement.
39
+ * @summary Delete the commission settlement
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
+ deleteCommissionSettlement: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
46
+ /**
47
+ * This will get commission settlement.
48
+ * @summary Retrieve the commission settlement
49
+ * @param {string} code Unique identifier for the object.
50
+ * @param {string} expand
51
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
52
+ * @param {*} [options] Override http request option.
53
+ * @throws {RequiredError}
54
+ */
55
+ getCommissionSettlement: (code: string, expand: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
56
+ /**
57
+ * Retrieves a list of commission settlements.
58
+ * @summary List commission settlements
59
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
60
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
61
+ * @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.
62
+ * @param {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
63
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
64
+ * @param {'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt'} [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.
65
+ * @param {'commissions'} [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.
66
+ * @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.
67
+ * @param {*} [options] Override http request option.
68
+ * @throws {RequiredError}
69
+ */
70
+ listCommissionSettlements: (authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt', search?: string, order?: 'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt', expand?: 'commissions', filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
71
+ /**
72
+ * This will publish multiple commission settlements.
73
+ * @summary Create the commission settlement publish
74
+ * @param {PublishCommissionSettlementsRequestDto} publishCommissionSettlementsRequestDto
75
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
76
+ * @param {*} [options] Override http request option.
77
+ * @throws {RequiredError}
78
+ */
79
+ publishCommissionSettlements: (publishCommissionSettlementsRequestDto: PublishCommissionSettlementsRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
80
+ /**
81
+ * This will update commission settlement.
82
+ * @summary Update the commission settlement
83
+ * @param {string} code
84
+ * @param {UpdateCommissionSettlementRequestDto} updateCommissionSettlementRequestDto
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
+ updateCommissionSettlement: (code: string, updateCommissionSettlementRequestDto: UpdateCommissionSettlementRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
90
+ };
91
+ /**
92
+ * CommissionSettlementsApi - functional programming interface
93
+ * @export
94
+ */
95
+ export declare const CommissionSettlementsApiFp: (configuration?: Configuration) => {
96
+ /**
97
+ * This will create commission settlement.
98
+ * @summary Create the commission settlement
99
+ * @param {CreateCommissionSettlementRequestDto} createCommissionSettlementRequestDto
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
+ createCommissionSettlement(createCommissionSettlementRequestDto: CreateCommissionSettlementRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateCommissionSettlementResponseClass>>;
105
+ /**
106
+ * This will delete commission settlement.
107
+ * @summary Delete the commission settlement
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
+ deleteCommissionSettlement(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
114
+ /**
115
+ * This will get commission settlement.
116
+ * @summary Retrieve the commission settlement
117
+ * @param {string} code Unique identifier for the object.
118
+ * @param {string} expand
119
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
120
+ * @param {*} [options] Override http request option.
121
+ * @throws {RequiredError}
122
+ */
123
+ getCommissionSettlement(code: string, expand: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetCommissionSettlementResponseClass>>;
124
+ /**
125
+ * Retrieves a list of commission settlements.
126
+ * @summary List commission settlements
127
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
128
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
129
+ * @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.
130
+ * @param {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
131
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
132
+ * @param {'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt'} [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.
133
+ * @param {'commissions'} [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.
134
+ * @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.
135
+ * @param {*} [options] Override http request option.
136
+ * @throws {RequiredError}
137
+ */
138
+ listCommissionSettlements(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt', search?: string, order?: 'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt', expand?: 'commissions', filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionSettlementsResponseClass>>;
139
+ /**
140
+ * This will publish multiple commission settlements.
141
+ * @summary Create the commission settlement publish
142
+ * @param {PublishCommissionSettlementsRequestDto} publishCommissionSettlementsRequestDto
143
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
144
+ * @param {*} [options] Override http request option.
145
+ * @throws {RequiredError}
146
+ */
147
+ publishCommissionSettlements(publishCommissionSettlementsRequestDto: PublishCommissionSettlementsRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PublishCommissionSettlementsResponseClass>>;
148
+ /**
149
+ * This will update commission settlement.
150
+ * @summary Update the commission settlement
151
+ * @param {string} code
152
+ * @param {UpdateCommissionSettlementRequestDto} updateCommissionSettlementRequestDto
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
+ updateCommissionSettlement(code: string, updateCommissionSettlementRequestDto: UpdateCommissionSettlementRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateCommissionSettlementResponseClass>>;
158
+ };
159
+ /**
160
+ * CommissionSettlementsApi - factory interface
161
+ * @export
162
+ */
163
+ export declare const CommissionSettlementsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
164
+ /**
165
+ * This will create commission settlement.
166
+ * @summary Create the commission settlement
167
+ * @param {CreateCommissionSettlementRequestDto} createCommissionSettlementRequestDto
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
+ createCommissionSettlement(createCommissionSettlementRequestDto: CreateCommissionSettlementRequestDto, authorization?: string, options?: any): AxiosPromise<CreateCommissionSettlementResponseClass>;
173
+ /**
174
+ * This will delete commission settlement.
175
+ * @summary Delete the commission settlement
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
+ deleteCommissionSettlement(code: string, authorization?: string, options?: any): AxiosPromise<void>;
182
+ /**
183
+ * This will get commission settlement.
184
+ * @summary Retrieve the commission settlement
185
+ * @param {string} code Unique identifier for the object.
186
+ * @param {string} expand
187
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
188
+ * @param {*} [options] Override http request option.
189
+ * @throws {RequiredError}
190
+ */
191
+ getCommissionSettlement(code: string, expand: string, authorization?: string, options?: any): AxiosPromise<GetCommissionSettlementResponseClass>;
192
+ /**
193
+ * Retrieves a list of commission settlements.
194
+ * @summary List commission settlements
195
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
196
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
197
+ * @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.
198
+ * @param {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
199
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
200
+ * @param {'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt'} [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.
201
+ * @param {'commissions'} [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.
202
+ * @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.
203
+ * @param {*} [options] Override http request option.
204
+ * @throws {RequiredError}
205
+ */
206
+ listCommissionSettlements(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt', search?: string, order?: 'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt', expand?: 'commissions', filters?: string, options?: any): AxiosPromise<ListCommissionSettlementsResponseClass>;
207
+ /**
208
+ * This will publish multiple commission settlements.
209
+ * @summary Create the commission settlement publish
210
+ * @param {PublishCommissionSettlementsRequestDto} publishCommissionSettlementsRequestDto
211
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
212
+ * @param {*} [options] Override http request option.
213
+ * @throws {RequiredError}
214
+ */
215
+ publishCommissionSettlements(publishCommissionSettlementsRequestDto: PublishCommissionSettlementsRequestDto, authorization?: string, options?: any): AxiosPromise<PublishCommissionSettlementsResponseClass>;
216
+ /**
217
+ * This will update commission settlement.
218
+ * @summary Update the commission settlement
219
+ * @param {string} code
220
+ * @param {UpdateCommissionSettlementRequestDto} updateCommissionSettlementRequestDto
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
+ updateCommissionSettlement(code: string, updateCommissionSettlementRequestDto: UpdateCommissionSettlementRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateCommissionSettlementResponseClass>;
226
+ };
227
+ /**
228
+ * Request parameters for createCommissionSettlement operation in CommissionSettlementsApi.
229
+ * @export
230
+ * @interface CommissionSettlementsApiCreateCommissionSettlementRequest
231
+ */
232
+ export interface CommissionSettlementsApiCreateCommissionSettlementRequest {
233
+ /**
234
+ *
235
+ * @type {CreateCommissionSettlementRequestDto}
236
+ * @memberof CommissionSettlementsApiCreateCommissionSettlement
237
+ */
238
+ readonly createCommissionSettlementRequestDto: CreateCommissionSettlementRequestDto;
239
+ /**
240
+ * Bearer Token: provided by the login endpoint under the name accessToken.
241
+ * @type {string}
242
+ * @memberof CommissionSettlementsApiCreateCommissionSettlement
243
+ */
244
+ readonly authorization?: string;
245
+ }
246
+ /**
247
+ * Request parameters for deleteCommissionSettlement operation in CommissionSettlementsApi.
248
+ * @export
249
+ * @interface CommissionSettlementsApiDeleteCommissionSettlementRequest
250
+ */
251
+ export interface CommissionSettlementsApiDeleteCommissionSettlementRequest {
252
+ /**
253
+ * Unique identifier for the object.
254
+ * @type {string}
255
+ * @memberof CommissionSettlementsApiDeleteCommissionSettlement
256
+ */
257
+ readonly code: string;
258
+ /**
259
+ * Bearer Token: provided by the login endpoint under the name accessToken.
260
+ * @type {string}
261
+ * @memberof CommissionSettlementsApiDeleteCommissionSettlement
262
+ */
263
+ readonly authorization?: string;
264
+ }
265
+ /**
266
+ * Request parameters for getCommissionSettlement operation in CommissionSettlementsApi.
267
+ * @export
268
+ * @interface CommissionSettlementsApiGetCommissionSettlementRequest
269
+ */
270
+ export interface CommissionSettlementsApiGetCommissionSettlementRequest {
271
+ /**
272
+ * Unique identifier for the object.
273
+ * @type {string}
274
+ * @memberof CommissionSettlementsApiGetCommissionSettlement
275
+ */
276
+ readonly code: string;
277
+ /**
278
+ *
279
+ * @type {string}
280
+ * @memberof CommissionSettlementsApiGetCommissionSettlement
281
+ */
282
+ readonly expand: string;
283
+ /**
284
+ * Bearer Token: provided by the login endpoint under the name accessToken.
285
+ * @type {string}
286
+ * @memberof CommissionSettlementsApiGetCommissionSettlement
287
+ */
288
+ readonly authorization?: string;
289
+ }
290
+ /**
291
+ * Request parameters for listCommissionSettlements operation in CommissionSettlementsApi.
292
+ * @export
293
+ * @interface CommissionSettlementsApiListCommissionSettlementsRequest
294
+ */
295
+ export interface CommissionSettlementsApiListCommissionSettlementsRequest {
296
+ /**
297
+ * Bearer Token: provided by the login endpoint under the name accessToken.
298
+ * @type {string}
299
+ * @memberof CommissionSettlementsApiListCommissionSettlements
300
+ */
301
+ readonly authorization?: string;
302
+ /**
303
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
304
+ * @type {number}
305
+ * @memberof CommissionSettlementsApiListCommissionSettlements
306
+ */
307
+ readonly pageSize?: number;
308
+ /**
309
+ * 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.
310
+ * @type {string}
311
+ * @memberof CommissionSettlementsApiListCommissionSettlements
312
+ */
313
+ readonly pageToken?: string;
314
+ /**
315
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
316
+ * @type {'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt'}
317
+ * @memberof CommissionSettlementsApiListCommissionSettlements
318
+ */
319
+ readonly filter?: 'id' | 'code' | 'settlementNumber' | 'status' | 'amount' | 'policyCount' | 'partnerCode' | 'createdBy' | 'updatedBy' | 'createdAt' | 'updatedAt';
320
+ /**
321
+ * To search the list by any field, pass search&#x3D;xxx to fetch the result.
322
+ * @type {string}
323
+ * @memberof CommissionSettlementsApiListCommissionSettlements
324
+ */
325
+ readonly search?: string;
326
+ /**
327
+ * 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.
328
+ * @type {'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt'}
329
+ * @memberof CommissionSettlementsApiListCommissionSettlements
330
+ */
331
+ readonly order?: 'code' | 'settlementNumber' | 'partnerNumber' | 'status' | 'amount' | 'policyCount' | 'createdAt' | 'updatedAt';
332
+ /**
333
+ * 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.
334
+ * @type {'commissions'}
335
+ * @memberof CommissionSettlementsApiListCommissionSettlements
336
+ */
337
+ readonly expand?: 'commissions';
338
+ /**
339
+ * 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.
340
+ * @type {string}
341
+ * @memberof CommissionSettlementsApiListCommissionSettlements
342
+ */
343
+ readonly filters?: string;
344
+ }
345
+ /**
346
+ * Request parameters for publishCommissionSettlements operation in CommissionSettlementsApi.
347
+ * @export
348
+ * @interface CommissionSettlementsApiPublishCommissionSettlementsRequest
349
+ */
350
+ export interface CommissionSettlementsApiPublishCommissionSettlementsRequest {
351
+ /**
352
+ *
353
+ * @type {PublishCommissionSettlementsRequestDto}
354
+ * @memberof CommissionSettlementsApiPublishCommissionSettlements
355
+ */
356
+ readonly publishCommissionSettlementsRequestDto: PublishCommissionSettlementsRequestDto;
357
+ /**
358
+ * Bearer Token: provided by the login endpoint under the name accessToken.
359
+ * @type {string}
360
+ * @memberof CommissionSettlementsApiPublishCommissionSettlements
361
+ */
362
+ readonly authorization?: string;
363
+ }
364
+ /**
365
+ * Request parameters for updateCommissionSettlement operation in CommissionSettlementsApi.
366
+ * @export
367
+ * @interface CommissionSettlementsApiUpdateCommissionSettlementRequest
368
+ */
369
+ export interface CommissionSettlementsApiUpdateCommissionSettlementRequest {
370
+ /**
371
+ *
372
+ * @type {string}
373
+ * @memberof CommissionSettlementsApiUpdateCommissionSettlement
374
+ */
375
+ readonly code: string;
376
+ /**
377
+ *
378
+ * @type {UpdateCommissionSettlementRequestDto}
379
+ * @memberof CommissionSettlementsApiUpdateCommissionSettlement
380
+ */
381
+ readonly updateCommissionSettlementRequestDto: UpdateCommissionSettlementRequestDto;
382
+ /**
383
+ * Bearer Token: provided by the login endpoint under the name accessToken.
384
+ * @type {string}
385
+ * @memberof CommissionSettlementsApiUpdateCommissionSettlement
386
+ */
387
+ readonly authorization?: string;
388
+ }
389
+ /**
390
+ * CommissionSettlementsApi - object-oriented interface
391
+ * @export
392
+ * @class CommissionSettlementsApi
393
+ * @extends {BaseAPI}
394
+ */
395
+ export declare class CommissionSettlementsApi extends BaseAPI {
396
+ /**
397
+ * This will create commission settlement.
398
+ * @summary Create the commission settlement
399
+ * @param {CommissionSettlementsApiCreateCommissionSettlementRequest} requestParameters Request parameters.
400
+ * @param {*} [options] Override http request option.
401
+ * @throws {RequiredError}
402
+ * @memberof CommissionSettlementsApi
403
+ */
404
+ createCommissionSettlement(requestParameters: CommissionSettlementsApiCreateCommissionSettlementRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateCommissionSettlementResponseClass, any, {}>>;
405
+ /**
406
+ * This will delete commission settlement.
407
+ * @summary Delete the commission settlement
408
+ * @param {CommissionSettlementsApiDeleteCommissionSettlementRequest} requestParameters Request parameters.
409
+ * @param {*} [options] Override http request option.
410
+ * @throws {RequiredError}
411
+ * @memberof CommissionSettlementsApi
412
+ */
413
+ deleteCommissionSettlement(requestParameters: CommissionSettlementsApiDeleteCommissionSettlementRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
414
+ /**
415
+ * This will get commission settlement.
416
+ * @summary Retrieve the commission settlement
417
+ * @param {CommissionSettlementsApiGetCommissionSettlementRequest} requestParameters Request parameters.
418
+ * @param {*} [options] Override http request option.
419
+ * @throws {RequiredError}
420
+ * @memberof CommissionSettlementsApi
421
+ */
422
+ getCommissionSettlement(requestParameters: CommissionSettlementsApiGetCommissionSettlementRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetCommissionSettlementResponseClass, any, {}>>;
423
+ /**
424
+ * Retrieves a list of commission settlements.
425
+ * @summary List commission settlements
426
+ * @param {CommissionSettlementsApiListCommissionSettlementsRequest} requestParameters Request parameters.
427
+ * @param {*} [options] Override http request option.
428
+ * @throws {RequiredError}
429
+ * @memberof CommissionSettlementsApi
430
+ */
431
+ listCommissionSettlements(requestParameters?: CommissionSettlementsApiListCommissionSettlementsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListCommissionSettlementsResponseClass, any, {}>>;
432
+ /**
433
+ * This will publish multiple commission settlements.
434
+ * @summary Create the commission settlement publish
435
+ * @param {CommissionSettlementsApiPublishCommissionSettlementsRequest} requestParameters Request parameters.
436
+ * @param {*} [options] Override http request option.
437
+ * @throws {RequiredError}
438
+ * @memberof CommissionSettlementsApi
439
+ */
440
+ publishCommissionSettlements(requestParameters: CommissionSettlementsApiPublishCommissionSettlementsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PublishCommissionSettlementsResponseClass, any, {}>>;
441
+ /**
442
+ * This will update commission settlement.
443
+ * @summary Update the commission settlement
444
+ * @param {CommissionSettlementsApiUpdateCommissionSettlementRequest} requestParameters Request parameters.
445
+ * @param {*} [options] Override http request option.
446
+ * @throws {RequiredError}
447
+ * @memberof CommissionSettlementsApi
448
+ */
449
+ updateCommissionSettlement(requestParameters: CommissionSettlementsApiUpdateCommissionSettlementRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateCommissionSettlementResponseClass, any, {}>>;
450
+ }