@emilgroup/document-sdk-node 1.2.0 → 1.3.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.
Files changed (141) hide show
  1. package/.openapi-generator/FILES +21 -0
  2. package/README.md +2 -2
  3. package/api/document-templates-api.ts +88 -94
  4. package/api/documents-api.ts +152 -34
  5. package/api/layouts-api.ts +52 -28
  6. package/api/product-documents-api.ts +599 -0
  7. package/api/search-keywords-api.ts +168 -0
  8. package/api/searchable-document-owners-api.ts +26 -22
  9. package/api/searchable-documents-api.ts +16 -12
  10. package/api.ts +4 -0
  11. package/dist/api/document-templates-api.d.ts +82 -78
  12. package/dist/api/document-templates-api.js +73 -67
  13. package/dist/api/documents-api.d.ts +93 -29
  14. package/dist/api/documents-api.js +121 -23
  15. package/dist/api/layouts-api.d.ts +52 -30
  16. package/dist/api/layouts-api.js +43 -23
  17. package/dist/api/product-documents-api.d.ts +345 -0
  18. package/dist/api/product-documents-api.js +558 -0
  19. package/dist/api/search-keywords-api.d.ts +96 -0
  20. package/dist/api/search-keywords-api.js +229 -0
  21. package/dist/api/searchable-document-owners-api.d.ts +23 -19
  22. package/dist/api/searchable-document-owners-api.js +16 -12
  23. package/dist/api/searchable-documents-api.d.ts +16 -12
  24. package/dist/api/searchable-documents-api.js +14 -10
  25. package/dist/api.d.ts +2 -0
  26. package/dist/api.js +2 -0
  27. package/dist/models/create-doc-template-request-dto.d.ts +10 -4
  28. package/dist/models/create-doc-template-response-class.d.ts +25 -0
  29. package/dist/models/create-doc-template-response-class.js +15 -0
  30. package/dist/models/create-document-request-dto.d.ts +21 -8
  31. package/dist/models/create-document-request-dto.js +2 -1
  32. package/dist/models/create-document-sync-response-class.d.ts +25 -0
  33. package/dist/models/create-document-sync-response-class.js +15 -0
  34. package/dist/models/create-html-template-dto.d.ts +1 -1
  35. package/dist/models/create-layout-request-dto.d.ts +10 -10
  36. package/dist/models/create-layout-response-class.d.ts +25 -0
  37. package/dist/models/create-layout-response-class.js +15 -0
  38. package/dist/models/create-presigned-post-request-dto.d.ts +128 -0
  39. package/dist/models/create-presigned-post-request-dto.js +52 -0
  40. package/dist/models/create-presigned-post-response-class.d.ts +30 -0
  41. package/dist/models/create-presigned-post-response-class.js +15 -0
  42. package/dist/models/delete-layout-request-dto.d.ts +1 -1
  43. package/dist/models/delete-product-document-request-dto.d.ts +30 -0
  44. package/dist/models/delete-product-document-request-dto.js +15 -0
  45. package/dist/models/delete-request-dto.d.ts +1 -1
  46. package/dist/models/delete-response-class.d.ts +24 -0
  47. package/dist/models/delete-response-class.js +15 -0
  48. package/dist/models/doc-template-class.d.ts +25 -19
  49. package/dist/models/document-class.d.ts +21 -8
  50. package/dist/models/document-class.js +2 -1
  51. package/dist/models/download-document-request-dto.d.ts +2 -2
  52. package/dist/models/get-doc-template-request-dto.d.ts +1 -1
  53. package/dist/models/get-doc-template-response-class.d.ts +1 -1
  54. package/dist/models/get-document-download-url-response-class.d.ts +1 -1
  55. package/dist/models/get-layout-request-dto.d.ts +1 -1
  56. package/dist/models/get-product-document-response-class.d.ts +25 -0
  57. package/dist/models/get-product-document-response-class.js +15 -0
  58. package/dist/models/get-signed-s3-key-url-response-class.d.ts +24 -0
  59. package/dist/models/get-signed-s3-key-url-response-class.js +15 -0
  60. package/dist/models/html-template-class.d.ts +7 -7
  61. package/dist/models/index.d.ts +19 -0
  62. package/dist/models/index.js +19 -0
  63. package/dist/models/layout-class.d.ts +11 -11
  64. package/dist/models/list-doc-template-request-dto.d.ts +48 -0
  65. package/dist/models/list-doc-template-request-dto.js +15 -0
  66. package/dist/models/list-doc-templates-response-class.d.ts +1 -1
  67. package/dist/models/list-documents-response-class.d.ts +1 -1
  68. package/dist/models/list-layouts-response-class.d.ts +1 -1
  69. package/dist/models/list-product-documents-response-class.d.ts +31 -0
  70. package/dist/models/list-product-documents-response-class.js +15 -0
  71. package/dist/models/list-search-keywords-request-dto.d.ts +24 -0
  72. package/dist/models/list-search-keywords-request-dto.js +15 -0
  73. package/dist/models/list-search-keywords-response-class.d.ts +24 -0
  74. package/dist/models/list-search-keywords-response-class.js +15 -0
  75. package/dist/models/list-searchable-document-owners-response-class.d.ts +3 -2
  76. package/dist/models/list-searchable-documents-request-dto.d.ts +2 -2
  77. package/dist/models/list-searchable-documents-response-class.d.ts +5 -4
  78. package/dist/models/product-document-class.d.ts +99 -0
  79. package/dist/models/product-document-class.js +36 -0
  80. package/dist/models/searchable-document-class.d.ts +66 -0
  81. package/dist/models/searchable-document-class.js +15 -0
  82. package/dist/models/searchable-document-owner-class.d.ts +30 -0
  83. package/dist/models/searchable-document-owner-class.js +15 -0
  84. package/dist/models/update-doc-template-request-dto.d.ts +16 -10
  85. package/dist/models/update-doc-template-response-class.d.ts +1 -1
  86. package/dist/models/update-document-request-dto.d.ts +10 -4
  87. package/dist/models/update-document-response-class.d.ts +25 -0
  88. package/dist/models/update-document-response-class.js +15 -0
  89. package/dist/models/update-html-template-dto.d.ts +42 -0
  90. package/dist/models/update-html-template-dto.js +21 -0
  91. package/dist/models/update-layout-request-dto.d.ts +15 -15
  92. package/dist/models/update-layout-response-class.d.ts +1 -1
  93. package/dist/models/upload-product-document-request-dto.d.ts +63 -0
  94. package/dist/models/upload-product-document-request-dto.js +24 -0
  95. package/models/create-doc-template-request-dto.ts +10 -4
  96. package/models/create-doc-template-response-class.ts +31 -0
  97. package/models/create-document-request-dto.ts +22 -9
  98. package/models/create-document-sync-response-class.ts +31 -0
  99. package/models/create-html-template-dto.ts +1 -1
  100. package/models/create-layout-request-dto.ts +10 -10
  101. package/models/create-layout-response-class.ts +31 -0
  102. package/models/create-presigned-post-request-dto.ts +138 -0
  103. package/models/create-presigned-post-response-class.ts +36 -0
  104. package/models/delete-layout-request-dto.ts +1 -1
  105. package/models/delete-product-document-request-dto.ts +36 -0
  106. package/models/delete-request-dto.ts +1 -1
  107. package/models/delete-response-class.ts +30 -0
  108. package/models/doc-template-class.ts +25 -19
  109. package/models/document-class.ts +22 -9
  110. package/models/download-document-request-dto.ts +2 -2
  111. package/models/get-doc-template-request-dto.ts +1 -1
  112. package/models/get-doc-template-response-class.ts +1 -1
  113. package/models/get-document-download-url-response-class.ts +1 -1
  114. package/models/get-layout-request-dto.ts +1 -1
  115. package/models/get-product-document-response-class.ts +31 -0
  116. package/models/get-signed-s3-key-url-response-class.ts +30 -0
  117. package/models/html-template-class.ts +7 -7
  118. package/models/index.ts +19 -0
  119. package/models/layout-class.ts +11 -11
  120. package/models/list-doc-template-request-dto.ts +54 -0
  121. package/models/list-doc-templates-response-class.ts +1 -1
  122. package/models/list-documents-response-class.ts +1 -1
  123. package/models/list-layouts-response-class.ts +1 -1
  124. package/models/list-product-documents-response-class.ts +37 -0
  125. package/models/list-search-keywords-request-dto.ts +30 -0
  126. package/models/list-search-keywords-response-class.ts +30 -0
  127. package/models/list-searchable-document-owners-response-class.ts +3 -2
  128. package/models/list-searchable-documents-request-dto.ts +2 -2
  129. package/models/list-searchable-documents-response-class.ts +5 -4
  130. package/models/product-document-class.ts +108 -0
  131. package/models/searchable-document-class.ts +72 -0
  132. package/models/searchable-document-owner-class.ts +36 -0
  133. package/models/update-doc-template-request-dto.ts +16 -10
  134. package/models/update-doc-template-response-class.ts +1 -1
  135. package/models/update-document-request-dto.ts +10 -4
  136. package/models/update-document-response-class.ts +31 -0
  137. package/models/update-html-template-dto.ts +51 -0
  138. package/models/update-layout-request-dto.ts +15 -15
  139. package/models/update-layout-response-class.ts +1 -1
  140. package/models/upload-product-document-request-dto.ts +72 -0
  141. package/package.json +2 -2
