@emilgroup/insurance-sdk-node 1.93.0 → 1.93.1-beta.11
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/.openapi-generator/FILES +29 -0
- package/README.md +2 -2
- package/api/product-configs-api.ts +1371 -0
- package/api.ts +2 -0
- package/dist/api/product-configs-api.d.ts +765 -0
- package/dist/api/product-configs-api.js +1225 -0
- package/dist/api.d.ts +1 -0
- package/dist/api.js +1 -0
- package/dist/models/amount-with-limit-class.d.ts +30 -0
- package/dist/models/amount-with-limit-class.js +15 -0
- package/dist/models/category-class.d.ts +57 -0
- package/dist/models/category-class.js +15 -0
- package/dist/models/claim-config-class.d.ts +39 -0
- package/dist/models/claim-config-class.js +15 -0
- package/dist/models/claim-position-fields-class.d.ts +31 -0
- package/dist/models/claim-position-fields-class.js +15 -0
- package/dist/models/coverage-class.d.ts +43 -0
- package/dist/models/coverage-class.js +15 -0
- package/dist/models/coverage-term-class.d.ts +54 -0
- package/dist/models/coverage-term-class.js +25 -0
- package/dist/models/custom-field-class.d.ts +50 -0
- package/dist/models/custom-field-class.js +23 -0
- package/dist/models/deductible-class.d.ts +60 -0
- package/dist/models/deductible-class.js +25 -0
- package/dist/models/delete-response-by-code-class.d.ts +24 -0
- package/dist/models/delete-response-by-code-class.js +15 -0
- package/dist/models/general-setting-class.d.ts +56 -0
- package/dist/models/general-setting-class.js +33 -0
- package/dist/models/index.d.ts +28 -0
- package/dist/models/index.js +28 -0
- package/dist/models/rest-create-product-config-response-class.d.ts +25 -0
- package/dist/models/rest-create-product-config-response-class.js +15 -0
- package/dist/models/rest-create-product-config-version-response-class.d.ts +25 -0
- package/dist/models/rest-create-product-config-version-response-class.js +15 -0
- package/dist/models/rest-get-product-config-response-class.d.ts +25 -0
- package/dist/models/rest-get-product-config-response-class.js +15 -0
- package/dist/models/rest-get-product-config-version-response-class.d.ts +25 -0
- package/dist/models/rest-get-product-config-version-response-class.js +15 -0
- package/dist/models/rest-list-product-config-versions-response-class.d.ts +43 -0
- package/dist/models/rest-list-product-config-versions-response-class.js +15 -0
- package/dist/models/rest-list-product-configs-response-class.d.ts +43 -0
- package/dist/models/rest-list-product-configs-response-class.js +15 -0
- package/dist/models/rest-update-product-config-response-class.d.ts +25 -0
- package/dist/models/rest-update-product-config-response-class.js +15 -0
- package/dist/models/rest-update-product-config-version-response-class.d.ts +25 -0
- package/dist/models/rest-update-product-config-version-response-class.js +15 -0
- package/dist/models/shared-product-config-class.d.ts +79 -0
- package/dist/models/shared-product-config-class.js +15 -0
- package/dist/models/shared-product-config-version-class.d.ts +85 -0
- package/dist/models/shared-product-config-version-class.js +21 -0
- package/dist/models/shared-product-field-override-class.d.ts +48 -0
- package/dist/models/shared-product-field-override-class.js +15 -0
- package/dist/models/shared-product-version-config-class.d.ts +32 -0
- package/dist/models/shared-product-version-config-class.js +15 -0
- package/dist/models/shared-tariff-variation-class.d.ts +64 -0
- package/dist/models/shared-tariff-variation-class.js +15 -0
- package/dist/models/tariff-coverage-term-class.d.ts +72 -0
- package/dist/models/tariff-coverage-term-class.js +30 -0
- package/dist/models/update-product-config-request-dto.d.ts +24 -0
- package/dist/models/update-product-config-request-dto.js +15 -0
- package/dist/models/update-product-config-version-status-request-dto.d.ts +30 -0
- package/dist/models/update-product-config-version-status-request-dto.js +21 -0
- package/dist/models/waiting-period-class.d.ts +41 -0
- package/dist/models/waiting-period-class.js +20 -0
- package/dist/models/warning-class.d.ts +47 -0
- package/dist/models/warning-class.js +20 -0
- package/models/amount-with-limit-class.ts +36 -0
- package/models/category-class.ts +63 -0
- package/models/claim-config-class.ts +45 -0
- package/models/claim-position-fields-class.ts +37 -0
- package/models/coverage-class.ts +49 -0
- package/models/coverage-term-class.ts +64 -0
- package/models/custom-field-class.ts +59 -0
- package/models/deductible-class.ts +70 -0
- package/models/delete-response-by-code-class.ts +30 -0
- package/models/general-setting-class.ts +66 -0
- package/models/index.ts +28 -0
- package/models/rest-create-product-config-response-class.ts +31 -0
- package/models/rest-create-product-config-version-response-class.ts +31 -0
- package/models/rest-get-product-config-response-class.ts +31 -0
- package/models/rest-get-product-config-version-response-class.ts +31 -0
- package/models/rest-list-product-config-versions-response-class.ts +49 -0
- package/models/rest-list-product-configs-response-class.ts +49 -0
- package/models/rest-update-product-config-response-class.ts +31 -0
- package/models/rest-update-product-config-version-response-class.ts +31 -0
- package/models/shared-product-config-class.ts +85 -0
- package/models/shared-product-config-version-class.ts +94 -0
- package/models/shared-product-field-override-class.ts +54 -0
- package/models/shared-product-version-config-class.ts +38 -0
- package/models/shared-tariff-variation-class.ts +70 -0
- package/models/tariff-coverage-term-class.ts +83 -0
- package/models/update-product-config-request-dto.ts +30 -0
- package/models/update-product-config-version-status-request-dto.ts +39 -0
- package/models/waiting-period-class.ts +50 -0
- package/models/warning-class.ts +56 -0
- package/package.json +2 -2
|
@@ -0,0 +1,765 @@
|
|
|
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 { DeleteResponseByCodeClass } from '../models';
|
|
16
|
+
import { EmptyResponseClass } from '../models';
|
|
17
|
+
import { RestCreateProductConfigResponseClass } from '../models';
|
|
18
|
+
import { RestCreateProductConfigVersionResponseClass } from '../models';
|
|
19
|
+
import { RestGetProductConfigResponseClass } from '../models';
|
|
20
|
+
import { RestGetProductConfigVersionResponseClass } from '../models';
|
|
21
|
+
import { RestListProductConfigVersionsResponseClass } from '../models';
|
|
22
|
+
import { RestListProductConfigsResponseClass } from '../models';
|
|
23
|
+
import { RestUpdateProductConfigResponseClass } from '../models';
|
|
24
|
+
import { RestUpdateProductConfigVersionResponseClass } from '../models';
|
|
25
|
+
import { UpdateProductConfigRequestDto } from '../models';
|
|
26
|
+
import { UpdateProductConfigVersionStatusRequestDto } from '../models';
|
|
27
|
+
/**
|
|
28
|
+
* ProductConfigsApi - axios parameter creator
|
|
29
|
+
* @export
|
|
30
|
+
*/
|
|
31
|
+
export declare const ProductConfigsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
32
|
+
/**
|
|
33
|
+
* Creates a product config. Accepts a JSON or YAML file containing the initial config version. Supported formats: .json, .yaml, .yml. Required fields: slug, productVersionId, file **Required Permissions** \"policy-management.products.create\"
|
|
34
|
+
* @summary Creates a new product config with initial version
|
|
35
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
36
|
+
* @param {*} [options] Override http request option.
|
|
37
|
+
* @throws {RequiredError}
|
|
38
|
+
*/
|
|
39
|
+
createProductConfig: (authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
40
|
+
/**
|
|
41
|
+
* Creates a new product config version. Accepts a JSON or YAML file containing the config. Supported formats: .json, .yaml, .yml Required fields: productConfigCode, file **Required Permissions** \"policy-management.products.create\"
|
|
42
|
+
* @summary Creates a new version for a product config
|
|
43
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
44
|
+
* @param {*} [options] Override http request option.
|
|
45
|
+
* @throws {RequiredError}
|
|
46
|
+
*/
|
|
47
|
+
createProductConfigVersion: (authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
48
|
+
/**
|
|
49
|
+
* Deletes a product config **Required Permissions** \"policy-management.products.delete\"
|
|
50
|
+
* @summary Delete the Product Config
|
|
51
|
+
* @param {string} code
|
|
52
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
53
|
+
* @param {*} [options] Override http request option.
|
|
54
|
+
* @throws {RequiredError}
|
|
55
|
+
*/
|
|
56
|
+
deleteProductConfig: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
57
|
+
/**
|
|
58
|
+
* Deletes a product config version **Required Permissions** \"policy-management.products.delete\"
|
|
59
|
+
* @summary Delete the Product Config Version
|
|
60
|
+
* @param {string} code
|
|
61
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
62
|
+
* @param {*} [options] Override http request option.
|
|
63
|
+
* @throws {RequiredError}
|
|
64
|
+
*/
|
|
65
|
+
deleteProductConfigVersion: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
66
|
+
/**
|
|
67
|
+
* Retrieves a product config by code **Required Permissions** \"policy-management.products.view\"
|
|
68
|
+
* @summary Retrieve the Product Config
|
|
69
|
+
* @param {string} code
|
|
70
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
71
|
+
* @param {*} [options] Override http request option.
|
|
72
|
+
* @throws {RequiredError}
|
|
73
|
+
*/
|
|
74
|
+
getProductConfig: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
75
|
+
/**
|
|
76
|
+
* Retrieves a product config version by code **Required Permissions** \"policy-management.products.view\"
|
|
77
|
+
* @summary Retrieve the Product Config Version
|
|
78
|
+
* @param {string} code
|
|
79
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
80
|
+
* @param {*} [options] Override http request option.
|
|
81
|
+
* @throws {RequiredError}
|
|
82
|
+
*/
|
|
83
|
+
getProductConfigVersion: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
84
|
+
/**
|
|
85
|
+
* Lists product config versions **Required Permissions** \"policy-management.products.view\"
|
|
86
|
+
* @summary List Product Config Versions
|
|
87
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
88
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
89
|
+
* @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.
|
|
90
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, productConfigCode, status, version, createdAt</i>
|
|
91
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
92
|
+
* @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: id, status, version, createdAt, updatedAt</i>
|
|
93
|
+
* @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/>
|
|
94
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, productConfigCode, status, version, createdAt</i>
|
|
95
|
+
* @param {*} [options] Override http request option.
|
|
96
|
+
* @throws {RequiredError}
|
|
97
|
+
*/
|
|
98
|
+
listProductConfigVersions: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
99
|
+
/**
|
|
100
|
+
* Lists product configs **Required Permissions** \"policy-management.products.view\"
|
|
101
|
+
* @summary List Product Configs
|
|
102
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
103
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
104
|
+
* @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.
|
|
105
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, slug, productSlug, productVersionId, createdAt</i>
|
|
106
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
107
|
+
* @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: id, createdAt, updatedAt</i>
|
|
108
|
+
* @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<i>
|
|
109
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, slug, productSlug, productVersionId, createdAt</i>
|
|
110
|
+
* @param {*} [options] Override http request option.
|
|
111
|
+
* @throws {RequiredError}
|
|
112
|
+
*/
|
|
113
|
+
listProductConfigs: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
114
|
+
/**
|
|
115
|
+
* Updates a product config **Required Permissions** \"policy-management.products.update\"
|
|
116
|
+
* @summary Update the Product Config
|
|
117
|
+
* @param {string} code
|
|
118
|
+
* @param {UpdateProductConfigRequestDto} updateProductConfigRequestDto
|
|
119
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
120
|
+
* @param {*} [options] Override http request option.
|
|
121
|
+
* @throws {RequiredError}
|
|
122
|
+
*/
|
|
123
|
+
updateProductConfig: (code: string, updateProductConfigRequestDto: UpdateProductConfigRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
124
|
+
/**
|
|
125
|
+
* Updates a draft product config version. Accepts a JSON or YAML file containing the config. Supported formats: .json, .yaml, .yml Required fields: file **Required Permissions** \"policy-management.products.update\"
|
|
126
|
+
* @summary Updates a draft product config version
|
|
127
|
+
* @param {string} code
|
|
128
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
129
|
+
* @param {*} [options] Override http request option.
|
|
130
|
+
* @throws {RequiredError}
|
|
131
|
+
*/
|
|
132
|
+
updateProductConfigVersion: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
133
|
+
/**
|
|
134
|
+
* Updates the status of a product config version **Required Permissions** \"policy-management.products.update\"
|
|
135
|
+
* @summary Update the Product Config Version Status
|
|
136
|
+
* @param {string} code
|
|
137
|
+
* @param {UpdateProductConfigVersionStatusRequestDto} updateProductConfigVersionStatusRequestDto
|
|
138
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
139
|
+
* @param {*} [options] Override http request option.
|
|
140
|
+
* @throws {RequiredError}
|
|
141
|
+
*/
|
|
142
|
+
updateProductConfigVersionStatus: (code: string, updateProductConfigVersionStatusRequestDto: UpdateProductConfigVersionStatusRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
143
|
+
};
|
|
144
|
+
/**
|
|
145
|
+
* ProductConfigsApi - functional programming interface
|
|
146
|
+
* @export
|
|
147
|
+
*/
|
|
148
|
+
export declare const ProductConfigsApiFp: (configuration?: Configuration) => {
|
|
149
|
+
/**
|
|
150
|
+
* Creates a product config. Accepts a JSON or YAML file containing the initial config version. Supported formats: .json, .yaml, .yml. Required fields: slug, productVersionId, file **Required Permissions** \"policy-management.products.create\"
|
|
151
|
+
* @summary Creates a new product config with initial version
|
|
152
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
153
|
+
* @param {*} [options] Override http request option.
|
|
154
|
+
* @throws {RequiredError}
|
|
155
|
+
*/
|
|
156
|
+
createProductConfig(authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RestCreateProductConfigResponseClass>>;
|
|
157
|
+
/**
|
|
158
|
+
* Creates a new product config version. Accepts a JSON or YAML file containing the config. Supported formats: .json, .yaml, .yml Required fields: productConfigCode, file **Required Permissions** \"policy-management.products.create\"
|
|
159
|
+
* @summary Creates a new version for a product config
|
|
160
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
161
|
+
* @param {*} [options] Override http request option.
|
|
162
|
+
* @throws {RequiredError}
|
|
163
|
+
*/
|
|
164
|
+
createProductConfigVersion(authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RestCreateProductConfigVersionResponseClass>>;
|
|
165
|
+
/**
|
|
166
|
+
* Deletes a product config **Required Permissions** \"policy-management.products.delete\"
|
|
167
|
+
* @summary Delete the Product Config
|
|
168
|
+
* @param {string} code
|
|
169
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
170
|
+
* @param {*} [options] Override http request option.
|
|
171
|
+
* @throws {RequiredError}
|
|
172
|
+
*/
|
|
173
|
+
deleteProductConfig(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponseByCodeClass>>;
|
|
174
|
+
/**
|
|
175
|
+
* Deletes a product config version **Required Permissions** \"policy-management.products.delete\"
|
|
176
|
+
* @summary Delete the Product Config Version
|
|
177
|
+
* @param {string} code
|
|
178
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
179
|
+
* @param {*} [options] Override http request option.
|
|
180
|
+
* @throws {RequiredError}
|
|
181
|
+
*/
|
|
182
|
+
deleteProductConfigVersion(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponseByCodeClass>>;
|
|
183
|
+
/**
|
|
184
|
+
* Retrieves a product config by code **Required Permissions** \"policy-management.products.view\"
|
|
185
|
+
* @summary Retrieve the Product Config
|
|
186
|
+
* @param {string} code
|
|
187
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
188
|
+
* @param {*} [options] Override http request option.
|
|
189
|
+
* @throws {RequiredError}
|
|
190
|
+
*/
|
|
191
|
+
getProductConfig(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RestGetProductConfigResponseClass>>;
|
|
192
|
+
/**
|
|
193
|
+
* Retrieves a product config version by code **Required Permissions** \"policy-management.products.view\"
|
|
194
|
+
* @summary Retrieve the Product Config Version
|
|
195
|
+
* @param {string} code
|
|
196
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
197
|
+
* @param {*} [options] Override http request option.
|
|
198
|
+
* @throws {RequiredError}
|
|
199
|
+
*/
|
|
200
|
+
getProductConfigVersion(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RestGetProductConfigVersionResponseClass>>;
|
|
201
|
+
/**
|
|
202
|
+
* Lists product config versions **Required Permissions** \"policy-management.products.view\"
|
|
203
|
+
* @summary List Product Config Versions
|
|
204
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
205
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
206
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=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. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, productConfigCode, status, version, createdAt</i>
|
|
208
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
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: id, status, version, createdAt, updatedAt</i>
|
|
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/>
|
|
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: code, productConfigCode, status, version, createdAt</i>
|
|
212
|
+
* @param {*} [options] Override http request option.
|
|
213
|
+
* @throws {RequiredError}
|
|
214
|
+
*/
|
|
215
|
+
listProductConfigVersions(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RestListProductConfigVersionsResponseClass>>;
|
|
216
|
+
/**
|
|
217
|
+
* Lists product configs **Required Permissions** \"policy-management.products.view\"
|
|
218
|
+
* @summary List Product Configs
|
|
219
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
220
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
221
|
+
* @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.
|
|
222
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, slug, productSlug, productVersionId, createdAt</i>
|
|
223
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
224
|
+
* @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: id, createdAt, updatedAt</i>
|
|
225
|
+
* @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<i>
|
|
226
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, slug, productSlug, productVersionId, createdAt</i>
|
|
227
|
+
* @param {*} [options] Override http request option.
|
|
228
|
+
* @throws {RequiredError}
|
|
229
|
+
*/
|
|
230
|
+
listProductConfigs(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RestListProductConfigsResponseClass>>;
|
|
231
|
+
/**
|
|
232
|
+
* Updates a product config **Required Permissions** \"policy-management.products.update\"
|
|
233
|
+
* @summary Update the Product Config
|
|
234
|
+
* @param {string} code
|
|
235
|
+
* @param {UpdateProductConfigRequestDto} updateProductConfigRequestDto
|
|
236
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
237
|
+
* @param {*} [options] Override http request option.
|
|
238
|
+
* @throws {RequiredError}
|
|
239
|
+
*/
|
|
240
|
+
updateProductConfig(code: string, updateProductConfigRequestDto: UpdateProductConfigRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RestUpdateProductConfigResponseClass>>;
|
|
241
|
+
/**
|
|
242
|
+
* Updates a draft product config version. Accepts a JSON or YAML file containing the config. Supported formats: .json, .yaml, .yml Required fields: file **Required Permissions** \"policy-management.products.update\"
|
|
243
|
+
* @summary Updates a draft product config version
|
|
244
|
+
* @param {string} code
|
|
245
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
246
|
+
* @param {*} [options] Override http request option.
|
|
247
|
+
* @throws {RequiredError}
|
|
248
|
+
*/
|
|
249
|
+
updateProductConfigVersion(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RestUpdateProductConfigVersionResponseClass>>;
|
|
250
|
+
/**
|
|
251
|
+
* Updates the status of a product config version **Required Permissions** \"policy-management.products.update\"
|
|
252
|
+
* @summary Update the Product Config Version Status
|
|
253
|
+
* @param {string} code
|
|
254
|
+
* @param {UpdateProductConfigVersionStatusRequestDto} updateProductConfigVersionStatusRequestDto
|
|
255
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
256
|
+
* @param {*} [options] Override http request option.
|
|
257
|
+
* @throws {RequiredError}
|
|
258
|
+
*/
|
|
259
|
+
updateProductConfigVersionStatus(code: string, updateProductConfigVersionStatusRequestDto: UpdateProductConfigVersionStatusRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmptyResponseClass>>;
|
|
260
|
+
};
|
|
261
|
+
/**
|
|
262
|
+
* ProductConfigsApi - factory interface
|
|
263
|
+
* @export
|
|
264
|
+
*/
|
|
265
|
+
export declare const ProductConfigsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
266
|
+
/**
|
|
267
|
+
* Creates a product config. Accepts a JSON or YAML file containing the initial config version. Supported formats: .json, .yaml, .yml. Required fields: slug, productVersionId, file **Required Permissions** \"policy-management.products.create\"
|
|
268
|
+
* @summary Creates a new product config with initial version
|
|
269
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
270
|
+
* @param {*} [options] Override http request option.
|
|
271
|
+
* @throws {RequiredError}
|
|
272
|
+
*/
|
|
273
|
+
createProductConfig(authorization?: string, options?: any): AxiosPromise<RestCreateProductConfigResponseClass>;
|
|
274
|
+
/**
|
|
275
|
+
* Creates a new product config version. Accepts a JSON or YAML file containing the config. Supported formats: .json, .yaml, .yml Required fields: productConfigCode, file **Required Permissions** \"policy-management.products.create\"
|
|
276
|
+
* @summary Creates a new version for a product config
|
|
277
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
278
|
+
* @param {*} [options] Override http request option.
|
|
279
|
+
* @throws {RequiredError}
|
|
280
|
+
*/
|
|
281
|
+
createProductConfigVersion(authorization?: string, options?: any): AxiosPromise<RestCreateProductConfigVersionResponseClass>;
|
|
282
|
+
/**
|
|
283
|
+
* Deletes a product config **Required Permissions** \"policy-management.products.delete\"
|
|
284
|
+
* @summary Delete the Product Config
|
|
285
|
+
* @param {string} code
|
|
286
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
287
|
+
* @param {*} [options] Override http request option.
|
|
288
|
+
* @throws {RequiredError}
|
|
289
|
+
*/
|
|
290
|
+
deleteProductConfig(code: string, authorization?: string, options?: any): AxiosPromise<DeleteResponseByCodeClass>;
|
|
291
|
+
/**
|
|
292
|
+
* Deletes a product config version **Required Permissions** \"policy-management.products.delete\"
|
|
293
|
+
* @summary Delete the Product Config Version
|
|
294
|
+
* @param {string} code
|
|
295
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
296
|
+
* @param {*} [options] Override http request option.
|
|
297
|
+
* @throws {RequiredError}
|
|
298
|
+
*/
|
|
299
|
+
deleteProductConfigVersion(code: string, authorization?: string, options?: any): AxiosPromise<DeleteResponseByCodeClass>;
|
|
300
|
+
/**
|
|
301
|
+
* Retrieves a product config by code **Required Permissions** \"policy-management.products.view\"
|
|
302
|
+
* @summary Retrieve the Product Config
|
|
303
|
+
* @param {string} code
|
|
304
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
305
|
+
* @param {*} [options] Override http request option.
|
|
306
|
+
* @throws {RequiredError}
|
|
307
|
+
*/
|
|
308
|
+
getProductConfig(code: string, authorization?: string, options?: any): AxiosPromise<RestGetProductConfigResponseClass>;
|
|
309
|
+
/**
|
|
310
|
+
* Retrieves a product config version by code **Required Permissions** \"policy-management.products.view\"
|
|
311
|
+
* @summary Retrieve the Product Config Version
|
|
312
|
+
* @param {string} code
|
|
313
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
314
|
+
* @param {*} [options] Override http request option.
|
|
315
|
+
* @throws {RequiredError}
|
|
316
|
+
*/
|
|
317
|
+
getProductConfigVersion(code: string, authorization?: string, options?: any): AxiosPromise<RestGetProductConfigVersionResponseClass>;
|
|
318
|
+
/**
|
|
319
|
+
* Lists product config versions **Required Permissions** \"policy-management.products.view\"
|
|
320
|
+
* @summary List Product Config Versions
|
|
321
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
322
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
323
|
+
* @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.
|
|
324
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, productConfigCode, status, version, createdAt</i>
|
|
325
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
326
|
+
* @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: id, status, version, createdAt, updatedAt</i>
|
|
327
|
+
* @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/>
|
|
328
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, productConfigCode, status, version, createdAt</i>
|
|
329
|
+
* @param {*} [options] Override http request option.
|
|
330
|
+
* @throws {RequiredError}
|
|
331
|
+
*/
|
|
332
|
+
listProductConfigVersions(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<RestListProductConfigVersionsResponseClass>;
|
|
333
|
+
/**
|
|
334
|
+
* Lists product configs **Required Permissions** \"policy-management.products.view\"
|
|
335
|
+
* @summary List Product Configs
|
|
336
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
337
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
338
|
+
* @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.
|
|
339
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, slug, productSlug, productVersionId, createdAt</i>
|
|
340
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
341
|
+
* @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: id, createdAt, updatedAt</i>
|
|
342
|
+
* @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<i>
|
|
343
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, slug, productSlug, productVersionId, createdAt</i>
|
|
344
|
+
* @param {*} [options] Override http request option.
|
|
345
|
+
* @throws {RequiredError}
|
|
346
|
+
*/
|
|
347
|
+
listProductConfigs(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<RestListProductConfigsResponseClass>;
|
|
348
|
+
/**
|
|
349
|
+
* Updates a product config **Required Permissions** \"policy-management.products.update\"
|
|
350
|
+
* @summary Update the Product Config
|
|
351
|
+
* @param {string} code
|
|
352
|
+
* @param {UpdateProductConfigRequestDto} updateProductConfigRequestDto
|
|
353
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
354
|
+
* @param {*} [options] Override http request option.
|
|
355
|
+
* @throws {RequiredError}
|
|
356
|
+
*/
|
|
357
|
+
updateProductConfig(code: string, updateProductConfigRequestDto: UpdateProductConfigRequestDto, authorization?: string, options?: any): AxiosPromise<RestUpdateProductConfigResponseClass>;
|
|
358
|
+
/**
|
|
359
|
+
* Updates a draft product config version. Accepts a JSON or YAML file containing the config. Supported formats: .json, .yaml, .yml Required fields: file **Required Permissions** \"policy-management.products.update\"
|
|
360
|
+
* @summary Updates a draft product config version
|
|
361
|
+
* @param {string} code
|
|
362
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
363
|
+
* @param {*} [options] Override http request option.
|
|
364
|
+
* @throws {RequiredError}
|
|
365
|
+
*/
|
|
366
|
+
updateProductConfigVersion(code: string, authorization?: string, options?: any): AxiosPromise<RestUpdateProductConfigVersionResponseClass>;
|
|
367
|
+
/**
|
|
368
|
+
* Updates the status of a product config version **Required Permissions** \"policy-management.products.update\"
|
|
369
|
+
* @summary Update the Product Config Version Status
|
|
370
|
+
* @param {string} code
|
|
371
|
+
* @param {UpdateProductConfigVersionStatusRequestDto} updateProductConfigVersionStatusRequestDto
|
|
372
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
373
|
+
* @param {*} [options] Override http request option.
|
|
374
|
+
* @throws {RequiredError}
|
|
375
|
+
*/
|
|
376
|
+
updateProductConfigVersionStatus(code: string, updateProductConfigVersionStatusRequestDto: UpdateProductConfigVersionStatusRequestDto, authorization?: string, options?: any): AxiosPromise<EmptyResponseClass>;
|
|
377
|
+
};
|
|
378
|
+
/**
|
|
379
|
+
* Request parameters for createProductConfig operation in ProductConfigsApi.
|
|
380
|
+
* @export
|
|
381
|
+
* @interface ProductConfigsApiCreateProductConfigRequest
|
|
382
|
+
*/
|
|
383
|
+
export interface ProductConfigsApiCreateProductConfigRequest {
|
|
384
|
+
/**
|
|
385
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
386
|
+
* @type {string}
|
|
387
|
+
* @memberof ProductConfigsApiCreateProductConfig
|
|
388
|
+
*/
|
|
389
|
+
readonly authorization?: string;
|
|
390
|
+
}
|
|
391
|
+
/**
|
|
392
|
+
* Request parameters for createProductConfigVersion operation in ProductConfigsApi.
|
|
393
|
+
* @export
|
|
394
|
+
* @interface ProductConfigsApiCreateProductConfigVersionRequest
|
|
395
|
+
*/
|
|
396
|
+
export interface ProductConfigsApiCreateProductConfigVersionRequest {
|
|
397
|
+
/**
|
|
398
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
399
|
+
* @type {string}
|
|
400
|
+
* @memberof ProductConfigsApiCreateProductConfigVersion
|
|
401
|
+
*/
|
|
402
|
+
readonly authorization?: string;
|
|
403
|
+
}
|
|
404
|
+
/**
|
|
405
|
+
* Request parameters for deleteProductConfig operation in ProductConfigsApi.
|
|
406
|
+
* @export
|
|
407
|
+
* @interface ProductConfigsApiDeleteProductConfigRequest
|
|
408
|
+
*/
|
|
409
|
+
export interface ProductConfigsApiDeleteProductConfigRequest {
|
|
410
|
+
/**
|
|
411
|
+
*
|
|
412
|
+
* @type {string}
|
|
413
|
+
* @memberof ProductConfigsApiDeleteProductConfig
|
|
414
|
+
*/
|
|
415
|
+
readonly code: string;
|
|
416
|
+
/**
|
|
417
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
418
|
+
* @type {string}
|
|
419
|
+
* @memberof ProductConfigsApiDeleteProductConfig
|
|
420
|
+
*/
|
|
421
|
+
readonly authorization?: string;
|
|
422
|
+
}
|
|
423
|
+
/**
|
|
424
|
+
* Request parameters for deleteProductConfigVersion operation in ProductConfigsApi.
|
|
425
|
+
* @export
|
|
426
|
+
* @interface ProductConfigsApiDeleteProductConfigVersionRequest
|
|
427
|
+
*/
|
|
428
|
+
export interface ProductConfigsApiDeleteProductConfigVersionRequest {
|
|
429
|
+
/**
|
|
430
|
+
*
|
|
431
|
+
* @type {string}
|
|
432
|
+
* @memberof ProductConfigsApiDeleteProductConfigVersion
|
|
433
|
+
*/
|
|
434
|
+
readonly code: string;
|
|
435
|
+
/**
|
|
436
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
437
|
+
* @type {string}
|
|
438
|
+
* @memberof ProductConfigsApiDeleteProductConfigVersion
|
|
439
|
+
*/
|
|
440
|
+
readonly authorization?: string;
|
|
441
|
+
}
|
|
442
|
+
/**
|
|
443
|
+
* Request parameters for getProductConfig operation in ProductConfigsApi.
|
|
444
|
+
* @export
|
|
445
|
+
* @interface ProductConfigsApiGetProductConfigRequest
|
|
446
|
+
*/
|
|
447
|
+
export interface ProductConfigsApiGetProductConfigRequest {
|
|
448
|
+
/**
|
|
449
|
+
*
|
|
450
|
+
* @type {string}
|
|
451
|
+
* @memberof ProductConfigsApiGetProductConfig
|
|
452
|
+
*/
|
|
453
|
+
readonly code: string;
|
|
454
|
+
/**
|
|
455
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
456
|
+
* @type {string}
|
|
457
|
+
* @memberof ProductConfigsApiGetProductConfig
|
|
458
|
+
*/
|
|
459
|
+
readonly authorization?: string;
|
|
460
|
+
}
|
|
461
|
+
/**
|
|
462
|
+
* Request parameters for getProductConfigVersion operation in ProductConfigsApi.
|
|
463
|
+
* @export
|
|
464
|
+
* @interface ProductConfigsApiGetProductConfigVersionRequest
|
|
465
|
+
*/
|
|
466
|
+
export interface ProductConfigsApiGetProductConfigVersionRequest {
|
|
467
|
+
/**
|
|
468
|
+
*
|
|
469
|
+
* @type {string}
|
|
470
|
+
* @memberof ProductConfigsApiGetProductConfigVersion
|
|
471
|
+
*/
|
|
472
|
+
readonly code: string;
|
|
473
|
+
/**
|
|
474
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
475
|
+
* @type {string}
|
|
476
|
+
* @memberof ProductConfigsApiGetProductConfigVersion
|
|
477
|
+
*/
|
|
478
|
+
readonly authorization?: string;
|
|
479
|
+
}
|
|
480
|
+
/**
|
|
481
|
+
* Request parameters for listProductConfigVersions operation in ProductConfigsApi.
|
|
482
|
+
* @export
|
|
483
|
+
* @interface ProductConfigsApiListProductConfigVersionsRequest
|
|
484
|
+
*/
|
|
485
|
+
export interface ProductConfigsApiListProductConfigVersionsRequest {
|
|
486
|
+
/**
|
|
487
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
488
|
+
* @type {string}
|
|
489
|
+
* @memberof ProductConfigsApiListProductConfigVersions
|
|
490
|
+
*/
|
|
491
|
+
readonly authorization?: string;
|
|
492
|
+
/**
|
|
493
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
494
|
+
* @type {number}
|
|
495
|
+
* @memberof ProductConfigsApiListProductConfigVersions
|
|
496
|
+
*/
|
|
497
|
+
readonly pageSize?: number;
|
|
498
|
+
/**
|
|
499
|
+
* 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.
|
|
500
|
+
* @type {string}
|
|
501
|
+
* @memberof ProductConfigsApiListProductConfigVersions
|
|
502
|
+
*/
|
|
503
|
+
readonly pageToken?: string;
|
|
504
|
+
/**
|
|
505
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, productConfigCode, status, version, createdAt</i>
|
|
506
|
+
* @type {string}
|
|
507
|
+
* @memberof ProductConfigsApiListProductConfigVersions
|
|
508
|
+
*/
|
|
509
|
+
readonly filter?: string;
|
|
510
|
+
/**
|
|
511
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
512
|
+
* @type {string}
|
|
513
|
+
* @memberof ProductConfigsApiListProductConfigVersions
|
|
514
|
+
*/
|
|
515
|
+
readonly search?: string;
|
|
516
|
+
/**
|
|
517
|
+
* 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: id, status, version, createdAt, updatedAt</i>
|
|
518
|
+
* @type {string}
|
|
519
|
+
* @memberof ProductConfigsApiListProductConfigVersions
|
|
520
|
+
*/
|
|
521
|
+
readonly order?: string;
|
|
522
|
+
/**
|
|
523
|
+
* 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/>
|
|
524
|
+
* @type {string}
|
|
525
|
+
* @memberof ProductConfigsApiListProductConfigVersions
|
|
526
|
+
*/
|
|
527
|
+
readonly expand?: string;
|
|
528
|
+
/**
|
|
529
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, productConfigCode, status, version, createdAt</i>
|
|
530
|
+
* @type {string}
|
|
531
|
+
* @memberof ProductConfigsApiListProductConfigVersions
|
|
532
|
+
*/
|
|
533
|
+
readonly filters?: string;
|
|
534
|
+
}
|
|
535
|
+
/**
|
|
536
|
+
* Request parameters for listProductConfigs operation in ProductConfigsApi.
|
|
537
|
+
* @export
|
|
538
|
+
* @interface ProductConfigsApiListProductConfigsRequest
|
|
539
|
+
*/
|
|
540
|
+
export interface ProductConfigsApiListProductConfigsRequest {
|
|
541
|
+
/**
|
|
542
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
543
|
+
* @type {string}
|
|
544
|
+
* @memberof ProductConfigsApiListProductConfigs
|
|
545
|
+
*/
|
|
546
|
+
readonly authorization?: string;
|
|
547
|
+
/**
|
|
548
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
549
|
+
* @type {number}
|
|
550
|
+
* @memberof ProductConfigsApiListProductConfigs
|
|
551
|
+
*/
|
|
552
|
+
readonly pageSize?: number;
|
|
553
|
+
/**
|
|
554
|
+
* 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.
|
|
555
|
+
* @type {string}
|
|
556
|
+
* @memberof ProductConfigsApiListProductConfigs
|
|
557
|
+
*/
|
|
558
|
+
readonly pageToken?: string;
|
|
559
|
+
/**
|
|
560
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code, slug, productSlug, productVersionId, createdAt</i>
|
|
561
|
+
* @type {string}
|
|
562
|
+
* @memberof ProductConfigsApiListProductConfigs
|
|
563
|
+
*/
|
|
564
|
+
readonly filter?: string;
|
|
565
|
+
/**
|
|
566
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
567
|
+
* @type {string}
|
|
568
|
+
* @memberof ProductConfigsApiListProductConfigs
|
|
569
|
+
*/
|
|
570
|
+
readonly search?: string;
|
|
571
|
+
/**
|
|
572
|
+
* 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: id, createdAt, updatedAt</i>
|
|
573
|
+
* @type {string}
|
|
574
|
+
* @memberof ProductConfigsApiListProductConfigs
|
|
575
|
+
*/
|
|
576
|
+
readonly order?: string;
|
|
577
|
+
/**
|
|
578
|
+
* 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<i>
|
|
579
|
+
* @type {string}
|
|
580
|
+
* @memberof ProductConfigsApiListProductConfigs
|
|
581
|
+
*/
|
|
582
|
+
readonly expand?: string;
|
|
583
|
+
/**
|
|
584
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code, slug, productSlug, productVersionId, createdAt</i>
|
|
585
|
+
* @type {string}
|
|
586
|
+
* @memberof ProductConfigsApiListProductConfigs
|
|
587
|
+
*/
|
|
588
|
+
readonly filters?: string;
|
|
589
|
+
}
|
|
590
|
+
/**
|
|
591
|
+
* Request parameters for updateProductConfig operation in ProductConfigsApi.
|
|
592
|
+
* @export
|
|
593
|
+
* @interface ProductConfigsApiUpdateProductConfigRequest
|
|
594
|
+
*/
|
|
595
|
+
export interface ProductConfigsApiUpdateProductConfigRequest {
|
|
596
|
+
/**
|
|
597
|
+
*
|
|
598
|
+
* @type {string}
|
|
599
|
+
* @memberof ProductConfigsApiUpdateProductConfig
|
|
600
|
+
*/
|
|
601
|
+
readonly code: string;
|
|
602
|
+
/**
|
|
603
|
+
*
|
|
604
|
+
* @type {UpdateProductConfigRequestDto}
|
|
605
|
+
* @memberof ProductConfigsApiUpdateProductConfig
|
|
606
|
+
*/
|
|
607
|
+
readonly updateProductConfigRequestDto: UpdateProductConfigRequestDto;
|
|
608
|
+
/**
|
|
609
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
610
|
+
* @type {string}
|
|
611
|
+
* @memberof ProductConfigsApiUpdateProductConfig
|
|
612
|
+
*/
|
|
613
|
+
readonly authorization?: string;
|
|
614
|
+
}
|
|
615
|
+
/**
|
|
616
|
+
* Request parameters for updateProductConfigVersion operation in ProductConfigsApi.
|
|
617
|
+
* @export
|
|
618
|
+
* @interface ProductConfigsApiUpdateProductConfigVersionRequest
|
|
619
|
+
*/
|
|
620
|
+
export interface ProductConfigsApiUpdateProductConfigVersionRequest {
|
|
621
|
+
/**
|
|
622
|
+
*
|
|
623
|
+
* @type {string}
|
|
624
|
+
* @memberof ProductConfigsApiUpdateProductConfigVersion
|
|
625
|
+
*/
|
|
626
|
+
readonly code: string;
|
|
627
|
+
/**
|
|
628
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
629
|
+
* @type {string}
|
|
630
|
+
* @memberof ProductConfigsApiUpdateProductConfigVersion
|
|
631
|
+
*/
|
|
632
|
+
readonly authorization?: string;
|
|
633
|
+
}
|
|
634
|
+
/**
|
|
635
|
+
* Request parameters for updateProductConfigVersionStatus operation in ProductConfigsApi.
|
|
636
|
+
* @export
|
|
637
|
+
* @interface ProductConfigsApiUpdateProductConfigVersionStatusRequest
|
|
638
|
+
*/
|
|
639
|
+
export interface ProductConfigsApiUpdateProductConfigVersionStatusRequest {
|
|
640
|
+
/**
|
|
641
|
+
*
|
|
642
|
+
* @type {string}
|
|
643
|
+
* @memberof ProductConfigsApiUpdateProductConfigVersionStatus
|
|
644
|
+
*/
|
|
645
|
+
readonly code: string;
|
|
646
|
+
/**
|
|
647
|
+
*
|
|
648
|
+
* @type {UpdateProductConfigVersionStatusRequestDto}
|
|
649
|
+
* @memberof ProductConfigsApiUpdateProductConfigVersionStatus
|
|
650
|
+
*/
|
|
651
|
+
readonly updateProductConfigVersionStatusRequestDto: UpdateProductConfigVersionStatusRequestDto;
|
|
652
|
+
/**
|
|
653
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
654
|
+
* @type {string}
|
|
655
|
+
* @memberof ProductConfigsApiUpdateProductConfigVersionStatus
|
|
656
|
+
*/
|
|
657
|
+
readonly authorization?: string;
|
|
658
|
+
}
|
|
659
|
+
/**
|
|
660
|
+
* ProductConfigsApi - object-oriented interface
|
|
661
|
+
* @export
|
|
662
|
+
* @class ProductConfigsApi
|
|
663
|
+
* @extends {BaseAPI}
|
|
664
|
+
*/
|
|
665
|
+
export declare class ProductConfigsApi extends BaseAPI {
|
|
666
|
+
/**
|
|
667
|
+
* Creates a product config. Accepts a JSON or YAML file containing the initial config version. Supported formats: .json, .yaml, .yml. Required fields: slug, productVersionId, file **Required Permissions** \"policy-management.products.create\"
|
|
668
|
+
* @summary Creates a new product config with initial version
|
|
669
|
+
* @param {ProductConfigsApiCreateProductConfigRequest} requestParameters Request parameters.
|
|
670
|
+
* @param {*} [options] Override http request option.
|
|
671
|
+
* @throws {RequiredError}
|
|
672
|
+
* @memberof ProductConfigsApi
|
|
673
|
+
*/
|
|
674
|
+
createProductConfig(requestParameters?: ProductConfigsApiCreateProductConfigRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RestCreateProductConfigResponseClass, any, {}>>;
|
|
675
|
+
/**
|
|
676
|
+
* Creates a new product config version. Accepts a JSON or YAML file containing the config. Supported formats: .json, .yaml, .yml Required fields: productConfigCode, file **Required Permissions** \"policy-management.products.create\"
|
|
677
|
+
* @summary Creates a new version for a product config
|
|
678
|
+
* @param {ProductConfigsApiCreateProductConfigVersionRequest} requestParameters Request parameters.
|
|
679
|
+
* @param {*} [options] Override http request option.
|
|
680
|
+
* @throws {RequiredError}
|
|
681
|
+
* @memberof ProductConfigsApi
|
|
682
|
+
*/
|
|
683
|
+
createProductConfigVersion(requestParameters?: ProductConfigsApiCreateProductConfigVersionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RestCreateProductConfigVersionResponseClass, any, {}>>;
|
|
684
|
+
/**
|
|
685
|
+
* Deletes a product config **Required Permissions** \"policy-management.products.delete\"
|
|
686
|
+
* @summary Delete the Product Config
|
|
687
|
+
* @param {ProductConfigsApiDeleteProductConfigRequest} requestParameters Request parameters.
|
|
688
|
+
* @param {*} [options] Override http request option.
|
|
689
|
+
* @throws {RequiredError}
|
|
690
|
+
* @memberof ProductConfigsApi
|
|
691
|
+
*/
|
|
692
|
+
deleteProductConfig(requestParameters: ProductConfigsApiDeleteProductConfigRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteResponseByCodeClass, any, {}>>;
|
|
693
|
+
/**
|
|
694
|
+
* Deletes a product config version **Required Permissions** \"policy-management.products.delete\"
|
|
695
|
+
* @summary Delete the Product Config Version
|
|
696
|
+
* @param {ProductConfigsApiDeleteProductConfigVersionRequest} requestParameters Request parameters.
|
|
697
|
+
* @param {*} [options] Override http request option.
|
|
698
|
+
* @throws {RequiredError}
|
|
699
|
+
* @memberof ProductConfigsApi
|
|
700
|
+
*/
|
|
701
|
+
deleteProductConfigVersion(requestParameters: ProductConfigsApiDeleteProductConfigVersionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteResponseByCodeClass, any, {}>>;
|
|
702
|
+
/**
|
|
703
|
+
* Retrieves a product config by code **Required Permissions** \"policy-management.products.view\"
|
|
704
|
+
* @summary Retrieve the Product Config
|
|
705
|
+
* @param {ProductConfigsApiGetProductConfigRequest} requestParameters Request parameters.
|
|
706
|
+
* @param {*} [options] Override http request option.
|
|
707
|
+
* @throws {RequiredError}
|
|
708
|
+
* @memberof ProductConfigsApi
|
|
709
|
+
*/
|
|
710
|
+
getProductConfig(requestParameters: ProductConfigsApiGetProductConfigRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RestGetProductConfigResponseClass, any, {}>>;
|
|
711
|
+
/**
|
|
712
|
+
* Retrieves a product config version by code **Required Permissions** \"policy-management.products.view\"
|
|
713
|
+
* @summary Retrieve the Product Config Version
|
|
714
|
+
* @param {ProductConfigsApiGetProductConfigVersionRequest} requestParameters Request parameters.
|
|
715
|
+
* @param {*} [options] Override http request option.
|
|
716
|
+
* @throws {RequiredError}
|
|
717
|
+
* @memberof ProductConfigsApi
|
|
718
|
+
*/
|
|
719
|
+
getProductConfigVersion(requestParameters: ProductConfigsApiGetProductConfigVersionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RestGetProductConfigVersionResponseClass, any, {}>>;
|
|
720
|
+
/**
|
|
721
|
+
* Lists product config versions **Required Permissions** \"policy-management.products.view\"
|
|
722
|
+
* @summary List Product Config Versions
|
|
723
|
+
* @param {ProductConfigsApiListProductConfigVersionsRequest} requestParameters Request parameters.
|
|
724
|
+
* @param {*} [options] Override http request option.
|
|
725
|
+
* @throws {RequiredError}
|
|
726
|
+
* @memberof ProductConfigsApi
|
|
727
|
+
*/
|
|
728
|
+
listProductConfigVersions(requestParameters?: ProductConfigsApiListProductConfigVersionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RestListProductConfigVersionsResponseClass, any, {}>>;
|
|
729
|
+
/**
|
|
730
|
+
* Lists product configs **Required Permissions** \"policy-management.products.view\"
|
|
731
|
+
* @summary List Product Configs
|
|
732
|
+
* @param {ProductConfigsApiListProductConfigsRequest} requestParameters Request parameters.
|
|
733
|
+
* @param {*} [options] Override http request option.
|
|
734
|
+
* @throws {RequiredError}
|
|
735
|
+
* @memberof ProductConfigsApi
|
|
736
|
+
*/
|
|
737
|
+
listProductConfigs(requestParameters?: ProductConfigsApiListProductConfigsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RestListProductConfigsResponseClass, any, {}>>;
|
|
738
|
+
/**
|
|
739
|
+
* Updates a product config **Required Permissions** \"policy-management.products.update\"
|
|
740
|
+
* @summary Update the Product Config
|
|
741
|
+
* @param {ProductConfigsApiUpdateProductConfigRequest} requestParameters Request parameters.
|
|
742
|
+
* @param {*} [options] Override http request option.
|
|
743
|
+
* @throws {RequiredError}
|
|
744
|
+
* @memberof ProductConfigsApi
|
|
745
|
+
*/
|
|
746
|
+
updateProductConfig(requestParameters: ProductConfigsApiUpdateProductConfigRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RestUpdateProductConfigResponseClass, any, {}>>;
|
|
747
|
+
/**
|
|
748
|
+
* Updates a draft product config version. Accepts a JSON or YAML file containing the config. Supported formats: .json, .yaml, .yml Required fields: file **Required Permissions** \"policy-management.products.update\"
|
|
749
|
+
* @summary Updates a draft product config version
|
|
750
|
+
* @param {ProductConfigsApiUpdateProductConfigVersionRequest} requestParameters Request parameters.
|
|
751
|
+
* @param {*} [options] Override http request option.
|
|
752
|
+
* @throws {RequiredError}
|
|
753
|
+
* @memberof ProductConfigsApi
|
|
754
|
+
*/
|
|
755
|
+
updateProductConfigVersion(requestParameters: ProductConfigsApiUpdateProductConfigVersionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RestUpdateProductConfigVersionResponseClass, any, {}>>;
|
|
756
|
+
/**
|
|
757
|
+
* Updates the status of a product config version **Required Permissions** \"policy-management.products.update\"
|
|
758
|
+
* @summary Update the Product Config Version Status
|
|
759
|
+
* @param {ProductConfigsApiUpdateProductConfigVersionStatusRequest} requestParameters Request parameters.
|
|
760
|
+
* @param {*} [options] Override http request option.
|
|
761
|
+
* @throws {RequiredError}
|
|
762
|
+
* @memberof ProductConfigsApi
|
|
763
|
+
*/
|
|
764
|
+
updateProductConfigVersionStatus(requestParameters: ProductConfigsApiUpdateProductConfigVersionStatusRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EmptyResponseClass, any, {}>>;
|
|
765
|
+
}
|