@emilgroup/document-sdk 1.28.0 → 1.28.1

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 (153) hide show
  1. package/.openapi-generator/FILES +36 -0
  2. package/README.md +2 -2
  3. package/api/document-templates-api.ts +67 -71
  4. package/api/documents-api.ts +39 -29
  5. package/api/docx-templates-api.ts +24 -12
  6. package/api/layouts-api.ts +20 -10
  7. package/api/product-documents-api.ts +14 -8
  8. package/api/search-keywords-api.ts +4 -2
  9. package/api/searchable-document-owners-api.ts +4 -2
  10. package/api/searchable-documents-api.ts +16 -16
  11. package/dist/api/document-templates-api.d.ts +59 -54
  12. package/dist/api/document-templates-api.js +34 -47
  13. package/dist/api/documents-api.d.ts +37 -31
  14. package/dist/api/documents-api.js +9 -11
  15. package/dist/api/docx-templates-api.d.ts +24 -18
  16. package/dist/api/layouts-api.d.ts +20 -15
  17. package/dist/api/product-documents-api.d.ts +15 -12
  18. package/dist/api/search-keywords-api.d.ts +4 -3
  19. package/dist/api/searchable-document-owners-api.d.ts +4 -3
  20. package/dist/api/searchable-documents-api.d.ts +13 -12
  21. package/dist/api/searchable-documents-api.js +9 -11
  22. package/dist/models/create-doc-template-request-dto.d.ts +2 -2
  23. package/dist/models/create-doc-template-response-class.d.ts +25 -0
  24. package/dist/models/create-doc-template-response-class.js +15 -0
  25. package/dist/models/create-document-request-dto.d.ts +10 -10
  26. package/dist/models/create-document-sync-response-class.d.ts +25 -0
  27. package/dist/models/create-document-sync-response-class.js +15 -0
  28. package/dist/models/create-layout-response-class.d.ts +25 -0
  29. package/dist/models/create-layout-response-class.js +15 -0
  30. package/dist/models/create-presigned-post-request-dto.d.ts +4 -4
  31. package/dist/models/create-presigned-post-response-class.d.ts +30 -0
  32. package/dist/models/create-presigned-post-response-class.js +15 -0
  33. package/dist/models/delete-response-class.d.ts +24 -0
  34. package/dist/models/delete-response-class.js +15 -0
  35. package/dist/models/doc-template-class.d.ts +104 -0
  36. package/dist/models/doc-template-class.js +15 -0
  37. package/dist/models/document-class.d.ts +171 -0
  38. package/dist/models/document-class.js +53 -0
  39. package/dist/models/docx-template-class.d.ts +102 -0
  40. package/dist/models/docx-template-class.js +15 -0
  41. package/dist/models/download-document-request-dto.d.ts +30 -0
  42. package/dist/models/download-document-request-dto.js +15 -0
  43. package/dist/models/get-doc-template-request-dto.d.ts +30 -0
  44. package/dist/models/get-doc-template-request-dto.js +15 -0
  45. package/dist/models/get-doc-template-response-class.d.ts +25 -0
  46. package/dist/models/get-doc-template-response-class.js +15 -0
  47. package/dist/models/get-document-download-url-response-class.d.ts +24 -0
  48. package/dist/models/get-document-download-url-response-class.js +15 -0
  49. package/dist/models/get-docx-template-download-url-response-class.d.ts +24 -0
  50. package/dist/models/get-docx-template-download-url-response-class.js +15 -0
  51. package/dist/models/get-docx-template-response-class.d.ts +25 -0
  52. package/dist/models/get-docx-template-response-class.js +15 -0
  53. package/dist/models/get-layout-response-class.d.ts +25 -0
  54. package/dist/models/get-layout-response-class.js +15 -0
  55. package/dist/models/get-product-document-download-url-response-class.d.ts +24 -0
  56. package/dist/models/get-product-document-download-url-response-class.js +15 -0
  57. package/dist/models/get-product-document-response-class.d.ts +25 -0
  58. package/dist/models/get-product-document-response-class.js +15 -0
  59. package/dist/models/get-signed-s3-key-url-response-class.d.ts +24 -0
  60. package/dist/models/get-signed-s3-key-url-response-class.js +15 -0
  61. package/dist/models/grpc-create-doc-template-request-dto.d.ts +55 -0
  62. package/dist/models/grpc-create-doc-template-request-dto.js +15 -0
  63. package/dist/models/grpc-update-doc-template-request-dto.d.ts +61 -0
  64. package/dist/models/grpc-update-doc-template-request-dto.js +15 -0
  65. package/dist/models/html-template-class.d.ts +78 -0
  66. package/dist/models/html-template-class.js +21 -0
  67. package/dist/models/index.d.ts +36 -0
  68. package/dist/models/index.js +36 -0
  69. package/dist/models/layout-class.d.ts +91 -0
  70. package/dist/models/layout-class.js +15 -0
  71. package/dist/models/list-doc-template-request-dto.d.ts +54 -0
  72. package/dist/models/list-doc-template-request-dto.js +15 -0
  73. package/dist/models/list-doc-templates-response-class.d.ts +31 -0
  74. package/dist/models/list-doc-templates-response-class.js +15 -0
  75. package/dist/models/list-documents-response-class.d.ts +31 -0
  76. package/dist/models/list-documents-response-class.js +15 -0
  77. package/dist/models/list-docx-templates-response-class.d.ts +31 -0
  78. package/dist/models/list-docx-templates-response-class.js +15 -0
  79. package/dist/models/list-layouts-response-class.d.ts +31 -0
  80. package/dist/models/list-layouts-response-class.js +15 -0
  81. package/dist/models/list-search-keywords-response-class.d.ts +24 -0
  82. package/dist/models/list-search-keywords-response-class.js +15 -0
  83. package/dist/models/list-searchable-document-owners-request-dto.d.ts +8 -1
  84. package/dist/models/list-searchable-document-owners-request-dto.js +7 -0
  85. package/dist/models/list-searchable-document-owners-response-class.d.ts +25 -0
  86. package/dist/models/list-searchable-document-owners-response-class.js +15 -0
  87. package/dist/models/list-searchable-documents-request-dto.d.ts +8 -1
  88. package/dist/models/list-searchable-documents-request-dto.js +7 -0
  89. package/dist/models/list-searchable-documents-response-class.d.ts +31 -0
  90. package/dist/models/list-searchable-documents-response-class.js +15 -0
  91. package/dist/models/searchable-document-class.d.ts +78 -0
  92. package/dist/models/searchable-document-class.js +15 -0
  93. package/dist/models/searchable-document-owner-class.d.ts +42 -0
  94. package/dist/models/searchable-document-owner-class.js +15 -0
  95. package/dist/models/update-doc-template-request-dto.d.ts +2 -2
  96. package/dist/models/update-doc-template-response-class.d.ts +25 -0
  97. package/dist/models/update-doc-template-response-class.js +15 -0
  98. package/dist/models/update-document-request-dto.d.ts +5 -5
  99. package/dist/models/update-document-response-class.d.ts +25 -0
  100. package/dist/models/update-document-response-class.js +15 -0
  101. package/dist/models/update-docx-template-response-class.d.ts +25 -0
  102. package/dist/models/update-docx-template-response-class.js +15 -0
  103. package/dist/models/update-layout-response-class.d.ts +25 -0
  104. package/dist/models/update-layout-response-class.js +15 -0
  105. package/dist/models/upload-docx-template-request-dto.d.ts +1 -1
  106. package/dist/models/upload-product-document-request-dto.d.ts +2 -2
  107. package/models/create-doc-template-request-dto.ts +2 -2
  108. package/models/create-doc-template-response-class.ts +31 -0
  109. package/models/create-document-request-dto.ts +10 -10
  110. package/models/create-document-sync-response-class.ts +31 -0
  111. package/models/create-layout-response-class.ts +31 -0
  112. package/models/create-presigned-post-request-dto.ts +4 -4
  113. package/models/create-presigned-post-response-class.ts +36 -0
  114. package/models/delete-response-class.ts +30 -0
  115. package/models/doc-template-class.ts +110 -0
  116. package/models/document-class.ts +181 -0
  117. package/models/docx-template-class.ts +108 -0
  118. package/models/download-document-request-dto.ts +36 -0
  119. package/models/get-doc-template-request-dto.ts +36 -0
  120. package/models/get-doc-template-response-class.ts +31 -0
  121. package/models/get-document-download-url-response-class.ts +30 -0
  122. package/models/get-docx-template-download-url-response-class.ts +30 -0
  123. package/models/get-docx-template-response-class.ts +31 -0
  124. package/models/get-layout-response-class.ts +31 -0
  125. package/models/get-product-document-download-url-response-class.ts +30 -0
  126. package/models/get-product-document-response-class.ts +31 -0
  127. package/models/get-signed-s3-key-url-response-class.ts +30 -0
  128. package/models/grpc-create-doc-template-request-dto.ts +61 -0
  129. package/models/grpc-update-doc-template-request-dto.ts +67 -0
  130. package/models/html-template-class.ts +87 -0
  131. package/models/index.ts +36 -0
  132. package/models/layout-class.ts +97 -0
  133. package/models/list-doc-template-request-dto.ts +60 -0
  134. package/models/list-doc-templates-response-class.ts +37 -0
  135. package/models/list-documents-response-class.ts +37 -0
  136. package/models/list-docx-templates-response-class.ts +37 -0
  137. package/models/list-layouts-response-class.ts +37 -0
  138. package/models/list-search-keywords-response-class.ts +30 -0
  139. package/models/list-searchable-document-owners-request-dto.ts +11 -1
  140. package/models/list-searchable-document-owners-response-class.ts +31 -0
  141. package/models/list-searchable-documents-request-dto.ts +11 -1
  142. package/models/list-searchable-documents-response-class.ts +37 -0
  143. package/models/searchable-document-class.ts +84 -0
  144. package/models/searchable-document-owner-class.ts +48 -0
  145. package/models/update-doc-template-request-dto.ts +2 -2
  146. package/models/update-doc-template-response-class.ts +31 -0
  147. package/models/update-document-request-dto.ts +5 -5
  148. package/models/update-document-response-class.ts +31 -0
  149. package/models/update-docx-template-response-class.ts +31 -0
  150. package/models/update-layout-response-class.ts +31 -0
  151. package/models/upload-docx-template-request-dto.ts +1 -1
  152. package/models/upload-product-document-request-dto.ts +2 -2
  153. package/package.json +1 -1
