@emilgroup/commission-sdk 1.1.1-beta.9 → 2.1.1-beta.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.
- package/README.md +2 -2
- package/api/commission-agreement-products-api.ts +8 -8
- package/api/commission-agreement-rules-api.ts +8 -8
- package/api/commission-agreement-versions-api.ts +8 -8
- package/api/commission-agreements-api.ts +8 -8
- package/api/commission-candidates-api.ts +8 -8
- package/api/commission-recipients-api.ts +8 -8
- package/dist/api/commission-agreement-products-api.d.ts +8 -8
- package/dist/api/commission-agreement-products-api.js +6 -6
- package/dist/api/commission-agreement-rules-api.d.ts +8 -8
- package/dist/api/commission-agreement-rules-api.js +6 -6
- package/dist/api/commission-agreement-versions-api.d.ts +8 -8
- package/dist/api/commission-agreement-versions-api.js +6 -6
- package/dist/api/commission-agreements-api.d.ts +8 -8
- package/dist/api/commission-agreements-api.js +6 -6
- package/dist/api/commission-candidates-api.d.ts +8 -8
- package/dist/api/commission-candidates-api.js +6 -6
- package/dist/api/commission-recipients-api.d.ts +8 -8
- package/dist/api/commission-recipients-api.js +6 -6
- package/dist/models/commission-agreement-rule-class.d.ts +6 -0
- package/models/commission-agreement-rule-class.ts +6 -0
- package/package.json +1 -1
|
@@ -68,11 +68,11 @@ export declare const CommissionAgreementRulesApiAxiosParamCreator: (configuratio
|
|
|
68
68
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
69
69
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
70
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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
71
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
71
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, commissionAgreementVersionId, commissionAgreementProductCode, status, createdAt</i>
|
|
72
72
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, commissionAgreementProductCode</i>
|
|
73
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.<br/> <br/> <i>Allowed values: code, createdAt, updatedAt, status</i>
|
|
74
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.<br/> <br/> <i>Allowed values: version, commissionAgreementProduct<i>
|
|
75
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
75
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, commissionAgreementVersionId, commissionAgreementProductCode, status, createdAt</i>
|
|
76
76
|
* @param {*} [options] Override http request option.
|
|
77
77
|
* @throws {RequiredError}
|
|
78
78
|
*/
|
|
@@ -136,11 +136,11 @@ export declare const CommissionAgreementRulesApiFp: (configuration?: Configurati
|
|
|
136
136
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
137
137
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
138
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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
139
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
139
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, commissionAgreementVersionId, commissionAgreementProductCode, status, createdAt</i>
|
|
140
140
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, commissionAgreementProductCode</i>
|
|
141
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.<br/> <br/> <i>Allowed values: code, createdAt, updatedAt, status</i>
|
|
142
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.<br/> <br/> <i>Allowed values: version, commissionAgreementProduct<i>
|
|
143
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
143
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, commissionAgreementVersionId, commissionAgreementProductCode, status, createdAt</i>
|
|
144
144
|
* @param {*} [options] Override http request option.
|
|
145
145
|
* @throws {RequiredError}
|
|
146
146
|
*/
|
|
@@ -204,11 +204,11 @@ export declare const CommissionAgreementRulesApiFactory: (configuration?: Config
|
|
|
204
204
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
205
205
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
206
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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
207
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
207
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, commissionAgreementVersionId, commissionAgreementProductCode, status, createdAt</i>
|
|
208
208
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, commissionAgreementProductCode</i>
|
|
209
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.<br/> <br/> <i>Allowed values: code, createdAt, updatedAt, status</i>
|
|
210
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.<br/> <br/> <i>Allowed values: version, commissionAgreementProduct<i>
|
|
211
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
211
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, commissionAgreementVersionId, commissionAgreementProductCode, status, createdAt</i>
|
|
212
212
|
* @param {*} [options] Override http request option.
|
|
213
213
|
* @throws {RequiredError}
|
|
214
214
|
*/
|
|
@@ -331,7 +331,7 @@ export interface CommissionAgreementRulesApiListCommissionAgreementRulesRequest
|
|
|
331
331
|
*/
|
|
332
332
|
readonly pageToken?: string;
|
|
333
333
|
/**
|
|
334
|
-
* Filter the response by one or multiple fields.
|
|
334
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, commissionAgreementVersionId, commissionAgreementProductCode, status, createdAt</i>
|
|
335
335
|
* @type {string}
|
|
336
336
|
* @memberof CommissionAgreementRulesApiListCommissionAgreementRules
|
|
337
337
|
*/
|
|
@@ -355,7 +355,7 @@ export interface CommissionAgreementRulesApiListCommissionAgreementRulesRequest
|
|
|
355
355
|
*/
|
|
356
356
|
readonly expand?: string;
|
|
357
357
|
/**
|
|
358
|
-
* Filters the response by one or multiple fields.
|
|
358
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, commissionAgreementVersionId, commissionAgreementProductCode, status, createdAt</i>
|
|
359
359
|
* @type {string}
|
|
360
360
|
* @memberof CommissionAgreementRulesApiListCommissionAgreementRules
|
|
361
361
|
*/
|
|
@@ -298,11 +298,11 @@ var CommissionAgreementRulesApiAxiosParamCreator = function (configuration) {
|
|
|
298
298
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
299
299
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
300
300
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
301
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
301
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, commissionAgreementVersionId, commissionAgreementProductCode, status, createdAt</i>
|
|
302
302
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, commissionAgreementProductCode</i>
|
|
303
303
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: code, createdAt, updatedAt, status</i>
|
|
304
304
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: version, commissionAgreementProduct<i>
|
|
305
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
305
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, commissionAgreementVersionId, commissionAgreementProductCode, status, createdAt</i>
|
|
306
306
|
* @param {*} [options] Override http request option.
|
|
307
307
|
* @throws {RequiredError}
|
|
308
308
|
*/
|
|
@@ -518,11 +518,11 @@ var CommissionAgreementRulesApiFp = function (configuration) {
|
|
|
518
518
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
519
519
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
520
520
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
521
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
521
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, commissionAgreementVersionId, commissionAgreementProductCode, status, createdAt</i>
|
|
522
522
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, commissionAgreementProductCode</i>
|
|
523
523
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: code, createdAt, updatedAt, status</i>
|
|
524
524
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: version, commissionAgreementProduct<i>
|
|
525
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
525
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, commissionAgreementVersionId, commissionAgreementProductCode, status, createdAt</i>
|
|
526
526
|
* @param {*} [options] Override http request option.
|
|
527
527
|
* @throws {RequiredError}
|
|
528
528
|
*/
|
|
@@ -622,11 +622,11 @@ var CommissionAgreementRulesApiFactory = function (configuration, basePath, axio
|
|
|
622
622
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
623
623
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
624
624
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
625
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
625
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, commissionAgreementVersionId, commissionAgreementProductCode, status, createdAt</i>
|
|
626
626
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, commissionAgreementProductCode</i>
|
|
627
627
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: code, createdAt, updatedAt, status</i>
|
|
628
628
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: version, commissionAgreementProduct<i>
|
|
629
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
629
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, commissionAgreementVersionId, commissionAgreementProductCode, status, createdAt</i>
|
|
630
630
|
* @param {*} [options] Override http request option.
|
|
631
631
|
* @throws {RequiredError}
|
|
632
632
|
*/
|
|
@@ -55,11 +55,11 @@ export declare const CommissionAgreementVersionsApiAxiosParamCreator: (configura
|
|
|
55
55
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
56
56
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
57
57
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
58
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
58
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, agreementCode, startDate, endDate, createdAt</i>
|
|
59
59
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
60
60
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: code, createdAt, startDate, endDate</i>
|
|
61
61
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: agreements<i>
|
|
62
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
62
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, agreementCode, startDate, endDate, createdAt</i>
|
|
63
63
|
* @param {*} [options] Override http request option.
|
|
64
64
|
* @throws {RequiredError}
|
|
65
65
|
*/
|
|
@@ -104,11 +104,11 @@ export declare const CommissionAgreementVersionsApiFp: (configuration?: Configur
|
|
|
104
104
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
105
105
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
106
106
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
107
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
107
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, agreementCode, startDate, endDate, createdAt</i>
|
|
108
108
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
109
109
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: code, createdAt, startDate, endDate</i>
|
|
110
110
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: agreements<i>
|
|
111
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
111
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, agreementCode, startDate, endDate, createdAt</i>
|
|
112
112
|
* @param {*} [options] Override http request option.
|
|
113
113
|
* @throws {RequiredError}
|
|
114
114
|
*/
|
|
@@ -153,11 +153,11 @@ export declare const CommissionAgreementVersionsApiFactory: (configuration?: Con
|
|
|
153
153
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
154
154
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
155
155
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
156
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
156
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, agreementCode, startDate, endDate, createdAt</i>
|
|
157
157
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
158
158
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: code, createdAt, startDate, endDate</i>
|
|
159
159
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: agreements<i>
|
|
160
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
160
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, agreementCode, startDate, endDate, createdAt</i>
|
|
161
161
|
* @param {*} [options] Override http request option.
|
|
162
162
|
* @throws {RequiredError}
|
|
163
163
|
*/
|
|
@@ -251,7 +251,7 @@ export interface CommissionAgreementVersionsApiListCommissionAgreementVersionsRe
|
|
|
251
251
|
*/
|
|
252
252
|
readonly pageToken?: string;
|
|
253
253
|
/**
|
|
254
|
-
* Filter the response by one or multiple fields.
|
|
254
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, agreementCode, startDate, endDate, createdAt</i>
|
|
255
255
|
* @type {string}
|
|
256
256
|
* @memberof CommissionAgreementVersionsApiListCommissionAgreementVersions
|
|
257
257
|
*/
|
|
@@ -275,7 +275,7 @@ export interface CommissionAgreementVersionsApiListCommissionAgreementVersionsRe
|
|
|
275
275
|
*/
|
|
276
276
|
readonly expand?: string;
|
|
277
277
|
/**
|
|
278
|
-
* Filters the response by one or multiple fields.
|
|
278
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, agreementCode, startDate, endDate, createdAt</i>
|
|
279
279
|
* @type {string}
|
|
280
280
|
* @memberof CommissionAgreementVersionsApiListCommissionAgreementVersions
|
|
281
281
|
*/
|
|
@@ -249,11 +249,11 @@ var CommissionAgreementVersionsApiAxiosParamCreator = function (configuration) {
|
|
|
249
249
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
250
250
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
251
251
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
252
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
252
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, agreementCode, startDate, endDate, createdAt</i>
|
|
253
253
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
254
254
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: code, createdAt, startDate, endDate</i>
|
|
255
255
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: agreements<i>
|
|
256
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
256
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, agreementCode, startDate, endDate, createdAt</i>
|
|
257
257
|
* @param {*} [options] Override http request option.
|
|
258
258
|
* @throws {RequiredError}
|
|
259
259
|
*/
|
|
@@ -395,11 +395,11 @@ var CommissionAgreementVersionsApiFp = function (configuration) {
|
|
|
395
395
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
396
396
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
397
397
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
398
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
398
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, agreementCode, startDate, endDate, createdAt</i>
|
|
399
399
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
400
400
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: code, createdAt, startDate, endDate</i>
|
|
401
401
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: agreements<i>
|
|
402
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
402
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, agreementCode, startDate, endDate, createdAt</i>
|
|
403
403
|
* @param {*} [options] Override http request option.
|
|
404
404
|
* @throws {RequiredError}
|
|
405
405
|
*/
|
|
@@ -466,11 +466,11 @@ var CommissionAgreementVersionsApiFactory = function (configuration, basePath, a
|
|
|
466
466
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
467
467
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
468
468
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
469
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
469
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, agreementCode, startDate, endDate, createdAt</i>
|
|
470
470
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
471
471
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: code, createdAt, startDate, endDate</i>
|
|
472
472
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: agreements<i>
|
|
473
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
473
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, agreementCode, startDate, endDate, createdAt</i>
|
|
474
474
|
* @param {*} [options] Override http request option.
|
|
475
475
|
* @throws {RequiredError}
|
|
476
476
|
*/
|
|
@@ -59,11 +59,11 @@ export declare const CommissionAgreementsApiAxiosParamCreator: (configuration?:
|
|
|
59
59
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
60
60
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
61
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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
62
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
62
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, createdAt, partnerCode, productSlug, endDate</i>
|
|
63
63
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, commissionAgreementNumber, name, description</i>
|
|
64
64
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: commissionAgreementNumber, status, createdAt, updatedAt, billingFrequency</i>
|
|
65
65
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: versions, products<i>
|
|
66
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
66
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, createdAt, partnerCode, productSlug, endDate</i>
|
|
67
67
|
* @param {*} [options] Override http request option.
|
|
68
68
|
* @throws {RequiredError}
|
|
69
69
|
*/
|
|
@@ -128,11 +128,11 @@ export declare const CommissionAgreementsApiFp: (configuration?: Configuration)
|
|
|
128
128
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
129
129
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
130
130
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
131
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
131
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, createdAt, partnerCode, productSlug, endDate</i>
|
|
132
132
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, commissionAgreementNumber, name, description</i>
|
|
133
133
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: commissionAgreementNumber, status, createdAt, updatedAt, billingFrequency</i>
|
|
134
134
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: versions, products<i>
|
|
135
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
135
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, createdAt, partnerCode, productSlug, endDate</i>
|
|
136
136
|
* @param {*} [options] Override http request option.
|
|
137
137
|
* @throws {RequiredError}
|
|
138
138
|
*/
|
|
@@ -197,11 +197,11 @@ export declare const CommissionAgreementsApiFactory: (configuration?: Configurat
|
|
|
197
197
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
198
198
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
199
199
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
200
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
200
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, createdAt, partnerCode, productSlug, endDate</i>
|
|
201
201
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, commissionAgreementNumber, name, description</i>
|
|
202
202
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: commissionAgreementNumber, status, createdAt, updatedAt, billingFrequency</i>
|
|
203
203
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: versions, products<i>
|
|
204
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
204
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, createdAt, partnerCode, productSlug, endDate</i>
|
|
205
205
|
* @param {*} [options] Override http request option.
|
|
206
206
|
* @throws {RequiredError}
|
|
207
207
|
*/
|
|
@@ -315,7 +315,7 @@ export interface CommissionAgreementsApiListCommissionAgreementsRequest {
|
|
|
315
315
|
*/
|
|
316
316
|
readonly pageToken?: string;
|
|
317
317
|
/**
|
|
318
|
-
* Filter the response by one or multiple fields.
|
|
318
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, createdAt, partnerCode, productSlug, endDate</i>
|
|
319
319
|
* @type {string}
|
|
320
320
|
* @memberof CommissionAgreementsApiListCommissionAgreements
|
|
321
321
|
*/
|
|
@@ -339,7 +339,7 @@ export interface CommissionAgreementsApiListCommissionAgreementsRequest {
|
|
|
339
339
|
*/
|
|
340
340
|
readonly expand?: string;
|
|
341
341
|
/**
|
|
342
|
-
* Filters the response by one or multiple fields.
|
|
342
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, createdAt, partnerCode, productSlug, endDate</i>
|
|
343
343
|
* @type {string}
|
|
344
344
|
* @memberof CommissionAgreementsApiListCommissionAgreements
|
|
345
345
|
*/
|
|
@@ -249,11 +249,11 @@ var CommissionAgreementsApiAxiosParamCreator = function (configuration) {
|
|
|
249
249
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
250
250
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
251
251
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
252
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
252
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, createdAt, partnerCode, productSlug, endDate</i>
|
|
253
253
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, commissionAgreementNumber, name, description</i>
|
|
254
254
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: commissionAgreementNumber, status, createdAt, updatedAt, billingFrequency</i>
|
|
255
255
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: versions, products<i>
|
|
256
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
256
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, createdAt, partnerCode, productSlug, endDate</i>
|
|
257
257
|
* @param {*} [options] Override http request option.
|
|
258
258
|
* @throws {RequiredError}
|
|
259
259
|
*/
|
|
@@ -501,11 +501,11 @@ var CommissionAgreementsApiFp = function (configuration) {
|
|
|
501
501
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
502
502
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
503
503
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
504
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
504
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, createdAt, partnerCode, productSlug, endDate</i>
|
|
505
505
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, commissionAgreementNumber, name, description</i>
|
|
506
506
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: commissionAgreementNumber, status, createdAt, updatedAt, billingFrequency</i>
|
|
507
507
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: versions, products<i>
|
|
508
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
508
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, createdAt, partnerCode, productSlug, endDate</i>
|
|
509
509
|
* @param {*} [options] Override http request option.
|
|
510
510
|
* @throws {RequiredError}
|
|
511
511
|
*/
|
|
@@ -616,11 +616,11 @@ var CommissionAgreementsApiFactory = function (configuration, basePath, axios) {
|
|
|
616
616
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
617
617
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
618
618
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
619
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
619
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, createdAt, partnerCode, productSlug, endDate</i>
|
|
620
620
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, commissionAgreementNumber, name, description</i>
|
|
621
621
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: commissionAgreementNumber, status, createdAt, updatedAt, billingFrequency</i>
|
|
622
622
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: versions, products<i>
|
|
623
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
623
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, createdAt, partnerCode, productSlug, endDate</i>
|
|
624
624
|
* @param {*} [options] Override http request option.
|
|
625
625
|
* @throws {RequiredError}
|
|
626
626
|
*/
|
|
@@ -57,11 +57,11 @@ export declare const CommissionCandidatesApiAxiosParamCreator: (configuration?:
|
|
|
57
57
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
58
58
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
59
59
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
60
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
60
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, policyCode, invoiceCode, commissionCode, candidateType, status, policyRenewalDate, createdAt</i>
|
|
61
61
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, policyCode, invoiceCode</i>
|
|
62
62
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: createdAt, updatedAt, policyRenewalDate</i>
|
|
63
63
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
64
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
64
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, policyCode, invoiceCode, commissionCode, candidateType, status, policyRenewalDate, createdAt</i>
|
|
65
65
|
* @param {*} [options] Override http request option.
|
|
66
66
|
* @throws {RequiredError}
|
|
67
67
|
*/
|
|
@@ -116,11 +116,11 @@ export declare const CommissionCandidatesApiFp: (configuration?: Configuration)
|
|
|
116
116
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
117
117
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
118
118
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
119
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
119
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, policyCode, invoiceCode, commissionCode, candidateType, status, policyRenewalDate, createdAt</i>
|
|
120
120
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, policyCode, invoiceCode</i>
|
|
121
121
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: createdAt, updatedAt, policyRenewalDate</i>
|
|
122
122
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
123
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
123
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, policyCode, invoiceCode, commissionCode, candidateType, status, policyRenewalDate, createdAt</i>
|
|
124
124
|
* @param {*} [options] Override http request option.
|
|
125
125
|
* @throws {RequiredError}
|
|
126
126
|
*/
|
|
@@ -175,11 +175,11 @@ export declare const CommissionCandidatesApiFactory: (configuration?: Configurat
|
|
|
175
175
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
176
176
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
177
177
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
178
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
178
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, policyCode, invoiceCode, commissionCode, candidateType, status, policyRenewalDate, createdAt</i>
|
|
179
179
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, policyCode, invoiceCode</i>
|
|
180
180
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: createdAt, updatedAt, policyRenewalDate</i>
|
|
181
181
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
182
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
182
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, policyCode, invoiceCode, commissionCode, candidateType, status, policyRenewalDate, createdAt</i>
|
|
183
183
|
* @param {*} [options] Override http request option.
|
|
184
184
|
* @throws {RequiredError}
|
|
185
185
|
*/
|
|
@@ -283,7 +283,7 @@ export interface CommissionCandidatesApiListCommissionCandidatesRequest {
|
|
|
283
283
|
*/
|
|
284
284
|
readonly pageToken?: string;
|
|
285
285
|
/**
|
|
286
|
-
* Filter the response by one or multiple fields.
|
|
286
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, policyCode, invoiceCode, commissionCode, candidateType, status, policyRenewalDate, createdAt</i>
|
|
287
287
|
* @type {string}
|
|
288
288
|
* @memberof CommissionCandidatesApiListCommissionCandidates
|
|
289
289
|
*/
|
|
@@ -307,7 +307,7 @@ export interface CommissionCandidatesApiListCommissionCandidatesRequest {
|
|
|
307
307
|
*/
|
|
308
308
|
readonly expand?: string;
|
|
309
309
|
/**
|
|
310
|
-
* Filters the response by one or multiple fields.
|
|
310
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, policyCode, invoiceCode, commissionCode, candidateType, status, policyRenewalDate, createdAt</i>
|
|
311
311
|
* @type {string}
|
|
312
312
|
* @memberof CommissionCandidatesApiListCommissionCandidates
|
|
313
313
|
*/
|
|
@@ -249,11 +249,11 @@ var CommissionCandidatesApiAxiosParamCreator = function (configuration) {
|
|
|
249
249
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
250
250
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
251
251
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
252
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
252
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, policyCode, invoiceCode, commissionCode, candidateType, status, policyRenewalDate, createdAt</i>
|
|
253
253
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, policyCode, invoiceCode</i>
|
|
254
254
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: createdAt, updatedAt, policyRenewalDate</i>
|
|
255
255
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
256
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
256
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, policyCode, invoiceCode, commissionCode, candidateType, status, policyRenewalDate, createdAt</i>
|
|
257
257
|
* @param {*} [options] Override http request option.
|
|
258
258
|
* @throws {RequiredError}
|
|
259
259
|
*/
|
|
@@ -448,11 +448,11 @@ var CommissionCandidatesApiFp = function (configuration) {
|
|
|
448
448
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
449
449
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
450
450
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
451
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
451
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, policyCode, invoiceCode, commissionCode, candidateType, status, policyRenewalDate, createdAt</i>
|
|
452
452
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, policyCode, invoiceCode</i>
|
|
453
453
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: createdAt, updatedAt, policyRenewalDate</i>
|
|
454
454
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
455
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
455
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, policyCode, invoiceCode, commissionCode, candidateType, status, policyRenewalDate, createdAt</i>
|
|
456
456
|
* @param {*} [options] Override http request option.
|
|
457
457
|
* @throws {RequiredError}
|
|
458
458
|
*/
|
|
@@ -541,11 +541,11 @@ var CommissionCandidatesApiFactory = function (configuration, basePath, axios) {
|
|
|
541
541
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
542
542
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
543
543
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
544
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
544
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, policyCode, invoiceCode, commissionCode, candidateType, status, policyRenewalDate, createdAt</i>
|
|
545
545
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, policyCode, invoiceCode</i>
|
|
546
546
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: createdAt, updatedAt, policyRenewalDate</i>
|
|
547
547
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
548
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
548
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, policyCode, invoiceCode, commissionCode, candidateType, status, policyRenewalDate, createdAt</i>
|
|
549
549
|
* @param {*} [options] Override http request option.
|
|
550
550
|
* @throws {RequiredError}
|
|
551
551
|
*/
|