docspring-ts 4.1.0 → 4.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (69) hide show
  1. package/AGENTS.md +3 -2
  2. package/README.md +4 -1
  3. package/dist/RequestSchemas.js +105 -8
  4. package/dist/RequestSchemas.js.map +1 -1
  5. package/dist/WebhookSignature.d.ts +6 -0
  6. package/dist/WebhookSignature.js +54 -0
  7. package/dist/WebhookSignature.js.map +1 -0
  8. package/dist/apis/Client.d.ts +13 -6
  9. package/dist/apis/Client.js +1601 -761
  10. package/dist/apis/Client.js.map +1 -1
  11. package/dist/http/isomorphic-fetch.js +1 -1
  12. package/dist/index.d.ts +2 -0
  13. package/dist/index.js +3 -1
  14. package/dist/index.js.map +1 -1
  15. package/dist/models/CreateTemplatePreviewRequest.d.ts +22 -0
  16. package/dist/models/CreateTemplatePreviewRequest.js +23 -0
  17. package/dist/models/CreateTemplatePreviewRequest.js.map +1 -0
  18. package/dist/models/CreateTemplateRequest.d.ts +1 -0
  19. package/dist/models/CreateTemplateRequest.js +6 -0
  20. package/dist/models/CreateTemplateRequest.js.map +1 -1
  21. package/dist/models/ErrorCode.d.ts +2 -0
  22. package/dist/models/ErrorCode.js +3 -1
  23. package/dist/models/ErrorCode.js.map +1 -1
  24. package/dist/models/ObjectSerializer.d.ts +5 -0
  25. package/dist/models/ObjectSerializer.js +14 -0
  26. package/dist/models/ObjectSerializer.js.map +1 -1
  27. package/dist/models/Submission.d.ts +6 -6
  28. package/dist/models/Submission.js +36 -36
  29. package/dist/models/Submission.js.map +1 -1
  30. package/dist/models/SubmissionList.d.ts +2 -2
  31. package/dist/models/SubmissionList.js +1 -1
  32. package/dist/models/SubmissionList.js.map +1 -1
  33. package/dist/models/SubmissionSummary.d.ts +47 -0
  34. package/dist/models/SubmissionSummary.js +131 -0
  35. package/dist/models/SubmissionSummary.js.map +1 -0
  36. package/dist/models/Template.d.ts +5 -4
  37. package/dist/models/Template.js +30 -24
  38. package/dist/models/Template.js.map +1 -1
  39. package/dist/models/TemplateDocument.d.ts +2 -2
  40. package/dist/models/TemplateDocument.js +12 -12
  41. package/dist/models/TemplateDocument.js.map +1 -1
  42. package/dist/models/TemplateDocumentSummary.d.ts +24 -0
  43. package/dist/models/TemplateDocumentSummary.js +41 -0
  44. package/dist/models/TemplateDocumentSummary.js.map +1 -0
  45. package/dist/models/TemplatePreview.d.ts +29 -0
  46. package/dist/models/TemplatePreview.js +65 -0
  47. package/dist/models/TemplatePreview.js.map +1 -0
  48. package/dist/models/TemplatePreviewState.d.ts +6 -0
  49. package/dist/models/TemplatePreviewState.js +9 -0
  50. package/dist/models/TemplatePreviewState.js.map +1 -0
  51. package/dist/models/TemplateSummary.d.ts +2 -29
  52. package/dist/models/TemplateSummary.js +1 -139
  53. package/dist/models/TemplateSummary.js.map +1 -1
  54. package/dist/models/UpdateTemplateRequest.d.ts +1 -0
  55. package/dist/models/UpdateTemplateRequest.js +6 -0
  56. package/dist/models/UpdateTemplateRequest.js.map +1 -1
  57. package/dist/models/all.d.ts +5 -0
  58. package/dist/models/all.js +5 -0
  59. package/dist/models/all.js.map +1 -1
  60. package/dist/types/ObjectParamAPI.d.ts +24 -0
  61. package/dist/types/ObjectParamAPI.js +24 -12
  62. package/dist/types/ObjectParamAPI.js.map +1 -1
  63. package/dist/types/ObservableAPI.d.ts +19 -12
  64. package/dist/types/ObservableAPI.js +262 -206
  65. package/dist/types/ObservableAPI.js.map +1 -1
  66. package/dist/types/PromiseAPI.d.ts +19 -12
  67. package/dist/types/PromiseAPI.js +44 -24
  68. package/dist/types/PromiseAPI.js.map +1 -1
  69. package/package.json +4 -1