@@ -13,7 +13,12 @@ import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
13
13
  import { Configuration } from '../configuration';
14
14
  import { RequestArgs, BaseAPI } from '../base';
15
15
  import { CreateDocTemplateRequestDto } from '../models';
16
+ import { CreateDocTemplateResponseClass } from '../models';
17
+ import { DeleteResponseClass } from '../models';
18
+ import { GetDocTemplateResponseClass } from '../models';
19
+ import { ListDocTemplatesResponseClass } from '../models';
16
20
  import { UpdateDocTemplateRequestDto } from '../models';
21
+ import { UpdateDocTemplateResponseClass } from '../models';
17
22
  /**
18
23
  * DocumentTemplatesApi - axios parameter creator
19
24
  * @export
@@ -41,26 +46,26 @@ export declare const DocumentTemplatesApiAxiosParamCreator: (configuration?: Con
41
46
  * Retrieves the details of the document template that was previously created. Supply the unique document template id that was returned when you created it and Emil Api will return the corresponding document template information.
42
47
  * @summary Retrieve the document template
43
48
  * @param {number} id
44
- * @param {string} expand Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
45
49
  * @param {string} [authorization] Bearer Token
50
+ * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
46
51
  * @param {*} [options] Override http request option.
47
52
  * @throws {RequiredError}
48
53
  */
