@emilgroup/insurance-sdk-node 1.52.0 → 1.53.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 (114) hide show
  1. package/.openapi-generator/FILES +33 -1
  2. package/README.md +2 -2
  3. package/api/commission-agreement-products-api.ts +710 -0
  4. package/api/commission-agreement-versions-api.ts +592 -0
  5. package/api/commission-agreements-api.ts +697 -0
  6. package/api/commission-recipients-api.ts +696 -0
  7. package/api/{default-api.ts → health-check-api.ts} +21 -17
  8. package/api/insured-objects-api.ts +5 -2
  9. package/api/policies-api.ts +176 -221
  10. package/api.ts +10 -2
  11. package/dist/api/commission-agreement-products-api.d.ts +403 -0
  12. package/dist/api/commission-agreement-products-api.js +652 -0
  13. package/dist/api/commission-agreement-versions-api.d.ts +337 -0
  14. package/dist/api/commission-agreement-versions-api.js +555 -0
  15. package/dist/api/commission-agreements-api.d.ts +394 -0
  16. package/dist/api/commission-agreements-api.js +646 -0
  17. package/dist/api/commission-recipients-api.d.ts +394 -0
  18. package/dist/api/commission-recipients-api.js +646 -0
  19. package/dist/api/health-check-api.d.ts +70 -0
  20. package/dist/api/{default-api.js → health-check-api.js} +30 -26
  21. package/dist/api/insured-objects-api.js +4 -2
  22. package/dist/api/policies-api.d.ts +134 -161
  23. package/dist/api/policies-api.js +129 -151
  24. package/dist/api.d.ts +5 -1
  25. package/dist/api.js +5 -1
  26. package/dist/models/commission-agreement-class.d.ts +89 -0
  27. package/dist/models/commission-agreement-class.js +23 -0
  28. package/dist/models/commission-agreement-item-class.d.ts +66 -0
  29. package/dist/models/commission-agreement-item-class.js +15 -0
  30. package/dist/models/commission-agreement-product-class.d.ts +72 -0
  31. package/dist/models/commission-agreement-product-class.js +15 -0
  32. package/dist/models/commission-agreement-version-class.d.ts +79 -0
  33. package/dist/models/commission-agreement-version-class.js +15 -0
  34. package/dist/models/commission-recipient-class.d.ts +78 -0
  35. package/dist/models/commission-recipient-class.js +15 -0
  36. package/dist/models/create-commission-agreement-item-dto.d.ts +36 -0
  37. package/dist/models/create-commission-agreement-item-dto.js +15 -0
  38. package/dist/models/create-commission-agreement-product-request-dto.d.ts +42 -0
  39. package/dist/models/create-commission-agreement-product-request-dto.js +15 -0
  40. package/dist/models/create-commission-agreement-product-response-class.d.ts +25 -0
  41. package/dist/models/create-commission-agreement-product-response-class.js +15 -0
  42. package/dist/models/create-commission-agreement-request-dto.d.ts +75 -0
  43. package/dist/models/create-commission-agreement-request-dto.js +23 -0
  44. package/dist/models/create-commission-agreement-response-class.d.ts +25 -0
  45. package/dist/models/create-commission-agreement-response-class.js +15 -0
  46. package/dist/models/create-commission-agreement-version-request-dto.d.ts +49 -0
  47. package/dist/models/create-commission-agreement-version-request-dto.js +15 -0
  48. package/dist/models/create-commission-agreement-version-response-class.d.ts +25 -0
  49. package/dist/models/create-commission-agreement-version-response-class.js +15 -0
  50. package/dist/models/create-commission-recipient-request-dto.d.ts +48 -0
  51. package/dist/models/create-commission-recipient-request-dto.js +15 -0
  52. package/dist/models/create-commission-recipient-response-class.d.ts +25 -0
  53. package/dist/models/create-commission-recipient-response-class.js +15 -0
  54. package/dist/models/get-commission-agreement-product-response-class.d.ts +25 -0
  55. package/dist/models/get-commission-agreement-product-response-class.js +15 -0
  56. package/dist/models/get-commission-agreement-response-class.d.ts +25 -0
  57. package/dist/models/get-commission-agreement-response-class.js +15 -0
  58. package/dist/models/get-commission-agreement-version-response-class.d.ts +25 -0
  59. package/dist/models/get-commission-agreement-version-response-class.js +15 -0
  60. package/dist/models/get-commission-recipient-response-class.d.ts +25 -0
  61. package/dist/models/get-commission-recipient-response-class.js +15 -0
  62. package/dist/models/index.d.ts +28 -0
  63. package/dist/models/index.js +28 -0
  64. package/dist/models/list-commission-agreement-products-response-class.d.ts +31 -0
  65. package/dist/models/list-commission-agreement-products-response-class.js +15 -0
  66. package/dist/models/list-commission-agreement-versions-response-class.d.ts +31 -0
  67. package/dist/models/list-commission-agreement-versions-response-class.js +15 -0
  68. package/dist/models/list-commission-agreements-response-class.d.ts +31 -0
  69. package/dist/models/list-commission-agreements-response-class.js +15 -0
  70. package/dist/models/list-commission-recipients-response-class.d.ts +31 -0
  71. package/dist/models/list-commission-recipients-response-class.js +15 -0
  72. package/dist/models/update-commission-agreement-product-request-dto.d.ts +42 -0
  73. package/dist/models/update-commission-agreement-product-request-dto.js +15 -0
  74. package/dist/models/update-commission-agreement-product-response-class.d.ts +25 -0
  75. package/dist/models/update-commission-agreement-product-response-class.js +15 -0
  76. package/dist/models/update-commission-agreement-request-dto.d.ts +44 -0
  77. package/dist/models/update-commission-agreement-request-dto.js +23 -0
  78. package/dist/models/update-commission-agreement-response-class.d.ts +25 -0
  79. package/dist/models/update-commission-agreement-response-class.js +15 -0
  80. package/dist/models/update-commission-recipient-request-dto.d.ts +48 -0
  81. package/dist/models/update-commission-recipient-request-dto.js +15 -0
  82. package/dist/models/update-commission-recipient-response-class.d.ts +25 -0
  83. package/dist/models/update-commission-recipient-response-class.js +15 -0
  84. package/models/commission-agreement-class.ts +98 -0
  85. package/models/commission-agreement-item-class.ts +72 -0
  86. package/models/commission-agreement-product-class.ts +78 -0
  87. package/models/commission-agreement-version-class.ts +85 -0
  88. package/models/commission-recipient-class.ts +84 -0
  89. package/models/create-commission-agreement-item-dto.ts +42 -0
  90. package/models/create-commission-agreement-product-request-dto.ts +48 -0
  91. package/models/create-commission-agreement-product-response-class.ts +31 -0
  92. package/models/create-commission-agreement-request-dto.ts +84 -0
  93. package/models/create-commission-agreement-response-class.ts +31 -0
  94. package/models/create-commission-agreement-version-request-dto.ts +55 -0
  95. package/models/create-commission-agreement-version-response-class.ts +31 -0
  96. package/models/create-commission-recipient-request-dto.ts +54 -0
  97. package/models/create-commission-recipient-response-class.ts +31 -0
  98. package/models/get-commission-agreement-product-response-class.ts +31 -0
  99. package/models/get-commission-agreement-response-class.ts +31 -0
  100. package/models/get-commission-agreement-version-response-class.ts +31 -0
  101. package/models/get-commission-recipient-response-class.ts +31 -0
  102. package/models/index.ts +28 -0
  103. package/models/list-commission-agreement-products-response-class.ts +37 -0
  104. package/models/list-commission-agreement-versions-response-class.ts +37 -0
  105. package/models/list-commission-agreements-response-class.ts +37 -0
  106. package/models/list-commission-recipients-response-class.ts +37 -0
  107. package/models/update-commission-agreement-product-request-dto.ts +48 -0
  108. package/models/update-commission-agreement-product-response-class.ts +31 -0
  109. package/models/update-commission-agreement-request-dto.ts +53 -0
  110. package/models/update-commission-agreement-response-class.ts +31 -0
  111. package/models/update-commission-recipient-request-dto.ts +54 -0
  112. package/models/update-commission-recipient-response-class.ts +31 -0
  113. package/package.json +1 -1
  114. package/dist/api/default-api.d.ts +0 -66
