@emilgroup/insurance-sdk-node 1.14.0 → 1.15.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
17
17
  Navigate to the folder of your consuming project and run one of the following commands:
18
18
 
19
19
  ```
20
- npm install @emilgroup/insurance-sdk-node@1.14.0 --save
20
+ npm install @emilgroup/insurance-sdk-node@1.15.0 --save
21
21
  ```
22
22
  or
23
23
  ```
24
- yarn add @emilgroup/insurance-sdk-node@1.14.0
24
+ yarn add @emilgroup/insurance-sdk-node@1.15.0
25
25
  ```
26
26
 
27
27
  And then you can import `PoliciesApi`.
@@ -104,11 +104,11 @@ export const PoliciesApiAxiosParamCreator = function (configuration?: Configurat
104
104
  * @summary Retrieve the policy
105
105
  * @param {string} code Unique identifier for the object.
106
106
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
107
- * @param {string} [expand] Fields to expand response by.
107
+ * @param {'versions' | 'product' | 'timelines' | 'premiums' | 'premiumItems' | 'premiumFormulas' | 'currentVersion' | 'currentTimelines' | 'currentPremiums' | 'currentPremiumItems' | 'currentPremiumFormulas'} [expand] You can expand policy in this endpoint. By default, versions will be an empty array.
108
108
  * @param {*} [options] Override http request option.
109
109
  * @throws {RequiredError}
110
110
  */
111
- getPolicy: async (code: string, authorization?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
111
+ getPolicy: async (code: string, authorization?: string, expand?: 'versions' | 'product' | 'timelines' | 'premiums' | 'premiumItems' | 'premiumFormulas' | 'currentVersion' | 'currentTimelines' | 'currentPremiums' | 'currentPremiumItems' | 'currentPremiumFormulas', options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
112
112
  // verify required parameter 'code' is not null or undefined
113
113
  assertParamExists('getPolicy', 'code', code)
114
114
  const localVarPath = `/insuranceservice/v1/policies/{code}`
@@ -205,14 +205,14 @@ export const PoliciesApiAxiosParamCreator = function (configuration?: Configurat
205
205
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
206
206
  * @param {number} [pageSize] Page size.
207
207
  * @param {string} [pageToken] Page token.
208
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time. Parameters: **code**, **policyNumber**, **accountCode**, **statuses**, **productName**, **productType**, **policyData**, **createdAt**, **policyStartDate**.
208
+ * @param {'code' | 'policyNumber' | 'accountCode' | 'statuses' | 'productName' | 'productType' | 'createdAt' | 'policyStartDate' | 'policyData'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
209
209
  * @param {string} [search] Search query.
210
- * @param {string} [order] Ordering criteria.
211
- * @param {string} [expand] You can expand policy versions list in this endpoint. By default, versions will be an empty array.
210
+ * @param {'policyNumber' | 'createdAt'} [order] Order allowing you to specify the desired order of entities retrieved from the server.
211
+ * @param {'versions' | 'product' | 'timelines' | 'premiums' | 'premiumItems' | 'premiumFormulas' | 'currentVersion' | 'currentTimelines' | 'currentPremiums' | 'currentPremiumItems' | 'currentPremiumFormulas'} [expand] You can expand policy versions list in this endpoint. By default, versions will be an empty array.
212
212
  * @param {*} [options] Override http request option.
213
213
  * @throws {RequiredError}
214
214
  */
215
- listPolicies: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
215
+ listPolicies: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: 'code' | 'policyNumber' | 'accountCode' | 'statuses' | 'productName' | 'productType' | 'createdAt' | 'policyStartDate' | 'policyData', search?: string, order?: 'policyNumber' | 'createdAt', expand?: 'versions' | 'product' | 'timelines' | 'premiums' | 'premiumItems' | 'premiumFormulas' | 'currentVersion' | 'currentTimelines' | 'currentPremiums' | 'currentPremiumItems' | 'currentPremiumFormulas', options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
216
216
  const localVarPath = `/insuranceservice/v1/policies`;
217
217
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
218
218
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -501,11 +501,11 @@ export const PoliciesApiFp = function(configuration?: Configuration) {
501
501
  * @summary Retrieve the policy
502
502
  * @param {string} code Unique identifier for the object.
503
503
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
504
- * @param {string} [expand] Fields to expand response by.
504
+ * @param {'versions' | 'product' | 'timelines' | 'premiums' | 'premiumItems' | 'premiumFormulas' | 'currentVersion' | 'currentTimelines' | 'currentPremiums' | 'currentPremiumItems' | 'currentPremiumFormulas'} [expand] You can expand policy in this endpoint. By default, versions will be an empty array.
505
505
  * @param {*} [options] Override http request option.
506
506
  * @throws {RequiredError}
507
507
  */
508
- async getPolicy(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPolicyResponseClass>> {
508
+ async getPolicy(code: string, authorization?: string, expand?: 'versions' | 'product' | 'timelines' | 'premiums' | 'premiumItems' | 'premiumFormulas' | 'currentVersion' | 'currentTimelines' | 'currentPremiums' | 'currentPremiumItems' | 'currentPremiumFormulas', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPolicyResponseClass>> {
509
509
  const localVarAxiosArgs = await localVarAxiosParamCreator.getPolicy(code, authorization, expand, options);
510
510
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
511
511
  },
@@ -528,14 +528,14 @@ export const PoliciesApiFp = function(configuration?: Configuration) {
528
528
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
529
529
  * @param {number} [pageSize] Page size.
530
530
  * @param {string} [pageToken] Page token.
531
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time. Parameters: **code**, **policyNumber**, **accountCode**, **statuses**, **productName**, **productType**, **policyData**, **createdAt**, **policyStartDate**.
531
+ * @param {'code' | 'policyNumber' | 'accountCode' | 'statuses' | 'productName' | 'productType' | 'createdAt' | 'policyStartDate' | 'policyData'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
532
532
  * @param {string} [search] Search query.
533
- * @param {string} [order] Ordering criteria.
534
- * @param {string} [expand] You can expand policy versions list in this endpoint. By default, versions will be an empty array.
533
+ * @param {'policyNumber' | 'createdAt'} [order] Order allowing you to specify the desired order of entities retrieved from the server.
534
+ * @param {'versions' | 'product' | 'timelines' | 'premiums' | 'premiumItems' | 'premiumFormulas' | 'currentVersion' | 'currentTimelines' | 'currentPremiums' | 'currentPremiumItems' | 'currentPremiumFormulas'} [expand] You can expand policy versions list in this endpoint. By default, versions will be an empty array.
535
535
  * @param {*} [options] Override http request option.
536
536
  * @throws {RequiredError}
537
537
  */
538
- async listPolicies(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPoliciesResponseClass>> {
538
+ async listPolicies(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'code' | 'policyNumber' | 'accountCode' | 'statuses' | 'productName' | 'productType' | 'createdAt' | 'policyStartDate' | 'policyData', search?: string, order?: 'policyNumber' | 'createdAt', expand?: 'versions' | 'product' | 'timelines' | 'premiums' | 'premiumItems' | 'premiumFormulas' | 'currentVersion' | 'currentTimelines' | 'currentPremiums' | 'currentPremiumItems' | 'currentPremiumFormulas', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPoliciesResponseClass>> {
539
539
  const localVarAxiosArgs = await localVarAxiosParamCreator.listPolicies(authorization, pageSize, pageToken, filter, search, order, expand, options);
540
540
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
541
541
  },
@@ -617,11 +617,11 @@ export const PoliciesApiFactory = function (configuration?: Configuration, baseP
617
617
  * @summary Retrieve the policy
618
618
  * @param {string} code Unique identifier for the object.
619
619
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
620
- * @param {string} [expand] Fields to expand response by.
620
+ * @param {'versions' | 'product' | 'timelines' | 'premiums' | 'premiumItems' | 'premiumFormulas' | 'currentVersion' | 'currentTimelines' | 'currentPremiums' | 'currentPremiumItems' | 'currentPremiumFormulas'} [expand] You can expand policy in this endpoint. By default, versions will be an empty array.
621
621
  * @param {*} [options] Override http request option.
622
622
  * @throws {RequiredError}
623
623
  */
624
- getPolicy(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetPolicyResponseClass> {
624
+ getPolicy(code: string, authorization?: string, expand?: 'versions' | 'product' | 'timelines' | 'premiums' | 'premiumItems' | 'premiumFormulas' | 'currentVersion' | 'currentTimelines' | 'currentPremiums' | 'currentPremiumItems' | 'currentPremiumFormulas', options?: any): AxiosPromise<GetPolicyResponseClass> {
625
625
  return localVarFp.getPolicy(code, authorization, expand, options).then((request) => request(axios, basePath));
626
626
  },
627
627
  /**
@@ -642,14 +642,14 @@ export const PoliciesApiFactory = function (configuration?: Configuration, baseP
642
642
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
643
643
  * @param {number} [pageSize] Page size.
644
644
  * @param {string} [pageToken] Page token.
645
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time. Parameters: **code**, **policyNumber**, **accountCode**, **statuses**, **productName**, **productType**, **policyData**, **createdAt**, **policyStartDate**.
645
+ * @param {'code' | 'policyNumber' | 'accountCode' | 'statuses' | 'productName' | 'productType' | 'createdAt' | 'policyStartDate' | 'policyData'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
646
646
  * @param {string} [search] Search query.
647
- * @param {string} [order] Ordering criteria.
648
- * @param {string} [expand] You can expand policy versions list in this endpoint. By default, versions will be an empty array.
647
+ * @param {'policyNumber' | 'createdAt'} [order] Order allowing you to specify the desired order of entities retrieved from the server.
648
+ * @param {'versions' | 'product' | 'timelines' | 'premiums' | 'premiumItems' | 'premiumFormulas' | 'currentVersion' | 'currentTimelines' | 'currentPremiums' | 'currentPremiumItems' | 'currentPremiumFormulas'} [expand] You can expand policy versions list in this endpoint. By default, versions will be an empty array.
649
649
  * @param {*} [options] Override http request option.
650
650
  * @throws {RequiredError}
651
651
  */
652
- listPolicies(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListPoliciesResponseClass> {
652
+ listPolicies(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'code' | 'policyNumber' | 'accountCode' | 'statuses' | 'productName' | 'productType' | 'createdAt' | 'policyStartDate' | 'policyData', search?: string, order?: 'policyNumber' | 'createdAt', expand?: 'versions' | 'product' | 'timelines' | 'premiums' | 'premiumItems' | 'premiumFormulas' | 'currentVersion' | 'currentTimelines' | 'currentPremiums' | 'currentPremiumItems' | 'currentPremiumFormulas', options?: any): AxiosPromise<ListPoliciesResponseClass> {
653
653
  return localVarFp.listPolicies(authorization, pageSize, pageToken, filter, search, order, expand, options).then((request) => request(axios, basePath));
654
654
  },
655
655
  /**
@@ -745,11 +745,11 @@ export interface PoliciesApiGetPolicyRequest {
745
745
  readonly authorization?: string
746
746
 
747
747
  /**
748
- * Fields to expand response by.
749
- * @type {string}
748
+ * You can expand policy in this endpoint. By default, versions will be an empty array.
749
+ * @type {'versions' | 'product' | 'timelines' | 'premiums' | 'premiumItems' | 'premiumFormulas' | 'currentVersion' | 'currentTimelines' | 'currentPremiums' | 'currentPremiumItems' | 'currentPremiumFormulas'}
750
750
  * @memberof PoliciesApiGetPolicy
751
751
  */
752
- readonly expand?: string
752
+ readonly expand?: 'versions' | 'product' | 'timelines' | 'premiums' | 'premiumItems' | 'premiumFormulas' | 'currentVersion' | 'currentTimelines' | 'currentPremiums' | 'currentPremiumItems' | 'currentPremiumFormulas'
753
753
  }
754
754
 
755
755
  /**
@@ -808,11 +808,11 @@ export interface PoliciesApiListPoliciesRequest {
808
808
  readonly pageToken?: string
809
809
 
810
810
  /**
811
- * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time. Parameters: **code**, **policyNumber**, **accountCode**, **statuses**, **productName**, **productType**, **policyData**, **createdAt**, **policyStartDate**.
812
- * @type {string}
811
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
812
+ * @type {'code' | 'policyNumber' | 'accountCode' | 'statuses' | 'productName' | 'productType' | 'createdAt' | 'policyStartDate' | 'policyData'}
813
813
  * @memberof PoliciesApiListPolicies
814
814
  */
815
- readonly filter?: string
815
+ readonly filter?: 'code' | 'policyNumber' | 'accountCode' | 'statuses' | 'productName' | 'productType' | 'createdAt' | 'policyStartDate' | 'policyData'
816
816
 
817
817
  /**
818
818
  * Search query.
@@ -822,18 +822,18 @@ export interface PoliciesApiListPoliciesRequest {
822
822
  readonly search?: string
823
823
 
824
824
  /**
825
- * Ordering criteria.
826
- * @type {string}
825
+ * Order allowing you to specify the desired order of entities retrieved from the server.
826
+ * @type {'policyNumber' | 'createdAt'}
827
827
  * @memberof PoliciesApiListPolicies
828
828
  */
829
- readonly order?: string
829
+ readonly order?: 'policyNumber' | 'createdAt'
830
830
 
831
831
  /**
832
832
  * You can expand policy versions list in this endpoint. By default, versions will be an empty array.
833
- * @type {string}
833
+ * @type {'versions' | 'product' | 'timelines' | 'premiums' | 'premiumItems' | 'premiumFormulas' | 'currentVersion' | 'currentTimelines' | 'currentPremiums' | 'currentPremiumItems' | 'currentPremiumFormulas'}
834
834
  * @memberof PoliciesApiListPolicies
835
835
  */
836
- readonly expand?: string
836
+ readonly expand?: 'versions' | 'product' | 'timelines' | 'premiums' | 'premiumItems' | 'premiumFormulas' | 'currentVersion' | 'currentTimelines' | 'currentPremiums' | 'currentPremiumItems' | 'currentPremiumFormulas'
837
837
  }
838
838
 
839
839
  /**
@@ -42,11 +42,11 @@ export declare const PoliciesApiAxiosParamCreator: (configuration?: Configuratio
42
42
  * @summary Retrieve the policy
43
43
  * @param {string} code Unique identifier for the object.
44
44
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
45
- * @param {string} [expand] Fields to expand response by.
45
+ * @param {'versions' | 'product' | 'timelines' | 'premiums' | 'premiumItems' | 'premiumFormulas' | 'currentVersion' | 'currentTimelines' | 'currentPremiums' | 'currentPremiumItems' | 'currentPremiumFormulas'} [expand] You can expand policy in this endpoint. By default, versions will be an empty array.
46
46
  * @param {*} [options] Override http request option.
47
47
  * @throws {RequiredError}
48
48
  */
49
- getPolicy: (code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
49
+ getPolicy: (code: string, authorization?: string, expand?: 'versions' | 'product' | 'timelines' | 'premiums' | 'premiumItems' | 'premiumFormulas' | 'currentVersion' | 'currentTimelines' | 'currentPremiums' | 'currentPremiumItems' | 'currentPremiumFormulas', options?: AxiosRequestConfig) => Promise<RequestArgs>;
50
50
  /**
51
51
  * This endpoint will return the current version of the policy. It is possible to filter the response by a specific date and the system will return the valid data that was (or will be) at the provided date.
52
52
  * @summary Retrieve current policy version
@@ -63,14 +63,14 @@ export declare const PoliciesApiAxiosParamCreator: (configuration?: Configuratio
63
63
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
64
64
  * @param {number} [pageSize] Page size.
65
65
  * @param {string} [pageToken] Page token.
66
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time. Parameters: **code**, **policyNumber**, **accountCode**, **statuses**, **productName**, **productType**, **policyData**, **createdAt**, **policyStartDate**.
66
+ * @param {'code' | 'policyNumber' | 'accountCode' | 'statuses' | 'productName' | 'productType' | 'createdAt' | 'policyStartDate' | 'policyData'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
67
67
  * @param {string} [search] Search query.
68
- * @param {string} [order] Ordering criteria.
69
- * @param {string} [expand] You can expand policy versions list in this endpoint. By default, versions will be an empty array.
68
+ * @param {'policyNumber' | 'createdAt'} [order] Order allowing you to specify the desired order of entities retrieved from the server.
69
+ * @param {'versions' | 'product' | 'timelines' | 'premiums' | 'premiumItems' | 'premiumFormulas' | 'currentVersion' | 'currentTimelines' | 'currentPremiums' | 'currentPremiumItems' | 'currentPremiumFormulas'} [expand] You can expand policy versions list in this endpoint. By default, versions will be an empty array.
70
70
  * @param {*} [options] Override http request option.
71
71
  * @throws {RequiredError}
72
72
  */
73
- listPolicies: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
73
+ listPolicies: (authorization?: string, pageSize?: number, pageToken?: string, filter?: 'code' | 'policyNumber' | 'accountCode' | 'statuses' | 'productName' | 'productType' | 'createdAt' | 'policyStartDate' | 'policyData', search?: string, order?: 'policyNumber' | 'createdAt', expand?: 'versions' | 'product' | 'timelines' | 'premiums' | 'premiumItems' | 'premiumFormulas' | 'currentVersion' | 'currentTimelines' | 'currentPremiums' | 'currentPremiumItems' | 'currentPremiumFormulas', options?: AxiosRequestConfig) => Promise<RequestArgs>;
74
74
  /**
75
75
  * Request to suspend an existing policy by tenant.
76
76
  * @summary Suspend a policy by tenant
@@ -131,11 +131,11 @@ export declare const PoliciesApiFp: (configuration?: Configuration) => {
131
131
  * @summary Retrieve the policy
132
132
  * @param {string} code Unique identifier for the object.
133
133
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
134
- * @param {string} [expand] Fields to expand response by.
134
+ * @param {'versions' | 'product' | 'timelines' | 'premiums' | 'premiumItems' | 'premiumFormulas' | 'currentVersion' | 'currentTimelines' | 'currentPremiums' | 'currentPremiumItems' | 'currentPremiumFormulas'} [expand] You can expand policy in this endpoint. By default, versions will be an empty array.
135
135
  * @param {*} [options] Override http request option.
136
136
  * @throws {RequiredError}
137
137
  */
138
- getPolicy(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPolicyResponseClass>>;
138
+ getPolicy(code: string, authorization?: string, expand?: 'versions' | 'product' | 'timelines' | 'premiums' | 'premiumItems' | 'premiumFormulas' | 'currentVersion' | 'currentTimelines' | 'currentPremiums' | 'currentPremiumItems' | 'currentPremiumFormulas', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPolicyResponseClass>>;
139
139
  /**
140
140
  * This endpoint will return the current version of the policy. It is possible to filter the response by a specific date and the system will return the valid data that was (or will be) at the provided date.
141
141
  * @summary Retrieve current policy version
@@ -152,14 +152,14 @@ export declare const PoliciesApiFp: (configuration?: Configuration) => {
152
152
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
153
153
  * @param {number} [pageSize] Page size.
154
154
  * @param {string} [pageToken] Page token.
155
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time. Parameters: **code**, **policyNumber**, **accountCode**, **statuses**, **productName**, **productType**, **policyData**, **createdAt**, **policyStartDate**.
155
+ * @param {'code' | 'policyNumber' | 'accountCode' | 'statuses' | 'productName' | 'productType' | 'createdAt' | 'policyStartDate' | 'policyData'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
156
156
  * @param {string} [search] Search query.
157
- * @param {string} [order] Ordering criteria.
158
- * @param {string} [expand] You can expand policy versions list in this endpoint. By default, versions will be an empty array.
157
+ * @param {'policyNumber' | 'createdAt'} [order] Order allowing you to specify the desired order of entities retrieved from the server.
158
+ * @param {'versions' | 'product' | 'timelines' | 'premiums' | 'premiumItems' | 'premiumFormulas' | 'currentVersion' | 'currentTimelines' | 'currentPremiums' | 'currentPremiumItems' | 'currentPremiumFormulas'} [expand] You can expand policy versions list in this endpoint. By default, versions will be an empty array.
159
159
  * @param {*} [options] Override http request option.
160
160
  * @throws {RequiredError}
161
161
  */
162
- listPolicies(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPoliciesResponseClass>>;
162
+ listPolicies(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'code' | 'policyNumber' | 'accountCode' | 'statuses' | 'productName' | 'productType' | 'createdAt' | 'policyStartDate' | 'policyData', search?: string, order?: 'policyNumber' | 'createdAt', expand?: 'versions' | 'product' | 'timelines' | 'premiums' | 'premiumItems' | 'premiumFormulas' | 'currentVersion' | 'currentTimelines' | 'currentPremiums' | 'currentPremiumItems' | 'currentPremiumFormulas', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPoliciesResponseClass>>;
163
163
  /**
164
164
  * Request to suspend an existing policy by tenant.
165
165
  * @summary Suspend a policy by tenant
@@ -220,11 +220,11 @@ export declare const PoliciesApiFactory: (configuration?: Configuration, basePat
220
220
  * @summary Retrieve the policy
221
221
  * @param {string} code Unique identifier for the object.
222
222
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
223
- * @param {string} [expand] Fields to expand response by.
223
+ * @param {'versions' | 'product' | 'timelines' | 'premiums' | 'premiumItems' | 'premiumFormulas' | 'currentVersion' | 'currentTimelines' | 'currentPremiums' | 'currentPremiumItems' | 'currentPremiumFormulas'} [expand] You can expand policy in this endpoint. By default, versions will be an empty array.
224
224
  * @param {*} [options] Override http request option.
225
225
  * @throws {RequiredError}
226
226
  */
227
- getPolicy(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetPolicyResponseClass>;
227
+ getPolicy(code: string, authorization?: string, expand?: 'versions' | 'product' | 'timelines' | 'premiums' | 'premiumItems' | 'premiumFormulas' | 'currentVersion' | 'currentTimelines' | 'currentPremiums' | 'currentPremiumItems' | 'currentPremiumFormulas', options?: any): AxiosPromise<GetPolicyResponseClass>;
228
228
  /**
229
229
  * This endpoint will return the current version of the policy. It is possible to filter the response by a specific date and the system will return the valid data that was (or will be) at the provided date.
230
230
  * @summary Retrieve current policy version
@@ -241,14 +241,14 @@ export declare const PoliciesApiFactory: (configuration?: Configuration, basePat
241
241
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
242
242
  * @param {number} [pageSize] Page size.
243
243
  * @param {string} [pageToken] Page token.
244
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time. Parameters: **code**, **policyNumber**, **accountCode**, **statuses**, **productName**, **productType**, **policyData**, **createdAt**, **policyStartDate**.
244
+ * @param {'code' | 'policyNumber' | 'accountCode' | 'statuses' | 'productName' | 'productType' | 'createdAt' | 'policyStartDate' | 'policyData'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
245
245
  * @param {string} [search] Search query.
246
- * @param {string} [order] Ordering criteria.
247
- * @param {string} [expand] You can expand policy versions list in this endpoint. By default, versions will be an empty array.
246
+ * @param {'policyNumber' | 'createdAt'} [order] Order allowing you to specify the desired order of entities retrieved from the server.
247
+ * @param {'versions' | 'product' | 'timelines' | 'premiums' | 'premiumItems' | 'premiumFormulas' | 'currentVersion' | 'currentTimelines' | 'currentPremiums' | 'currentPremiumItems' | 'currentPremiumFormulas'} [expand] You can expand policy versions list in this endpoint. By default, versions will be an empty array.
248
248
  * @param {*} [options] Override http request option.
249
249
  * @throws {RequiredError}
250
250
  */
251
- listPolicies(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListPoliciesResponseClass>;
251
+ listPolicies(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'code' | 'policyNumber' | 'accountCode' | 'statuses' | 'productName' | 'productType' | 'createdAt' | 'policyStartDate' | 'policyData', search?: string, order?: 'policyNumber' | 'createdAt', expand?: 'versions' | 'product' | 'timelines' | 'premiums' | 'premiumItems' | 'premiumFormulas' | 'currentVersion' | 'currentTimelines' | 'currentPremiums' | 'currentPremiumItems' | 'currentPremiumFormulas', options?: any): AxiosPromise<ListPoliciesResponseClass>;
252
252
  /**
253
253
  * Request to suspend an existing policy by tenant.
254
254
  * @summary Suspend a policy by tenant
@@ -328,11 +328,11 @@ export interface PoliciesApiGetPolicyRequest {
328
328
  */
329
329
  readonly authorization?: string;
330
330
  /**
331
- * Fields to expand response by.
332
- * @type {string}
331
+ * You can expand policy in this endpoint. By default, versions will be an empty array.
332
+ * @type {'versions' | 'product' | 'timelines' | 'premiums' | 'premiumItems' | 'premiumFormulas' | 'currentVersion' | 'currentTimelines' | 'currentPremiums' | 'currentPremiumItems' | 'currentPremiumFormulas'}
333
333
  * @memberof PoliciesApiGetPolicy
334
334
  */
335
- readonly expand?: string;
335
+ readonly expand?: 'versions' | 'product' | 'timelines' | 'premiums' | 'premiumItems' | 'premiumFormulas' | 'currentVersion' | 'currentTimelines' | 'currentPremiums' | 'currentPremiumItems' | 'currentPremiumFormulas';
336
336
  }
337
337
  /**
338
338
  * Request parameters for getPolicyDataByDate operation in PoliciesApi.
@@ -384,11 +384,11 @@ export interface PoliciesApiListPoliciesRequest {
384
384
  */
385
385
  readonly pageToken?: string;
386
386
  /**
387
- * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time. Parameters: **code**, **policyNumber**, **accountCode**, **statuses**, **productName**, **productType**, **policyData**, **createdAt**, **policyStartDate**.
388
- * @type {string}
387
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
388
+ * @type {'code' | 'policyNumber' | 'accountCode' | 'statuses' | 'productName' | 'productType' | 'createdAt' | 'policyStartDate' | 'policyData'}
389
389
  * @memberof PoliciesApiListPolicies
390
390
  */
391
- readonly filter?: string;
391
+ readonly filter?: 'code' | 'policyNumber' | 'accountCode' | 'statuses' | 'productName' | 'productType' | 'createdAt' | 'policyStartDate' | 'policyData';
392
392
  /**
393
393
  * Search query.
394
394
  * @type {string}
@@ -396,17 +396,17 @@ export interface PoliciesApiListPoliciesRequest {
396
396
  */
397
397
  readonly search?: string;
398
398
  /**
399
- * Ordering criteria.
400
- * @type {string}
399
+ * Order allowing you to specify the desired order of entities retrieved from the server.
400
+ * @type {'policyNumber' | 'createdAt'}
401
401
  * @memberof PoliciesApiListPolicies
402
402
  */
403
- readonly order?: string;
403
+ readonly order?: 'policyNumber' | 'createdAt';
404
404
  /**
405
405
  * You can expand policy versions list in this endpoint. By default, versions will be an empty array.
406
- * @type {string}
406
+ * @type {'versions' | 'product' | 'timelines' | 'premiums' | 'premiumItems' | 'premiumFormulas' | 'currentVersion' | 'currentTimelines' | 'currentPremiums' | 'currentPremiumItems' | 'currentPremiumFormulas'}
407
407
  * @memberof PoliciesApiListPolicies
408
408
  */
409
- readonly expand?: string;
409
+ readonly expand?: 'versions' | 'product' | 'timelines' | 'premiums' | 'premiumItems' | 'premiumFormulas' | 'currentVersion' | 'currentTimelines' | 'currentPremiums' | 'currentPremiumItems' | 'currentPremiumFormulas';
410
410
  }
411
411
  /**
412
412
  * Request parameters for suspendPolicy operation in PoliciesApi.
@@ -150,7 +150,7 @@ var PoliciesApiAxiosParamCreator = function (configuration) {
150
150
  * @summary Retrieve the policy
151
151
  * @param {string} code Unique identifier for the object.
152
152
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
153
- * @param {string} [expand] Fields to expand response by.
153
+ * @param {'versions' | 'product' | 'timelines' | 'premiums' | 'premiumItems' | 'premiumFormulas' | 'currentVersion' | 'currentTimelines' | 'currentPremiums' | 'currentPremiumItems' | 'currentPremiumFormulas'} [expand] You can expand policy in this endpoint. By default, versions will be an empty array.
154
154
  * @param {*} [options] Override http request option.
155
155
  * @throws {RequiredError}
156
156
  */
@@ -255,10 +255,10 @@ var PoliciesApiAxiosParamCreator = function (configuration) {
255
255
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
256
256
  * @param {number} [pageSize] Page size.
257
257
  * @param {string} [pageToken] Page token.
258
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time. Parameters: **code**, **policyNumber**, **accountCode**, **statuses**, **productName**, **productType**, **policyData**, **createdAt**, **policyStartDate**.
258
+ * @param {'code' | 'policyNumber' | 'accountCode' | 'statuses' | 'productName' | 'productType' | 'createdAt' | 'policyStartDate' | 'policyData'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
259
259
  * @param {string} [search] Search query.
260
- * @param {string} [order] Ordering criteria.
261
- * @param {string} [expand] You can expand policy versions list in this endpoint. By default, versions will be an empty array.
260
+ * @param {'policyNumber' | 'createdAt'} [order] Order allowing you to specify the desired order of entities retrieved from the server.
261
+ * @param {'versions' | 'product' | 'timelines' | 'premiums' | 'premiumItems' | 'premiumFormulas' | 'currentVersion' | 'currentTimelines' | 'currentPremiums' | 'currentPremiumItems' | 'currentPremiumFormulas'} [expand] You can expand policy versions list in this endpoint. By default, versions will be an empty array.
262
262
  * @param {*} [options] Override http request option.
263
263
  * @throws {RequiredError}
264
264
  */
@@ -565,7 +565,7 @@ var PoliciesApiFp = function (configuration) {
565
565
  * @summary Retrieve the policy
566
566
  * @param {string} code Unique identifier for the object.
567
567
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
568
- * @param {string} [expand] Fields to expand response by.
568
+ * @param {'versions' | 'product' | 'timelines' | 'premiums' | 'premiumItems' | 'premiumFormulas' | 'currentVersion' | 'currentTimelines' | 'currentPremiums' | 'currentPremiumItems' | 'currentPremiumFormulas'} [expand] You can expand policy in this endpoint. By default, versions will be an empty array.
569
569
  * @param {*} [options] Override http request option.
570
570
  * @throws {RequiredError}
571
571
  */
@@ -610,10 +610,10 @@ var PoliciesApiFp = function (configuration) {
610
610
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
611
611
  * @param {number} [pageSize] Page size.
612
612
  * @param {string} [pageToken] Page token.
613
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time. Parameters: **code**, **policyNumber**, **accountCode**, **statuses**, **productName**, **productType**, **policyData**, **createdAt**, **policyStartDate**.
613
+ * @param {'code' | 'policyNumber' | 'accountCode' | 'statuses' | 'productName' | 'productType' | 'createdAt' | 'policyStartDate' | 'policyData'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
614
614
  * @param {string} [search] Search query.
615
- * @param {string} [order] Ordering criteria.
616
- * @param {string} [expand] You can expand policy versions list in this endpoint. By default, versions will be an empty array.
615
+ * @param {'policyNumber' | 'createdAt'} [order] Order allowing you to specify the desired order of entities retrieved from the server.
616
+ * @param {'versions' | 'product' | 'timelines' | 'premiums' | 'premiumItems' | 'premiumFormulas' | 'currentVersion' | 'currentTimelines' | 'currentPremiums' | 'currentPremiumItems' | 'currentPremiumFormulas'} [expand] You can expand policy versions list in this endpoint. By default, versions will be an empty array.
617
617
  * @param {*} [options] Override http request option.
618
618
  * @throws {RequiredError}
619
619
  */
@@ -744,7 +744,7 @@ var PoliciesApiFactory = function (configuration, basePath, axios) {
744
744
  * @summary Retrieve the policy
745
745
  * @param {string} code Unique identifier for the object.
746
746
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
747
- * @param {string} [expand] Fields to expand response by.
747
+ * @param {'versions' | 'product' | 'timelines' | 'premiums' | 'premiumItems' | 'premiumFormulas' | 'currentVersion' | 'currentTimelines' | 'currentPremiums' | 'currentPremiumItems' | 'currentPremiumFormulas'} [expand] You can expand policy in this endpoint. By default, versions will be an empty array.
748
748
  * @param {*} [options] Override http request option.
749
749
  * @throws {RequiredError}
750
750
  */
@@ -769,10 +769,10 @@ var PoliciesApiFactory = function (configuration, basePath, axios) {
769
769
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
770
770
  * @param {number} [pageSize] Page size.
771
771
  * @param {string} [pageToken] Page token.
772
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time. Parameters: **code**, **policyNumber**, **accountCode**, **statuses**, **productName**, **productType**, **policyData**, **createdAt**, **policyStartDate**.
772
+ * @param {'code' | 'policyNumber' | 'accountCode' | 'statuses' | 'productName' | 'productType' | 'createdAt' | 'policyStartDate' | 'policyData'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
773
773
  * @param {string} [search] Search query.
774
- * @param {string} [order] Ordering criteria.
775
- * @param {string} [expand] You can expand policy versions list in this endpoint. By default, versions will be an empty array.
774
+ * @param {'policyNumber' | 'createdAt'} [order] Order allowing you to specify the desired order of entities retrieved from the server.
775
+ * @param {'versions' | 'product' | 'timelines' | 'premiums' | 'premiumItems' | 'premiumFormulas' | 'currentVersion' | 'currentTimelines' | 'currentPremiums' | 'currentPremiumItems' | 'currentPremiumFormulas'} [expand] You can expand policy versions list in this endpoint. By default, versions will be an empty array.
776
776
  * @param {*} [options] Override http request option.
777
777
  * @throws {RequiredError}
778
778
  */
@@ -34,7 +34,7 @@ export interface LeadClass {
34
34
  */
35
35
  'code'?: string;
36
36
  /**
37
- * ERN of the organization that created the lead.
37
+ * Emil Resources Names (ERN) identifies the most specific owner of a resource.
38
38
  * @type {string}
39
39
  * @memberof LeadClass
40
40
  */
@@ -120,7 +120,7 @@ export interface PolicyClass {
120
120
  */
121
121
  'leadCode'?: string;
122
122
  /**
123
- * ERN of the organization that created the policy.
123
+ * Emil Resources Names (ERN) identifies the most specific owner of a resource.
124
124
  * @type {string}
125
125
  * @memberof PolicyClass
126
126
  */
@@ -21,6 +21,12 @@ export interface PolicyObjectClass {
21
21
  * @memberof PolicyObjectClass
22
22
  */
23
23
  'insuredObjectId': number;
24
+ /**
25
+ * Unique identifier for the object.
26
+ * @type {string}
27
+ * @memberof PolicyObjectClass
28
+ */
29
+ 'code': string;
24
30
  /**
25
31
  * Insured object name.
26
32
  * @type {string}
@@ -27,4 +27,10 @@ export interface PolicyObjectDto {
27
27
  * @memberof PolicyObjectDto
28
28
  */
29
29
  'data': object;
30
+ /**
31
+ *
32
+ * @type {string}
33
+ * @memberof PolicyObjectDto
34
+ */
35
+ 'code'?: string;
30
36
  }
@@ -39,7 +39,7 @@ export interface LeadClass {
39
39
  */
40
40
  'code'?: string;
41
41
  /**
42
- * ERN of the organization that created the lead.
42
+ * Emil Resources Names (ERN) identifies the most specific owner of a resource.
43
43
  * @type {string}
44
44
  * @memberof LeadClass
45
45
  */
@@ -125,7 +125,7 @@ export interface PolicyClass {
125
125
  */
126
126
  'leadCode'?: string;
127
127
  /**
128
- * ERN of the organization that created the policy.
128
+ * Emil Resources Names (ERN) identifies the most specific owner of a resource.
129
129
  * @type {string}
130
130
  * @memberof PolicyClass
131
131
  */
@@ -26,6 +26,12 @@ export interface PolicyObjectClass {
26
26
  * @memberof PolicyObjectClass
27
27
  */
28
28
  'insuredObjectId': number;
29
+ /**
30
+ * Unique identifier for the object.
31
+ * @type {string}
32
+ * @memberof PolicyObjectClass
33
+ */
34
+ 'code': string;
29
35
  /**
30
36
  * Insured object name.
31
37
  * @type {string}
@@ -32,5 +32,11 @@ export interface PolicyObjectDto {
32
32
  * @memberof PolicyObjectDto
33
33
  */
34
34
  'data': object;
35
+ /**
36
+ *
37
+ * @type {string}
38
+ * @memberof PolicyObjectDto
39
+ */
40
+ 'code'?: string;
35
41
  }
36
42
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@emilgroup/insurance-sdk-node",
3
- "version": "1.14.0",
3
+ "version": "1.15.0",
4
4
  "description": "OpenAPI client for @emilgroup/insurance-sdk-node",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "keywords": [
@@ -23,7 +23,7 @@
23
23
  "url": "^0.11.0"
24
24
  },
25
25
  "devDependencies": {
26
- "@types/node": "^12.11.5",
26
+ "@types/node": "^12.11.5",
27
27
  "typescript": "^4.0"
28
28
  }
29
29
  }