49
- getDocTemplate: (id: number, expand: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
54
+ getDocTemplate: (id: number, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
50
55
  /**
51
56
  * Returns a list of document templates you have previously created. The document templates are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
52
57
  * @summary List document templates
53
- * @param {number} pageSize A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
54
- * @param {string} pageToken A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
55
- * @param {string} filter Filter response by productSlug, slug and name.
56
- * @param {string} search Search document templates by name | slug
57
- * @param {string} order Order response by createdAt.
58
- * @param {string} expand Expand response by bodyTemplate.
59
58
  * @param {string} [authorization] Bearer Token
59
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
60
+ * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
61
+ * @param {string} [filter] Filter response by productSlug, slug and name.
62
+ * @param {string} [search] Search document templates by name | slug
63
+ * @param {string} [order] Order response by createdAt.
64
+ * @param {string} [expand] Expand response by bodyTemplate.
60
65
  * @param {*} [options] Override http request option.
61
66
  * @throws {RequiredError}
62
67
  */
63
- listDocTemplates: (pageSize: number, pageToken: string, filter: string, search: string, order: string, expand: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
68
+ listDocTemplates: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
64
69
  /**
65
70
  * Updates the specified document template by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
66
71
  * @summary Update the document template
@@ -85,7 +90,7 @@ export declare const DocumentTemplatesApiFp: (configuration?: Configuration) =>
85
90
  * @param {*} [options] Override http request option.
86
91
  * @throws {RequiredError}
87
92
  */
88
- createDocTemplate(createDocTemplateRequestDto: CreateDocTemplateRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
93
+ createDocTemplate(createDocTemplateRequestDto: CreateDocTemplateRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateDocTemplateResponseClass>>;
89
94
  /**
90
95
  * Permanently deletes the document template. Supply the unique code that was returned when you created the document template and this will delete it.
91
96
  * @summary Delete the document template
@@ -94,31 +99,31 @@ export declare const DocumentTemplatesApiFp: (configuration?: Configuration) =>
94
99
  * @param {*} [options] Override http request option.
95
100
  * @throws {RequiredError}
96
101
  */
97
- deleteDocTemplate(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
102
+ deleteDocTemplate(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponseClass>>;
98
103
  /**
99
104
  * Retrieves the details of the document template that was previously created. Supply the unique document template id that was returned when you created it and Emil Api will return the corresponding document template information.
100
105
  * @summary Retrieve the document template
101
106
  * @param {number} id
102
- * @param {string} expand Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
103
107
  * @param {string} [authorization] Bearer Token
108
+ * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
104
109
  * @param {*} [options] Override http request option.
105
110
  * @throws {RequiredError}
106
111
  */
107
- getDocTemplate(id: number, expand: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
112
+ getDocTemplate(id: number, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetDocTemplateResponseClass>>;
108
113
  /**
109
114
  * Returns a list of document templates you have previously created. The document templates are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
110
115
  * @summary List document templates
111
- * @param {number} pageSize A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
112
- * @param {string} pageToken A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
113
- * @param {string} filter Filter response by productSlug, slug and name.
114
- * @param {string} search Search document templates by name | slug
115
- * @param {string} order Order response by createdAt.
116
- * @param {string} expand Expand response by bodyTemplate.
117
116
  * @param {string} [authorization] Bearer Token
117
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
118
+ * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
119
+ * @param {string} [filter] Filter response by productSlug, slug and name.
120
+ * @param {string} [search] Search document templates by name | slug
121
+ * @param {string} [order] Order response by createdAt.
122
+ * @param {string} [expand] Expand response by bodyTemplate.
118
123
  * @param {*} [options] Override http request option.
119
124
  * @throws {RequiredError}
120
125
  */
121
- listDocTemplates(pageSize: number, pageToken: string, filter: string, search: string, order: string, expand: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
126
+ listDocTemplates(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListDocTemplatesResponseClass>>;
122
127
  /**
123
128
  * Updates the specified document template by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
124
129
  * @summary Update the document template
@@ -128,7 +133,7 @@ export declare const DocumentTemplatesApiFp: (configuration?: Configuration) =>
128
133
  * @param {*} [options] Override http request option.
129
134
  * @throws {RequiredError}
130
135
  */
131
- updateDocTemplate(id: number, updateDocTemplateRequestDto: UpdateDocTemplateRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
136
+ updateDocTemplate(id: number, updateDocTemplateRequestDto: UpdateDocTemplateRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateDocTemplateResponseClass>>;
132
137
  };
133
138
  /**
134
139
  * DocumentTemplatesApi - factory interface
@@ -143,7 +148,7 @@ export declare const DocumentTemplatesApiFactory: (configuration?: Configuration
143
148
  * @param {*} [options] Override http request option.
144
149
  * @throws {RequiredError}
145
150
  */
146
- createDocTemplate(createDocTemplateRequestDto: CreateDocTemplateRequestDto, authorization?: string, options?: any): AxiosPromise<void>;
151
+ createDocTemplate(createDocTemplateRequestDto: CreateDocTemplateRequestDto, authorization?: string, options?: any): AxiosPromise<CreateDocTemplateResponseClass>;
147
152
  /**
148
153
  * Permanently deletes the document template. Supply the unique code that was returned when you created the document template and this will delete it.
149
154
  * @summary Delete the document template
@@ -152,31 +157,31 @@ export declare const DocumentTemplatesApiFactory: (configuration?: Configuration
152
157
  * @param {*} [options] Override http request option.
153
158
  * @throws {RequiredError}
154
159
  */
155
- deleteDocTemplate(id: number, authorization?: string, options?: any): AxiosPromise<void>;
160
+ deleteDocTemplate(id: number, authorization?: string, options?: any): AxiosPromise<DeleteResponseClass>;
156
161
  /**
157
162
  * Retrieves the details of the document template that was previously created. Supply the unique document template id that was returned when you created it and Emil Api will return the corresponding document template information.
158
163
  * @summary Retrieve the document template
159
164
  * @param {number} id
160
- * @param {string} expand Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
161
165
  * @param {string} [authorization] Bearer Token
166
+ * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
162
167
  * @param {*} [options] Override http request option.
163
168
  * @throws {RequiredError}
164
169
  */
165
- getDocTemplate(id: number, expand: string, authorization?: string, options?: any): AxiosPromise<void>;
170
+ getDocTemplate(id: number, authorization?: string, expand?: string, options?: any): AxiosPromise<GetDocTemplateResponseClass>;
166
171
  /**
167
172
  * Returns a list of document templates you have previously created. The document templates are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
168
173
  * @summary List document templates
169
- * @param {number} pageSize A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
170
- * @param {string} pageToken A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
171
- * @param {string} filter Filter response by productSlug, slug and name.
172
- * @param {string} search Search document templates by name | slug
173
- * @param {string} order Order response by createdAt.
174
- * @param {string} expand Expand response by bodyTemplate.
175
174
  * @param {string} [authorization] Bearer Token
175
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
176
+ * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
177
+ * @param {string} [filter] Filter response by productSlug, slug and name.
178
+ * @param {string} [search] Search document templates by name | slug
179
+ * @param {string} [order] Order response by createdAt.
180
+ * @param {string} [expand] Expand response by bodyTemplate.
176
181
  * @param {*} [options] Override http request option.
177
182
  * @throws {RequiredError}
178
183
  */
179
- listDocTemplates(pageSize: number, pageToken: string, filter: string, search: string, order: string, expand: string, authorization?: string, options?: any): AxiosPromise<void>;
184
+ listDocTemplates(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListDocTemplatesResponseClass>;
180
185
  /**
181
186
  * Updates the specified document template by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
182
187
  * @summary Update the document template
@@ -186,7 +191,7 @@ export declare const DocumentTemplatesApiFactory: (configuration?: Configuration
186
191
  * @param {*} [options] Override http request option.
187
192
  * @throws {RequiredError}
188
193
  */
189
- updateDocTemplate(id: number, updateDocTemplateRequestDto: UpdateDocTemplateRequestDto, authorization?: string, options?: any): AxiosPromise<void>;
194
+ updateDocTemplate(id: number, updateDocTemplateRequestDto: UpdateDocTemplateRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateDocTemplateResponseClass>;
190
195
  };
191
196
  /**
192
197
  * Request parameters for createDocTemplate operation in DocumentTemplatesApi.
@@ -239,17 +244,17 @@ export interface DocumentTemplatesApiGetDocTemplateRequest {
239
244
  */
240
245
  readonly id: number;
241
246
  /**
242
- * Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
247
+ * Bearer Token
243
248
  * @type {string}
244
249
  * @memberof DocumentTemplatesApiGetDocTemplate
245
250
  */
246
- readonly expand: string;
251
+ readonly authorization?: string;
247
252
  /**
248
- * Bearer Token
253
+ * Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
249
254
  * @type {string}
250
255
  * @memberof DocumentTemplatesApiGetDocTemplate
251
256
  */
252
- readonly authorization?: string;
257
+ readonly expand?: string;
253
258
  }
254
259
  /**
255
260
  * Request parameters for listDocTemplates operation in DocumentTemplatesApi.
@@ -257,48 +262,48 @@ export interface DocumentTemplatesApiGetDocTemplateRequest {
257
262
  * @interface DocumentTemplatesApiListDocTemplatesRequest
258
263
  */
259
264
  export interface DocumentTemplatesApiListDocTemplatesRequest {
265
+ /**
266
+ * Bearer Token
267
+ * @type {string}
268
+ * @memberof DocumentTemplatesApiListDocTemplates
269
+ */
270
+ readonly authorization?: string;
260
271
  /**
261
272
  * A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
262
273
  * @type {number}
263
274
  * @memberof DocumentTemplatesApiListDocTemplates
264
275
  */
265
- readonly pageSize: number;
276
+ readonly pageSize?: number;
266
277
  /**
267
278
  * A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
268
279
  * @type {string}
269
280
  * @memberof DocumentTemplatesApiListDocTemplates
270
281
  */
271
- readonly pageToken: string;
282
+ readonly pageToken?: string;
272
283
  /**
273
284
  * Filter response by productSlug, slug and name.
274
285
  * @type {string}
275
286
  * @memberof DocumentTemplatesApiListDocTemplates
276
287
  */
277
- readonly filter: string;
288
+ readonly filter?: string;
278
289
  /**
279
290
  * Search document templates by name | slug
280
291
  * @type {string}
281
292
  * @memberof DocumentTemplatesApiListDocTemplates
282
293
  */
283
- readonly search: string;
294
+ readonly search?: string;
284
295
  /**
285
296
  * Order response by createdAt.
286
297
  * @type {string}
287
298
  * @memberof DocumentTemplatesApiListDocTemplates
288
299
  */
289
- readonly order: string;
300
+ readonly order?: string;
290
301
  /**
291
302
  * Expand response by bodyTemplate.
292
303
  * @type {string}
293
304
  * @memberof DocumentTemplatesApiListDocTemplates
294
305
  */
295
- readonly expand: string;
296
- /**
297
- * Bearer Token
298
- * @type {string}
299
- * @memberof DocumentTemplatesApiListDocTemplates
300
- */
301
- readonly authorization?: string;
306
+ readonly expand?: string;
302
307
  }
303
308
  /**
304
309
  * Request parameters for updateDocTemplate operation in DocumentTemplatesApi.
@@ -340,7 +345,7 @@ export declare class DocumentTemplatesApi extends BaseAPI {
340
345
  * @throws {RequiredError}
341
346
  * @memberof DocumentTemplatesApi
342
347
  */
343
- createDocTemplate(requestParameters: DocumentTemplatesApiCreateDocTemplateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
348
+ createDocTemplate(requestParameters: DocumentTemplatesApiCreateDocTemplateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateDocTemplateResponseClass, any>>;
344
349
  /**
345
350
  * Permanently deletes the document template. Supply the unique code that was returned when you created the document template and this will delete it.
346
351
  * @summary Delete the document template
@@ -349,7 +354,7 @@ export declare class DocumentTemplatesApi extends BaseAPI {
349
354
  * @throws {RequiredError}
350
355
  * @memberof DocumentTemplatesApi
351
356
  */
352
- deleteDocTemplate(requestParameters: DocumentTemplatesApiDeleteDocTemplateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
357
+ deleteDocTemplate(requestParameters: DocumentTemplatesApiDeleteDocTemplateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteResponseClass, any>>;
353
358
  /**
354
359
  * Retrieves the details of the document template that was previously created. Supply the unique document template id that was returned when you created it and Emil Api will return the corresponding document template information.
355
360
  * @summary Retrieve the document template
@@ -358,7 +363,7 @@ export declare class DocumentTemplatesApi extends BaseAPI {
358
363
  * @throws {RequiredError}
359
364
  * @memberof DocumentTemplatesApi
360
365
  */
361
- getDocTemplate(requestParameters: DocumentTemplatesApiGetDocTemplateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
366
+ getDocTemplate(requestParameters: DocumentTemplatesApiGetDocTemplateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetDocTemplateResponseClass, any>>;
362
367
  /**
363
368
  * Returns a list of document templates you have previously created. The document templates are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
364
369
  * @summary List document templates
@@ -367,7 +372,7 @@ export declare class DocumentTemplatesApi extends BaseAPI {
367
372
  * @throws {RequiredError}
368
373
  * @memberof DocumentTemplatesApi
369
374
  */
370
- listDocTemplates(requestParameters: DocumentTemplatesApiListDocTemplatesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
375
+ listDocTemplates(requestParameters?: DocumentTemplatesApiListDocTemplatesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListDocTemplatesResponseClass, any>>;
371
376
  /**
372
377
  * Updates the specified document template by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
373
378
  * @summary Update the document template
@@ -376,5 +381,5 @@ export declare class DocumentTemplatesApi extends BaseAPI {
376
381
  * @throws {RequiredError}
377
382
  * @memberof DocumentTemplatesApi
378
383
  */
379
- updateDocTemplate(requestParameters: DocumentTemplatesApiUpdateDocTemplateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
384
+ updateDocTemplate(requestParameters: DocumentTemplatesApiUpdateDocTemplateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateDocTemplateResponseClass, any>>;
380
385
  }
@@ -193,12 +193,12 @@ var DocumentTemplatesApiAxiosParamCreator = function (configuration) {
193
193
  * Retrieves the details of the document template that was previously created. Supply the unique document template id that was returned when you created it and Emil Api will return the corresponding document template information.
194
194
  * @summary Retrieve the document template
195
195
  * @param {number} id
196
- * @param {string} expand Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
197
196
  * @param {string} [authorization] Bearer Token
197
+ * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
198
198
  * @param {*} [options] Override http request option.
199
199
  * @throws {RequiredError}
200
200
  */
201
- getDocTemplate: function (id, expand, authorization, options) {
201
+ getDocTemplate: function (id, authorization, expand, options) {
202
202
  if (options === void 0) { options = {}; }
203
203
  return __awaiter(_this, void 0, void 0, function () {
204
204
  var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
@@ -207,8 +207,6 @@ var DocumentTemplatesApiAxiosParamCreator = function (configuration) {
207
207
  case 0:
208
208
  // verify required parameter 'id' is not null or undefined
209
209
  (0, common_1.assertParamExists)('getDocTemplate', 'id', id);
210
- // verify required parameter 'expand' is not null or undefined
211
- (0, common_1.assertParamExists)('getDocTemplate', 'expand', expand);
212
210
  localVarPath = "/documentservice/v1/doc-templates/{id}"
213
211
  .replace("{".concat("id", "}"), encodeURIComponent(String(id)));
214
212
  localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
@@ -246,35 +244,23 @@ var DocumentTemplatesApiAxiosParamCreator = function (configuration) {
246
244
  /**
247
245
  * Returns a list of document templates you have previously created. The document templates are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
248
246
  * @summary List document templates
249
- * @param {number} pageSize A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
250
- * @param {string} pageToken A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
251
- * @param {string} filter Filter response by productSlug, slug and name.
252
- * @param {string} search Search document templates by name | slug
253
- * @param {string} order Order response by createdAt.
254
- * @param {string} expand Expand response by bodyTemplate.
255
247
  * @param {string} [authorization] Bearer Token
248
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
249
+ * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
250
+ * @param {string} [filter] Filter response by productSlug, slug and name.
251
+ * @param {string} [search] Search document templates by name | slug
252
+ * @param {string} [order] Order response by createdAt.
253
+ * @param {string} [expand] Expand response by bodyTemplate.
256
254
  * @param {*} [options] Override http request option.
257
255
  * @throws {RequiredError}
258
256
  */
259
- listDocTemplates: function (pageSize, pageToken, filter, search, order, expand, authorization, options) {
257
+ listDocTemplates: function (authorization, pageSize, pageToken, filter, search, order, expand, options) {
260
258
  if (options === void 0) { options = {}; }
261
259
  return __awaiter(_this, void 0, void 0, function () {
262
260
  var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
263
261
  return __generator(this, function (_a) {
264
262
  switch (_a.label) {
265
263
  case 0:
266
- // verify required parameter 'pageSize' is not null or undefined
267
- (0, common_1.assertParamExists)('listDocTemplates', 'pageSize', pageSize);
268
- // verify required parameter 'pageToken' is not null or undefined
269
- (0, common_1.assertParamExists)('listDocTemplates', 'pageToken', pageToken);
270
- // verify required parameter 'filter' is not null or undefined
271
- (0, common_1.assertParamExists)('listDocTemplates', 'filter', filter);
272
- // verify required parameter 'search' is not null or undefined
273
- (0, common_1.assertParamExists)('listDocTemplates', 'search', search);
274
- // verify required parameter 'order' is not null or undefined
275
- (0, common_1.assertParamExists)('listDocTemplates', 'order', order);
276
- // verify required parameter 'expand' is not null or undefined
277
- (0, common_1.assertParamExists)('listDocTemplates', 'expand', expand);
278
264
  localVarPath = "/documentservice/v1/doc-templates";
279
265
  localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
280
266
  if (configuration) {
@@ -432,17 +418,17 @@ var DocumentTemplatesApiFp = function (configuration) {
432
418
  * Retrieves the details of the document template that was previously created. Supply the unique document template id that was returned when you created it and Emil Api will return the corresponding document template information.
433
419
  * @summary Retrieve the document template
434
420
  * @param {number} id
435
- * @param {string} expand Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
436
421
  * @param {string} [authorization] Bearer Token
422
+ * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
437
423
  * @param {*} [options] Override http request option.
438
424
  * @throws {RequiredError}
439
425
  */
440
- getDocTemplate: function (id, expand, authorization, options) {
426
+ getDocTemplate: function (id, authorization, expand, options) {
441
427
  return __awaiter(this, void 0, void 0, function () {
442
428
  var localVarAxiosArgs;
443
429
  return __generator(this, function (_a) {
444
430
  switch (_a.label) {
445
- case 0: return [4 /*yield*/, localVarAxiosParamCreator.getDocTemplate(id, expand, authorization, options)];
431
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.getDocTemplate(id, authorization, expand, options)];
446
432
  case 1:
447
433
  localVarAxiosArgs = _a.sent();
448
434
  return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
@@ -453,22 +439,22 @@ var DocumentTemplatesApiFp = function (configuration) {
453
439
  /**
454
440
  * Returns a list of document templates you have previously created. The document templates are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
455
441
  * @summary List document templates
456
- * @param {number} pageSize A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
457
- * @param {string} pageToken A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
458
- * @param {string} filter Filter response by productSlug, slug and name.
459
- * @param {string} search Search document templates by name | slug
460
- * @param {string} order Order response by createdAt.
461
- * @param {string} expand Expand response by bodyTemplate.
462
442
  * @param {string} [authorization] Bearer Token
443
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
444
+ * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
445
+ * @param {string} [filter] Filter response by productSlug, slug and name.
446
+ * @param {string} [search] Search document templates by name | slug
447
+ * @param {string} [order] Order response by createdAt.
448
+ * @param {string} [expand] Expand response by bodyTemplate.
463
449
  * @param {*} [options] Override http request option.
464
450
  * @throws {RequiredError}
465
451
  */
466
- listDocTemplates: function (pageSize, pageToken, filter, search, order, expand, authorization, options) {
452
+ listDocTemplates: function (authorization, pageSize, pageToken, filter, search, order, expand, options) {
467
453
  return __awaiter(this, void 0, void 0, function () {
468
454
  var localVarAxiosArgs;
469
455
  return __generator(this, function (_a) {
470
456
  switch (_a.label) {
471
- case 0: return [4 /*yield*/, localVarAxiosParamCreator.listDocTemplates(pageSize, pageToken, filter, search, order, expand, authorization, options)];
457
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.listDocTemplates(authorization, pageSize, pageToken, filter, search, order, expand, options)];
472
458
  case 1:
473
459
  localVarAxiosArgs = _a.sent();
474
460
  return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
@@ -534,29 +520,29 @@ var DocumentTemplatesApiFactory = function (configuration, basePath, axios) {
534
520
  * Retrieves the details of the document template that was previously created. Supply the unique document template id that was returned when you created it and Emil Api will return the corresponding document template information.
535
521
  * @summary Retrieve the document template
536
522
  * @param {number} id
537
- * @param {string} expand Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
538
523
  * @param {string} [authorization] Bearer Token
524
+ * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
539
525
  * @param {*} [options] Override http request option.
540
526
  * @throws {RequiredError}
541
527
  */
542
- getDocTemplate: function (id, expand, authorization, options) {
543
- return localVarFp.getDocTemplate(id, expand, authorization, options).then(function (request) { return request(axios, basePath); });
528
+ getDocTemplate: function (id, authorization, expand, options) {
529
+ return localVarFp.getDocTemplate(id, authorization, expand, options).then(function (request) { return request(axios, basePath); });
544
530
  },
545
531
  /**
546
532
  * Returns a list of document templates you have previously created. The document templates are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
547
533
  * @summary List document templates
548
- * @param {number} pageSize A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
549
- * @param {string} pageToken A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
550
- * @param {string} filter Filter response by productSlug, slug and name.
551
- * @param {string} search Search document templates by name | slug
552
- * @param {string} order Order response by createdAt.
553
- * @param {string} expand Expand response by bodyTemplate.
554
534
  * @param {string} [authorization] Bearer Token
535
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
536
+ * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
537
+ * @param {string} [filter] Filter response by productSlug, slug and name.
538
+ * @param {string} [search] Search document templates by name | slug
539
+ * @param {string} [order] Order response by createdAt.
540
+ * @param {string} [expand] Expand response by bodyTemplate.
555
541
  * @param {*} [options] Override http request option.
556
542
  * @throws {RequiredError}
557
543
  */
558
- listDocTemplates: function (pageSize, pageToken, filter, search, order, expand, authorization, options) {
559
- return localVarFp.listDocTemplates(pageSize, pageToken, filter, search, order, expand, authorization, options).then(function (request) { return request(axios, basePath); });
544
+ listDocTemplates: function (authorization, pageSize, pageToken, filter, search, order, expand, options) {
545
+ return localVarFp.listDocTemplates(authorization, pageSize, pageToken, filter, search, order, expand, options).then(function (request) { return request(axios, basePath); });
560
546
  },
561
547
  /**
562
548
  * Updates the specified document template by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
@@ -618,7 +604,7 @@ var DocumentTemplatesApi = /** @class */ (function (_super) {
618
604
  */
619
605
  DocumentTemplatesApi.prototype.getDocTemplate = function (requestParameters, options) {
620
606
  var _this = this;
621
- return (0, exports.DocumentTemplatesApiFp)(this.configuration).getDocTemplate(requestParameters.id, requestParameters.expand, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
607
+ return (0, exports.DocumentTemplatesApiFp)(this.configuration).getDocTemplate(requestParameters.id, requestParameters.authorization, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
622
608
  };
623
609
  /**
624
610
  * Returns a list of document templates you have previously created. The document templates are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
@@ -630,7 +616,8 @@ var DocumentTemplatesApi = /** @class */ (function (_super) {
630
616
  */
631
617
  DocumentTemplatesApi.prototype.listDocTemplates = function (requestParameters, options) {
632
618
  var _this = this;
633
- return (0, exports.DocumentTemplatesApiFp)(this.configuration).listDocTemplates(requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
619
+ if (requestParameters === void 0) { requestParameters = {}; }
620
+ return (0, exports.DocumentTemplatesApiFp)(this.configuration).listDocTemplates(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
634
621
  };
635
622
  /**
636
623
  * Updates the specified document template by setting the values of the parameters passed. Any parameters not provided will be left unchanged.