-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathgraphql-signatures-types.ts
1273 lines (1064 loc) · 46.9 KB
/
graphql-signatures-types.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
export type Maybe<T> = T | null;
export type InputMaybe<T> = Maybe<T>;
export type Exact<T extends { [key: string]: unknown }> = { [K in keyof T]: T[K] };
export type MakeOptional<T, K extends keyof T> = Omit<T, K> & { [SubKey in K]?: Maybe<T[SubKey]> };
export type MakeMaybe<T, K extends keyof T> = Omit<T, K> & { [SubKey in K]: Maybe<T[SubKey]> };
export type MakeEmpty<T extends { [key: string]: unknown }, K extends keyof T> = { [_ in K]?: never };
export type Incremental<T> = T | { [P in keyof T]?: P extends ' $fragmentName' | '__typename' ? T[P] : never };
/** All built-in and custom scalars, mapped to their actual values */
export type Scalars = {
ID: { input: string; output: string; }
String: { input: string; output: string; }
Boolean: { input: boolean; output: boolean; }
Int: { input: number; output: number; }
Float: { input: number; output: number; }
Blob: { input: string; output: string; }
Date: { input: string; output: string; }
DateTime: { input: string; output: string; }
URI: { input: string; output: string; }
};
export type AddSignatoriesInput = {
signatories: Array<CreateSignatureOrderSignatoryInput>;
signatureOrderId: Scalars['ID']['input'];
};
export type AddSignatoriesOutput = {
__typename?: 'AddSignatoriesOutput';
signatories: Array<Signatory>;
signatureOrder: SignatureOrder;
};
export type AddSignatoryInput = {
/** Define a subset of documents for the signatory. Must be a non-empty list. Leave null for all documents. */
documents?: InputMaybe<Array<SignatoryDocumentInput>>;
/** Selectively enable evidence providers for this signatory. */
evidenceProviders?: InputMaybe<Array<SignatoryEvidenceProviderInput>>;
evidenceValidation?: InputMaybe<Array<SignatoryEvidenceValidationInput>>;
/** Will not be displayed to signatories, can be used as a reference to your own system. */
reference?: InputMaybe<Scalars['String']['input']>;
/** Define a role for the signatory, i.e. 'Chairman'. Will be visible in the document output. */
role?: InputMaybe<Scalars['String']['input']>;
signatureAppearance?: InputMaybe<SignatureAppearanceInput>;
signatureOrderId: Scalars['ID']['input'];
/** Override UI settings for signatory, defaults to UI settings for signature order */
ui?: InputMaybe<SignatoryUiInput>;
};
export type AddSignatoryOutput = {
__typename?: 'AddSignatoryOutput';
signatory: Signatory;
signatureOrder: SignatureOrder;
};
export type AllOfEvidenceProviderInput = {
providers: Array<SingleEvidenceProviderInput>;
};
export type AllOfSignatureEvidenceProvider = SignatureEvidenceProvider & {
__typename?: 'AllOfSignatureEvidenceProvider';
id: Scalars['ID']['output'];
providers: Array<CriiptoVerifySignatureEvidenceProvider | DrawableSignatureEvidenceProvider | NoopSignatureEvidenceProvider | OidcJwtSignatureEvidenceProvider>;
};
export type AnonymousViewer = Viewer & {
__typename?: 'AnonymousViewer';
authenticated: Scalars['Boolean']['output'];
id: Scalars['ID']['output'];
};
export type Application = Viewer & {
__typename?: 'Application';
apiKeys: Array<ApplicationApiKey>;
id: Scalars['ID']['output'];
name: Scalars['String']['output'];
signatureOrders: SignatureOrderConnection;
/** Tenants are only accessable from user viewers */
tenant?: Maybe<Tenant>;
verifyApplication: VerifyApplication;
webhookLogs: Array<WebhookExceptionInvocation | WebhookHttpErrorInvocation | WebhookSuccessfulInvocation | WebhookTimeoutInvocation>;
};
export type ApplicationSignatureOrdersArgs = {
after?: InputMaybe<Scalars['String']['input']>;
first?: InputMaybe<Scalars['Int']['input']>;
status?: InputMaybe<SignatureOrderStatus>;
};
export type ApplicationWebhookLogsArgs = {
from: Scalars['String']['input'];
succeeded?: InputMaybe<Scalars['Boolean']['input']>;
to: Scalars['String']['input'];
};
export type ApplicationApiKey = {
__typename?: 'ApplicationApiKey';
clientId: Scalars['String']['output'];
clientSecret?: Maybe<Scalars['String']['output']>;
id: Scalars['ID']['output'];
mode: ApplicationApiKeyMode | '%future added value';
note?: Maybe<Scalars['String']['output']>;
};
export enum ApplicationApiKeyMode {
READ_ONLY = 'READ_ONLY',
READ_WRITE = 'READ_WRITE'
}
export type CancelSignatureOrderInput = {
signatureOrderId: Scalars['ID']['input'];
};
export type CancelSignatureOrderOutput = {
__typename?: 'CancelSignatureOrderOutput';
signatureOrder: SignatureOrder;
};
export type ChangeSignatoryInput = {
/** Define a subset of documents for the signatory. Must be a non-empty list. Leave null for all documents. */
documents?: InputMaybe<Array<SignatoryDocumentInput>>;
/** Selectively enable evidence providers for this signatory. */
evidenceProviders?: InputMaybe<Array<SignatoryEvidenceProviderInput>>;
evidenceValidation?: InputMaybe<Array<SignatoryEvidenceValidationInput>>;
/** Will not be displayed to signatories, can be used as a reference to your own system. */
reference?: InputMaybe<Scalars['String']['input']>;
/** Define a role for the signatory, i.e. 'Chairman'. Will be visible in the document output. */
role?: InputMaybe<Scalars['String']['input']>;
signatoryId: Scalars['ID']['input'];
signatureAppearance?: InputMaybe<SignatureAppearanceInput>;
/** Override UI settings for signatory, defaults to UI settings for signature order */
ui?: InputMaybe<SignatoryUiInput>;
};
export type ChangeSignatoryOutput = {
__typename?: 'ChangeSignatoryOutput';
signatory: Signatory;
signatureOrder: SignatureOrder;
};
export type CleanupSignatureOrderInput = {
signatureOrderId: Scalars['ID']['input'];
};
export type CleanupSignatureOrderOutput = {
__typename?: 'CleanupSignatureOrderOutput';
signatureOrder: SignatureOrder;
};
export type CloseSignatureOrderInput = {
/** Retains documents on Criipto servers after closing a signature order. You MUST manually call the cleanupSignatureOrder mutation when you are sure you have downloaded the blobs. Maximum value is 7 days. */
retainDocumentsForDays?: InputMaybe<Scalars['Int']['input']>;
signatureOrderId: Scalars['ID']['input'];
};
export type CloseSignatureOrderOutput = {
__typename?: 'CloseSignatureOrderOutput';
signatureOrder: SignatureOrder;
};
export type CompositeSignature = Signature & {
__typename?: 'CompositeSignature';
signatory?: Maybe<Signatory>;
signatures: Array<DrawableSignature | EmptySignature | JwtSignature>;
};
export type CreateApplicationApiKeyInput = {
applicationId: Scalars['ID']['input'];
mode?: InputMaybe<ApplicationApiKeyMode | '%future added value'>;
note?: InputMaybe<Scalars['String']['input']>;
};
export type CreateApplicationApiKeyOutput = {
__typename?: 'CreateApplicationApiKeyOutput';
apiKey: ApplicationApiKey;
application: Application;
};
export type CreateApplicationInput = {
name: Scalars['String']['input'];
tenantId: Scalars['ID']['input'];
verifyApplicationDomain: Scalars['String']['input'];
verifyApplicationEnvironment: VerifyApplicationEnvironment | '%future added value';
verifyApplicationRealm: Scalars['String']['input'];
};
export type CreateApplicationOutput = {
__typename?: 'CreateApplicationOutput';
apiKey: ApplicationApiKey;
application: Application;
tenant: Tenant;
};
export type CreateSignatureOrderInput = {
/** By default signatories will be prompted to sign with a Criipto Verify based e-ID, this setting disables it. */
disableVerifyEvidenceProvider?: InputMaybe<Scalars['Boolean']['input']>;
documents: Array<DocumentInput>;
/** Define evidence providers for signature order if not using built-in Criipto Verify for e-IDs */
evidenceProviders?: InputMaybe<Array<EvidenceProviderInput>>;
/** Defines when a signatory must be validated, default is when signing, but can be expanded to also be required when viewing documents. */
evidenceValidationStages?: InputMaybe<Array<EvidenceValidationStage | '%future added value'>>;
/** When this signature order will auto-close/expire at exactly in one of the following ISO-8601 formats: yyyy-MM-ddTHH:mm:ssZ, yyyy-MM-ddTHH:mm:ss.ffZ, yyyy-MM-ddTHH:mm:ss.fffZ, yyyy-MM-ddTHH:mm:ssK, yyyy-MM-ddTHH:mm:ss.ffK, yyyy-MM-ddTHH:mm:ss.fffK. Cannot be provided with `expiresInDays`. */
expiresAt?: InputMaybe<Scalars['String']['input']>;
/** When this signature order will auto-close/expire. Default 90 days. Cannot be provided with `expiresAt` */
expiresInDays?: InputMaybe<Scalars['Int']['input']>;
/** Attempt to automatically fix document formatting errors if possible. Default 'true'. */
fixDocumentFormattingErrors?: InputMaybe<Scalars['Boolean']['input']>;
/** Max allowed signatories (as it influences pages needed for seals). Default 14. */
maxSignatories?: InputMaybe<Scalars['Int']['input']>;
signatories?: InputMaybe<Array<CreateSignatureOrderSignatoryInput>>;
/** Configure appearance of signatures inside documents */
signatureAppearance?: InputMaybe<SignatureAppearanceInput>;
/** Timezone to render signature seals in, default UTC. */
timezone?: InputMaybe<Scalars['String']['input']>;
title?: InputMaybe<Scalars['String']['input']>;
/** Various settings for how the UI is presented to the signatory. */
ui?: InputMaybe<CreateSignatureOrderUiInput>;
/** Signature order webhook settings */
webhook?: InputMaybe<CreateSignatureOrderWebhookInput>;
};
export type CreateSignatureOrderOutput = {
__typename?: 'CreateSignatureOrderOutput';
application: Application;
signatureOrder: SignatureOrder;
};
export type CreateSignatureOrderSignatoryInput = {
/** Define a subset of documents for the signatory. Must be a non-empty list. Leave null for all documents. */
documents?: InputMaybe<Array<SignatoryDocumentInput>>;
/** Selectively enable evidence providers for this signatory. */
evidenceProviders?: InputMaybe<Array<SignatoryEvidenceProviderInput>>;
evidenceValidation?: InputMaybe<Array<SignatoryEvidenceValidationInput>>;
/** Will not be displayed to signatories, can be used as a reference to your own system. */
reference?: InputMaybe<Scalars['String']['input']>;
/** Define a role for the signatory, i.e. 'Chairman'. Will be visible in the document output. */
role?: InputMaybe<Scalars['String']['input']>;
signatureAppearance?: InputMaybe<SignatureAppearanceInput>;
/** Override UI settings for signatory, defaults to UI settings for signature order */
ui?: InputMaybe<SignatoryUiInput>;
};
export type CreateSignatureOrderUiInput = {
/** Removes the UI options to reject a document or signature order. */
disableRejection?: InputMaybe<Scalars['Boolean']['input']>;
/** The language of texts rendered to the signatory. */
language?: InputMaybe<Language | '%future added value'>;
/** Define a logo to be shown in the signatory UI. */
logo?: InputMaybe<SignatureOrderUiLogoInput>;
/** Renders a UI layer for PDF annotations, such as links, making them interactive in the UI/browser */
renderPdfAnnotationLayer?: InputMaybe<Scalars['Boolean']['input']>;
/** The signatory will be redirected to this URL after signing or rejected the signature order. */
signatoryRedirectUri?: InputMaybe<Scalars['String']['input']>;
/** Add stylesheet/css via an absolute HTTPS URL. */
stylesheet?: InputMaybe<Scalars['String']['input']>;
};
export type CreateSignatureOrderWebhookInput = {
/** If defined, webhook invocations will have a X-Criipto-Signature header containing a HMAC-SHA256 signature (as a base64 string) of the webhook request body (utf-8). The secret should be between 256 and 512 bits. */
secret?: InputMaybe<Scalars['Blob']['input']>;
/** Webhook url. POST requests will be executed towards this URL on certain signatory events. */
url: Scalars['String']['input'];
/** Validates webhook connectivity by triggering a WEBHOOK_VALIDATION event, your webhook must respond within 5 seconds with 200/OK or the signature order creation will fail. */
validateConnectivity?: InputMaybe<Scalars['Boolean']['input']>;
};
/** Criipto Verify based evidence for signatures. */
export type CriiptoVerifyProviderInput = {
acrValues?: InputMaybe<Array<Scalars['String']['input']>>;
alwaysRedirect?: InputMaybe<Scalars['Boolean']['input']>;
/** Set a custom login_hint for the underlying authentication request. */
loginHint?: InputMaybe<Scalars['String']['input']>;
/** Messages displayed when performing authentication (only supported by DKMitID currently). */
message?: InputMaybe<Scalars['String']['input']>;
/** Set a custom scope for the underlying authentication request. */
scope?: InputMaybe<Scalars['String']['input']>;
/** Enforces that signatories sign by unique evidence by comparing the values of previous evidence on the key you define. For Criipto Verify you likely want to use `sub` which is a unique pseudonym value present in all e-ID tokens issued. */
uniqueEvidenceKey?: InputMaybe<Scalars['String']['input']>;
};
export type CriiptoVerifySignatureEvidenceProvider = SignatureEvidenceProvider & SingleSignatureEvidenceProvider & {
__typename?: 'CriiptoVerifySignatureEvidenceProvider';
acrValues: Array<Scalars['String']['output']>;
alwaysRedirect: Scalars['Boolean']['output'];
clientID: Scalars['String']['output'];
domain: Scalars['String']['output'];
id: Scalars['ID']['output'];
loginHint?: Maybe<Scalars['String']['output']>;
message?: Maybe<Scalars['String']['output']>;
name: Scalars['String']['output'];
scope?: Maybe<Scalars['String']['output']>;
};
export type DeleteApplicationApiKeyInput = {
apiKeyId: Scalars['ID']['input'];
applicationId: Scalars['ID']['input'];
};
export type DeleteApplicationApiKeyOutput = {
__typename?: 'DeleteApplicationApiKeyOutput';
application: Application;
};
export type DeleteSignatoryInput = {
signatoryId: Scalars['ID']['input'];
signatureOrderId: Scalars['ID']['input'];
};
export type DeleteSignatoryOutput = {
__typename?: 'DeleteSignatoryOutput';
signatureOrder: SignatureOrder;
};
export type Document = {
blob?: Maybe<Scalars['Blob']['output']>;
id: Scalars['ID']['output'];
originalBlob?: Maybe<Scalars['Blob']['output']>;
reference?: Maybe<Scalars['String']['output']>;
signatoryViewerStatus?: Maybe<SignatoryDocumentStatus | '%future added value'>;
signatures?: Maybe<Array<CompositeSignature | DrawableSignature | EmptySignature | JwtSignature>>;
title: Scalars['String']['output'];
};
export enum DocumentIdLocation {
BOTTOM = 'BOTTOM',
LEFT = 'LEFT',
RIGHT = 'RIGHT',
TOP = 'TOP'
}
export type DocumentInput = {
pdf?: InputMaybe<PadesDocumentInput>;
/** When enabled, will remove any existing signatures from the document before storing. (PDF only) */
removePreviousSignatures?: InputMaybe<Scalars['Boolean']['input']>;
/** XML signing is coming soon, reach out to learn more. */
xml?: InputMaybe<XadesDocumentInput>;
};
/** Document storage mode. Temporary documents will be deleted once completed. */
export enum DocumentStorageMode {
/** Temporary documents will be deleted once completed. */
Temporary = 'Temporary'
}
export type DownloadVerificationCriiptoVerifyInput = {
jwt: Scalars['String']['input'];
};
export type DownloadVerificationInput = {
criiptoVerify?: InputMaybe<DownloadVerificationCriiptoVerifyInput>;
oidc?: InputMaybe<DownloadVerificationOidcInput>;
};
export type DownloadVerificationOidcInput = {
jwt: Scalars['String']['input'];
};
/** Hand drawn signature evidence for signatures. */
export type DrawableEvidenceProviderInput = {
/** Required minimum height of drawed area in pixels. */
minimumHeight?: InputMaybe<Scalars['Int']['input']>;
/** Required minimum width of drawed area in pixels. */
minimumWidth?: InputMaybe<Scalars['Int']['input']>;
requireName?: InputMaybe<Scalars['Boolean']['input']>;
};
export type DrawableSignature = Signature & SingleSignature & {
__typename?: 'DrawableSignature';
image: Scalars['Blob']['output'];
name?: Maybe<Scalars['String']['output']>;
signatory?: Maybe<Signatory>;
};
export type DrawableSignatureEvidenceProvider = SignatureEvidenceProvider & SingleSignatureEvidenceProvider & {
__typename?: 'DrawableSignatureEvidenceProvider';
id: Scalars['ID']['output'];
minimumHeight?: Maybe<Scalars['Int']['output']>;
minimumWidth?: Maybe<Scalars['Int']['output']>;
requireName: Scalars['Boolean']['output'];
};
export type EmptySignature = Signature & SingleSignature & {
__typename?: 'EmptySignature';
signatory?: Maybe<Signatory>;
};
/** Must define a evidence provider subsection. */
export type EvidenceProviderInput = {
allOf?: InputMaybe<AllOfEvidenceProviderInput>;
/** Criipto Verify based evidence for signatures. */
criiptoVerify?: InputMaybe<CriiptoVerifyProviderInput>;
/** Hand drawn signature evidence for signatures. */
drawable?: InputMaybe<DrawableEvidenceProviderInput>;
/** Determined if this evidence provider should be enabled by signatories by default. Default true */
enabledByDefault?: InputMaybe<Scalars['Boolean']['input']>;
/** TEST environment only. Does not manipulate the PDF, use for integration or webhook testing. */
noop?: InputMaybe<NoopEvidenceProviderInput>;
/** OIDC/JWT based evidence for signatures. */
oidc?: InputMaybe<OidcEvidenceProviderInput>;
};
export enum EvidenceValidationStage {
SIGN = 'SIGN',
/** Require the signatory to be validated before viewing documents */
VIEW = 'VIEW'
}
export type ExtendSignatureOrderInput = {
/** Expiration to add to order, in days, max 30. */
additionalExpirationInDays: Scalars['Int']['input'];
signatureOrderId: Scalars['ID']['input'];
};
export type ExtendSignatureOrderOutput = {
__typename?: 'ExtendSignatureOrderOutput';
signatureOrder: SignatureOrder;
};
export type JwtSignature = Signature & SingleSignature & {
__typename?: 'JWTSignature';
jwks: Scalars['String']['output'];
jwt: Scalars['String']['output'];
signatory?: Maybe<Signatory>;
};
export enum Language {
DA_DK = 'DA_DK',
EN_US = 'EN_US',
NB_NO = 'NB_NO',
SV_SE = 'SV_SE'
}
export type Mutation = {
__typename?: 'Mutation';
/** Add multiple signatures to your signature order. */
addSignatories?: Maybe<AddSignatoriesOutput>;
/** Add a signatory to your signature order. */
addSignatory?: Maybe<AddSignatoryOutput>;
/** Cancels the signature order without closing it, use if you no longer need a signature order. Documents are deleted from storage after cancelling. */
cancelSignatureOrder?: Maybe<CancelSignatureOrderOutput>;
/** Change an existing signatory */
changeSignatory?: Maybe<ChangeSignatoryOutput>;
/** Cleans up the signature order and removes any saved documents from the servers. */
cleanupSignatureOrder?: Maybe<CleanupSignatureOrderOutput>;
/** Finalizes the documents in the signature order and returns them to you as blobs. Documents are deleted from storage after closing. */
closeSignatureOrder?: Maybe<CloseSignatureOrderOutput>;
/** Creates a signature application for a given tenant. */
createApplication?: Maybe<CreateApplicationOutput>;
/** Creates a new set of api credentials for an existing application. */
createApplicationApiKey?: Maybe<CreateApplicationApiKeyOutput>;
/** Creates a signature order to be signed. */
createSignatureOrder?: Maybe<CreateSignatureOrderOutput>;
/** Deletes a set of API credentials for an application. */
deleteApplicationApiKey?: Maybe<DeleteApplicationApiKeyOutput>;
/** Delete a signatory from a signature order */
deleteSignatory?: Maybe<DeleteSignatoryOutput>;
/** Extends the expiration of the signature order. */
extendSignatureOrder?: Maybe<ExtendSignatureOrderOutput>;
/** Refreshes the client secret for an existing set of API credentials. Warning: The old client secret will stop working immediately. */
refreshApplicationApiKey?: Maybe<RefreshApplicationApiKeyOutput>;
/** Used by Signatory frontends to reject a signature order in full. */
rejectSignatureOrder?: Maybe<RejectSignatureOrderOutput>;
retrySignatureOrderWebhook?: Maybe<RetrySignatureOrderWebhookOutput>;
/** Used by Signatory frontends to sign the documents in a signature order. */
sign?: Maybe<SignOutput>;
/** Sign with API credentials acting as a specific signatory. The signatory MUST be preapproved in this case. */
signActingAs?: Maybe<SignActingAsOutput>;
/** Signatory frontend use only. */
signatoryBeacon?: Maybe<SignatoryBeaconOutput>;
/** Signatory frontend use only. */
trackSignatory?: Maybe<TrackSignatoryOutput>;
/** Used by Signatory frontends to mark documents as opened, approved or rejected. */
updateSignatoryDocumentStatus?: Maybe<UpdateSignatoryDocumentStatusOutput>;
validateDocument?: Maybe<ValidateDocumentOutput>;
};
export type MutationAddSignatoriesArgs = {
input: AddSignatoriesInput;
};
export type MutationAddSignatoryArgs = {
input: AddSignatoryInput;
};
export type MutationCancelSignatureOrderArgs = {
input: CancelSignatureOrderInput;
};
export type MutationChangeSignatoryArgs = {
input: ChangeSignatoryInput;
};
export type MutationCleanupSignatureOrderArgs = {
input: CleanupSignatureOrderInput;
};
export type MutationCloseSignatureOrderArgs = {
input: CloseSignatureOrderInput;
};
export type MutationCreateApplicationArgs = {
input: CreateApplicationInput;
};
export type MutationCreateApplicationApiKeyArgs = {
input: CreateApplicationApiKeyInput;
};
export type MutationCreateSignatureOrderArgs = {
input: CreateSignatureOrderInput;
};
export type MutationDeleteApplicationApiKeyArgs = {
input: DeleteApplicationApiKeyInput;
};
export type MutationDeleteSignatoryArgs = {
input: DeleteSignatoryInput;
};
export type MutationExtendSignatureOrderArgs = {
input: ExtendSignatureOrderInput;
};
export type MutationRefreshApplicationApiKeyArgs = {
input: RefreshApplicationApiKeyInput;
};
export type MutationRejectSignatureOrderArgs = {
input: RejectSignatureOrderInput;
};
export type MutationRetrySignatureOrderWebhookArgs = {
input: RetrySignatureOrderWebhookInput;
};
export type MutationSignArgs = {
input: SignInput;
};
export type MutationSignActingAsArgs = {
input: SignActingAsInput;
};
export type MutationSignatoryBeaconArgs = {
input: SignatoryBeaconInput;
};
export type MutationTrackSignatoryArgs = {
input: TrackSignatoryInput;
};
export type MutationUpdateSignatoryDocumentStatusArgs = {
input: UpdateSignatoryDocumentStatusInput;
};
export type MutationValidateDocumentArgs = {
input: ValidateDocumentInput;
};
/** TEST only. Allows empty signatures for testing. */
export type NoopEvidenceProviderInput = {
name: Scalars['String']['input'];
};
export type NoopSignatureEvidenceProvider = SignatureEvidenceProvider & SingleSignatureEvidenceProvider & {
__typename?: 'NoopSignatureEvidenceProvider';
id: Scalars['ID']['output'];
name: Scalars['String']['output'];
};
/** OIDC/JWT based evidence for signatures. */
export type OidcEvidenceProviderInput = {
acrValues?: InputMaybe<Array<Scalars['String']['input']>>;
alwaysRedirect?: InputMaybe<Scalars['Boolean']['input']>;
audience: Scalars['String']['input'];
clientID: Scalars['String']['input'];
domain: Scalars['String']['input'];
name: Scalars['String']['input'];
/** Enforces that signatories sign by unique evidence by comparing the values of previous evidence on the key you define. */
uniqueEvidenceKey?: InputMaybe<Scalars['String']['input']>;
};
export type OidcJwtSignatureEvidenceProvider = SignatureEvidenceProvider & SingleSignatureEvidenceProvider & {
__typename?: 'OidcJWTSignatureEvidenceProvider';
acrValues: Array<Scalars['String']['output']>;
alwaysRedirect: Scalars['Boolean']['output'];
clientID: Scalars['String']['output'];
domain: Scalars['String']['output'];
id: Scalars['ID']['output'];
name: Scalars['String']['output'];
};
export type PadesDocumentFormInput = {
enabled: Scalars['Boolean']['input'];
};
export type PadesDocumentInput = {
blob: Scalars['Blob']['input'];
/** Will add a unique identifier for the document to the specified margin of each page. Useful when printing signed documents. */
displayDocumentID?: InputMaybe<DocumentIdLocation | '%future added value'>;
form?: InputMaybe<PadesDocumentFormInput>;
/** Will not be displayed to signatories, can be used as a reference to your own system. */
reference?: InputMaybe<Scalars['String']['input']>;
storageMode: DocumentStorageMode | '%future added value';
title: Scalars['String']['input'];
};
/** Information about pagination in a connection. */
export type PageInfo = {
__typename?: 'PageInfo';
/** When paginating forwards, the cursor to continue. */
endCursor?: Maybe<Scalars['String']['output']>;
/** When paginating forwards, are there more items? */
hasNextPage: Scalars['Boolean']['output'];
/** When paginating backwards, are there more items? */
hasPreviousPage: Scalars['Boolean']['output'];
/** When paginating backwards, the cursor to continue. */
startCursor?: Maybe<Scalars['String']['output']>;
};
export type PdfDocument = Document & {
__typename?: 'PdfDocument';
blob?: Maybe<Scalars['Blob']['output']>;
form?: Maybe<PdfDocumentForm>;
id: Scalars['ID']['output'];
originalBlob?: Maybe<Scalars['Blob']['output']>;
reference?: Maybe<Scalars['String']['output']>;
signatoryViewerStatus?: Maybe<SignatoryDocumentStatus | '%future added value'>;
signatures?: Maybe<Array<CompositeSignature | DrawableSignature | EmptySignature | JwtSignature>>;
title: Scalars['String']['output'];
};
export type PdfDocumentForm = {
__typename?: 'PdfDocumentForm';
enabled: Scalars['Boolean']['output'];
};
export type PdfSealPosition = {
page: Scalars['Int']['input'];
x: Scalars['Float']['input'];
y: Scalars['Float']['input'];
};
export type Query = {
__typename?: 'Query';
application?: Maybe<Application>;
document?: Maybe<PdfDocument | XmlDocument>;
/** Query a signatory by id. Useful when using webhooks. */
signatory?: Maybe<Signatory>;
signatureOrder?: Maybe<SignatureOrder>;
/** Tenants are only accessable from user viewers */
tenant?: Maybe<Tenant>;
timezones: Array<Scalars['String']['output']>;
viewer: AnonymousViewer | Application | SignatoryViewer | UnvalidatedSignatoryViewer | UserViewer;
};
export type QueryApplicationArgs = {
id?: InputMaybe<Scalars['ID']['input']>;
verifyApplication?: InputMaybe<VerifyApplicationQueryInput>;
};
export type QueryDocumentArgs = {
id: Scalars['ID']['input'];
};
export type QuerySignatoryArgs = {
id: Scalars['ID']['input'];
};
export type QuerySignatureOrderArgs = {
id: Scalars['ID']['input'];
};
export type QueryTenantArgs = {
id: Scalars['ID']['input'];
};
export type RefreshApplicationApiKeyInput = {
apiKeyId: Scalars['ID']['input'];
applicationId: Scalars['ID']['input'];
};
export type RefreshApplicationApiKeyOutput = {
__typename?: 'RefreshApplicationApiKeyOutput';
apiKey: ApplicationApiKey;
application: Application;
};
export type RejectSignatureOrderInput = {
dummy: Scalars['Boolean']['input'];
reason?: InputMaybe<Scalars['String']['input']>;
};
export type RejectSignatureOrderOutput = {
__typename?: 'RejectSignatureOrderOutput';
viewer: AnonymousViewer | Application | SignatoryViewer | UnvalidatedSignatoryViewer | UserViewer;
};
export type RetrySignatureOrderWebhookInput = {
retryPayload: Scalars['String']['input'];
signatureOrderId: Scalars['ID']['input'];
};
export type RetrySignatureOrderWebhookOutput = {
__typename?: 'RetrySignatureOrderWebhookOutput';
invocation: WebhookExceptionInvocation | WebhookHttpErrorInvocation | WebhookSuccessfulInvocation | WebhookTimeoutInvocation;
};
export type SignActingAsInput = {
evidence: SignInput;
signatoryId: Scalars['ID']['input'];
};
export type SignActingAsOutput = {
__typename?: 'SignActingAsOutput';
signatory: Signatory;
signatureOrder: SignatureOrder;
};
export type SignAllOfInput = {
criiptoVerify?: InputMaybe<SignCriiptoVerifyInput>;
drawable?: InputMaybe<SignDrawableInput>;
noop?: InputMaybe<Scalars['Boolean']['input']>;
oidc?: InputMaybe<SignOidcInput>;
};
export type SignCriiptoVerifyInput = {
jwt: Scalars['String']['input'];
};
export type SignDocumentFormFieldInput = {
field: Scalars['String']['input'];
value: Scalars['String']['input'];
};
export type SignDocumentFormInput = {
fields: Array<SignDocumentFormFieldInput>;
};
export type SignDocumentInput = {
form?: InputMaybe<SignDocumentFormInput>;
id: Scalars['ID']['input'];
};
export type SignDrawableInput = {
image: Scalars['Blob']['input'];
name?: InputMaybe<Scalars['String']['input']>;
};
export type SignInput = {
allOf?: InputMaybe<SignAllOfInput>;
criiptoVerify?: InputMaybe<SignCriiptoVerifyInput>;
documents?: InputMaybe<Array<SignDocumentInput>>;
drawable?: InputMaybe<SignDrawableInput>;
/** EvidenceProvider id */
id: Scalars['ID']['input'];
noop?: InputMaybe<Scalars['Boolean']['input']>;
oidc?: InputMaybe<SignOidcInput>;
};
export type SignOidcInput = {
jwt: Scalars['String']['input'];
};
export type SignOutput = {
__typename?: 'SignOutput';
viewer: AnonymousViewer | Application | SignatoryViewer | UnvalidatedSignatoryViewer | UserViewer;
};
export type Signatory = {
__typename?: 'Signatory';
documents: SignatoryDocumentConnection;
/** A download link for signatories to download their signed documents. Signatories must verify their identity before downloading. Can be used when signature order is closed with document retention. */
downloadHref?: Maybe<Scalars['String']['output']>;
evidenceProviders: Array<AllOfSignatureEvidenceProvider | CriiptoVerifySignatureEvidenceProvider | DrawableSignatureEvidenceProvider | NoopSignatureEvidenceProvider | OidcJwtSignatureEvidenceProvider>;
/** A link to the signatures frontend, you can send this link to your users to enable them to sign your documents. */
href: Scalars['String']['output'];
id: Scalars['ID']['output'];
reference?: Maybe<Scalars['String']['output']>;
role?: Maybe<Scalars['String']['output']>;
/** Signature order for the signatory. */
signatureOrder: SignatureOrder;
/** The current status of the signatory. */
status: SignatoryStatus | '%future added value';
/** The reason for the signatory status (rejection reason when rejected). */
statusReason?: Maybe<Scalars['String']['output']>;
/** The signature frontend authentication token, only required if you need to build a custom url. */
token: Scalars['String']['output'];
ui: SignatureOrderUi;
};
export type SignatoryBeaconInput = {
lastActionAt: Scalars['DateTime']['input'];
};
export type SignatoryBeaconOutput = {
__typename?: 'SignatoryBeaconOutput';
viewer: AnonymousViewer | Application | SignatoryViewer | UnvalidatedSignatoryViewer | UserViewer;
};
export type SignatoryDocumentConnection = {
__typename?: 'SignatoryDocumentConnection';
edges: Array<SignatoryDocumentEdge>;
};
export type SignatoryDocumentEdge = {
__typename?: 'SignatoryDocumentEdge';
node: PdfDocument | XmlDocument;
status?: Maybe<SignatoryDocumentStatus | '%future added value'>;
};
export type SignatoryDocumentInput = {
id: Scalars['ID']['input'];
/** Define custom position for PDF seal. Uses PDF coordinate system (bottom-left as 0,0). If defined for one signatory/document, must be defined for all. */
pdfSealPosition?: InputMaybe<PdfSealPosition>;
preapproved?: InputMaybe<Scalars['Boolean']['input']>;
};
export enum SignatoryDocumentStatus {
APPROVED = 'APPROVED',
OPENED = 'OPENED',
PREAPPROVED = 'PREAPPROVED',
REJECTED = 'REJECTED',
SIGNED = 'SIGNED'
}
export type SignatoryEvidenceProviderInput = {
allOf?: InputMaybe<AllOfEvidenceProviderInput>;
/** Criipto Verify based evidence for signatures. */
criiptoVerify?: InputMaybe<CriiptoVerifyProviderInput>;
/** Hand drawn signature evidence for signatures. */
drawable?: InputMaybe<DrawableEvidenceProviderInput>;
id: Scalars['ID']['input'];
/** TEST environment only. Does not manipulate the PDF, use for integration or webhook testing. */
noop?: InputMaybe<NoopEvidenceProviderInput>;
/** OIDC/JWT based evidence for signatures. */
oidc?: InputMaybe<OidcEvidenceProviderInput>;
};
export type SignatoryEvidenceValidationInput = {
boolean?: InputMaybe<Scalars['Boolean']['input']>;
key: Scalars['String']['input'];
value?: InputMaybe<Scalars['String']['input']>;
};
export enum SignatoryFrontendEvent {
DOWNLOAD_LINK_OPENED = 'DOWNLOAD_LINK_OPENED',
SIGN_LINK_OPENED = 'SIGN_LINK_OPENED'
}
export enum SignatoryStatus {
DELETED = 'DELETED',
ERROR = 'ERROR',
OPEN = 'OPEN',
REJECTED = 'REJECTED',
SIGNED = 'SIGNED'
}
export type SignatoryUiInput = {
/** Removes the UI options to reject a document or signature order. */
disableRejection?: InputMaybe<Scalars['Boolean']['input']>;
/** The language of texts rendered to the signatory. */
language?: InputMaybe<Language | '%future added value'>;
/** Define a logo to be shown in the signatory UI. */
logo?: InputMaybe<SignatureOrderUiLogoInput>;
/** Renders a UI layer for PDF annotations, such as links, making them interactive in the UI/browser */
renderPdfAnnotationLayer?: InputMaybe<Scalars['Boolean']['input']>;
/** The signatory will be redirected to this URL after signing or rejected the signature order. */
signatoryRedirectUri?: InputMaybe<Scalars['String']['input']>;
/** Add stylesheet/css via an absolute HTTPS URL. */
stylesheet?: InputMaybe<Scalars['String']['input']>;
};
export type SignatoryViewer = Viewer & {
__typename?: 'SignatoryViewer';
authenticated: Scalars['Boolean']['output'];
documents: SignatoryDocumentConnection;
download?: Maybe<SignatoryViewerDownload>;
evidenceProviders: Array<AllOfSignatureEvidenceProvider | CriiptoVerifySignatureEvidenceProvider | DrawableSignatureEvidenceProvider | NoopSignatureEvidenceProvider | OidcJwtSignatureEvidenceProvider>;
id: Scalars['ID']['output'];
signatoryId: Scalars['ID']['output'];
signatureOrderStatus: SignatureOrderStatus | '%future added value';
signer: Scalars['Boolean']['output'];
status: SignatoryStatus | '%future added value';
ui: SignatureOrderUi;
};
export type SignatoryViewerDownloadArgs = {
verification?: InputMaybe<DownloadVerificationInput>;
};
export type SignatoryViewerDownload = {
__typename?: 'SignatoryViewerDownload';
documents?: Maybe<SignatoryDocumentConnection>;
expired: Scalars['Boolean']['output'];
verificationEvidenceProvider?: Maybe<AllOfSignatureEvidenceProvider | CriiptoVerifySignatureEvidenceProvider | DrawableSignatureEvidenceProvider | NoopSignatureEvidenceProvider | OidcJwtSignatureEvidenceProvider>;
verificationRequired: Scalars['Boolean']['output'];
};
/** Represents a signature on a document. */
export type Signature = {
signatory?: Maybe<Signatory>;
};
export type SignatureAppearanceInput = {
displayName?: InputMaybe<Array<SignatureAppearanceTemplateInput>>;
footer?: InputMaybe<Array<SignatureAppearanceTemplateInput>>;
headerLeft?: InputMaybe<Array<SignatureAppearanceTemplateInput>>;
/** Render evidence claim as identifier in the signature appearance inside the document. You can supply multiple keys and they will be tried in order. If no key is found a GUID will be rendered. */
identifierFromEvidence: Array<Scalars['String']['input']>;
};
export type SignatureAppearanceTemplateInput = {
replacements?: InputMaybe<Array<SignatureAppearanceTemplateReplacementInput>>;
template: Scalars['String']['input'];
};
export type SignatureAppearanceTemplateReplacementInput = {
fromEvidence: Array<Scalars['String']['input']>;
placeholder: Scalars['String']['input'];
};
export type SignatureEvidenceProvider = {
id: Scalars['ID']['output'];
};
export type SignatureOrder = {
__typename?: 'SignatureOrder';
application?: Maybe<Application>;
closedAt?: Maybe<Scalars['DateTime']['output']>;
createdAt: Scalars['DateTime']['output'];
documents: Array<PdfDocument | XmlDocument>;
evidenceProviders: Array<AllOfSignatureEvidenceProvider | CriiptoVerifySignatureEvidenceProvider | DrawableSignatureEvidenceProvider | NoopSignatureEvidenceProvider | OidcJwtSignatureEvidenceProvider>;
expiresAt: Scalars['DateTime']['output'];
id: Scalars['ID']['output'];
/** List of signatories for the signature order. */
signatories: Array<Signatory>;
status: SignatureOrderStatus | '%future added value';
/** Tenants are only accessable from user viewers */
tenant?: Maybe<Tenant>;
timezone: Scalars['String']['output'];
title?: Maybe<Scalars['String']['output']>;
ui: SignatureOrderUi;
webhook?: Maybe<SignatureOrderWebhook>;
};
/** A connection from an object to a list of objects of type SignatureOrder */
export type SignatureOrderConnection = {
__typename?: 'SignatureOrderConnection';
/** Information to aid in pagination. */
edges: Array<SignatureOrderEdge>;
/** Information to aid in pagination. */
pageInfo: PageInfo;
/** A count of the total number of objects in this connection, ignoring pagination. This allows a client to fetch the first five objects by passing \"5\" as the argument to `first`, then fetch the total count so it could display \"5 of 83\", for example. In cases where we employ infinite scrolling or don't have an exact count of entries, this field will return `null`. */
totalCount?: Maybe<Scalars['Int']['output']>;
};
/** An edge in a connection from an object to another object of type SignatureOrder */
export type SignatureOrderEdge = {
__typename?: 'SignatureOrderEdge';
/** A cursor for use in pagination */
cursor: Scalars['String']['output'];
/** The item at the end of the edge. Must NOT be an enumerable collection. */
node: SignatureOrder;
};
export enum SignatureOrderStatus {
CANCELLED = 'CANCELLED',
CLOSED = 'CLOSED',
EXPIRED = 'EXPIRED',
OPEN = 'OPEN'
}