@@ -14,6 +14,7 @@ import { CreateSignatureRequestEventRequest } from '../models/CreateSignatureReq
14
14
  import { CreateSignatureRequestTokenRequest } from '../models/CreateSignatureRequestTokenRequest';
15
15
  import { CreateSubmissionBatchRequest } from '../models/CreateSubmissionBatchRequest';
16
16
  import { CreateSubmissionRequest } from '../models/CreateSubmissionRequest';
17
+ import { CreateTemplatePreviewRequest } from '../models/CreateTemplatePreviewRequest';
17
18
  import { CreateTemplateRequest } from '../models/CreateTemplateRequest';
18
19
  import { CreateWebhookRequest } from '../models/CreateWebhookRequest';
19
20
  import { CustomFile } from '../models/CustomFile';
@@ -38,12 +39,14 @@ import { SignatureRequestToken } from '../models/SignatureRequestToken';
38
39
  import { Submission } from '../models/Submission';
39
40
  import { SubmissionBatch } from '../models/SubmissionBatch';
40
41
  import { SubmissionList } from '../models/SubmissionList';
42
+ import { SubmissionState } from '../models/SubmissionState';
41
43
  import { SubmissionValidation } from '../models/SubmissionValidation';
42
44
  import { Template } from '../models/Template';
43
45
  import { TemplateDiff } from '../models/TemplateDiff';
44
46
  import { TemplateFields } from '../models/TemplateFields';
45
47
  import { TemplateModelCode } from '../models/TemplateModelCode';
46
48
  import { TemplatePageImages } from '../models/TemplatePageImages';
49
+ import { TemplatePreview } from '../models/TemplatePreview';
47
50
  import { TemplateSummaryList } from '../models/TemplateSummaryList';
48
51
  import { TemplateVersion } from '../models/TemplateVersion';
49
52
  import { UpdateSignatureRequestRequest } from '../models/UpdateSignatureRequestRequest';
