@smartytalent/api-client 0.8.2 → 0.8.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/apis/DocumentsApi.d.ts +221 -0
- package/dist/apis/DocumentsApi.d.ts.map +1 -0
- package/dist/apis/DocumentsApi.js +506 -0
- package/dist/apis/DocumentsApi.js.map +1 -0
- package/dist/apis/PersonasApi.d.ts +1 -0
- package/dist/apis/PersonasApi.d.ts.map +1 -1
- package/dist/apis/PersonasApi.js +3 -0
- package/dist/apis/PersonasApi.js.map +1 -1
- package/dist/apis/index.d.ts +1 -0
- package/dist/apis/index.d.ts.map +1 -1
- package/dist/apis/index.js +1 -0
- package/dist/apis/index.js.map +1 -1
- package/dist/models/CreateDocumentRequestBody.d.ts +34 -0
- package/dist/models/CreateDocumentRequestBody.d.ts.map +1 -0
- package/dist/models/CreateDocumentRequestBody.js +52 -0
- package/dist/models/CreateDocumentRequestBody.js.map +1 -0
- package/dist/models/CreateDocumentRequestBodyData.d.ts +54 -0
- package/dist/models/CreateDocumentRequestBodyData.d.ts.map +1 -0
- package/dist/models/CreateDocumentRequestBodyData.js +66 -0
- package/dist/models/CreateDocumentRequestBodyData.js.map +1 -0
- package/dist/models/CreateDocumentRequestBodyDataAttributes.d.ts +104 -0
- package/dist/models/CreateDocumentRequestBodyDataAttributes.d.ts.map +1 -0
- package/dist/models/CreateDocumentRequestBodyDataAttributes.js +87 -0
- package/dist/models/CreateDocumentRequestBodyDataAttributes.js.map +1 -0
- package/dist/models/DocumentAttributesSchema.d.ts +190 -0
- package/dist/models/DocumentAttributesSchema.d.ts.map +1 -0
- package/dist/models/DocumentAttributesSchema.js +113 -0
- package/dist/models/DocumentAttributesSchema.js.map +1 -0
- package/dist/models/DocumentAttributesSchemaOrganization.d.ts +33 -0
- package/dist/models/DocumentAttributesSchemaOrganization.d.ts.map +1 -0
- package/dist/models/DocumentAttributesSchemaOrganization.js +49 -0
- package/dist/models/DocumentAttributesSchemaOrganization.js.map +1 -0
- package/dist/models/DocumentRelationshipsCandidateSchema.d.ts +34 -0
- package/dist/models/DocumentRelationshipsCandidateSchema.d.ts.map +1 -0
- package/dist/models/DocumentRelationshipsCandidateSchema.js +50 -0
- package/dist/models/DocumentRelationshipsCandidateSchema.js.map +1 -0
- package/dist/models/DocumentRelationshipsConversationSchema.d.ts +34 -0
- package/dist/models/DocumentRelationshipsConversationSchema.d.ts.map +1 -0
- package/dist/models/DocumentRelationshipsConversationSchema.js +50 -0
- package/dist/models/DocumentRelationshipsConversationSchema.js.map +1 -0
- package/dist/models/DocumentRelationshipsConversationSchemaData.d.ts +39 -0
- package/dist/models/DocumentRelationshipsConversationSchemaData.d.ts.map +1 -0
- package/dist/models/DocumentRelationshipsConversationSchemaData.js +51 -0
- package/dist/models/DocumentRelationshipsConversationSchemaData.js.map +1 -0
- package/dist/models/DocumentRelationshipsJobSchema.d.ts +34 -0
- package/dist/models/DocumentRelationshipsJobSchema.d.ts.map +1 -0
- package/dist/models/DocumentRelationshipsJobSchema.js +50 -0
- package/dist/models/DocumentRelationshipsJobSchema.js.map +1 -0
- package/dist/models/DocumentRelationshipsSchema.d.ts +48 -0
- package/dist/models/DocumentRelationshipsSchema.d.ts.map +1 -0
- package/dist/models/DocumentRelationshipsSchema.js +56 -0
- package/dist/models/DocumentRelationshipsSchema.js.map +1 -0
- package/dist/models/DocumentResourceSchema.d.ts +75 -0
- package/dist/models/DocumentResourceSchema.d.ts.map +1 -0
- package/dist/models/DocumentResourceSchema.js +75 -0
- package/dist/models/DocumentResourceSchema.js.map +1 -0
- package/dist/models/DocumentSchema.d.ts +49 -0
- package/dist/models/DocumentSchema.d.ts.map +1 -0
- package/dist/models/DocumentSchema.js +55 -0
- package/dist/models/DocumentSchema.js.map +1 -0
- package/dist/models/DocumentsSchema.d.ts +48 -0
- package/dist/models/DocumentsSchema.d.ts.map +1 -0
- package/dist/models/DocumentsSchema.js +56 -0
- package/dist/models/DocumentsSchema.js.map +1 -0
- package/dist/models/GuestDocumentActionSchema.d.ts +72 -0
- package/dist/models/GuestDocumentActionSchema.d.ts.map +1 -0
- package/dist/models/GuestDocumentActionSchema.js +73 -0
- package/dist/models/GuestDocumentActionSchema.js.map +1 -0
- package/dist/models/GuestDocumentAttributesSchema.d.ts +157 -0
- package/dist/models/GuestDocumentAttributesSchema.d.ts.map +1 -0
- package/dist/models/GuestDocumentAttributesSchema.js +110 -0
- package/dist/models/GuestDocumentAttributesSchema.js.map +1 -0
- package/dist/models/GuestDocumentAttributesSchemaOrganization.d.ts +33 -0
- package/dist/models/GuestDocumentAttributesSchemaOrganization.d.ts.map +1 -0
- package/dist/models/GuestDocumentAttributesSchemaOrganization.js +49 -0
- package/dist/models/GuestDocumentAttributesSchemaOrganization.js.map +1 -0
- package/dist/models/GuestDocumentAttributesSchemaTimestamps.d.ts +45 -0
- package/dist/models/GuestDocumentAttributesSchemaTimestamps.d.ts.map +1 -0
- package/dist/models/GuestDocumentAttributesSchemaTimestamps.js +53 -0
- package/dist/models/GuestDocumentAttributesSchemaTimestamps.js.map +1 -0
- package/dist/models/GuestDocumentAttributesSchemaViewer.d.ts +57 -0
- package/dist/models/GuestDocumentAttributesSchemaViewer.d.ts.map +1 -0
- package/dist/models/GuestDocumentAttributesSchemaViewer.js +57 -0
- package/dist/models/GuestDocumentAttributesSchemaViewer.js.map +1 -0
- package/dist/models/GuestDocumentMetaSchema.d.ts +44 -0
- package/dist/models/GuestDocumentMetaSchema.d.ts.map +1 -0
- package/dist/models/GuestDocumentMetaSchema.js +55 -0
- package/dist/models/GuestDocumentMetaSchema.js.map +1 -0
- package/dist/models/GuestDocumentResourceSchema.d.ts +53 -0
- package/dist/models/GuestDocumentResourceSchema.d.ts.map +1 -0
- package/dist/models/GuestDocumentResourceSchema.js +61 -0
- package/dist/models/GuestDocumentResourceSchema.js.map +1 -0
- package/dist/models/GuestDocumentSchema.d.ts +39 -0
- package/dist/models/GuestDocumentSchema.d.ts.map +1 -0
- package/dist/models/GuestDocumentSchema.js +50 -0
- package/dist/models/GuestDocumentSchema.js.map +1 -0
- package/dist/models/PersonaAttributesSchema.d.ts +298 -4
- package/dist/models/PersonaAttributesSchema.d.ts.map +1 -1
- package/dist/models/PersonaAttributesSchema.js +86 -4
- package/dist/models/PersonaAttributesSchema.js.map +1 -1
- package/dist/models/PersonaResourceSchema.d.ts +1 -1
- package/dist/models/PersonaResourceSchema.js +1 -1
- package/dist/models/PersonaResourceSchema.js.map +1 -1
- package/dist/models/SubmitGuestDocumentRequestBody.d.ts +41 -0
- package/dist/models/SubmitGuestDocumentRequestBody.d.ts.map +1 -0
- package/dist/models/SubmitGuestDocumentRequestBody.js +57 -0
- package/dist/models/SubmitGuestDocumentRequestBody.js.map +1 -0
- package/dist/models/SubmitGuestDocumentRequestBodyData.d.ts +53 -0
- package/dist/models/SubmitGuestDocumentRequestBodyData.d.ts.map +1 -0
- package/dist/models/SubmitGuestDocumentRequestBodyData.js +65 -0
- package/dist/models/SubmitGuestDocumentRequestBodyData.js.map +1 -0
- package/dist/models/SubmitGuestDocumentRequestBodyDataAttributes.d.ts +48 -0
- package/dist/models/SubmitGuestDocumentRequestBodyDataAttributes.d.ts.map +1 -0
- package/dist/models/SubmitGuestDocumentRequestBodyDataAttributes.js +62 -0
- package/dist/models/SubmitGuestDocumentRequestBodyDataAttributes.js.map +1 -0
- package/dist/models/UpdateDocumentRequestBody.d.ts +34 -0
- package/dist/models/UpdateDocumentRequestBody.d.ts.map +1 -0
- package/dist/models/UpdateDocumentRequestBody.js +52 -0
- package/dist/models/UpdateDocumentRequestBody.js.map +1 -0
- package/dist/models/UpdateDocumentRequestBodyData.d.ts +60 -0
- package/dist/models/UpdateDocumentRequestBodyData.d.ts.map +1 -0
- package/dist/models/UpdateDocumentRequestBodyData.js +66 -0
- package/dist/models/UpdateDocumentRequestBodyData.js.map +1 -0
- package/dist/models/UpdateDocumentRequestBodyDataAttributes.d.ts +85 -0
- package/dist/models/UpdateDocumentRequestBodyDataAttributes.d.ts.map +1 -0
- package/dist/models/UpdateDocumentRequestBodyDataAttributes.js +71 -0
- package/dist/models/UpdateDocumentRequestBodyDataAttributes.js.map +1 -0
- package/dist/models/index.d.ts +27 -0
- package/dist/models/index.d.ts.map +1 -1
- package/dist/models/index.js +27 -0
- package/dist/models/index.js.map +1 -1
- package/package.json +1 -1
|
@@ -0,0 +1,221 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* SmartyMeet Dev03 API REST
|
|
3
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.1
|
|
6
|
+
* Contact: developer@smartymeet.com
|
|
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 * as runtime from '../runtime';
|
|
13
|
+
import type { CreateDocumentRequestBody, DocumentSchema, DocumentsSchema, GuestDocumentActionSchema, GuestDocumentSchema, SubmitGuestDocumentRequestBody, UpdateDocumentRequestBody } from '../models/index';
|
|
14
|
+
export interface CreateDocumentRequest {
|
|
15
|
+
createDocumentRequestBody: CreateDocumentRequestBody;
|
|
16
|
+
}
|
|
17
|
+
export interface DeleteDocumentRequest {
|
|
18
|
+
documentId: string;
|
|
19
|
+
}
|
|
20
|
+
export interface DocumentOptionsRequest {
|
|
21
|
+
documentId: string;
|
|
22
|
+
}
|
|
23
|
+
export interface GuestDocumentOptionsRequest {
|
|
24
|
+
documentId: string;
|
|
25
|
+
}
|
|
26
|
+
export interface ListDocumentsRequest {
|
|
27
|
+
filterStatus?: ListDocumentsFilterStatusEnum;
|
|
28
|
+
filterCandidateId?: string;
|
|
29
|
+
filterCreatedFrom?: Date;
|
|
30
|
+
filterCreatedTo?: Date;
|
|
31
|
+
filterModifiedFrom?: Date;
|
|
32
|
+
filterModifiedTo?: Date;
|
|
33
|
+
pageSize?: number;
|
|
34
|
+
pageNumber?: number;
|
|
35
|
+
pageAfter?: string;
|
|
36
|
+
pageBefore?: string;
|
|
37
|
+
}
|
|
38
|
+
export interface ShowDocumentRequest {
|
|
39
|
+
documentId: string;
|
|
40
|
+
}
|
|
41
|
+
export interface ShowGuestDocumentRequest {
|
|
42
|
+
documentId: string;
|
|
43
|
+
tenantId: string;
|
|
44
|
+
token: string;
|
|
45
|
+
process?: ShowGuestDocumentProcessEnum;
|
|
46
|
+
}
|
|
47
|
+
export interface SubmitGuestDocumentRequest {
|
|
48
|
+
documentId: string;
|
|
49
|
+
submitGuestDocumentRequestBody: SubmitGuestDocumentRequestBody;
|
|
50
|
+
}
|
|
51
|
+
export interface UpdateDocumentRequest {
|
|
52
|
+
documentId: string;
|
|
53
|
+
updateDocumentRequestBody: UpdateDocumentRequestBody;
|
|
54
|
+
}
|
|
55
|
+
/**
|
|
56
|
+
*
|
|
57
|
+
*/
|
|
58
|
+
export declare class DocumentsApi extends runtime.BaseAPI {
|
|
59
|
+
/**
|
|
60
|
+
* Creates request options for createDocument without sending the request
|
|
61
|
+
*/
|
|
62
|
+
createDocumentRequestOpts(requestParameters: CreateDocumentRequest): Promise<runtime.RequestOpts>;
|
|
63
|
+
/**
|
|
64
|
+
* Creates a document DRAFT. There is no create-and-send shortcut - sending happens via `PATCH status=pending`, which validates the content, assigns the human `reference`, mints per-participant access tokens, stamps `contentHash` and LOCKS the content. `documentType` is required; `process` derives from it when absent (employment_offer -> offer; employment_contract/b2b_contract/nda -> contract; policy/consent -> document). `body` is the typed block tree, `fields` the registry the body references by id, `participants` the recipient list (ids are server-assigned).
|
|
65
|
+
* Create Document
|
|
66
|
+
*/
|
|
67
|
+
createDocumentRaw(requestParameters: CreateDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentSchema>>;
|
|
68
|
+
/**
|
|
69
|
+
* Creates a document DRAFT. There is no create-and-send shortcut - sending happens via `PATCH status=pending`, which validates the content, assigns the human `reference`, mints per-participant access tokens, stamps `contentHash` and LOCKS the content. `documentType` is required; `process` derives from it when absent (employment_offer -> offer; employment_contract/b2b_contract/nda -> contract; policy/consent -> document). `body` is the typed block tree, `fields` the registry the body references by id, `participants` the recipient list (ids are server-assigned).
|
|
70
|
+
* Create Document
|
|
71
|
+
*/
|
|
72
|
+
createDocument(requestParameters: CreateDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentSchema>;
|
|
73
|
+
/**
|
|
74
|
+
* Creates request options for deleteDocument without sending the request
|
|
75
|
+
*/
|
|
76
|
+
deleteDocumentRequestOpts(requestParameters: DeleteDocumentRequest): Promise<runtime.RequestOpts>;
|
|
77
|
+
/**
|
|
78
|
+
* Deletes a DRAFT. A sent document is an evidence artifact - it only accepts `PATCH status=withdrawn` and cannot be deleted.
|
|
79
|
+
* Delete Document
|
|
80
|
+
*/
|
|
81
|
+
deleteDocumentRaw(requestParameters: DeleteDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
82
|
+
/**
|
|
83
|
+
* Deletes a DRAFT. A sent document is an evidence artifact - it only accepts `PATCH status=withdrawn` and cannot be deleted.
|
|
84
|
+
* Delete Document
|
|
85
|
+
*/
|
|
86
|
+
deleteDocument(requestParameters: DeleteDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
87
|
+
/**
|
|
88
|
+
* Creates request options for documentOptions without sending the request
|
|
89
|
+
*/
|
|
90
|
+
documentOptionsRequestOpts(requestParameters: DocumentOptionsRequest): Promise<runtime.RequestOpts>;
|
|
91
|
+
/**
|
|
92
|
+
* Enable CORS by returning correct headers
|
|
93
|
+
* Document Options
|
|
94
|
+
*/
|
|
95
|
+
documentOptionsRaw(requestParameters: DocumentOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
96
|
+
/**
|
|
97
|
+
* Enable CORS by returning correct headers
|
|
98
|
+
* Document Options
|
|
99
|
+
*/
|
|
100
|
+
documentOptions(requestParameters: DocumentOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
101
|
+
/**
|
|
102
|
+
* Creates request options for documentsOptions without sending the request
|
|
103
|
+
*/
|
|
104
|
+
documentsOptionsRequestOpts(): Promise<runtime.RequestOpts>;
|
|
105
|
+
/**
|
|
106
|
+
* Enable CORS by returning correct headers
|
|
107
|
+
* Documents Options
|
|
108
|
+
*/
|
|
109
|
+
documentsOptionsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
110
|
+
/**
|
|
111
|
+
* Enable CORS by returning correct headers
|
|
112
|
+
* Documents Options
|
|
113
|
+
*/
|
|
114
|
+
documentsOptions(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
115
|
+
/**
|
|
116
|
+
* Creates request options for guestDocumentOptions without sending the request
|
|
117
|
+
*/
|
|
118
|
+
guestDocumentOptionsRequestOpts(requestParameters: GuestDocumentOptionsRequest): Promise<runtime.RequestOpts>;
|
|
119
|
+
/**
|
|
120
|
+
* Enable CORS by returning correct headers
|
|
121
|
+
* Guest Document Options
|
|
122
|
+
*/
|
|
123
|
+
guestDocumentOptionsRaw(requestParameters: GuestDocumentOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
124
|
+
/**
|
|
125
|
+
* Enable CORS by returning correct headers
|
|
126
|
+
* Guest Document Options
|
|
127
|
+
*/
|
|
128
|
+
guestDocumentOptions(requestParameters: GuestDocumentOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
129
|
+
/**
|
|
130
|
+
* Creates request options for listDocuments without sending the request
|
|
131
|
+
*/
|
|
132
|
+
listDocumentsRequestOpts(requestParameters: ListDocumentsRequest): Promise<runtime.RequestOpts>;
|
|
133
|
+
/**
|
|
134
|
+
* Returns a collection of documents for the caller\'s tenant. Use one filter at a time (one GSI per query): - `filterStatus=pending` - sent, awaiting the recipient - `filterCandidateId=<id>` - documents for one candidate
|
|
135
|
+
* List Documents
|
|
136
|
+
*/
|
|
137
|
+
listDocumentsRaw(requestParameters: ListDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentsSchema>>;
|
|
138
|
+
/**
|
|
139
|
+
* Returns a collection of documents for the caller\'s tenant. Use one filter at a time (one GSI per query): - `filterStatus=pending` - sent, awaiting the recipient - `filterCandidateId=<id>` - documents for one candidate
|
|
140
|
+
* List Documents
|
|
141
|
+
*/
|
|
142
|
+
listDocuments(requestParameters?: ListDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentsSchema>;
|
|
143
|
+
/**
|
|
144
|
+
* Creates request options for showDocument without sending the request
|
|
145
|
+
*/
|
|
146
|
+
showDocumentRequestOpts(requestParameters: ShowDocumentRequest): Promise<runtime.RequestOpts>;
|
|
147
|
+
/**
|
|
148
|
+
* Returns a single document, including the block tree, field registry, participants (without their access tokens), the activity/evidence trail and `contentHash` once sent.
|
|
149
|
+
* Show Document
|
|
150
|
+
*/
|
|
151
|
+
showDocumentRaw(requestParameters: ShowDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentSchema>>;
|
|
152
|
+
/**
|
|
153
|
+
* Returns a single document, including the block tree, field registry, participants (without their access tokens), the activity/evidence trail and `contentHash` once sent.
|
|
154
|
+
* Show Document
|
|
155
|
+
*/
|
|
156
|
+
showDocument(requestParameters: ShowDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentSchema>;
|
|
157
|
+
/**
|
|
158
|
+
* Creates request options for showGuestDocument without sending the request
|
|
159
|
+
*/
|
|
160
|
+
showGuestDocumentRequestOpts(requestParameters: ShowGuestDocumentRequest): Promise<runtime.RequestOpts>;
|
|
161
|
+
/**
|
|
162
|
+
* Recipient opens the sign link from the email. There is no authorizer on this path: auth is `tenantId` + `token` (per-participant, minted at send) from the link query string, never a session. The token resolves the VIEWER server-side. `process` from the link path must match the row - a mismatch is treated exactly like a bad token. Returns EVERYTHING the screen needs in one resource (the page holds a credential and must not fan out): process, documentType, effective status, title, reference, languageCode, organization, timestamps, the block-tree body, the field registry, availableActions (computed server-side from the backend\'s documentType matrix), sanitized participants and activity, comments (always [] in v1) and the resolved viewer. No meta, no candidateId/jobId, no contentHash, no relationships. Every auth failure (unknown tenant, unknown or draft document, wrong token, wrong process) collapses to the same 404 - existence is never leaked.
|
|
163
|
+
* Show Guest Document
|
|
164
|
+
*/
|
|
165
|
+
showGuestDocumentRaw(requestParameters: ShowGuestDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GuestDocumentSchema>>;
|
|
166
|
+
/**
|
|
167
|
+
* Recipient opens the sign link from the email. There is no authorizer on this path: auth is `tenantId` + `token` (per-participant, minted at send) from the link query string, never a session. The token resolves the VIEWER server-side. `process` from the link path must match the row - a mismatch is treated exactly like a bad token. Returns EVERYTHING the screen needs in one resource (the page holds a credential and must not fan out): process, documentType, effective status, title, reference, languageCode, organization, timestamps, the block-tree body, the field registry, availableActions (computed server-side from the backend\'s documentType matrix), sanitized participants and activity, comments (always [] in v1) and the resolved viewer. No meta, no candidateId/jobId, no contentHash, no relationships. Every auth failure (unknown tenant, unknown or draft document, wrong token, wrong process) collapses to the same 404 - existence is never leaked.
|
|
168
|
+
* Show Guest Document
|
|
169
|
+
*/
|
|
170
|
+
showGuestDocument(requestParameters: ShowGuestDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GuestDocumentSchema>;
|
|
171
|
+
/**
|
|
172
|
+
* Creates request options for submitGuestDocument without sending the request
|
|
173
|
+
*/
|
|
174
|
+
submitGuestDocumentRequestOpts(requestParameters: SubmitGuestDocumentRequest): Promise<runtime.RequestOpts>;
|
|
175
|
+
/**
|
|
176
|
+
* Recipient acts on the document. Auth is `meta.tenantId` + `meta.accessToken` from the emailed link, never a session. `attributes.action` is `VIEW` (explicit, idempotent mark-as-opened - fire-and-forget after first render; never appears in availableActions), `ACCEPT` or `DECLINE`. `attributes.confirmations` must include every assertion the action requires. Returns the DELTA the FE applies to its state: `{outcome, status, participant, activity[]}` - never invent entries client-side. Error contract (frozen): 409 = the document settled between GET and PATCH (already acted / expired / withdrawn) - go to the terminal screen; 400 = payload problem (unknown action, missing confirmations) - stay on the form; 404 = auth, identical to GET. ACCEPT/DECLINE are single-use - a racing second write gets 409, never an overwrite.
|
|
177
|
+
* Submit Guest Document
|
|
178
|
+
*/
|
|
179
|
+
submitGuestDocumentRaw(requestParameters: SubmitGuestDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GuestDocumentActionSchema>>;
|
|
180
|
+
/**
|
|
181
|
+
* Recipient acts on the document. Auth is `meta.tenantId` + `meta.accessToken` from the emailed link, never a session. `attributes.action` is `VIEW` (explicit, idempotent mark-as-opened - fire-and-forget after first render; never appears in availableActions), `ACCEPT` or `DECLINE`. `attributes.confirmations` must include every assertion the action requires. Returns the DELTA the FE applies to its state: `{outcome, status, participant, activity[]}` - never invent entries client-side. Error contract (frozen): 409 = the document settled between GET and PATCH (already acted / expired / withdrawn) - go to the terminal screen; 400 = payload problem (unknown action, missing confirmations) - stay on the form; 404 = auth, identical to GET. ACCEPT/DECLINE are single-use - a racing second write gets 409, never an overwrite.
|
|
182
|
+
* Submit Guest Document
|
|
183
|
+
*/
|
|
184
|
+
submitGuestDocument(requestParameters: SubmitGuestDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GuestDocumentActionSchema>;
|
|
185
|
+
/**
|
|
186
|
+
* Creates request options for updateDocument without sending the request
|
|
187
|
+
*/
|
|
188
|
+
updateDocumentRequestOpts(requestParameters: UpdateDocumentRequest): Promise<runtime.RequestOpts>;
|
|
189
|
+
/**
|
|
190
|
+
* Draft edits and the two lifecycle doors. - While `draft`: title, body, fields, participants, expiry and relationships are editable. - `status: pending` is the SEND door: send-validation (title, well- formed blocks, required fields filled, exactly one counterparty signer with an email), the `reference` is assigned, per-participant tokens are minted, `contentHash` is stamped, the content LOCKS and `service:document:sent` fires (the Send Document Link workflow emails the guest link). - `status: withdrawn` is the only write a sent document accepts.
|
|
191
|
+
* Update Document
|
|
192
|
+
*/
|
|
193
|
+
updateDocumentRaw(requestParameters: UpdateDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentSchema>>;
|
|
194
|
+
/**
|
|
195
|
+
* Draft edits and the two lifecycle doors. - While `draft`: title, body, fields, participants, expiry and relationships are editable. - `status: pending` is the SEND door: send-validation (title, well- formed blocks, required fields filled, exactly one counterparty signer with an email), the `reference` is assigned, per-participant tokens are minted, `contentHash` is stamped, the content LOCKS and `service:document:sent` fires (the Send Document Link workflow emails the guest link). - `status: withdrawn` is the only write a sent document accepts.
|
|
196
|
+
* Update Document
|
|
197
|
+
*/
|
|
198
|
+
updateDocument(requestParameters: UpdateDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentSchema>;
|
|
199
|
+
}
|
|
200
|
+
/**
|
|
201
|
+
* @export
|
|
202
|
+
*/
|
|
203
|
+
export declare const ListDocumentsFilterStatusEnum: {
|
|
204
|
+
readonly Draft: "draft";
|
|
205
|
+
readonly Pending: "pending";
|
|
206
|
+
readonly Completed: "completed";
|
|
207
|
+
readonly Declined: "declined";
|
|
208
|
+
readonly Expired: "expired";
|
|
209
|
+
readonly Withdrawn: "withdrawn";
|
|
210
|
+
};
|
|
211
|
+
export type ListDocumentsFilterStatusEnum = typeof ListDocumentsFilterStatusEnum[keyof typeof ListDocumentsFilterStatusEnum];
|
|
212
|
+
/**
|
|
213
|
+
* @export
|
|
214
|
+
*/
|
|
215
|
+
export declare const ShowGuestDocumentProcessEnum: {
|
|
216
|
+
readonly Offer: "offer";
|
|
217
|
+
readonly Contract: "contract";
|
|
218
|
+
readonly Document: "document";
|
|
219
|
+
};
|
|
220
|
+
export type ShowGuestDocumentProcessEnum = typeof ShowGuestDocumentProcessEnum[keyof typeof ShowGuestDocumentProcessEnum];
|
|
221
|
+
//# sourceMappingURL=DocumentsApi.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"DocumentsApi.d.ts","sourceRoot":"","sources":["../../src/apis/DocumentsApi.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAGH,OAAO,KAAK,OAAO,MAAM,YAAY,CAAC;AACtC,OAAO,KAAK,EACV,yBAAyB,EACzB,cAAc,EACd,eAAe,EAEf,yBAAyB,EACzB,mBAAmB,EACnB,8BAA8B,EAC9B,yBAAyB,EAC1B,MAAM,iBAAiB,CAAC;AAoBzB,MAAM,WAAW,qBAAqB;IAClC,yBAAyB,EAAE,yBAAyB,CAAC;CACxD;AAED,MAAM,WAAW,qBAAqB;IAClC,UAAU,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,sBAAsB;IACnC,UAAU,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,2BAA2B;IACxC,UAAU,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,oBAAoB;IACjC,YAAY,CAAC,EAAE,6BAA6B,CAAC;IAC7C,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,iBAAiB,CAAC,EAAE,IAAI,CAAC;IACzB,eAAe,CAAC,EAAE,IAAI,CAAC;IACvB,kBAAkB,CAAC,EAAE,IAAI,CAAC;IAC1B,gBAAgB,CAAC,EAAE,IAAI,CAAC;IACxB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,mBAAmB;IAChC,UAAU,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,wBAAwB;IACrC,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,4BAA4B,CAAC;CAC1C;AAED,MAAM,WAAW,0BAA0B;IACvC,UAAU,EAAE,MAAM,CAAC;IACnB,8BAA8B,EAAE,8BAA8B,CAAC;CAClE;AAED,MAAM,WAAW,qBAAqB;IAClC,UAAU,EAAE,MAAM,CAAC;IACnB,yBAAyB,EAAE,yBAAyB,CAAC;CACxD;AAED;;GAEG;AACH,qBAAa,YAAa,SAAQ,OAAO,CAAC,OAAO;IAE7C;;OAEG;IACG,yBAAyB,CAAC,iBAAiB,EAAE,qBAAqB,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC;IAmCvG;;;OAGG;IACG,iBAAiB,CAAC,iBAAiB,EAAE,qBAAqB,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC;IAO3K;;;OAGG;IACG,cAAc,CAAC,iBAAiB,EAAE,qBAAqB,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,cAAc,CAAC;IAKnJ;;OAEG;IACG,yBAAyB,CAAC,iBAAiB,EAAE,qBAAqB,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC;IAiCvG;;;OAGG;IACG,iBAAiB,CAAC,iBAAiB,EAAE,qBAAqB,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAOjK;;;OAGG;IACG,cAAc,CAAC,iBAAiB,EAAE,qBAAqB,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC;IAIzI;;OAEG;IACG,0BAA0B,CAAC,iBAAiB,EAAE,sBAAsB,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC;IAwBzG;;;OAGG;IACG,kBAAkB,CAAC,iBAAiB,EAAE,sBAAsB,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAOnK;;;OAGG;IACG,eAAe,CAAC,iBAAiB,EAAE,sBAAsB,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC;IAI3I;;OAEG;IACG,2BAA2B,IAAI,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC;IAgBjE;;;OAGG;IACG,mBAAmB,CAAC,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAOzH;;;OAGG;IACG,gBAAgB,CAAC,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC;IAIjG;;OAEG;IACG,+BAA+B,CAAC,iBAAiB,EAAE,2BAA2B,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC;IAwBnH;;;OAGG;IACG,uBAAuB,CAAC,iBAAiB,EAAE,2BAA2B,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAO7K;;;OAGG;IACG,oBAAoB,CAAC,iBAAiB,EAAE,2BAA2B,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC;IAIrJ;;OAEG;IACG,wBAAwB,CAAC,iBAAiB,EAAE,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC;IAiErG;;;OAGG;IACG,gBAAgB,CAAC,iBAAiB,EAAE,oBAAoB,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,eAAe,CAAC,CAAC;IAO1K;;;OAGG;IACG,aAAa,CAAC,iBAAiB,GAAE,oBAAyB,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,eAAe,CAAC;IAKvJ;;OAEG;IACG,uBAAuB,CAAC,iBAAiB,EAAE,mBAAmB,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC;IAiCnG;;;OAGG;IACG,eAAe,CAAC,iBAAiB,EAAE,mBAAmB,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC;IAOvK;;;OAGG;IACG,YAAY,CAAC,iBAAiB,EAAE,mBAAmB,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,cAAc,CAAC;IAK/I;;OAEG;IACG,4BAA4B,CAAC,iBAAiB,EAAE,wBAAwB,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC;IAkD7G;;;OAGG;IACG,oBAAoB,CAAC,iBAAiB,EAAE,wBAAwB,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,mBAAmB,CAAC,CAAC;IAOtL;;;OAGG;IACG,iBAAiB,CAAC,iBAAiB,EAAE,wBAAwB,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAK9J;;OAEG;IACG,8BAA8B,CAAC,iBAAiB,EAAE,0BAA0B,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC;IAkCjH;;;OAGG;IACG,sBAAsB,CAAC,iBAAiB,EAAE,0BAA0B,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,yBAAyB,CAAC,CAAC;IAOhM;;;OAGG;IACG,mBAAmB,CAAC,iBAAiB,EAAE,0BAA0B,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,yBAAyB,CAAC;IAKxK;;OAEG;IACG,yBAAyB,CAAC,iBAAiB,EAAE,qBAAqB,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC;IA2CvG;;;OAGG;IACG,iBAAiB,CAAC,iBAAiB,EAAE,qBAAqB,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC;IAO3K;;;OAGG;IACG,cAAc,CAAC,iBAAiB,EAAE,qBAAqB,EAAE,aAAa,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,oBAAoB,GAAG,OAAO,CAAC,cAAc,CAAC;CAKtJ;AAED;;GAEG;AACH,eAAO,MAAM,6BAA6B;;;;;;;CAOhC,CAAC;AACX,MAAM,MAAM,6BAA6B,GAAG,OAAO,6BAA6B,CAAC,MAAM,OAAO,6BAA6B,CAAC,CAAC;AAC7H;;GAEG;AACH,eAAO,MAAM,4BAA4B;;;;CAI/B,CAAC;AACX,MAAM,MAAM,4BAA4B,GAAG,OAAO,4BAA4B,CAAC,MAAM,OAAO,4BAA4B,CAAC,CAAC"}
|