@emilgroup/document-sdk 1.0.0 → 1.2.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/.openapi-generator/FILES +7 -0
- package/README.md +2 -2
- package/api/document-templates-api.ts +1 -1
- package/api/documents-api.ts +1 -1
- package/api/layouts-api.ts +1 -1
- package/api/product-documents-api.ts +599 -0
- package/api/search-keywords-api.ts +1 -1
- package/api/searchable-document-owners-api.ts +1 -1
- package/api/searchable-documents-api.ts +21 -7
- package/api.ts +3 -1
- package/base.ts +1 -1
- package/common.ts +2 -2
- package/configuration.ts +1 -1
- package/dist/api/document-templates-api.d.ts +1 -1
- package/dist/api/document-templates-api.js +1 -1
- package/dist/api/documents-api.d.ts +1 -1
- package/dist/api/documents-api.js +1 -1
- package/dist/api/layouts-api.d.ts +1 -1
- package/dist/api/layouts-api.js +1 -1
- package/dist/api/product-documents-api.d.ts +345 -0
- package/dist/api/product-documents-api.js +558 -0
- package/dist/api/search-keywords-api.d.ts +1 -1
- package/dist/api/search-keywords-api.js +1 -1
- package/dist/api/searchable-document-owners-api.d.ts +1 -1
- package/dist/api/searchable-document-owners-api.js +1 -1
- package/dist/api/searchable-documents-api.d.ts +13 -4
- package/dist/api/searchable-documents-api.js +13 -7
- package/dist/api.d.ts +2 -1
- package/dist/api.js +2 -1
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +2 -2
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/dist/models/create-doc-template-request-dto.d.ts +1 -1
- package/dist/models/create-doc-template-request-dto.js +1 -1
- package/dist/models/create-doc-template-response-class.d.ts +1 -1
- package/dist/models/create-doc-template-response-class.js +1 -1
- package/dist/models/create-document-request-dto.d.ts +2 -1
- package/dist/models/create-document-request-dto.js +3 -2
- package/dist/models/create-document-sync-response-class.d.ts +1 -1
- package/dist/models/create-document-sync-response-class.js +1 -1
- package/dist/models/create-html-template-dto.d.ts +1 -1
- package/dist/models/create-html-template-dto.js +1 -1
- package/dist/models/create-layout-request-dto.d.ts +1 -1
- package/dist/models/create-layout-request-dto.js +1 -1
- package/dist/models/create-layout-response-class.d.ts +1 -1
- package/dist/models/create-layout-response-class.js +1 -1
- package/dist/models/create-presigned-post-request-dto.d.ts +2 -1
- package/dist/models/create-presigned-post-request-dto.js +3 -2
- package/dist/models/create-presigned-post-response-class.d.ts +1 -1
- package/dist/models/create-presigned-post-response-class.js +1 -1
- package/dist/models/delete-layout-request-dto.d.ts +1 -1
- package/dist/models/delete-layout-request-dto.js +1 -1
- package/dist/models/delete-product-document-request-dto.d.ts +30 -0
- package/dist/models/delete-product-document-request-dto.js +15 -0
- package/dist/models/delete-request-dto.d.ts +1 -1
- package/dist/models/delete-request-dto.js +1 -1
- package/dist/models/delete-response-class.d.ts +1 -1
- package/dist/models/delete-response-class.js +1 -1
- package/dist/models/doc-template-class.d.ts +1 -1
- package/dist/models/doc-template-class.js +1 -1
- package/dist/models/document-class.d.ts +2 -1
- package/dist/models/document-class.js +3 -2
- package/dist/models/download-document-request-dto.d.ts +1 -1
- package/dist/models/download-document-request-dto.js +1 -1
- package/dist/models/get-doc-template-request-dto.d.ts +1 -1
- package/dist/models/get-doc-template-request-dto.js +1 -1
- package/dist/models/get-doc-template-response-class.d.ts +1 -1
- package/dist/models/get-doc-template-response-class.js +1 -1
- package/dist/models/get-document-download-url-response-class.d.ts +1 -1
- package/dist/models/get-document-download-url-response-class.js +1 -1
- package/dist/models/get-layout-request-dto.d.ts +1 -1
- package/dist/models/get-layout-request-dto.js +1 -1
- package/dist/models/get-layout-response-class.d.ts +1 -1
- package/dist/models/get-layout-response-class.js +1 -1
- package/dist/models/get-product-document-response-class.d.ts +25 -0
- package/dist/models/get-product-document-response-class.js +15 -0
- package/dist/models/get-signed-s3-key-url-response-class.d.ts +1 -1
- package/dist/models/get-signed-s3-key-url-response-class.js +1 -1
- package/dist/models/html-template-class.d.ts +1 -1
- package/dist/models/html-template-class.js +1 -1
- package/dist/models/index.d.ts +6 -0
- package/dist/models/index.js +6 -0
- package/dist/models/layout-class.d.ts +1 -1
- package/dist/models/layout-class.js +1 -1
- package/dist/models/list-doc-template-request-dto.d.ts +1 -1
- package/dist/models/list-doc-template-request-dto.js +1 -1
- package/dist/models/list-doc-templates-response-class.d.ts +1 -1
- package/dist/models/list-doc-templates-response-class.js +1 -1
- package/dist/models/list-documents-response-class.d.ts +1 -1
- package/dist/models/list-documents-response-class.js +1 -1
- package/dist/models/list-layouts-response-class.d.ts +1 -1
- package/dist/models/list-layouts-response-class.js +1 -1
- package/dist/models/list-product-documents-response-class.d.ts +31 -0
- package/dist/models/list-product-documents-response-class.js +15 -0
- package/dist/models/list-request-dto.d.ts +1 -1
- package/dist/models/list-request-dto.js +1 -1
- package/dist/models/list-search-keywords-request-dto.d.ts +1 -1
- package/dist/models/list-search-keywords-request-dto.js +1 -1
- package/dist/models/list-search-keywords-response-class.d.ts +1 -1
- package/dist/models/list-search-keywords-response-class.js +1 -1
- package/dist/models/list-searchable-document-owners-request-dto.d.ts +31 -0
- package/dist/models/list-searchable-document-owners-request-dto.js +22 -0
- package/dist/models/list-searchable-document-owners-response-class.d.ts +1 -1
- package/dist/models/list-searchable-document-owners-response-class.js +1 -1
- package/dist/models/list-searchable-documents-request-dto.d.ts +14 -1
- package/dist/models/list-searchable-documents-request-dto.js +8 -1
- package/dist/models/list-searchable-documents-response-class.d.ts +1 -1
- package/dist/models/list-searchable-documents-response-class.js +1 -1
- package/dist/models/product-document-class.d.ts +99 -0
- package/dist/models/product-document-class.js +36 -0
- package/dist/models/searchable-document-class.d.ts +1 -1
- package/dist/models/searchable-document-class.js +1 -1
- package/dist/models/searchable-document-owner-class.d.ts +1 -1
- package/dist/models/searchable-document-owner-class.js +1 -1
- package/dist/models/update-doc-template-request-dto.d.ts +1 -1
- package/dist/models/update-doc-template-request-dto.js +1 -1
- package/dist/models/update-doc-template-response-class.d.ts +1 -1
- package/dist/models/update-doc-template-response-class.js +1 -1
- package/dist/models/update-document-request-dto.d.ts +1 -1
- package/dist/models/update-document-request-dto.js +1 -1
- package/dist/models/update-document-response-class.d.ts +1 -1
- package/dist/models/update-document-response-class.js +1 -1
- package/dist/models/update-html-template-dto.d.ts +1 -1
- package/dist/models/update-html-template-dto.js +1 -1
- package/dist/models/update-layout-request-dto.d.ts +1 -1
- package/dist/models/update-layout-request-dto.js +1 -1
- package/dist/models/update-layout-response-class.d.ts +1 -1
- package/dist/models/update-layout-response-class.js +1 -1
- package/dist/models/upload-product-document-request-dto.d.ts +63 -0
- package/dist/models/upload-product-document-request-dto.js +24 -0
- package/index.ts +1 -1
- package/models/create-doc-template-request-dto.ts +1 -1
- package/models/create-doc-template-response-class.ts +1 -1
- package/models/create-document-request-dto.ts +3 -2
- package/models/create-document-sync-response-class.ts +1 -1
- package/models/create-html-template-dto.ts +1 -1
- package/models/create-layout-request-dto.ts +1 -1
- package/models/create-layout-response-class.ts +1 -1
- package/models/create-presigned-post-request-dto.ts +3 -2
- package/models/create-presigned-post-response-class.ts +1 -1
- package/models/delete-layout-request-dto.ts +1 -1
- package/models/delete-product-document-request-dto.ts +36 -0
- package/models/delete-request-dto.ts +1 -1
- package/models/delete-response-class.ts +1 -1
- package/models/doc-template-class.ts +1 -1
- package/models/document-class.ts +3 -2
- package/models/download-document-request-dto.ts +1 -1
- package/models/get-doc-template-request-dto.ts +1 -1
- package/models/get-doc-template-response-class.ts +1 -1
- package/models/get-document-download-url-response-class.ts +1 -1
- package/models/get-layout-request-dto.ts +1 -1
- package/models/get-layout-response-class.ts +1 -1
- package/models/get-product-document-response-class.ts +31 -0
- package/models/get-signed-s3-key-url-response-class.ts +1 -1
- package/models/html-template-class.ts +1 -1
- package/models/index.ts +6 -0
- package/models/layout-class.ts +1 -1
- package/models/list-doc-template-request-dto.ts +1 -1
- package/models/list-doc-templates-response-class.ts +1 -1
- package/models/list-documents-response-class.ts +1 -1
- package/models/list-layouts-response-class.ts +1 -1
- package/models/list-product-documents-response-class.ts +37 -0
- package/models/list-request-dto.ts +1 -1
- package/models/list-search-keywords-request-dto.ts +1 -1
- package/models/list-search-keywords-response-class.ts +1 -1
- package/models/list-searchable-document-owners-request-dto.ts +40 -0
- package/models/list-searchable-document-owners-response-class.ts +1 -1
- package/models/list-searchable-documents-request-dto.ts +17 -1
- package/models/list-searchable-documents-response-class.ts +1 -1
- package/models/product-document-class.ts +108 -0
- package/models/searchable-document-class.ts +1 -1
- package/models/searchable-document-owner-class.ts +1 -1
- package/models/update-doc-template-request-dto.ts +1 -1
- package/models/update-doc-template-response-class.ts +1 -1
- package/models/update-document-request-dto.ts +1 -1
- package/models/update-document-response-class.ts +1 -1
- package/models/update-html-template-dto.ts +1 -1
- package/models/update-layout-request-dto.ts +1 -1
- package/models/update-layout-response-class.ts +1 -1
- package/models/upload-product-document-request-dto.ts +72 -0
- package/package.json +1 -1
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* The EMIL DocumentService API description
|
|
6
6
|
*
|
|
7
7
|
* The version of the OpenAPI document: 1.0
|
|
8
|
-
*
|
|
8
|
+
* Contact: kontakt@emil.de
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
11
|
* https://openapi-generator.tech
|
|
@@ -38,10 +38,11 @@ export const SearchableDocumentsApiAxiosParamCreator = function (configuration?:
|
|
|
38
38
|
* @param {string} searchText Text to search in the documents.
|
|
39
39
|
* @param {string} ownerIds List of searched document owner IDs separated with | (search in all documents if an \'*\' list provided).
|
|
40
40
|
* @param {string} [authorization] Bearer Token
|
|
41
|
+
* @param {'car' | 'homeowner' | 'household' | 'privateLiability'} [product] PBM product the documents belongs to.
|
|
41
42
|
* @param {*} [options] Override http request option.
|
|
42
43
|
* @throws {RequiredError}
|
|
43
44
|
*/
|
|
44
|
-
listSearchableDocuments: async (searchText: string, ownerIds: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
45
|
+
listSearchableDocuments: async (searchText: string, ownerIds: string, authorization?: string, product?: 'car' | 'homeowner' | 'household' | 'privateLiability', options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
45
46
|
// verify required parameter 'searchText' is not null or undefined
|
|
46
47
|
assertParamExists('listSearchableDocuments', 'searchText', searchText)
|
|
47
48
|
// verify required parameter 'ownerIds' is not null or undefined
|
|
@@ -72,6 +73,10 @@ export const SearchableDocumentsApiAxiosParamCreator = function (configuration?:
|
|
|
72
73
|
localVarQueryParameter['ownerIds'] = ownerIds;
|
|
73
74
|
}
|
|
74
75
|
|
|
76
|
+
if (product !== undefined) {
|
|
77
|
+
localVarQueryParameter['product'] = product;
|
|
78
|
+
}
|
|
79
|
+
|
|
75
80
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
76
81
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
77
82
|
}
|
|
@@ -103,11 +108,12 @@ export const SearchableDocumentsApiFp = function(configuration?: Configuration)
|
|
|
103
108
|
* @param {string} searchText Text to search in the documents.
|
|
104
109
|
* @param {string} ownerIds List of searched document owner IDs separated with | (search in all documents if an \'*\' list provided).
|
|
105
110
|
* @param {string} [authorization] Bearer Token
|
|
111
|
+
* @param {'car' | 'homeowner' | 'household' | 'privateLiability'} [product] PBM product the documents belongs to.
|
|
106
112
|
* @param {*} [options] Override http request option.
|
|
107
113
|
* @throws {RequiredError}
|
|
108
114
|
*/
|
|
109
|
-
async listSearchableDocuments(searchText: string, ownerIds: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListSearchableDocumentsResponseClass>> {
|
|
110
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listSearchableDocuments(searchText, ownerIds, authorization, options);
|
|
115
|
+
async listSearchableDocuments(searchText: string, ownerIds: string, authorization?: string, product?: 'car' | 'homeowner' | 'household' | 'privateLiability', options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListSearchableDocumentsResponseClass>> {
|
|
116
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listSearchableDocuments(searchText, ownerIds, authorization, product, options);
|
|
111
117
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
112
118
|
},
|
|
113
119
|
}
|
|
@@ -126,11 +132,12 @@ export const SearchableDocumentsApiFactory = function (configuration?: Configura
|
|
|
126
132
|
* @param {string} searchText Text to search in the documents.
|
|
127
133
|
* @param {string} ownerIds List of searched document owner IDs separated with | (search in all documents if an \'*\' list provided).
|
|
128
134
|
* @param {string} [authorization] Bearer Token
|
|
135
|
+
* @param {'car' | 'homeowner' | 'household' | 'privateLiability'} [product] PBM product the documents belongs to.
|
|
129
136
|
* @param {*} [options] Override http request option.
|
|
130
137
|
* @throws {RequiredError}
|
|
131
138
|
*/
|
|
132
|
-
listSearchableDocuments(searchText: string, ownerIds: string, authorization?: string, options?: any): AxiosPromise<ListSearchableDocumentsResponseClass> {
|
|
133
|
-
return localVarFp.listSearchableDocuments(searchText, ownerIds, authorization, options).then((request) => request(axios, basePath));
|
|
139
|
+
listSearchableDocuments(searchText: string, ownerIds: string, authorization?: string, product?: 'car' | 'homeowner' | 'household' | 'privateLiability', options?: any): AxiosPromise<ListSearchableDocumentsResponseClass> {
|
|
140
|
+
return localVarFp.listSearchableDocuments(searchText, ownerIds, authorization, product, options).then((request) => request(axios, basePath));
|
|
134
141
|
},
|
|
135
142
|
};
|
|
136
143
|
};
|
|
@@ -161,6 +168,13 @@ export interface SearchableDocumentsApiListSearchableDocumentsRequest {
|
|
|
161
168
|
* @memberof SearchableDocumentsApiListSearchableDocuments
|
|
162
169
|
*/
|
|
163
170
|
readonly authorization?: string
|
|
171
|
+
|
|
172
|
+
/**
|
|
173
|
+
* PBM product the documents belongs to.
|
|
174
|
+
* @type {'car' | 'homeowner' | 'household' | 'privateLiability'}
|
|
175
|
+
* @memberof SearchableDocumentsApiListSearchableDocuments
|
|
176
|
+
*/
|
|
177
|
+
readonly product?: 'car' | 'homeowner' | 'household' | 'privateLiability'
|
|
164
178
|
}
|
|
165
179
|
|
|
166
180
|
/**
|
|
@@ -179,6 +193,6 @@ export class SearchableDocumentsApi extends BaseAPI {
|
|
|
179
193
|
* @memberof SearchableDocumentsApi
|
|
180
194
|
*/
|
|
181
195
|
public listSearchableDocuments(requestParameters: SearchableDocumentsApiListSearchableDocumentsRequest, options?: AxiosRequestConfig) {
|
|
182
|
-
return SearchableDocumentsApiFp(this.configuration).listSearchableDocuments(requestParameters.searchText, requestParameters.ownerIds, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
196
|
+
return SearchableDocumentsApiFp(this.configuration).listSearchableDocuments(requestParameters.searchText, requestParameters.ownerIds, requestParameters.authorization, requestParameters.product, options).then((request) => request(this.axios, this.basePath));
|
|
183
197
|
}
|
|
184
198
|
}
|
package/api.ts
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* The EMIL DocumentService API description
|
|
6
6
|
*
|
|
7
7
|
* The version of the OpenAPI document: 1.0
|
|
8
|
-
*
|
|
8
|
+
* Contact: kontakt@emil.de
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
11
|
* https://openapi-generator.tech
|
|
@@ -27,6 +27,7 @@ import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } fr
|
|
|
27
27
|
import { DocumentTemplatesApi } from './api';
|
|
28
28
|
import { DocumentsApi } from './api';
|
|
29
29
|
import { LayoutsApi } from './api';
|
|
30
|
+
import { ProductDocumentsApi } from './api';
|
|
30
31
|
import { SearchKeywordsApi } from './api';
|
|
31
32
|
import { SearchableDocumentOwnersApi } from './api';
|
|
32
33
|
import { SearchableDocumentsApi } from './api';
|
|
@@ -35,6 +36,7 @@ import { SearchableDocumentsApi } from './api';
|
|
|
35
36
|
export * from './api/document-templates-api';
|
|
36
37
|
export * from './api/documents-api';
|
|
37
38
|
export * from './api/layouts-api';
|
|
39
|
+
export * from './api/product-documents-api';
|
|
38
40
|
export * from './api/search-keywords-api';
|
|
39
41
|
export * from './api/searchable-document-owners-api';
|
|
40
42
|
export * from './api/searchable-documents-api';
|
package/base.ts
CHANGED
package/common.ts
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* The EMIL DocumentService API description
|
|
6
6
|
*
|
|
7
7
|
* The version of the OpenAPI document: 1.0
|
|
8
|
-
*
|
|
8
|
+
* Contact: kontakt@emil.de
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
11
|
* https://openapi-generator.tech
|
|
@@ -144,7 +144,7 @@ export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxi
|
|
|
144
144
|
* The EMIL DocumentService API description
|
|
145
145
|
*
|
|
146
146
|
* The version of the OpenAPI document: 1.0
|
|
147
|
-
*
|
|
147
|
+
* Contact: kontakt@emil.de
|
|
148
148
|
*
|
|
149
149
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
150
150
|
* https://openapi-generator.tech
|
package/configuration.ts
CHANGED
package/dist/api/layouts-api.js
CHANGED
|
@@ -0,0 +1,345 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* EMIL DocumentService
|
|
3
|
+
* The EMIL DocumentService 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 { GetProductDocumentResponseClass } from '../models';
|
|
16
|
+
import { ListProductDocumentsResponseClass } from '../models';
|
|
17
|
+
import { ProductDocumentClass } from '../models';
|
|
18
|
+
import { UploadProductDocumentRequestDto } from '../models';
|
|
19
|
+
/**
|
|
20
|
+
* ProductDocumentsApi - axios parameter creator
|
|
21
|
+
* @export
|
|
22
|
+
*/
|
|
23
|
+
export declare const ProductDocumentsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
24
|
+
/**
|
|
25
|
+
* Permanently deletes the product document. Supply the unique code that was returned when you created the product document and this will delete it.
|
|
26
|
+
* @summary Delete the product document
|
|
27
|
+
* @param {string} code
|
|
28
|
+
* @param {string} productSlug
|
|
29
|
+
* @param {string} [authorization] Bearer Token
|
|
30
|
+
* @param {*} [options] Override http request option.
|
|
31
|
+
* @throws {RequiredError}
|
|
32
|
+
*/
|
|
33
|
+
deleteProductDocument: (code: string, productSlug: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
34
|
+
/**
|
|
35
|
+
* Get a product document.
|
|
36
|
+
* @summary Retrieve the product document
|
|
37
|
+
* @param {string} productSlug
|
|
38
|
+
* @param {string} code
|
|
39
|
+
* @param {string} [authorization] Bearer Token
|
|
40
|
+
* @param {*} [options] Override http request option.
|
|
41
|
+
* @throws {RequiredError}
|
|
42
|
+
*/
|
|
43
|
+
getProductDocument: (productSlug: string, code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44
|
+
/**
|
|
45
|
+
* Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
46
|
+
* @summary List product documents
|
|
47
|
+
* @param {string} productSlug
|
|
48
|
+
* @param {string} [authorization] Bearer Token
|
|
49
|
+
* @param {number} [pageSize] Page size
|
|
50
|
+
* @param {string} [pageToken] Page token
|
|
51
|
+
* @param {string} [filter] List filter
|
|
52
|
+
* @param {string} [search] Search query
|
|
53
|
+
* @param {string} [order] Ordering criteria
|
|
54
|
+
* @param {string} [expand] Extra fields to fetch
|
|
55
|
+
* @param {*} [options] Override http request option.
|
|
56
|
+
* @throws {RequiredError}
|
|
57
|
+
*/
|
|
58
|
+
listProductDocuments: (productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
59
|
+
/**
|
|
60
|
+
* Upload a product document.
|
|
61
|
+
* @summary Create the product document
|
|
62
|
+
* @param {string} productSlug
|
|
63
|
+
* @param {UploadProductDocumentRequestDto} uploadProductDocumentRequestDto
|
|
64
|
+
* @param {string} [authorization] Bearer Token
|
|
65
|
+
* @param {*} [options] Override http request option.
|
|
66
|
+
* @throws {RequiredError}
|
|
67
|
+
*/
|
|
68
|
+
uploadProductDocument: (productSlug: string, uploadProductDocumentRequestDto: UploadProductDocumentRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
69
|
+
};
|
|
70
|
+
/**
|
|
71
|
+
* ProductDocumentsApi - functional programming interface
|
|
72
|
+
* @export
|
|
73
|
+
*/
|
|
74
|
+
export declare const ProductDocumentsApiFp: (configuration?: Configuration) => {
|
|
75
|
+
/**
|
|
76
|
+
* Permanently deletes the product document. Supply the unique code that was returned when you created the product document and this will delete it.
|
|
77
|
+
* @summary Delete the product document
|
|
78
|
+
* @param {string} code
|
|
79
|
+
* @param {string} productSlug
|
|
80
|
+
* @param {string} [authorization] Bearer Token
|
|
81
|
+
* @param {*} [options] Override http request option.
|
|
82
|
+
* @throws {RequiredError}
|
|
83
|
+
*/
|
|
84
|
+
deleteProductDocument(code: string, productSlug: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
85
|
+
/**
|
|
86
|
+
* Get a product document.
|
|
87
|
+
* @summary Retrieve the product document
|
|
88
|
+
* @param {string} productSlug
|
|
89
|
+
* @param {string} code
|
|
90
|
+
* @param {string} [authorization] Bearer Token
|
|
91
|
+
* @param {*} [options] Override http request option.
|
|
92
|
+
* @throws {RequiredError}
|
|
93
|
+
*/
|
|
94
|
+
getProductDocument(productSlug: string, code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetProductDocumentResponseClass>>;
|
|
95
|
+
/**
|
|
96
|
+
* Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
97
|
+
* @summary List product documents
|
|
98
|
+
* @param {string} productSlug
|
|
99
|
+
* @param {string} [authorization] Bearer Token
|
|
100
|
+
* @param {number} [pageSize] Page size
|
|
101
|
+
* @param {string} [pageToken] Page token
|
|
102
|
+
* @param {string} [filter] List filter
|
|
103
|
+
* @param {string} [search] Search query
|
|
104
|
+
* @param {string} [order] Ordering criteria
|
|
105
|
+
* @param {string} [expand] Extra fields to fetch
|
|
106
|
+
* @param {*} [options] Override http request option.
|
|
107
|
+
* @throws {RequiredError}
|
|
108
|
+
*/
|
|
109
|
+
listProductDocuments(productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListProductDocumentsResponseClass>>;
|
|
110
|
+
/**
|
|
111
|
+
* Upload a product document.
|
|
112
|
+
* @summary Create the product document
|
|
113
|
+
* @param {string} productSlug
|
|
114
|
+
* @param {UploadProductDocumentRequestDto} uploadProductDocumentRequestDto
|
|
115
|
+
* @param {string} [authorization] Bearer Token
|
|
116
|
+
* @param {*} [options] Override http request option.
|
|
117
|
+
* @throws {RequiredError}
|
|
118
|
+
*/
|
|
119
|
+
uploadProductDocument(productSlug: string, uploadProductDocumentRequestDto: UploadProductDocumentRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductDocumentClass>>;
|
|
120
|
+
};
|
|
121
|
+
/**
|
|
122
|
+
* ProductDocumentsApi - factory interface
|
|
123
|
+
* @export
|
|
124
|
+
*/
|
|
125
|
+
export declare const ProductDocumentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
126
|
+
/**
|
|
127
|
+
* Permanently deletes the product document. Supply the unique code that was returned when you created the product document and this will delete it.
|
|
128
|
+
* @summary Delete the product document
|
|
129
|
+
* @param {string} code
|
|
130
|
+
* @param {string} productSlug
|
|
131
|
+
* @param {string} [authorization] Bearer Token
|
|
132
|
+
* @param {*} [options] Override http request option.
|
|
133
|
+
* @throws {RequiredError}
|
|
134
|
+
*/
|
|
135
|
+
deleteProductDocument(code: string, productSlug: string, authorization?: string, options?: any): AxiosPromise<object>;
|
|
136
|
+
/**
|
|
137
|
+
* Get a product document.
|
|
138
|
+
* @summary Retrieve the product document
|
|
139
|
+
* @param {string} productSlug
|
|
140
|
+
* @param {string} code
|
|
141
|
+
* @param {string} [authorization] Bearer Token
|
|
142
|
+
* @param {*} [options] Override http request option.
|
|
143
|
+
* @throws {RequiredError}
|
|
144
|
+
*/
|
|
145
|
+
getProductDocument(productSlug: string, code: string, authorization?: string, options?: any): AxiosPromise<GetProductDocumentResponseClass>;
|
|
146
|
+
/**
|
|
147
|
+
* Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
148
|
+
* @summary List product documents
|
|
149
|
+
* @param {string} productSlug
|
|
150
|
+
* @param {string} [authorization] Bearer Token
|
|
151
|
+
* @param {number} [pageSize] Page size
|
|
152
|
+
* @param {string} [pageToken] Page token
|
|
153
|
+
* @param {string} [filter] List filter
|
|
154
|
+
* @param {string} [search] Search query
|
|
155
|
+
* @param {string} [order] Ordering criteria
|
|
156
|
+
* @param {string} [expand] Extra fields to fetch
|
|
157
|
+
* @param {*} [options] Override http request option.
|
|
158
|
+
* @throws {RequiredError}
|
|
159
|
+
*/
|
|
160
|
+
listProductDocuments(productSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListProductDocumentsResponseClass>;
|
|
161
|
+
/**
|
|
162
|
+
* Upload a product document.
|
|
163
|
+
* @summary Create the product document
|
|
164
|
+
* @param {string} productSlug
|
|
165
|
+
* @param {UploadProductDocumentRequestDto} uploadProductDocumentRequestDto
|
|
166
|
+
* @param {string} [authorization] Bearer Token
|
|
167
|
+
* @param {*} [options] Override http request option.
|
|
168
|
+
* @throws {RequiredError}
|
|
169
|
+
*/
|
|
170
|
+
uploadProductDocument(productSlug: string, uploadProductDocumentRequestDto: UploadProductDocumentRequestDto, authorization?: string, options?: any): AxiosPromise<ProductDocumentClass>;
|
|
171
|
+
};
|
|
172
|
+
/**
|
|
173
|
+
* Request parameters for deleteProductDocument operation in ProductDocumentsApi.
|
|
174
|
+
* @export
|
|
175
|
+
* @interface ProductDocumentsApiDeleteProductDocumentRequest
|
|
176
|
+
*/
|
|
177
|
+
export interface ProductDocumentsApiDeleteProductDocumentRequest {
|
|
178
|
+
/**
|
|
179
|
+
*
|
|
180
|
+
* @type {string}
|
|
181
|
+
* @memberof ProductDocumentsApiDeleteProductDocument
|
|
182
|
+
*/
|
|
183
|
+
readonly code: string;
|
|
184
|
+
/**
|
|
185
|
+
*
|
|
186
|
+
* @type {string}
|
|
187
|
+
* @memberof ProductDocumentsApiDeleteProductDocument
|
|
188
|
+
*/
|
|
189
|
+
readonly productSlug: string;
|
|
190
|
+
/**
|
|
191
|
+
* Bearer Token
|
|
192
|
+
* @type {string}
|
|
193
|
+
* @memberof ProductDocumentsApiDeleteProductDocument
|
|
194
|
+
*/
|
|
195
|
+
readonly authorization?: string;
|
|
196
|
+
}
|
|
197
|
+
/**
|
|
198
|
+
* Request parameters for getProductDocument operation in ProductDocumentsApi.
|
|
199
|
+
* @export
|
|
200
|
+
* @interface ProductDocumentsApiGetProductDocumentRequest
|
|
201
|
+
*/
|
|
202
|
+
export interface ProductDocumentsApiGetProductDocumentRequest {
|
|
203
|
+
/**
|
|
204
|
+
*
|
|
205
|
+
* @type {string}
|
|
206
|
+
* @memberof ProductDocumentsApiGetProductDocument
|
|
207
|
+
*/
|
|
208
|
+
readonly productSlug: string;
|
|
209
|
+
/**
|
|
210
|
+
*
|
|
211
|
+
* @type {string}
|
|
212
|
+
* @memberof ProductDocumentsApiGetProductDocument
|
|
213
|
+
*/
|
|
214
|
+
readonly code: string;
|
|
215
|
+
/**
|
|
216
|
+
* Bearer Token
|
|
217
|
+
* @type {string}
|
|
218
|
+
* @memberof ProductDocumentsApiGetProductDocument
|
|
219
|
+
*/
|
|
220
|
+
readonly authorization?: string;
|
|
221
|
+
}
|
|
222
|
+
/**
|
|
223
|
+
* Request parameters for listProductDocuments operation in ProductDocumentsApi.
|
|
224
|
+
* @export
|
|
225
|
+
* @interface ProductDocumentsApiListProductDocumentsRequest
|
|
226
|
+
*/
|
|
227
|
+
export interface ProductDocumentsApiListProductDocumentsRequest {
|
|
228
|
+
/**
|
|
229
|
+
*
|
|
230
|
+
* @type {string}
|
|
231
|
+
* @memberof ProductDocumentsApiListProductDocuments
|
|
232
|
+
*/
|
|
233
|
+
readonly productSlug: string;
|
|
234
|
+
/**
|
|
235
|
+
* Bearer Token
|
|
236
|
+
* @type {string}
|
|
237
|
+
* @memberof ProductDocumentsApiListProductDocuments
|
|
238
|
+
*/
|
|
239
|
+
readonly authorization?: string;
|
|
240
|
+
/**
|
|
241
|
+
* Page size
|
|
242
|
+
* @type {number}
|
|
243
|
+
* @memberof ProductDocumentsApiListProductDocuments
|
|
244
|
+
*/
|
|
245
|
+
readonly pageSize?: number;
|
|
246
|
+
/**
|
|
247
|
+
* Page token
|
|
248
|
+
* @type {string}
|
|
249
|
+
* @memberof ProductDocumentsApiListProductDocuments
|
|
250
|
+
*/
|
|
251
|
+
readonly pageToken?: string;
|
|
252
|
+
/**
|
|
253
|
+
* List filter
|
|
254
|
+
* @type {string}
|
|
255
|
+
* @memberof ProductDocumentsApiListProductDocuments
|
|
256
|
+
*/
|
|
257
|
+
readonly filter?: string;
|
|
258
|
+
/**
|
|
259
|
+
* Search query
|
|
260
|
+
* @type {string}
|
|
261
|
+
* @memberof ProductDocumentsApiListProductDocuments
|
|
262
|
+
*/
|
|
263
|
+
readonly search?: string;
|
|
264
|
+
/**
|
|
265
|
+
* Ordering criteria
|
|
266
|
+
* @type {string}
|
|
267
|
+
* @memberof ProductDocumentsApiListProductDocuments
|
|
268
|
+
*/
|
|
269
|
+
readonly order?: string;
|
|
270
|
+
/**
|
|
271
|
+
* Extra fields to fetch
|
|
272
|
+
* @type {string}
|
|
273
|
+
* @memberof ProductDocumentsApiListProductDocuments
|
|
274
|
+
*/
|
|
275
|
+
readonly expand?: string;
|
|
276
|
+
}
|
|
277
|
+
/**
|
|
278
|
+
* Request parameters for uploadProductDocument operation in ProductDocumentsApi.
|
|
279
|
+
* @export
|
|
280
|
+
* @interface ProductDocumentsApiUploadProductDocumentRequest
|
|
281
|
+
*/
|
|
282
|
+
export interface ProductDocumentsApiUploadProductDocumentRequest {
|
|
283
|
+
/**
|
|
284
|
+
*
|
|
285
|
+
* @type {string}
|
|
286
|
+
* @memberof ProductDocumentsApiUploadProductDocument
|
|
287
|
+
*/
|
|
288
|
+
readonly productSlug: string;
|
|
289
|
+
/**
|
|
290
|
+
*
|
|
291
|
+
* @type {UploadProductDocumentRequestDto}
|
|
292
|
+
* @memberof ProductDocumentsApiUploadProductDocument
|
|
293
|
+
*/
|
|
294
|
+
readonly uploadProductDocumentRequestDto: UploadProductDocumentRequestDto;
|
|
295
|
+
/**
|
|
296
|
+
* Bearer Token
|
|
297
|
+
* @type {string}
|
|
298
|
+
* @memberof ProductDocumentsApiUploadProductDocument
|
|
299
|
+
*/
|
|
300
|
+
readonly authorization?: string;
|
|
301
|
+
}
|
|
302
|
+
/**
|
|
303
|
+
* ProductDocumentsApi - object-oriented interface
|
|
304
|
+
* @export
|
|
305
|
+
* @class ProductDocumentsApi
|
|
306
|
+
* @extends {BaseAPI}
|
|
307
|
+
*/
|
|
308
|
+
export declare class ProductDocumentsApi extends BaseAPI {
|
|
309
|
+
/**
|
|
310
|
+
* Permanently deletes the product document. Supply the unique code that was returned when you created the product document and this will delete it.
|
|
311
|
+
* @summary Delete the product document
|
|
312
|
+
* @param {ProductDocumentsApiDeleteProductDocumentRequest} requestParameters Request parameters.
|
|
313
|
+
* @param {*} [options] Override http request option.
|
|
314
|
+
* @throws {RequiredError}
|
|
315
|
+
* @memberof ProductDocumentsApi
|
|
316
|
+
*/
|
|
317
|
+
deleteProductDocument(requestParameters: ProductDocumentsApiDeleteProductDocumentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
318
|
+
/**
|
|
319
|
+
* Get a product document.
|
|
320
|
+
* @summary Retrieve the product document
|
|
321
|
+
* @param {ProductDocumentsApiGetProductDocumentRequest} requestParameters Request parameters.
|
|
322
|
+
* @param {*} [options] Override http request option.
|
|
323
|
+
* @throws {RequiredError}
|
|
324
|
+
* @memberof ProductDocumentsApi
|
|
325
|
+
*/
|
|
326
|
+
getProductDocument(requestParameters: ProductDocumentsApiGetProductDocumentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetProductDocumentResponseClass, any>>;
|
|
327
|
+
/**
|
|
328
|
+
* Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
329
|
+
* @summary List product documents
|
|
330
|
+
* @param {ProductDocumentsApiListProductDocumentsRequest} requestParameters Request parameters.
|
|
331
|
+
* @param {*} [options] Override http request option.
|
|
332
|
+
* @throws {RequiredError}
|
|
333
|
+
* @memberof ProductDocumentsApi
|
|
334
|
+
*/
|
|
335
|
+
listProductDocuments(requestParameters: ProductDocumentsApiListProductDocumentsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListProductDocumentsResponseClass, any>>;
|
|
336
|
+
/**
|
|
337
|
+
* Upload a product document.
|
|
338
|
+
* @summary Create the product document
|
|
339
|
+
* @param {ProductDocumentsApiUploadProductDocumentRequest} requestParameters Request parameters.
|
|
340
|
+
* @param {*} [options] Override http request option.
|
|
341
|
+
* @throws {RequiredError}
|
|
342
|
+
* @memberof ProductDocumentsApi
|
|
343
|
+
*/
|
|
344
|
+
uploadProductDocument(requestParameters: ProductDocumentsApiUploadProductDocumentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ProductDocumentClass, any>>;
|
|
345
|
+
}
|