@emilgroup/insurance-sdk-node 1.95.0 → 1.95.1-beta.7
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 +43 -0
- package/README.md +2 -2
- package/api/product-configs-api.ts +857 -0
- package/api/product-versions-api.ts +188 -0
- package/api.ts +2 -0
- package/dist/api/product-configs-api.d.ts +476 -0
- package/dist/api/product-configs-api.js +769 -0
- package/dist/api/product-versions-api.d.ts +110 -0
- package/dist/api/product-versions-api.js +129 -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/calculated-policy-object-class.d.ts +36 -0
- package/dist/models/calculated-policy-object-class.js +15 -0
- package/dist/models/calculation-errors-class.d.ts +25 -0
- package/dist/models/calculation-errors-class.js +15 -0
- package/dist/models/calculation-item-errors-class.d.ts +43 -0
- package/dist/models/calculation-item-errors-class.js +15 -0
- package/dist/models/calculation-message-class.d.ts +30 -0
- package/dist/models/calculation-message-class.js +15 -0
- package/dist/models/category-calculation-order-class.d.ts +25 -0
- package/dist/models/category-calculation-order-class.js +15 -0
- package/dist/models/category-calculation-step-class.d.ts +58 -0
- package/dist/models/category-calculation-step-class.js +24 -0
- package/dist/models/category-class.d.ts +52 -0
- package/dist/models/category-class.js +15 -0
- package/dist/models/category-coverage-summary-class.d.ts +43 -0
- package/dist/models/category-coverage-summary-class.js +15 -0
- package/dist/models/category-definition-class.d.ts +43 -0
- package/dist/models/category-definition-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 +31 -0
- package/dist/models/coverage-class.js +15 -0
- package/dist/models/coverage-definition-class.d.ts +36 -0
- package/dist/models/coverage-definition-class.js +15 -0
- package/dist/models/coverage-term-class.d.ts +66 -0
- package/dist/models/coverage-term-class.js +30 -0
- package/dist/models/create-product-field-request-dto.d.ts +6 -0
- package/dist/models/create-product-request-dto.d.ts +1 -0
- package/dist/models/create-product-request-dto.js +2 -1
- package/dist/models/custom-field-class.d.ts +52 -0
- package/dist/models/custom-field-class.js +25 -0
- package/dist/models/deductible-class.d.ts +60 -0
- package/dist/models/deductible-class.js +25 -0
- package/dist/models/general-setting-class.d.ts +49 -0
- package/dist/models/general-setting-class.js +33 -0
- package/dist/models/get-product-config-tariffs-response-class.d.ts +31 -0
- package/dist/models/get-product-config-tariffs-response-class.js +15 -0
- package/dist/models/index.d.ts +42 -0
- package/dist/models/index.js +42 -0
- package/dist/models/lead-policy-object-class.d.ts +42 -0
- package/dist/models/lead-policy-object-class.js +15 -0
- package/dist/models/list-product-versions-response-class.d.ts +31 -0
- package/dist/models/list-product-versions-response-class.js +15 -0
- package/dist/models/product-config-summary-class.d.ts +72 -0
- package/dist/models/product-config-summary-class.js +15 -0
- package/dist/models/product-field-class.d.ts +6 -0
- package/dist/models/product-version-class.d.ts +6 -0
- package/dist/models/rest-calculate-product-tariff-quote-request-dto.d.ts +38 -0
- package/dist/models/rest-calculate-product-tariff-quote-request-dto.js +15 -0
- package/dist/models/rest-calculate-product-tariff-quote-response-class.d.ts +25 -0
- package/dist/models/rest-calculate-product-tariff-quote-response-class.js +15 -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-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-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/shared-create-estimated-invoice-response-class.d.ts +25 -0
- package/dist/models/shared-create-estimated-invoice-response-class.js +15 -0
- package/dist/models/shared-create-payment-method-request-dto.d.ts +2 -0
- package/dist/models/shared-create-payment-method-request-dto.js +3 -1
- package/dist/models/shared-payment-method-response-class.d.ts +2 -0
- package/dist/models/shared-payment-method-response-class.js +3 -1
- 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-data-class.d.ts +39 -0
- package/dist/models/shared-product-config-data-class.js +15 -0
- package/dist/models/shared-product-field-class.d.ts +6 -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-tariff-quote-class.d.ts +52 -0
- package/dist/models/shared-product-tariff-quote-class.js +15 -0
- package/dist/models/shared-tariff-variation-class.d.ts +73 -0
- package/dist/models/shared-tariff-variation-class.js +15 -0
- package/dist/models/tariff-calculation-order-class.d.ts +36 -0
- package/dist/models/tariff-calculation-order-class.js +20 -0
- package/dist/models/tariff-calculation-step-class.d.ts +58 -0
- package/dist/models/tariff-calculation-step-class.js +24 -0
- package/dist/models/tariff-category-summary-class.d.ts +57 -0
- package/dist/models/tariff-category-summary-class.js +15 -0
- package/dist/models/tariff-coverage-term-class.d.ts +60 -0
- package/dist/models/tariff-coverage-term-class.js +30 -0
- package/dist/models/tariff-info-class.d.ts +47 -0
- package/dist/models/tariff-info-class.js +20 -0
- package/dist/models/tariff-summary-class.d.ts +52 -0
- package/dist/models/tariff-summary-class.js +15 -0
- package/dist/models/update-product-field-request-dto.d.ts +6 -0
- package/dist/models/waiting-period-class.d.ts +40 -0
- package/dist/models/waiting-period-class.js +19 -0
- package/dist/models/warning-class.d.ts +41 -0
- package/dist/models/warning-class.js +20 -0
- package/models/amount-with-limit-class.ts +36 -0
- package/models/calculated-policy-object-class.ts +42 -0
- package/models/calculation-errors-class.ts +31 -0
- package/models/calculation-item-errors-class.ts +49 -0
- package/models/calculation-message-class.ts +36 -0
- package/models/category-calculation-order-class.ts +31 -0
- package/models/category-calculation-step-class.ts +68 -0
- package/models/category-class.ts +58 -0
- package/models/category-coverage-summary-class.ts +49 -0
- package/models/category-definition-class.ts +49 -0
- package/models/claim-config-class.ts +45 -0
- package/models/claim-position-fields-class.ts +37 -0
- package/models/coverage-class.ts +37 -0
- package/models/coverage-definition-class.ts +42 -0
- package/models/coverage-term-class.ts +77 -0
- package/models/create-product-field-request-dto.ts +6 -0
- package/models/create-product-request-dto.ts +2 -1
- package/models/custom-field-class.ts +61 -0
- package/models/deductible-class.ts +70 -0
- package/models/general-setting-class.ts +59 -0
- package/models/get-product-config-tariffs-response-class.ts +37 -0
- package/models/index.ts +42 -0
- package/models/lead-policy-object-class.ts +48 -0
- package/models/list-product-versions-response-class.ts +37 -0
- package/models/product-config-summary-class.ts +78 -0
- package/models/product-field-class.ts +6 -0
- package/models/product-version-class.ts +6 -0
- package/models/rest-calculate-product-tariff-quote-request-dto.ts +44 -0
- package/models/rest-calculate-product-tariff-quote-response-class.ts +31 -0
- package/models/rest-create-product-config-response-class.ts +31 -0
- package/models/rest-get-product-config-response-class.ts +31 -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/shared-create-estimated-invoice-response-class.ts +31 -0
- package/models/shared-create-payment-method-request-dto.ts +3 -1
- package/models/shared-payment-method-response-class.ts +3 -1
- package/models/shared-product-config-class.ts +85 -0
- package/models/shared-product-config-data-class.ts +45 -0
- package/models/shared-product-field-class.ts +6 -0
- package/models/shared-product-field-override-class.ts +54 -0
- package/models/shared-product-tariff-quote-class.ts +58 -0
- package/models/shared-tariff-variation-class.ts +79 -0
- package/models/tariff-calculation-order-class.ts +45 -0
- package/models/tariff-calculation-step-class.ts +68 -0
- package/models/tariff-category-summary-class.ts +63 -0
- package/models/tariff-coverage-term-class.ts +71 -0
- package/models/tariff-info-class.ts +56 -0
- package/models/tariff-summary-class.ts +58 -0
- package/models/update-product-field-request-dto.ts +6 -0
- package/models/waiting-period-class.ts +49 -0
- package/models/warning-class.ts +50 -0
- package/package.json +1 -1
|
@@ -0,0 +1,476 @@
|
|
|
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 { GetProductConfigTariffsResponseClass } from '../models';
|
|
16
|
+
import { RestCalculateProductTariffQuoteRequestDto } from '../models';
|
|
17
|
+
import { RestCalculateProductTariffQuoteResponseClass } from '../models';
|
|
18
|
+
import { RestCreateProductConfigResponseClass } from '../models';
|
|
19
|
+
import { RestGetProductConfigResponseClass } from '../models';
|
|
20
|
+
import { RestListProductConfigsResponseClass } from '../models';
|
|
21
|
+
import { RestUpdateProductConfigResponseClass } from '../models';
|
|
22
|
+
/**
|
|
23
|
+
* ProductConfigsApi - axios parameter creator
|
|
24
|
+
* @export
|
|
25
|
+
*/
|
|
26
|
+
export declare const ProductConfigsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
27
|
+
/**
|
|
28
|
+
* Calculates and returns a tariff quote with estimated invoice data. **Required Permissions** \"policy-management.products.view\"
|
|
29
|
+
* @summary Calculates a quote for a selected tariff
|
|
30
|
+
* @param {number} productVersionId Product version id
|
|
31
|
+
* @param {RestCalculateProductTariffQuoteRequestDto} restCalculateProductTariffQuoteRequestDto
|
|
32
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
33
|
+
* @param {*} [options] Override http request option.
|
|
34
|
+
* @throws {RequiredError}
|
|
35
|
+
*/
|
|
36
|
+
calculateProductTariffQuote: (productVersionId: number, restCalculateProductTariffQuoteRequestDto: RestCalculateProductTariffQuoteRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
37
|
+
/**
|
|
38
|
+
* Creates a product config. Accepts a JSON or YAML file containing the config. **Required Permissions** \"policy-management.products.create\"
|
|
39
|
+
* @summary Creates a new product config
|
|
40
|
+
* @param {string} slug Unique identifier for the product config
|
|
41
|
+
* @param {number} productVersionId Product version id
|
|
42
|
+
* @param {any} file JSON or YAML file containing the config. Supported formats: .json, .yaml, .yml
|
|
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
|
+
createProductConfig: (slug: string, productVersionId: number, file: any, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
48
|
+
/**
|
|
49
|
+
* Retrieves a product config by code **Required Permissions** \"policy-management.products.view\"
|
|
50
|
+
* @summary Retrieve the Product Config
|
|
51
|
+
* @param {string} code Unique identifier for the object.
|
|
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
|
+
getProductConfig: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
57
|
+
/**
|
|
58
|
+
* Retrieves list of available tariffs for the product config **Required Permissions** \"policy-management.products.view\"
|
|
59
|
+
* @summary Retrieve the Product Config Tariffs
|
|
60
|
+
* @param {number} productVersionId Product version id
|
|
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
|
+
getProductConfigTariffs: (productVersionId: number, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
66
|
+
/**
|
|
67
|
+
* Lists product configs **Required Permissions** \"policy-management.products.view\"
|
|
68
|
+
* @summary List Product Configs
|
|
69
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
70
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
71
|
+
* @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.
|
|
72
|
+
* @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>
|
|
73
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
74
|
+
* @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>
|
|
75
|
+
* @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/>
|
|
76
|
+
* @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>
|
|
77
|
+
* @param {*} [options] Override http request option.
|
|
78
|
+
* @throws {RequiredError}
|
|
79
|
+
*/
|
|
80
|
+
listProductConfigs: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
81
|
+
/**
|
|
82
|
+
* Updates a product config. Accepts a JSON or YAML file containing the config. **Required Permissions** \"policy-management.products.update\"
|
|
83
|
+
* @summary Updates a product config
|
|
84
|
+
* @param {string} code Unique identifier for the object.
|
|
85
|
+
* @param {any} file JSON or YAML file containing the config. Supported formats: .json, .yaml, .yml
|
|
86
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
87
|
+
* @param {string} [slug] Unique identifier for the product config
|
|
88
|
+
* @param {*} [options] Override http request option.
|
|
89
|
+
* @throws {RequiredError}
|
|
90
|
+
*/
|
|
91
|
+
updateProductConfig: (code: string, file: any, authorization?: string, slug?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
92
|
+
};
|
|
93
|
+
/**
|
|
94
|
+
* ProductConfigsApi - functional programming interface
|
|
95
|
+
* @export
|
|
96
|
+
*/
|
|
97
|
+
export declare const ProductConfigsApiFp: (configuration?: Configuration) => {
|
|
98
|
+
/**
|
|
99
|
+
* Calculates and returns a tariff quote with estimated invoice data. **Required Permissions** \"policy-management.products.view\"
|
|
100
|
+
* @summary Calculates a quote for a selected tariff
|
|
101
|
+
* @param {number} productVersionId Product version id
|
|
102
|
+
* @param {RestCalculateProductTariffQuoteRequestDto} restCalculateProductTariffQuoteRequestDto
|
|
103
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
104
|
+
* @param {*} [options] Override http request option.
|
|
105
|
+
* @throws {RequiredError}
|
|
106
|
+
*/
|
|
107
|
+
calculateProductTariffQuote(productVersionId: number, restCalculateProductTariffQuoteRequestDto: RestCalculateProductTariffQuoteRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RestCalculateProductTariffQuoteResponseClass>>;
|
|
108
|
+
/**
|
|
109
|
+
* Creates a product config. Accepts a JSON or YAML file containing the config. **Required Permissions** \"policy-management.products.create\"
|
|
110
|
+
* @summary Creates a new product config
|
|
111
|
+
* @param {string} slug Unique identifier for the product config
|
|
112
|
+
* @param {number} productVersionId Product version id
|
|
113
|
+
* @param {any} file JSON or YAML file containing the config. Supported formats: .json, .yaml, .yml
|
|
114
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
115
|
+
* @param {*} [options] Override http request option.
|
|
116
|
+
* @throws {RequiredError}
|
|
117
|
+
*/
|
|
118
|
+
createProductConfig(slug: string, productVersionId: number, file: any, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RestCreateProductConfigResponseClass>>;
|
|
119
|
+
/**
|
|
120
|
+
* Retrieves a product config by code **Required Permissions** \"policy-management.products.view\"
|
|
121
|
+
* @summary Retrieve the Product Config
|
|
122
|
+
* @param {string} code Unique identifier for the object.
|
|
123
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
124
|
+
* @param {*} [options] Override http request option.
|
|
125
|
+
* @throws {RequiredError}
|
|
126
|
+
*/
|
|
127
|
+
getProductConfig(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RestGetProductConfigResponseClass>>;
|
|
128
|
+
/**
|
|
129
|
+
* Retrieves list of available tariffs for the product config **Required Permissions** \"policy-management.products.view\"
|
|
130
|
+
* @summary Retrieve the Product Config Tariffs
|
|
131
|
+
* @param {number} productVersionId Product version id
|
|
132
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
133
|
+
* @param {*} [options] Override http request option.
|
|
134
|
+
* @throws {RequiredError}
|
|
135
|
+
*/
|
|
136
|
+
getProductConfigTariffs(productVersionId: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetProductConfigTariffsResponseClass>>;
|
|
137
|
+
/**
|
|
138
|
+
* Lists product configs **Required Permissions** \"policy-management.products.view\"
|
|
139
|
+
* @summary List Product Configs
|
|
140
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
141
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
142
|
+
* @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.
|
|
143
|
+
* @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>
|
|
144
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
145
|
+
* @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>
|
|
146
|
+
* @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/>
|
|
147
|
+
* @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>
|
|
148
|
+
* @param {*} [options] Override http request option.
|
|
149
|
+
* @throws {RequiredError}
|
|
150
|
+
*/
|
|
151
|
+
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>>;
|
|
152
|
+
/**
|
|
153
|
+
* Updates a product config. Accepts a JSON or YAML file containing the config. **Required Permissions** \"policy-management.products.update\"
|
|
154
|
+
* @summary Updates a product config
|
|
155
|
+
* @param {string} code Unique identifier for the object.
|
|
156
|
+
* @param {any} file JSON or YAML file containing the config. Supported formats: .json, .yaml, .yml
|
|
157
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
158
|
+
* @param {string} [slug] Unique identifier for the product config
|
|
159
|
+
* @param {*} [options] Override http request option.
|
|
160
|
+
* @throws {RequiredError}
|
|
161
|
+
*/
|
|
162
|
+
updateProductConfig(code: string, file: any, authorization?: string, slug?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RestUpdateProductConfigResponseClass>>;
|
|
163
|
+
};
|
|
164
|
+
/**
|
|
165
|
+
* ProductConfigsApi - factory interface
|
|
166
|
+
* @export
|
|
167
|
+
*/
|
|
168
|
+
export declare const ProductConfigsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
169
|
+
/**
|
|
170
|
+
* Calculates and returns a tariff quote with estimated invoice data. **Required Permissions** \"policy-management.products.view\"
|
|
171
|
+
* @summary Calculates a quote for a selected tariff
|
|
172
|
+
* @param {number} productVersionId Product version id
|
|
173
|
+
* @param {RestCalculateProductTariffQuoteRequestDto} restCalculateProductTariffQuoteRequestDto
|
|
174
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
175
|
+
* @param {*} [options] Override http request option.
|
|
176
|
+
* @throws {RequiredError}
|
|
177
|
+
*/
|
|
178
|
+
calculateProductTariffQuote(productVersionId: number, restCalculateProductTariffQuoteRequestDto: RestCalculateProductTariffQuoteRequestDto, authorization?: string, options?: any): AxiosPromise<RestCalculateProductTariffQuoteResponseClass>;
|
|
179
|
+
/**
|
|
180
|
+
* Creates a product config. Accepts a JSON or YAML file containing the config. **Required Permissions** \"policy-management.products.create\"
|
|
181
|
+
* @summary Creates a new product config
|
|
182
|
+
* @param {string} slug Unique identifier for the product config
|
|
183
|
+
* @param {number} productVersionId Product version id
|
|
184
|
+
* @param {any} file JSON or YAML file containing the config. Supported formats: .json, .yaml, .yml
|
|
185
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
186
|
+
* @param {*} [options] Override http request option.
|
|
187
|
+
* @throws {RequiredError}
|
|
188
|
+
*/
|
|
189
|
+
createProductConfig(slug: string, productVersionId: number, file: any, authorization?: string, options?: any): AxiosPromise<RestCreateProductConfigResponseClass>;
|
|
190
|
+
/**
|
|
191
|
+
* Retrieves a product config by code **Required Permissions** \"policy-management.products.view\"
|
|
192
|
+
* @summary Retrieve the Product Config
|
|
193
|
+
* @param {string} code Unique identifier for the object.
|
|
194
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
195
|
+
* @param {*} [options] Override http request option.
|
|
196
|
+
* @throws {RequiredError}
|
|
197
|
+
*/
|
|
198
|
+
getProductConfig(code: string, authorization?: string, options?: any): AxiosPromise<RestGetProductConfigResponseClass>;
|
|
199
|
+
/**
|
|
200
|
+
* Retrieves list of available tariffs for the product config **Required Permissions** \"policy-management.products.view\"
|
|
201
|
+
* @summary Retrieve the Product Config Tariffs
|
|
202
|
+
* @param {number} productVersionId Product version id
|
|
203
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
204
|
+
* @param {*} [options] Override http request option.
|
|
205
|
+
* @throws {RequiredError}
|
|
206
|
+
*/
|
|
207
|
+
getProductConfigTariffs(productVersionId: number, authorization?: string, options?: any): AxiosPromise<GetProductConfigTariffsResponseClass>;
|
|
208
|
+
/**
|
|
209
|
+
* Lists product configs **Required Permissions** \"policy-management.products.view\"
|
|
210
|
+
* @summary List Product Configs
|
|
211
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
212
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
213
|
+
* @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.
|
|
214
|
+
* @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>
|
|
215
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
216
|
+
* @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>
|
|
217
|
+
* @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/>
|
|
218
|
+
* @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>
|
|
219
|
+
* @param {*} [options] Override http request option.
|
|
220
|
+
* @throws {RequiredError}
|
|
221
|
+
*/
|
|
222
|
+
listProductConfigs(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<RestListProductConfigsResponseClass>;
|
|
223
|
+
/**
|
|
224
|
+
* Updates a product config. Accepts a JSON or YAML file containing the config. **Required Permissions** \"policy-management.products.update\"
|
|
225
|
+
* @summary Updates a product config
|
|
226
|
+
* @param {string} code Unique identifier for the object.
|
|
227
|
+
* @param {any} file JSON or YAML file containing the config. Supported formats: .json, .yaml, .yml
|
|
228
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
229
|
+
* @param {string} [slug] Unique identifier for the product config
|
|
230
|
+
* @param {*} [options] Override http request option.
|
|
231
|
+
* @throws {RequiredError}
|
|
232
|
+
*/
|
|
233
|
+
updateProductConfig(code: string, file: any, authorization?: string, slug?: string, options?: any): AxiosPromise<RestUpdateProductConfigResponseClass>;
|
|
234
|
+
};
|
|
235
|
+
/**
|
|
236
|
+
* Request parameters for calculateProductTariffQuote operation in ProductConfigsApi.
|
|
237
|
+
* @export
|
|
238
|
+
* @interface ProductConfigsApiCalculateProductTariffQuoteRequest
|
|
239
|
+
*/
|
|
240
|
+
export interface ProductConfigsApiCalculateProductTariffQuoteRequest {
|
|
241
|
+
/**
|
|
242
|
+
* Product version id
|
|
243
|
+
* @type {number}
|
|
244
|
+
* @memberof ProductConfigsApiCalculateProductTariffQuote
|
|
245
|
+
*/
|
|
246
|
+
readonly productVersionId: number;
|
|
247
|
+
/**
|
|
248
|
+
*
|
|
249
|
+
* @type {RestCalculateProductTariffQuoteRequestDto}
|
|
250
|
+
* @memberof ProductConfigsApiCalculateProductTariffQuote
|
|
251
|
+
*/
|
|
252
|
+
readonly restCalculateProductTariffQuoteRequestDto: RestCalculateProductTariffQuoteRequestDto;
|
|
253
|
+
/**
|
|
254
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
255
|
+
* @type {string}
|
|
256
|
+
* @memberof ProductConfigsApiCalculateProductTariffQuote
|
|
257
|
+
*/
|
|
258
|
+
readonly authorization?: string;
|
|
259
|
+
}
|
|
260
|
+
/**
|
|
261
|
+
* Request parameters for createProductConfig operation in ProductConfigsApi.
|
|
262
|
+
* @export
|
|
263
|
+
* @interface ProductConfigsApiCreateProductConfigRequest
|
|
264
|
+
*/
|
|
265
|
+
export interface ProductConfigsApiCreateProductConfigRequest {
|
|
266
|
+
/**
|
|
267
|
+
* Unique identifier for the product config
|
|
268
|
+
* @type {string}
|
|
269
|
+
* @memberof ProductConfigsApiCreateProductConfig
|
|
270
|
+
*/
|
|
271
|
+
readonly slug: string;
|
|
272
|
+
/**
|
|
273
|
+
* Product version id
|
|
274
|
+
* @type {number}
|
|
275
|
+
* @memberof ProductConfigsApiCreateProductConfig
|
|
276
|
+
*/
|
|
277
|
+
readonly productVersionId: number;
|
|
278
|
+
/**
|
|
279
|
+
* JSON or YAML file containing the config. Supported formats: .json, .yaml, .yml
|
|
280
|
+
* @type {any}
|
|
281
|
+
* @memberof ProductConfigsApiCreateProductConfig
|
|
282
|
+
*/
|
|
283
|
+
readonly file: any;
|
|
284
|
+
/**
|
|
285
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
286
|
+
* @type {string}
|
|
287
|
+
* @memberof ProductConfigsApiCreateProductConfig
|
|
288
|
+
*/
|
|
289
|
+
readonly authorization?: string;
|
|
290
|
+
}
|
|
291
|
+
/**
|
|
292
|
+
* Request parameters for getProductConfig operation in ProductConfigsApi.
|
|
293
|
+
* @export
|
|
294
|
+
* @interface ProductConfigsApiGetProductConfigRequest
|
|
295
|
+
*/
|
|
296
|
+
export interface ProductConfigsApiGetProductConfigRequest {
|
|
297
|
+
/**
|
|
298
|
+
* Unique identifier for the object.
|
|
299
|
+
* @type {string}
|
|
300
|
+
* @memberof ProductConfigsApiGetProductConfig
|
|
301
|
+
*/
|
|
302
|
+
readonly code: string;
|
|
303
|
+
/**
|
|
304
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
305
|
+
* @type {string}
|
|
306
|
+
* @memberof ProductConfigsApiGetProductConfig
|
|
307
|
+
*/
|
|
308
|
+
readonly authorization?: string;
|
|
309
|
+
}
|
|
310
|
+
/**
|
|
311
|
+
* Request parameters for getProductConfigTariffs operation in ProductConfigsApi.
|
|
312
|
+
* @export
|
|
313
|
+
* @interface ProductConfigsApiGetProductConfigTariffsRequest
|
|
314
|
+
*/
|
|
315
|
+
export interface ProductConfigsApiGetProductConfigTariffsRequest {
|
|
316
|
+
/**
|
|
317
|
+
* Product version id
|
|
318
|
+
* @type {number}
|
|
319
|
+
* @memberof ProductConfigsApiGetProductConfigTariffs
|
|
320
|
+
*/
|
|
321
|
+
readonly productVersionId: number;
|
|
322
|
+
/**
|
|
323
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
324
|
+
* @type {string}
|
|
325
|
+
* @memberof ProductConfigsApiGetProductConfigTariffs
|
|
326
|
+
*/
|
|
327
|
+
readonly authorization?: string;
|
|
328
|
+
}
|
|
329
|
+
/**
|
|
330
|
+
* Request parameters for listProductConfigs operation in ProductConfigsApi.
|
|
331
|
+
* @export
|
|
332
|
+
* @interface ProductConfigsApiListProductConfigsRequest
|
|
333
|
+
*/
|
|
334
|
+
export interface ProductConfigsApiListProductConfigsRequest {
|
|
335
|
+
/**
|
|
336
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
337
|
+
* @type {string}
|
|
338
|
+
* @memberof ProductConfigsApiListProductConfigs
|
|
339
|
+
*/
|
|
340
|
+
readonly authorization?: string;
|
|
341
|
+
/**
|
|
342
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
343
|
+
* @type {number}
|
|
344
|
+
* @memberof ProductConfigsApiListProductConfigs
|
|
345
|
+
*/
|
|
346
|
+
readonly pageSize?: number;
|
|
347
|
+
/**
|
|
348
|
+
* 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.
|
|
349
|
+
* @type {string}
|
|
350
|
+
* @memberof ProductConfigsApiListProductConfigs
|
|
351
|
+
*/
|
|
352
|
+
readonly pageToken?: string;
|
|
353
|
+
/**
|
|
354
|
+
* 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>
|
|
355
|
+
* @type {string}
|
|
356
|
+
* @memberof ProductConfigsApiListProductConfigs
|
|
357
|
+
*/
|
|
358
|
+
readonly filter?: string;
|
|
359
|
+
/**
|
|
360
|
+
* To search the list by any field, pass search=xxx to fetch the result.
|
|
361
|
+
* @type {string}
|
|
362
|
+
* @memberof ProductConfigsApiListProductConfigs
|
|
363
|
+
*/
|
|
364
|
+
readonly search?: string;
|
|
365
|
+
/**
|
|
366
|
+
* 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>
|
|
367
|
+
* @type {string}
|
|
368
|
+
* @memberof ProductConfigsApiListProductConfigs
|
|
369
|
+
*/
|
|
370
|
+
readonly order?: string;
|
|
371
|
+
/**
|
|
372
|
+
* 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/>
|
|
373
|
+
* @type {string}
|
|
374
|
+
* @memberof ProductConfigsApiListProductConfigs
|
|
375
|
+
*/
|
|
376
|
+
readonly expand?: string;
|
|
377
|
+
/**
|
|
378
|
+
* 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>
|
|
379
|
+
* @type {string}
|
|
380
|
+
* @memberof ProductConfigsApiListProductConfigs
|
|
381
|
+
*/
|
|
382
|
+
readonly filters?: string;
|
|
383
|
+
}
|
|
384
|
+
/**
|
|
385
|
+
* Request parameters for updateProductConfig operation in ProductConfigsApi.
|
|
386
|
+
* @export
|
|
387
|
+
* @interface ProductConfigsApiUpdateProductConfigRequest
|
|
388
|
+
*/
|
|
389
|
+
export interface ProductConfigsApiUpdateProductConfigRequest {
|
|
390
|
+
/**
|
|
391
|
+
* Unique identifier for the object.
|
|
392
|
+
* @type {string}
|
|
393
|
+
* @memberof ProductConfigsApiUpdateProductConfig
|
|
394
|
+
*/
|
|
395
|
+
readonly code: string;
|
|
396
|
+
/**
|
|
397
|
+
* JSON or YAML file containing the config. Supported formats: .json, .yaml, .yml
|
|
398
|
+
* @type {any}
|
|
399
|
+
* @memberof ProductConfigsApiUpdateProductConfig
|
|
400
|
+
*/
|
|
401
|
+
readonly file: any;
|
|
402
|
+
/**
|
|
403
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
404
|
+
* @type {string}
|
|
405
|
+
* @memberof ProductConfigsApiUpdateProductConfig
|
|
406
|
+
*/
|
|
407
|
+
readonly authorization?: string;
|
|
408
|
+
/**
|
|
409
|
+
* Unique identifier for the product config
|
|
410
|
+
* @type {string}
|
|
411
|
+
* @memberof ProductConfigsApiUpdateProductConfig
|
|
412
|
+
*/
|
|
413
|
+
readonly slug?: string;
|
|
414
|
+
}
|
|
415
|
+
/**
|
|
416
|
+
* ProductConfigsApi - object-oriented interface
|
|
417
|
+
* @export
|
|
418
|
+
* @class ProductConfigsApi
|
|
419
|
+
* @extends {BaseAPI}
|
|
420
|
+
*/
|
|
421
|
+
export declare class ProductConfigsApi extends BaseAPI {
|
|
422
|
+
/**
|
|
423
|
+
* Calculates and returns a tariff quote with estimated invoice data. **Required Permissions** \"policy-management.products.view\"
|
|
424
|
+
* @summary Calculates a quote for a selected tariff
|
|
425
|
+
* @param {ProductConfigsApiCalculateProductTariffQuoteRequest} requestParameters Request parameters.
|
|
426
|
+
* @param {*} [options] Override http request option.
|
|
427
|
+
* @throws {RequiredError}
|
|
428
|
+
* @memberof ProductConfigsApi
|
|
429
|
+
*/
|
|
430
|
+
calculateProductTariffQuote(requestParameters: ProductConfigsApiCalculateProductTariffQuoteRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RestCalculateProductTariffQuoteResponseClass, any, {}>>;
|
|
431
|
+
/**
|
|
432
|
+
* Creates a product config. Accepts a JSON or YAML file containing the config. **Required Permissions** \"policy-management.products.create\"
|
|
433
|
+
* @summary Creates a new product config
|
|
434
|
+
* @param {ProductConfigsApiCreateProductConfigRequest} requestParameters Request parameters.
|
|
435
|
+
* @param {*} [options] Override http request option.
|
|
436
|
+
* @throws {RequiredError}
|
|
437
|
+
* @memberof ProductConfigsApi
|
|
438
|
+
*/
|
|
439
|
+
createProductConfig(requestParameters: ProductConfigsApiCreateProductConfigRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RestCreateProductConfigResponseClass, any, {}>>;
|
|
440
|
+
/**
|
|
441
|
+
* Retrieves a product config by code **Required Permissions** \"policy-management.products.view\"
|
|
442
|
+
* @summary Retrieve the Product Config
|
|
443
|
+
* @param {ProductConfigsApiGetProductConfigRequest} requestParameters Request parameters.
|
|
444
|
+
* @param {*} [options] Override http request option.
|
|
445
|
+
* @throws {RequiredError}
|
|
446
|
+
* @memberof ProductConfigsApi
|
|
447
|
+
*/
|
|
448
|
+
getProductConfig(requestParameters: ProductConfigsApiGetProductConfigRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RestGetProductConfigResponseClass, any, {}>>;
|
|
449
|
+
/**
|
|
450
|
+
* Retrieves list of available tariffs for the product config **Required Permissions** \"policy-management.products.view\"
|
|
451
|
+
* @summary Retrieve the Product Config Tariffs
|
|
452
|
+
* @param {ProductConfigsApiGetProductConfigTariffsRequest} requestParameters Request parameters.
|
|
453
|
+
* @param {*} [options] Override http request option.
|
|
454
|
+
* @throws {RequiredError}
|
|
455
|
+
* @memberof ProductConfigsApi
|
|
456
|
+
*/
|
|
457
|
+
getProductConfigTariffs(requestParameters: ProductConfigsApiGetProductConfigTariffsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetProductConfigTariffsResponseClass, any, {}>>;
|
|
458
|
+
/**
|
|
459
|
+
* Lists product configs **Required Permissions** \"policy-management.products.view\"
|
|
460
|
+
* @summary List Product Configs
|
|
461
|
+
* @param {ProductConfigsApiListProductConfigsRequest} requestParameters Request parameters.
|
|
462
|
+
* @param {*} [options] Override http request option.
|
|
463
|
+
* @throws {RequiredError}
|
|
464
|
+
* @memberof ProductConfigsApi
|
|
465
|
+
*/
|
|
466
|
+
listProductConfigs(requestParameters?: ProductConfigsApiListProductConfigsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RestListProductConfigsResponseClass, any, {}>>;
|
|
467
|
+
/**
|
|
468
|
+
* Updates a product config. Accepts a JSON or YAML file containing the config. **Required Permissions** \"policy-management.products.update\"
|
|
469
|
+
* @summary Updates a product config
|
|
470
|
+
* @param {ProductConfigsApiUpdateProductConfigRequest} requestParameters Request parameters.
|
|
471
|
+
* @param {*} [options] Override http request option.
|
|
472
|
+
* @throws {RequiredError}
|
|
473
|
+
* @memberof ProductConfigsApi
|
|
474
|
+
*/
|
|
475
|
+
updateProductConfig(requestParameters: ProductConfigsApiUpdateProductConfigRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RestUpdateProductConfigResponseClass, any, {}>>;
|
|
476
|
+
}
|