@@ -0,0 +1,394 @@
1
+ /**
2
+ * EMIL InsuranceService
3
+ * The EMIL InsuranceService 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 { CreateCommissionAgreementRequestDto } from '../models';
16
+ import { CreateCommissionAgreementResponseClass } from '../models';
17
+ import { DeleteResponseClass } from '../models';
18
+ import { GetCommissionAgreementResponseClass } from '../models';
19
+ import { ListCommissionAgreementsResponseClass } from '../models';
20
+ import { UpdateCommissionAgreementRequestDto } from '../models';
21
+ import { UpdateCommissionAgreementResponseClass } from '../models';
22
+ /**
23
+ * CommissionAgreementsApi - axios parameter creator
24
+ * @export
25
+ */
26
+ export declare const CommissionAgreementsApiAxiosParamCreator: (configuration?: Configuration) => {
27
+ /**
28
+ * This will create the commission agreement.
29
+ * @summary Create the Commission agreement
30
+ * @param {CreateCommissionAgreementRequestDto} createCommissionAgreementRequestDto
31
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
32
+ * @param {*} [options] Override http request option.
33
+ * @throws {RequiredError}
34
+ */
35
+ createCommissionAgreement: (createCommissionAgreementRequestDto: CreateCommissionAgreementRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
36
+ /**
37
+ * Permanently deletes the commission agreement. Supply the unique code that was returned when you created the commission agreement and this will delete it.
38
+ * @summary Delete the commission agreement
39
+ * @param {string} code Unique identifier for the object.
40
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
41
+ * @param {*} [options] Override http request option.
42
+ * @throws {RequiredError}
43
+ */
44
+ deleteCommissionAgreement: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
45
+ /**
46
+ * Retrieves the details of the commission agreement that was previously created. Supply the unique commission agreement code that was returned when you created it and Emil Api will return the corresponding commission agreement information.
47
+ * @summary Retrieve the commission agreement
48
+ * @param {string} code
49
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
50
+ * @param {string} [expand] You can expand commission agreement in this endpoint. \&#39; + \&#39;Allowed values: versions, products, recipients.
51
+ * @param {*} [options] Override http request option.
52
+ * @throws {RequiredError}
53
+ */
54
+ getCommissionAgreement: (code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
55
+ /**
56
+ * Returns a list of commission agreements you have previously created. The commission agreements are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
57
+ * @summary List commission agreements
58
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
59
+ * @param {number} [pageSize] Page size.
60
+ * @param {string} [pageToken] Page token.
61
+ * @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: code, name, description&lt;/i&gt;
62
+ * @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: name, code, description&lt;/i&gt;
63
+ * @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: id, createdAt, updatedAt&lt;/i&gt;
64
+ * @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: versions, products, recipients.&lt;i&gt;
65
+ * @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: code, name, description&lt;/i&gt;
66
+ * @param {*} [options] Override http request option.
67
+ * @throws {RequiredError}
68
+ */
69
+ listCommissionAgreements: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
70
+ /**
71
+ * Updates the specified commission agreement by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
72
+ * @summary Update the commission agreement
73
+ * @param {string} code
74
+ * @param {UpdateCommissionAgreementRequestDto} updateCommissionAgreementRequestDto
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
+ updateCommissionAgreement: (code: string, updateCommissionAgreementRequestDto: UpdateCommissionAgreementRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
80
+ };
81
+ /**
82
+ * CommissionAgreementsApi - functional programming interface
83
+ * @export
84
+ */
85
+ export declare const CommissionAgreementsApiFp: (configuration?: Configuration) => {
86
+ /**
87
+ * This will create the commission agreement.
88
+ * @summary Create the Commission agreement
89
+ * @param {CreateCommissionAgreementRequestDto} createCommissionAgreementRequestDto
90
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
91
+ * @param {*} [options] Override http request option.
92
+ * @throws {RequiredError}
93
+ */
94
+ createCommissionAgreement(createCommissionAgreementRequestDto: CreateCommissionAgreementRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateCommissionAgreementResponseClass>>;
95
+ /**
96
+ * Permanently deletes the commission agreement. Supply the unique code that was returned when you created the commission agreement and this will delete it.
97
+ * @summary Delete the commission agreement
98
+ * @param {string} code Unique identifier for the object.
99
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
100
+ * @param {*} [options] Override http request option.
101
+ * @throws {RequiredError}
102
+ */
103
+ deleteCommissionAgreement(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponseClass>>;
104
+ /**
105
+ * Retrieves the details of the commission agreement that was previously created. Supply the unique commission agreement code that was returned when you created it and Emil Api will return the corresponding commission agreement information.
106
+ * @summary Retrieve the commission agreement
107
+ * @param {string} code
108
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
109
+ * @param {string} [expand] You can expand commission agreement in this endpoint. \&#39; + \&#39;Allowed values: versions, products, recipients.
110
+ * @param {*} [options] Override http request option.
111
+ * @throws {RequiredError}
112
+ */
113
+ getCommissionAgreement(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetCommissionAgreementResponseClass>>;
114
+ /**
115
+ * Returns a list of commission agreements you have previously created. The commission agreements are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
116
+ * @summary List commission agreements
117
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
118
+ * @param {number} [pageSize] Page size.
119
+ * @param {string} [pageToken] Page token.
120
+ * @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: code, name, description&lt;/i&gt;
121
+ * @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: name, code, description&lt;/i&gt;
122
+ * @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: id, createdAt, updatedAt&lt;/i&gt;
123
+ * @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: versions, products, recipients.&lt;i&gt;
124
+ * @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: code, name, description&lt;/i&gt;
125
+ * @param {*} [options] Override http request option.
126
+ * @throws {RequiredError}
127
+ */
128
+ listCommissionAgreements(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionAgreementsResponseClass>>;
129
+ /**
130
+ * Updates the specified commission agreement by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
131
+ * @summary Update the commission agreement
132
+ * @param {string} code
133
+ * @param {UpdateCommissionAgreementRequestDto} updateCommissionAgreementRequestDto
134
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
135
+ * @param {*} [options] Override http request option.
136
+ * @throws {RequiredError}
137
+ */
138
+ updateCommissionAgreement(code: string, updateCommissionAgreementRequestDto: UpdateCommissionAgreementRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateCommissionAgreementResponseClass>>;
139
+ };
140
+ /**
141
+ * CommissionAgreementsApi - factory interface
142
+ * @export
143
+ */
144
+ export declare const CommissionAgreementsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
145
+ /**
146
+ * This will create the commission agreement.
147
+ * @summary Create the Commission agreement
148
+ * @param {CreateCommissionAgreementRequestDto} createCommissionAgreementRequestDto
149
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
150
+ * @param {*} [options] Override http request option.
151
+ * @throws {RequiredError}
152
+ */
153
+ createCommissionAgreement(createCommissionAgreementRequestDto: CreateCommissionAgreementRequestDto, authorization?: string, options?: any): AxiosPromise<CreateCommissionAgreementResponseClass>;
154
+ /**
155
+ * Permanently deletes the commission agreement. Supply the unique code that was returned when you created the commission agreement and this will delete it.
156
+ * @summary Delete the commission agreement
157
+ * @param {string} code Unique identifier for the object.
158
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
159
+ * @param {*} [options] Override http request option.
160
+ * @throws {RequiredError}
161
+ */
162
+ deleteCommissionAgreement(code: string, authorization?: string, options?: any): AxiosPromise<DeleteResponseClass>;
163
+ /**
164
+ * Retrieves the details of the commission agreement that was previously created. Supply the unique commission agreement code that was returned when you created it and Emil Api will return the corresponding commission agreement information.
165
+ * @summary Retrieve the commission agreement
166
+ * @param {string} code
167
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
168
+ * @param {string} [expand] You can expand commission agreement in this endpoint. \&#39; + \&#39;Allowed values: versions, products, recipients.
169
+ * @param {*} [options] Override http request option.
170
+ * @throws {RequiredError}
171
+ */
172
+ getCommissionAgreement(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetCommissionAgreementResponseClass>;
173
+ /**
174
+ * Returns a list of commission agreements you have previously created. The commission agreements are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
175
+ * @summary List commission agreements
176
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
177
+ * @param {number} [pageSize] Page size.
178
+ * @param {string} [pageToken] Page token.
179
+ * @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: code, name, description&lt;/i&gt;
180
+ * @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: name, code, description&lt;/i&gt;
181
+ * @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: id, createdAt, updatedAt&lt;/i&gt;
182
+ * @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: versions, products, recipients.&lt;i&gt;
183
+ * @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: code, name, description&lt;/i&gt;
184
+ * @param {*} [options] Override http request option.
185
+ * @throws {RequiredError}
186
+ */
187
+ listCommissionAgreements(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListCommissionAgreementsResponseClass>;
188
+ /**
189
+ * Updates the specified commission agreement by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
190
+ * @summary Update the commission agreement
191
+ * @param {string} code
192
+ * @param {UpdateCommissionAgreementRequestDto} updateCommissionAgreementRequestDto
193
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
194
+ * @param {*} [options] Override http request option.
195
+ * @throws {RequiredError}
196
+ */
197
+ updateCommissionAgreement(code: string, updateCommissionAgreementRequestDto: UpdateCommissionAgreementRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateCommissionAgreementResponseClass>;
198
+ };
199
+ /**
200
+ * Request parameters for createCommissionAgreement operation in CommissionAgreementsApi.
201
+ * @export
202
+ * @interface CommissionAgreementsApiCreateCommissionAgreementRequest
203
+ */
204
+ export interface CommissionAgreementsApiCreateCommissionAgreementRequest {
205
+ /**
206
+ *
207
+ * @type {CreateCommissionAgreementRequestDto}
208
+ * @memberof CommissionAgreementsApiCreateCommissionAgreement
209
+ */
210
+ readonly createCommissionAgreementRequestDto: CreateCommissionAgreementRequestDto;
211
+ /**
212
+ * Bearer Token: provided by the login endpoint under the name accessToken.
213
+ * @type {string}
214
+ * @memberof CommissionAgreementsApiCreateCommissionAgreement
215
+ */
216
+ readonly authorization?: string;
217
+ }
218
+ /**
219
+ * Request parameters for deleteCommissionAgreement operation in CommissionAgreementsApi.
220
+ * @export
221
+ * @interface CommissionAgreementsApiDeleteCommissionAgreementRequest
222
+ */
223
+ export interface CommissionAgreementsApiDeleteCommissionAgreementRequest {
224
+ /**
225
+ * Unique identifier for the object.
226
+ * @type {string}
227
+ * @memberof CommissionAgreementsApiDeleteCommissionAgreement
228
+ */
229
+ readonly code: string;
230
+ /**
231
+ * Bearer Token: provided by the login endpoint under the name accessToken.
232
+ * @type {string}
233
+ * @memberof CommissionAgreementsApiDeleteCommissionAgreement
234
+ */
235
+ readonly authorization?: string;
236
+ }
237
+ /**
238
+ * Request parameters for getCommissionAgreement operation in CommissionAgreementsApi.
239
+ * @export
240
+ * @interface CommissionAgreementsApiGetCommissionAgreementRequest
241
+ */
242
+ export interface CommissionAgreementsApiGetCommissionAgreementRequest {
243
+ /**
244
+ *
245
+ * @type {string}
246
+ * @memberof CommissionAgreementsApiGetCommissionAgreement
247
+ */
248
+ readonly code: string;
249
+ /**
250
+ * Bearer Token: provided by the login endpoint under the name accessToken.
251
+ * @type {string}
252
+ * @memberof CommissionAgreementsApiGetCommissionAgreement
253
+ */
254
+ readonly authorization?: string;
255
+ /**
256
+ * You can expand commission agreement in this endpoint. \&#39; + \&#39;Allowed values: versions, products, recipients.
257
+ * @type {string}
258
+ * @memberof CommissionAgreementsApiGetCommissionAgreement
259
+ */
260
+ readonly expand?: string;
261
+ }
262
+ /**
263
+ * Request parameters for listCommissionAgreements operation in CommissionAgreementsApi.
264
+ * @export
265
+ * @interface CommissionAgreementsApiListCommissionAgreementsRequest
266
+ */
267
+ export interface CommissionAgreementsApiListCommissionAgreementsRequest {
268
+ /**
269
+ * Bearer Token: provided by the login endpoint under the name accessToken.
270
+ * @type {string}
271
+ * @memberof CommissionAgreementsApiListCommissionAgreements
272
+ */
273
+ readonly authorization?: string;
274
+ /**
275
+ * Page size.
276
+ * @type {number}
277
+ * @memberof CommissionAgreementsApiListCommissionAgreements
278
+ */
279
+ readonly pageSize?: number;
280
+ /**
281
+ * Page token.
282
+ * @type {string}
283
+ * @memberof CommissionAgreementsApiListCommissionAgreements
284
+ */
285
+ readonly pageToken?: string;
286
+ /**
287
+ * 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: code, name, description&lt;/i&gt;
288
+ * @type {string}
289
+ * @memberof CommissionAgreementsApiListCommissionAgreements
290
+ */
291
+ readonly filter?: string;
292
+ /**
293
+ * 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: name, code, description&lt;/i&gt;
294
+ * @type {string}
295
+ * @memberof CommissionAgreementsApiListCommissionAgreements
296
+ */
297
+ readonly search?: string;
298
+ /**
299
+ * 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: id, createdAt, updatedAt&lt;/i&gt;
300
+ * @type {string}
301
+ * @memberof CommissionAgreementsApiListCommissionAgreements
302
+ */
303
+ readonly order?: string;
304
+ /**
305
+ * 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: versions, products, recipients.&lt;i&gt;
306
+ * @type {string}
307
+ * @memberof CommissionAgreementsApiListCommissionAgreements
308
+ */
309
+ readonly expand?: string;
310
+ /**
311
+ * 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: code, name, description&lt;/i&gt;
312
+ * @type {string}
313
+ * @memberof CommissionAgreementsApiListCommissionAgreements
314
+ */
315
+ readonly filters?: string;
316
+ }
317
+ /**
318
+ * Request parameters for updateCommissionAgreement operation in CommissionAgreementsApi.
319
+ * @export
320
+ * @interface CommissionAgreementsApiUpdateCommissionAgreementRequest
321
+ */
322
+ export interface CommissionAgreementsApiUpdateCommissionAgreementRequest {
323
+ /**
324
+ *
325
+ * @type {string}
326
+ * @memberof CommissionAgreementsApiUpdateCommissionAgreement
327
+ */
328
+ readonly code: string;
329
+ /**
330
+ *
331
+ * @type {UpdateCommissionAgreementRequestDto}
332
+ * @memberof CommissionAgreementsApiUpdateCommissionAgreement
333
+ */
334
+ readonly updateCommissionAgreementRequestDto: UpdateCommissionAgreementRequestDto;
335
+ /**
336
+ * Bearer Token: provided by the login endpoint under the name accessToken.
337
+ * @type {string}
338
+ * @memberof CommissionAgreementsApiUpdateCommissionAgreement
339
+ */
340
+ readonly authorization?: string;
341
+ }
342
+ /**
343
+ * CommissionAgreementsApi - object-oriented interface
344
+ * @export
345
+ * @class CommissionAgreementsApi
346
+ * @extends {BaseAPI}
347
+ */
348
+ export declare class CommissionAgreementsApi extends BaseAPI {
349
+ /**
350
+ * This will create the commission agreement.
351
+ * @summary Create the Commission agreement
352
+ * @param {CommissionAgreementsApiCreateCommissionAgreementRequest} requestParameters Request parameters.
353
+ * @param {*} [options] Override http request option.
354
+ * @throws {RequiredError}
355
+ * @memberof CommissionAgreementsApi
356
+ */
357
+ createCommissionAgreement(requestParameters: CommissionAgreementsApiCreateCommissionAgreementRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateCommissionAgreementResponseClass, any>>;
358
+ /**
359
+ * Permanently deletes the commission agreement. Supply the unique code that was returned when you created the commission agreement and this will delete it.
360
+ * @summary Delete the commission agreement
361
+ * @param {CommissionAgreementsApiDeleteCommissionAgreementRequest} requestParameters Request parameters.
362
+ * @param {*} [options] Override http request option.
363
+ * @throws {RequiredError}
364
+ * @memberof CommissionAgreementsApi
365
+ */
366
+ deleteCommissionAgreement(requestParameters: CommissionAgreementsApiDeleteCommissionAgreementRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteResponseClass, any>>;
367
+ /**
368
+ * Retrieves the details of the commission agreement that was previously created. Supply the unique commission agreement code that was returned when you created it and Emil Api will return the corresponding commission agreement information.
369
+ * @summary Retrieve the commission agreement
370
+ * @param {CommissionAgreementsApiGetCommissionAgreementRequest} requestParameters Request parameters.
371
+ * @param {*} [options] Override http request option.
372
+ * @throws {RequiredError}
373
+ * @memberof CommissionAgreementsApi
374
+ */
375
+ getCommissionAgreement(requestParameters: CommissionAgreementsApiGetCommissionAgreementRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetCommissionAgreementResponseClass, any>>;
376
+ /**
377
+ * Returns a list of commission agreements you have previously created. The commission agreements are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
378
+ * @summary List commission agreements
379
+ * @param {CommissionAgreementsApiListCommissionAgreementsRequest} requestParameters Request parameters.
380
+ * @param {*} [options] Override http request option.
381
+ * @throws {RequiredError}
382
+ * @memberof CommissionAgreementsApi
383
+ */
384
+ listCommissionAgreements(requestParameters?: CommissionAgreementsApiListCommissionAgreementsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListCommissionAgreementsResponseClass, any>>;
385
+ /**
386
+ * Updates the specified commission agreement by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
387
+ * @summary Update the commission agreement
388
+ * @param {CommissionAgreementsApiUpdateCommissionAgreementRequest} requestParameters Request parameters.
389
+ * @param {*} [options] Override http request option.
390
+ * @throws {RequiredError}
391
+ * @memberof CommissionAgreementsApi
392
+ */
393
+ updateCommissionAgreement(requestParameters: CommissionAgreementsApiUpdateCommissionAgreementRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateCommissionAgreementResponseClass, any>>;
394
+ }