@@ -0,0 +1,229 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * EMIL DocumentService
6
+ * The EMIL DocumentService API description
7
+ *
8
+ * The version of the OpenAPI document: 1.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ var __extends = (this && this.__extends) || (function () {
16
+ var extendStatics = function (d, b) {
17
+ extendStatics = Object.setPrototypeOf ||
18
+ ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
19
+ function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
20
+ return extendStatics(d, b);
21
+ };
22
+ return function (d, b) {
23
+ if (typeof b !== "function" && b !== null)
24
+ throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
25
+ extendStatics(d, b);
26
+ function __() { this.constructor = d; }
27
+ d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
28
+ };
29
+ })();
30
+ var __assign = (this && this.__assign) || function () {
31
+ __assign = Object.assign || function(t) {
32
+ for (var s, i = 1, n = arguments.length; i < n; i++) {
33
+ s = arguments[i];
34
+ for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
35
+ t[p] = s[p];
36
+ }
37
+ return t;
38
+ };
39
+ return __assign.apply(this, arguments);
40
+ };
41
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
42
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
43
+ return new (P || (P = Promise))(function (resolve, reject) {
44
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
45
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
46
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
47
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
48
+ });
49
+ };
50
+ var __generator = (this && this.__generator) || function (thisArg, body) {
51
+ var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
52
+ return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
53
+ function verb(n) { return function (v) { return step([n, v]); }; }
54
+ function step(op) {
55
+ if (f) throw new TypeError("Generator is already executing.");
56
+ while (g && (g = 0, op[0] && (_ = 0)), _) try {
57
+ if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
58
+ if (y = 0, t) op = [op[0] & 2, t.value];
59
+ switch (op[0]) {
60
+ case 0: case 1: t = op; break;
61
+ case 4: _.label++; return { value: op[1], done: false };
62
+ case 5: _.label++; y = op[1]; op = [0]; continue;
63
+ case 7: op = _.ops.pop(); _.trys.pop(); continue;
64
+ default:
65
+ if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
66
+ if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
67
+ if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
68
+ if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
69
+ if (t[2]) _.ops.pop();
70
+ _.trys.pop(); continue;
71
+ }
72
+ op = body.call(thisArg, _);
73
+ } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
74
+ if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
75
+ }
76
+ };
77
+ var __importDefault = (this && this.__importDefault) || function (mod) {
78
+ return (mod && mod.__esModule) ? mod : { "default": mod };
79
+ };
80
+ Object.defineProperty(exports, "__esModule", { value: true });
81
+ exports.SearchKeywordsApi = exports.SearchKeywordsApiFactory = exports.SearchKeywordsApiFp = exports.SearchKeywordsApiAxiosParamCreator = void 0;
82
+ var axios_1 = __importDefault(require("axios"));
83
+ // Some imports not used depending on template conditions
84
+ // @ts-ignore
85
+ var common_1 = require("../common");
86
+ // @ts-ignore
87
+ var base_1 = require("../base");
88
+ // URLSearchParams not necessarily used
89
+ // @ts-ignore
90
+ var url_1 = require("url");
91
+ var FormData = require('form-data');
92
+ /**
93
+ * SearchKeywordsApi - axios parameter creator
94
+ * @export
95
+ */
96
+ var SearchKeywordsApiAxiosParamCreator = function (configuration) {
97
+ var _this = this;
98
+ return {
99
+ /**
100
+ * Returns a list of search keywords, including synonyms, used to search and browse documents based on user-entered text.
101
+ * @summary List keywords
102
+ * @param {string} searchText Text to search in the documents.
103
+ * @param {string} [authorization] Bearer Token
104
+ * @param {*} [options] Override http request option.
105
+ * @throws {RequiredError}
106
+ */
107
+ listSearchKeywords: function (searchText, authorization, options) {
108
+ if (options === void 0) { options = {}; }
109
+ return __awaiter(_this, void 0, void 0, function () {
110
+ var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
111
+ return __generator(this, function (_a) {
112
+ switch (_a.label) {
113
+ case 0:
114
+ // verify required parameter 'searchText' is not null or undefined
115
+ (0, common_1.assertParamExists)('listSearchKeywords', 'searchText', searchText);
116
+ localVarPath = "/documentservice/v1/search-keywords";
117
+ localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
118
+ if (configuration) {
119
+ baseOptions = configuration.baseOptions;
120
+ baseAccessToken = configuration.accessToken;
121
+ }
122
+ localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
123
+ localVarHeaderParameter = {};
124
+ localVarQueryParameter = {};
125
+ // authentication bearer required
126
+ // http bearer authentication required
127
+ return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
128
+ case 1:
129
+ // authentication bearer required
130
+ // http bearer authentication required
131
+ _a.sent();
132
+ if (searchText !== undefined) {
133
+ localVarQueryParameter['searchText'] = searchText;
134
+ }
135
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
136
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
137
+ }
138
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
139
+ headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
140
+ localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
141
+ return [2 /*return*/, {
142
+ url: (0, common_1.toPathString)(localVarUrlObj),
143
+ options: localVarRequestOptions,
144
+ }];
145
+ }
146
+ });
147
+ });
148
+ },
149
+ };
150
+ };
151
+ exports.SearchKeywordsApiAxiosParamCreator = SearchKeywordsApiAxiosParamCreator;
152
+ /**
153
+ * SearchKeywordsApi - functional programming interface
154
+ * @export
155
+ */
156
+ var SearchKeywordsApiFp = function (configuration) {
157
+ var localVarAxiosParamCreator = (0, exports.SearchKeywordsApiAxiosParamCreator)(configuration);
158
+ return {
159
+ /**
160
+ * Returns a list of search keywords, including synonyms, used to search and browse documents based on user-entered text.
161
+ * @summary List keywords
162
+ * @param {string} searchText Text to search in the documents.
163
+ * @param {string} [authorization] Bearer Token
164
+ * @param {*} [options] Override http request option.
165
+ * @throws {RequiredError}
166
+ */
167
+ listSearchKeywords: function (searchText, authorization, options) {
168
+ return __awaiter(this, void 0, void 0, function () {
169
+ var localVarAxiosArgs;
170
+ return __generator(this, function (_a) {
171
+ switch (_a.label) {
172
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.listSearchKeywords(searchText, authorization, options)];
173
+ case 1:
174
+ localVarAxiosArgs = _a.sent();
175
+ return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
176
+ }
177
+ });
178
+ });
179
+ },
180
+ };
181
+ };
182
+ exports.SearchKeywordsApiFp = SearchKeywordsApiFp;
183
+ /**
184
+ * SearchKeywordsApi - factory interface
185
+ * @export
186
+ */
187
+ var SearchKeywordsApiFactory = function (configuration, basePath, axios) {
188
+ var localVarFp = (0, exports.SearchKeywordsApiFp)(configuration);
189
+ return {
190
+ /**
191
+ * Returns a list of search keywords, including synonyms, used to search and browse documents based on user-entered text.
192
+ * @summary List keywords
193
+ * @param {string} searchText Text to search in the documents.
194
+ * @param {string} [authorization] Bearer Token
195
+ * @param {*} [options] Override http request option.
196
+ * @throws {RequiredError}
197
+ */
198
+ listSearchKeywords: function (searchText, authorization, options) {
199
+ return localVarFp.listSearchKeywords(searchText, authorization, options).then(function (request) { return request(axios, basePath); });
200
+ },
201
+ };
202
+ };
203
+ exports.SearchKeywordsApiFactory = SearchKeywordsApiFactory;
204
+ /**
205
+ * SearchKeywordsApi - object-oriented interface
206
+ * @export
207
+ * @class SearchKeywordsApi
208
+ * @extends {BaseAPI}
209
+ */
210
+ var SearchKeywordsApi = /** @class */ (function (_super) {
211
+ __extends(SearchKeywordsApi, _super);
212
+ function SearchKeywordsApi() {
213
+ return _super !== null && _super.apply(this, arguments) || this;
214
+ }
215
+ /**
216
+ * Returns a list of search keywords, including synonyms, used to search and browse documents based on user-entered text.
217
+ * @summary List keywords
218
+ * @param {SearchKeywordsApiListSearchKeywordsRequest} requestParameters Request parameters.
219
+ * @param {*} [options] Override http request option.
220
+ * @throws {RequiredError}
221
+ * @memberof SearchKeywordsApi
222
+ */
223
+ SearchKeywordsApi.prototype.listSearchKeywords = function (requestParameters, options) {
224
+ var _this = this;
225
+ return (0, exports.SearchKeywordsApiFp)(this.configuration).listSearchKeywords(requestParameters.searchText, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
226
+ };
227
+ return SearchKeywordsApi;
228
+ }(base_1.BaseAPI));
229
+ exports.SearchKeywordsApi = SearchKeywordsApi;
@@ -19,7 +19,8 @@ import { ListSearchableDocumentOwnersResponseClass } from '../models';
19
19
  */
20
20
  export declare const SearchableDocumentOwnersApiAxiosParamCreator: (configuration?: Configuration) => {
21
21
  /**
22
- *
22
+ * Returns the list of the searchable document owners.
23
+ * @summary List searchable document owners
23
24
  * @param {string} [authorization] Bearer Token
24
25
  * @param {number} [pageSize] Page size
25
26
  * @param {string} [pageToken] Page token
@@ -30,7 +31,7 @@ export declare const SearchableDocumentOwnersApiAxiosParamCreator: (configuratio
30
31
  * @param {*} [options] Override http request option.
31
32
  * @throws {RequiredError}
32
33
  */
33
- listSearchableDocuments: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
34
+ listSearchableDocumentOwners: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
34
35
  };
35
36
  /**
36
37
  * SearchableDocumentOwnersApi - functional programming interface
@@ -38,7 +39,8 @@ export declare const SearchableDocumentOwnersApiAxiosParamCreator: (configuratio
38
39
  */
39
40
  export declare const SearchableDocumentOwnersApiFp: (configuration?: Configuration) => {
40
41
  /**
41
- *
42
+ * Returns the list of the searchable document owners.
43
+ * @summary List searchable document owners
42
44
  * @param {string} [authorization] Bearer Token
43
45
  * @param {number} [pageSize] Page size
44
46
  * @param {string} [pageToken] Page token
@@ -49,7 +51,7 @@ export declare const SearchableDocumentOwnersApiFp: (configuration?: Configurati
49
51
  * @param {*} [options] Override http request option.
50
52
  * @throws {RequiredError}
51
53
  */
52
- listSearchableDocuments(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListSearchableDocumentOwnersResponseClass>>;
54
+ listSearchableDocumentOwners(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListSearchableDocumentOwnersResponseClass>>;
53
55
  };
54
56
  /**
55
57
  * SearchableDocumentOwnersApi - factory interface
@@ -57,7 +59,8 @@ export declare const SearchableDocumentOwnersApiFp: (configuration?: Configurati
57
59
  */
58
60
  export declare const SearchableDocumentOwnersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
59
61
  /**
60
- *
62
+ * Returns the list of the searchable document owners.
63
+ * @summary List searchable document owners
61
64
  * @param {string} [authorization] Bearer Token
62
65
  * @param {number} [pageSize] Page size
63
66
  * @param {string} [pageToken] Page token
@@ -68,54 +71,54 @@ export declare const SearchableDocumentOwnersApiFactory: (configuration?: Config
68
71
  * @param {*} [options] Override http request option.
69
72
  * @throws {RequiredError}
70
73
  */
71
- listSearchableDocuments(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListSearchableDocumentOwnersResponseClass>;
74
+ listSearchableDocumentOwners(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListSearchableDocumentOwnersResponseClass>;
72
75
  };
73
76
  /**
74
- * Request parameters for listSearchableDocuments operation in SearchableDocumentOwnersApi.
77
+ * Request parameters for listSearchableDocumentOwners operation in SearchableDocumentOwnersApi.
75
78
  * @export
76
- * @interface SearchableDocumentOwnersApiListSearchableDocumentsRequest
79
+ * @interface SearchableDocumentOwnersApiListSearchableDocumentOwnersRequest
77
80
  */
78
- export interface SearchableDocumentOwnersApiListSearchableDocumentsRequest {
81
+ export interface SearchableDocumentOwnersApiListSearchableDocumentOwnersRequest {
79
82
  /**
80
83
  * Bearer Token
81
84
  * @type {string}
82
- * @memberof SearchableDocumentOwnersApiListSearchableDocuments
85
+ * @memberof SearchableDocumentOwnersApiListSearchableDocumentOwners
83
86
  */
84
87
  readonly authorization?: string;
85
88
  /**
86
89
  * Page size
87
90
  * @type {number}
88
- * @memberof SearchableDocumentOwnersApiListSearchableDocuments
91
+ * @memberof SearchableDocumentOwnersApiListSearchableDocumentOwners
89
92
  */
90
93
  readonly pageSize?: number;
91
94
  /**
92
95
  * Page token
93
96
  * @type {string}
94
- * @memberof SearchableDocumentOwnersApiListSearchableDocuments
97
+ * @memberof SearchableDocumentOwnersApiListSearchableDocumentOwners
95
98
  */
96
99
  readonly pageToken?: string;
97
100
  /**
98
101
  * List filter
99
102
  * @type {string}
100
- * @memberof SearchableDocumentOwnersApiListSearchableDocuments
103
+ * @memberof SearchableDocumentOwnersApiListSearchableDocumentOwners
101
104
  */
102
105
  readonly filter?: string;
103
106
  /**
104
107
  * Search query
105
108
  * @type {string}
106
- * @memberof SearchableDocumentOwnersApiListSearchableDocuments
109
+ * @memberof SearchableDocumentOwnersApiListSearchableDocumentOwners
107
110
  */
108
111
  readonly search?: string;
109
112
  /**
110
113
  * Ordering criteria
111
114
  * @type {string}
112
- * @memberof SearchableDocumentOwnersApiListSearchableDocuments
115
+ * @memberof SearchableDocumentOwnersApiListSearchableDocumentOwners
113
116
  */
114
117
  readonly order?: string;
115
118
  /**
116
119
  * Extra fields to fetch
117
120
  * @type {string}
118
- * @memberof SearchableDocumentOwnersApiListSearchableDocuments
121
+ * @memberof SearchableDocumentOwnersApiListSearchableDocumentOwners
119
122
  */
120
123
  readonly expand?: string;
121
124
  }
@@ -127,11 +130,12 @@ export interface SearchableDocumentOwnersApiListSearchableDocumentsRequest {
127
130
  */
128
131
  export declare class SearchableDocumentOwnersApi extends BaseAPI {
129
132
  /**
130
- *
131
- * @param {SearchableDocumentOwnersApiListSearchableDocumentsRequest} requestParameters Request parameters.
133
+ * Returns the list of the searchable document owners.
134
+ * @summary List searchable document owners
135
+ * @param {SearchableDocumentOwnersApiListSearchableDocumentOwnersRequest} requestParameters Request parameters.
132
136
  * @param {*} [options] Override http request option.
133
137
  * @throws {RequiredError}
134
138
  * @memberof SearchableDocumentOwnersApi
135
139
  */
136
- listSearchableDocuments(requestParameters?: SearchableDocumentOwnersApiListSearchableDocumentsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListSearchableDocumentOwnersResponseClass, any>>;
140
+ listSearchableDocumentOwners(requestParameters?: SearchableDocumentOwnersApiListSearchableDocumentOwnersRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListSearchableDocumentOwnersResponseClass, any>>;
137
141
  }
@@ -97,7 +97,8 @@ var SearchableDocumentOwnersApiAxiosParamCreator = function (configuration) {
97
97
  var _this = this;
98
98
  return {
99
99
  /**
100
- *
100
+ * Returns the list of the searchable document owners.
101
+ * @summary List searchable document owners
101
102
  * @param {string} [authorization] Bearer Token
102
103
  * @param {number} [pageSize] Page size
103
104
  * @param {string} [pageToken] Page token
@@ -108,7 +109,7 @@ var SearchableDocumentOwnersApiAxiosParamCreator = function (configuration) {
108
109
  * @param {*} [options] Override http request option.
109
110
  * @throws {RequiredError}
110
111
  */
111
- listSearchableDocuments: function (authorization, pageSize, pageToken, filter, search, order, expand, options) {
112
+ listSearchableDocumentOwners: function (authorization, pageSize, pageToken, filter, search, order, expand, options) {
112
113
  if (options === void 0) { options = {}; }
113
114
  return __awaiter(_this, void 0, void 0, function () {
114
115
  var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
@@ -174,7 +175,8 @@ var SearchableDocumentOwnersApiFp = function (configuration) {
174
175
  var localVarAxiosParamCreator = (0, exports.SearchableDocumentOwnersApiAxiosParamCreator)(configuration);
175
176
  return {
176
177
  /**
177
- *
178
+ * Returns the list of the searchable document owners.
179
+ * @summary List searchable document owners
178
180
  * @param {string} [authorization] Bearer Token
179
181
  * @param {number} [pageSize] Page size
180
182
  * @param {string} [pageToken] Page token
@@ -185,12 +187,12 @@ var SearchableDocumentOwnersApiFp = function (configuration) {
185
187
  * @param {*} [options] Override http request option.
186
188
  * @throws {RequiredError}
187
189
  */
188
- listSearchableDocuments: function (authorization, pageSize, pageToken, filter, search, order, expand, options) {
190
+ listSearchableDocumentOwners: function (authorization, pageSize, pageToken, filter, search, order, expand, options) {
189
191
  return __awaiter(this, void 0, void 0, function () {
190
192
  var localVarAxiosArgs;
191
193
  return __generator(this, function (_a) {
192
194
  switch (_a.label) {
193
- case 0: return [4 /*yield*/, localVarAxiosParamCreator.listSearchableDocuments(authorization, pageSize, pageToken, filter, search, order, expand, options)];
195
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.listSearchableDocumentOwners(authorization, pageSize, pageToken, filter, search, order, expand, options)];
194
196
  case 1:
195
197
  localVarAxiosArgs = _a.sent();
196
198
  return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
@@ -209,7 +211,8 @@ var SearchableDocumentOwnersApiFactory = function (configuration, basePath, axio
209
211
  var localVarFp = (0, exports.SearchableDocumentOwnersApiFp)(configuration);
210
212
  return {
211
213
  /**
212
- *
214
+ * Returns the list of the searchable document owners.
215
+ * @summary List searchable document owners
213
216
  * @param {string} [authorization] Bearer Token
214
217
  * @param {number} [pageSize] Page size
215
218
  * @param {string} [pageToken] Page token
@@ -220,8 +223,8 @@ var SearchableDocumentOwnersApiFactory = function (configuration, basePath, axio
220
223
  * @param {*} [options] Override http request option.
221
224
  * @throws {RequiredError}
222
225
  */
223
- listSearchableDocuments: function (authorization, pageSize, pageToken, filter, search, order, expand, options) {
224
- return localVarFp.listSearchableDocuments(authorization, pageSize, pageToken, filter, search, order, expand, options).then(function (request) { return request(axios, basePath); });
226
+ listSearchableDocumentOwners: function (authorization, pageSize, pageToken, filter, search, order, expand, options) {
227
+ return localVarFp.listSearchableDocumentOwners(authorization, pageSize, pageToken, filter, search, order, expand, options).then(function (request) { return request(axios, basePath); });
225
228
  },
226
229
  };
227
230
  };
@@ -238,16 +241,17 @@ var SearchableDocumentOwnersApi = /** @class */ (function (_super) {
238
241
  return _super !== null && _super.apply(this, arguments) || this;
239
242
  }
240
243
  /**
241
- *
242
- * @param {SearchableDocumentOwnersApiListSearchableDocumentsRequest} requestParameters Request parameters.
244
+ * Returns the list of the searchable document owners.
245
+ * @summary List searchable document owners
246
+ * @param {SearchableDocumentOwnersApiListSearchableDocumentOwnersRequest} requestParameters Request parameters.
243
247
  * @param {*} [options] Override http request option.
244
248
  * @throws {RequiredError}
245
249
  * @memberof SearchableDocumentOwnersApi
246
250
  */
247
- SearchableDocumentOwnersApi.prototype.listSearchableDocuments = function (requestParameters, options) {
251
+ SearchableDocumentOwnersApi.prototype.listSearchableDocumentOwners = function (requestParameters, options) {
248
252
  var _this = this;
249
253
  if (requestParameters === void 0) { requestParameters = {}; }
250
- return (0, exports.SearchableDocumentOwnersApiFp)(this.configuration).listSearchableDocuments(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
254
+ return (0, exports.SearchableDocumentOwnersApiFp)(this.configuration).listSearchableDocumentOwners(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
251
255
  };
252
256
  return SearchableDocumentOwnersApi;
253
257
  }(base_1.BaseAPI));
@@ -19,9 +19,10 @@ import { ListSearchableDocumentsResponseClass } from '../models';
19
19
  */
20
20
  export declare const SearchableDocumentsApiAxiosParamCreator: (configuration?: Configuration) => {
21
21
  /**
22
- *
23
- * @param {string} searchText Text to search in the documents
24
- * @param {string} ownerIds List of searched document owner IDs separated with | (search in all documents if an \&#39;*\&#39; list provided)
22
+ * Returns a list of searchable documents you have previously created. The searchable documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
23
+ * @summary List searchable documents
24
+ * @param {string} searchText Text to search in the documents.
25
+ * @param {string} ownerIds List of searched document owner IDs separated with | (search in all documents if an \&#39;*\&#39; list provided).
25
26
  * @param {string} [authorization] Bearer Token
26
27
  * @param {*} [options] Override http request option.
27
28
  * @throws {RequiredError}
@@ -34,9 +35,10 @@ export declare const SearchableDocumentsApiAxiosParamCreator: (configuration?: C
34
35
  */
35
36
  export declare const SearchableDocumentsApiFp: (configuration?: Configuration) => {
36
37
  /**
37
- *
38
- * @param {string} searchText Text to search in the documents
39
- * @param {string} ownerIds List of searched document owner IDs separated with | (search in all documents if an \&#39;*\&#39; list provided)
38
+ * Returns a list of searchable documents you have previously created. The searchable documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
39
+ * @summary List searchable documents
40
+ * @param {string} searchText Text to search in the documents.
41
+ * @param {string} ownerIds List of searched document owner IDs separated with | (search in all documents if an \&#39;*\&#39; list provided).
40
42
  * @param {string} [authorization] Bearer Token
41
43
  * @param {*} [options] Override http request option.
42
44
  * @throws {RequiredError}
@@ -49,9 +51,10 @@ export declare const SearchableDocumentsApiFp: (configuration?: Configuration) =
49
51
  */
50
52
  export declare const SearchableDocumentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
51
53
  /**
52
- *
53
- * @param {string} searchText Text to search in the documents
54
- * @param {string} ownerIds List of searched document owner IDs separated with | (search in all documents if an \&#39;*\&#39; list provided)
54
+ * Returns a list of searchable documents you have previously created. The searchable documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
55
+ * @summary List searchable documents
56
+ * @param {string} searchText Text to search in the documents.
57
+ * @param {string} ownerIds List of searched document owner IDs separated with | (search in all documents if an \&#39;*\&#39; list provided).
55
58
  * @param {string} [authorization] Bearer Token
56
59
  * @param {*} [options] Override http request option.
57
60
  * @throws {RequiredError}
@@ -65,13 +68,13 @@ export declare const SearchableDocumentsApiFactory: (configuration?: Configurati
65
68
  */
66
69
  export interface SearchableDocumentsApiListSearchableDocumentsRequest {
67
70
  /**
68
- * Text to search in the documents
71
+ * Text to search in the documents.
69
72
  * @type {string}
70
73
  * @memberof SearchableDocumentsApiListSearchableDocuments
71
74
  */
72
75
  readonly searchText: string;
73
76
  /**
74
- * List of searched document owner IDs separated with | (search in all documents if an \&#39;*\&#39; list provided)
77
+ * List of searched document owner IDs separated with | (search in all documents if an \&#39;*\&#39; list provided).
75
78
  * @type {string}
76
79
  * @memberof SearchableDocumentsApiListSearchableDocuments
77
80
  */
@@ -91,7 +94,8 @@ export interface SearchableDocumentsApiListSearchableDocumentsRequest {
91
94
  */
92
95
  export declare class SearchableDocumentsApi extends BaseAPI {
93
96
  /**
94
- *
97
+ * Returns a list of searchable documents you have previously created. The searchable documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
98
+ * @summary List searchable documents
95
99
  * @param {SearchableDocumentsApiListSearchableDocumentsRequest} requestParameters Request parameters.
96
100
  * @param {*} [options] Override http request option.
97
101
  * @throws {RequiredError}
@@ -97,9 +97,10 @@ var SearchableDocumentsApiAxiosParamCreator = function (configuration) {
97
97
  var _this = this;
98
98
  return {
99
99
  /**
100
- *
101
- * @param {string} searchText Text to search in the documents
102
- * @param {string} ownerIds List of searched document owner IDs separated with | (search in all documents if an \&#39;*\&#39; list provided)
100
+ * Returns a list of searchable documents you have previously created. The searchable documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
101
+ * @summary List searchable documents
102
+ * @param {string} searchText Text to search in the documents.
103
+ * @param {string} ownerIds List of searched document owner IDs separated with | (search in all documents if an \&#39;*\&#39; list provided).
103
104
  * @param {string} [authorization] Bearer Token
104
105
  * @param {*} [options] Override http request option.
105
106
  * @throws {RequiredError}
@@ -162,9 +163,10 @@ var SearchableDocumentsApiFp = function (configuration) {
162
163
  var localVarAxiosParamCreator = (0, exports.SearchableDocumentsApiAxiosParamCreator)(configuration);
163
164
  return {
164
165
  /**
165
- *
166
- * @param {string} searchText Text to search in the documents
167
- * @param {string} ownerIds List of searched document owner IDs separated with | (search in all documents if an \&#39;*\&#39; list provided)
166
+ * Returns a list of searchable documents you have previously created. The searchable documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
167
+ * @summary List searchable documents
168
+ * @param {string} searchText Text to search in the documents.
169
+ * @param {string} ownerIds List of searched document owner IDs separated with | (search in all documents if an \&#39;*\&#39; list provided).
168
170
  * @param {string} [authorization] Bearer Token
169
171
  * @param {*} [options] Override http request option.
170
172
  * @throws {RequiredError}
@@ -193,9 +195,10 @@ var SearchableDocumentsApiFactory = function (configuration, basePath, axios) {
193
195
  var localVarFp = (0, exports.SearchableDocumentsApiFp)(configuration);
194
196
  return {
195
197
  /**
196
- *
197
- * @param {string} searchText Text to search in the documents
198
- * @param {string} ownerIds List of searched document owner IDs separated with | (search in all documents if an \&#39;*\&#39; list provided)
198
+ * Returns a list of searchable documents you have previously created. The searchable documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
199
+ * @summary List searchable documents
200
+ * @param {string} searchText Text to search in the documents.
201
+ * @param {string} ownerIds List of searched document owner IDs separated with | (search in all documents if an \&#39;*\&#39; list provided).
199
202
  * @param {string} [authorization] Bearer Token
200
203
  * @param {*} [options] Override http request option.
201
204
  * @throws {RequiredError}
@@ -218,7 +221,8 @@ var SearchableDocumentsApi = /** @class */ (function (_super) {
218
221
  return _super !== null && _super.apply(this, arguments) || this;
219
222
  }
220
223
  /**
221
- *
224
+ * Returns a list of searchable documents you have previously created. The searchable documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
225
+ * @summary List searchable documents
222
226
  * @param {SearchableDocumentsApiListSearchableDocumentsRequest} requestParameters Request parameters.
223
227
  * @param {*} [options] Override http request option.
224
228
  * @throws {RequiredError}
package/dist/api.d.ts CHANGED
@@ -12,5 +12,7 @@
12
12
  export * from './api/document-templates-api';
13
13
  export * from './api/documents-api';
14
14
  export * from './api/layouts-api';
15
+ export * from './api/product-documents-api';
16
+ export * from './api/search-keywords-api';
15
17
  export * from './api/searchable-document-owners-api';
16
18
  export * from './api/searchable-documents-api';
package/dist/api.js CHANGED
@@ -30,5 +30,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
30
30
  __exportStar(require("./api/document-templates-api"), exports);
31
31
  __exportStar(require("./api/documents-api"), exports);
32
32
  __exportStar(require("./api/layouts-api"), exports);
33
+ __exportStar(require("./api/product-documents-api"), exports);
34
+ __exportStar(require("./api/search-keywords-api"), exports);
33
35
  __exportStar(require("./api/searchable-document-owners-api"), exports);
34
36
  __exportStar(require("./api/searchable-documents-api"), exports);
@@ -17,27 +17,33 @@ import { CreateHtmlTemplateDto } from './create-html-template-dto';
17
17
  */
18
18
  export interface CreateDocTemplateRequestDto {
19
19
  /**
20
- * Template name
20
+ * Template name.
21
21
  * @type {string}
22
22
  * @memberof CreateDocTemplateRequestDto
23
23
  */
24
24
  'name': string;
25
25
  /**
26
- * Template slug
26
+ * A slug is a human-readable, unique identifier, used to identify a resource instead of a less human-readable identifier like an id.
27
27
  * @type {string}
28
28
  * @memberof CreateDocTemplateRequestDto
29
29
  */
30
30
  'slug': string;
31
31
  /**
32
- *
32
+ * Unique identifier referencing the layout.
33
33
  * @type {number}
34
34
  * @memberof CreateDocTemplateRequestDto
35
35
  */
36
36
  'layoutId': number;
37
37
  /**
38
- *
38
+ * Body template.
39
39
  * @type {CreateHtmlTemplateDto}
40
40
  * @memberof CreateDocTemplateRequestDto
41
41
  */
42
42
  'bodyTemplate': CreateHtmlTemplateDto;
43
+ /**
44
+ * A slug is a human-readable, unique identifier, used to identify a resource instead of a less human-readable identifier like an id.
45
+ * @type {string}
46
+ * @memberof CreateDocTemplateRequestDto
47
+ */
48
+ 'productSlug'?: string;
43
49
  }
@@ -0,0 +1,25 @@
1
+ /**
2
+ * EMIL DocumentService
3
+ * The EMIL DocumentService API description
4
+ *
5
+ * The version of the OpenAPI document: 1.0
6
+ *
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 { DocTemplateClass } from './doc-template-class';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface CreateDocTemplateResponseClass
17
+ */
18
+ export interface CreateDocTemplateResponseClass {
19
+ /**
20
+ * Document template.
21
+ * @type {DocTemplateClass}
22
+ * @memberof CreateDocTemplateResponseClass
23
+ */
24
+ 'template': DocTemplateClass;
25
+ }