@@ -67,8 +70,8 @@ export declare class ObservableClient {
67
70
  addTemplateFields(templateId: string, body: AddTemplateFieldsRequest, _options?: ConfigurationOptions): Observable<TemplateFields>;
68
71
  copyTemplateWithHttpInfo(templateId: string, body?: CopyTemplateRequest, _options?: ConfigurationOptions): Observable<HttpInfo<Template>>;
69
72
  copyTemplate(templateId: string, body?: CopyTemplateRequest, _options?: ConfigurationOptions): Observable<Template>;
70
- createCombinedPdfWithHttpInfo(body: CreateCombinedPdfRequest, wait?: boolean, _options?: ConfigurationOptions): Observable<HttpInfo<CombinedPdf>>;
71
- createCombinedPdf(body: CreateCombinedPdfRequest, wait?: boolean, _options?: ConfigurationOptions): Observable<CombinedPdf>;
73
+ createCombinedPdfWithHttpInfo(body: CreateCombinedPdfRequest, wait?: boolean, idempotencyKey?: string, _options?: ConfigurationOptions): Observable<HttpInfo<CombinedPdf>>;
74
+ createCombinedPdf(body: CreateCombinedPdfRequest, wait?: boolean, idempotencyKey?: string, _options?: ConfigurationOptions): Observable<CombinedPdf>;
72
75
  createCustomFileFromUploadWithHttpInfo(body: CreateCustomFileFromUploadRequest, _options?: ConfigurationOptions): Observable<HttpInfo<CustomFile>>;
73
76
  createCustomFileFromUpload(body: CreateCustomFileFromUploadRequest, _options?: ConfigurationOptions): Observable<CustomFile>;
74
77
  createFolderWithHttpInfo(body: CreateFolderRequest, _options?: ConfigurationOptions): Observable<HttpInfo<Folder>>;
@@ -77,12 +80,14 @@ export declare class ObservableClient {
77
80
  createSignatureRequestEvent(signatureRequestId: string, body: CreateSignatureRequestEventRequest, _options?: ConfigurationOptions): Observable<SignatureRequestEvent>;
78
81
  createSignatureRequestTokenWithHttpInfo(signatureRequestId: string, body?: CreateSignatureRequestTokenRequest, _options?: ConfigurationOptions): Observable<HttpInfo<SignatureRequestToken>>;
79
82
  createSignatureRequestToken(signatureRequestId: string, body?: CreateSignatureRequestTokenRequest, _options?: ConfigurationOptions): Observable<SignatureRequestToken>;
80
- createSubmissionWithHttpInfo(templateId: string, body: CreateSubmissionRequest, version?: string, wait?: boolean, _options?: ConfigurationOptions): Observable<HttpInfo<Submission>>;
81
- createSubmission(templateId: string, body: CreateSubmissionRequest, version?: string, wait?: boolean, _options?: ConfigurationOptions): Observable<Submission>;
82
- createSubmissionBatchWithHttpInfo(body: CreateSubmissionBatchRequest, wait?: boolean, _options?: ConfigurationOptions): Observable<HttpInfo<SubmissionBatch>>;
83
- createSubmissionBatch(body: CreateSubmissionBatchRequest, wait?: boolean, _options?: ConfigurationOptions): Observable<SubmissionBatch>;
83
+ createSubmissionWithHttpInfo(templateId: string, body: CreateSubmissionRequest, version?: string, wait?: boolean, idempotencyKey?: string, _options?: ConfigurationOptions): Observable<HttpInfo<Submission>>;
84
+ createSubmission(templateId: string, body: CreateSubmissionRequest, version?: string, wait?: boolean, idempotencyKey?: string, _options?: ConfigurationOptions): Observable<Submission>;
85
+ createSubmissionBatchWithHttpInfo(body: CreateSubmissionBatchRequest, wait?: boolean, idempotencyKey?: string, _options?: ConfigurationOptions): Observable<HttpInfo<SubmissionBatch>>;
86
+ createSubmissionBatch(body: CreateSubmissionBatchRequest, wait?: boolean, idempotencyKey?: string, _options?: ConfigurationOptions): Observable<SubmissionBatch>;
84
87
  createTemplateWithHttpInfo(body: CreateTemplateRequest, wait?: boolean, _options?: ConfigurationOptions): Observable<HttpInfo<Template>>;
85
88
  createTemplate(body: CreateTemplateRequest, wait?: boolean, _options?: ConfigurationOptions): Observable<Template>;
89
+ createTemplatePreviewWithHttpInfo(templateId: string, body: CreateTemplatePreviewRequest, version?: string, _options?: ConfigurationOptions): Observable<HttpInfo<TemplatePreview>>;
90
+ createTemplatePreview(templateId: string, body: CreateTemplatePreviewRequest, version?: string, _options?: ConfigurationOptions): Observable<TemplatePreview>;
86
91
  createWebhookWithHttpInfo(body: CreateWebhookRequest, _options?: ConfigurationOptions): Observable<HttpInfo<Webhook>>;
87
92
  createWebhook(body: CreateWebhookRequest, _options?: ConfigurationOptions): Observable<Webhook>;
88
93
  deleteCustomFileWithHttpInfo(customFileId: string, _options?: ConfigurationOptions): Observable<HttpInfo<CustomFile>>;
@@ -119,10 +124,12 @@ export declare class ObservableClient {
119
124
  getTemplate(templateId: string, version?: string, _options?: ConfigurationOptions): Observable<Template>;
120
125
  getTemplateDiffWithHttpInfo(templateId: string, version?: string, _options?: ConfigurationOptions): Observable<HttpInfo<TemplateDiff>>;
121
126
  getTemplateDiff(templateId: string, version?: string, _options?: ConfigurationOptions): Observable<TemplateDiff>;
122
- getTemplateModelCodeWithHttpInfo(templateId: string, lang: ModelCodeLanguage, version?: string, _options?: ConfigurationOptions): Observable<HttpInfo<TemplateModelCode>>;
123
- getTemplateModelCode(templateId: string, lang: ModelCodeLanguage, version?: string, _options?: ConfigurationOptions): Observable<TemplateModelCode>;
127
+ getTemplateModelCodeWithHttpInfo(templateId: string, lang: ModelCodeLanguage, version?: string, justTypes?: boolean, _options?: ConfigurationOptions): Observable<HttpInfo<TemplateModelCode>>;
128
+ getTemplateModelCode(templateId: string, lang: ModelCodeLanguage, version?: string, justTypes?: boolean, _options?: ConfigurationOptions): Observable<TemplateModelCode>;
124
129
  getTemplatePageImagesWithHttpInfo(templateId: string, version?: string, _options?: ConfigurationOptions): Observable<HttpInfo<TemplatePageImages>>;
125
130
  getTemplatePageImages(templateId: string, version?: string, _options?: ConfigurationOptions): Observable<TemplatePageImages>;
131
+ getTemplatePreviewWithHttpInfo(templateId: string, previewId: string, _options?: ConfigurationOptions): Observable<HttpInfo<TemplatePreview>>;
132
+ getTemplatePreview(templateId: string, previewId: string, _options?: ConfigurationOptions): Observable<TemplatePreview>;
126
133
  getTemplateSchemaWithHttpInfo(templateId: string, version?: string, _options?: ConfigurationOptions): Observable<HttpInfo<{
127
134
  [key: string]: any;
128
135
  }>>;
@@ -137,12 +144,12 @@ export declare class ObservableClient {
137
144
  listCustomFiles(limit?: number, cursor?: string, _options?: ConfigurationOptions): Observable<CustomFileList>;
138
145
  listFoldersWithHttpInfo(parentFolderId?: string, limit?: number, cursor?: string, _options?: ConfigurationOptions): Observable<HttpInfo<FolderList>>;
139
146
  listFolders(parentFolderId?: string, limit?: number, cursor?: string, _options?: ConfigurationOptions): Observable<FolderList>;
140
- listSubmissionsWithHttpInfo(templateId?: string, test?: boolean, createdAfter?: Date, createdBefore?: Date, includeData?: boolean, limit?: number, cursor?: string, _options?: ConfigurationOptions): Observable<HttpInfo<SubmissionList>>;
141
- listSubmissions(templateId?: string, test?: boolean, createdAfter?: Date, createdBefore?: Date, includeData?: boolean, limit?: number, cursor?: string, _options?: ConfigurationOptions): Observable<SubmissionList>;
147
+ listSubmissionsWithHttpInfo(templateId?: string, test?: boolean, createdAfter?: Date, createdBefore?: Date, includeData?: boolean, limit?: number, cursor?: string, state?: SubmissionState, includeFiles?: boolean, _options?: ConfigurationOptions): Observable<HttpInfo<SubmissionList>>;
148
+ listSubmissions(templateId?: string, test?: boolean, createdAfter?: Date, createdBefore?: Date, includeData?: boolean, limit?: number, cursor?: string, state?: SubmissionState, includeFiles?: boolean, _options?: ConfigurationOptions): Observable<SubmissionList>;
142
149
  listTemplateFieldsWithHttpInfo(templateId: string, version?: string, _options?: ConfigurationOptions): Observable<HttpInfo<TemplateFields>>;
143
150
  listTemplateFields(templateId: string, version?: string, _options?: ConfigurationOptions): Observable<TemplateFields>;
144
- listTemplateSubmissionsWithHttpInfo(templateId: string, test?: boolean, createdAfter?: Date, createdBefore?: Date, includeData?: boolean, limit?: number, cursor?: string, _options?: ConfigurationOptions): Observable<HttpInfo<SubmissionList>>;
145
- listTemplateSubmissions(templateId: string, test?: boolean, createdAfter?: Date, createdBefore?: Date, includeData?: boolean, limit?: number, cursor?: string, _options?: ConfigurationOptions): Observable<SubmissionList>;
151
+ listTemplateSubmissionsWithHttpInfo(templateId: string, test?: boolean, createdAfter?: Date, createdBefore?: Date, includeData?: boolean, limit?: number, cursor?: string, state?: SubmissionState, includeFiles?: boolean, _options?: ConfigurationOptions): Observable<HttpInfo<SubmissionList>>;
152
+ listTemplateSubmissions(templateId: string, test?: boolean, createdAfter?: Date, createdBefore?: Date, includeData?: boolean, limit?: number, cursor?: string, state?: SubmissionState, includeFiles?: boolean, _options?: ConfigurationOptions): Observable<SubmissionList>;
146
153
  listTemplatesWithHttpInfo(query?: string, parentFolderId?: string, limit?: number, cursor?: string, _options?: ConfigurationOptions): Observable<HttpInfo<TemplateSummaryList>>;
147
154
  listTemplates(query?: string, parentFolderId?: string, limit?: number, cursor?: string, _options?: ConfigurationOptions): Observable<TemplateSummaryList>;
148
155
  listWebhooksWithHttpInfo(eventType?: WebhookEventType, mode?: WebhookMode, templateId?: string, folderId?: string, apiTokenId?: string, limit?: number, cursor?: string, _options?: ConfigurationOptions): Observable<HttpInfo<WebhookList>>;