From 9aceb33e7703255e0b3cd3444986ef24dc9c06b6 Mon Sep 17 00:00:00 2001 From: Aram Date: Fri, 13 Mar 2020 12:00:12 -0700 Subject: [PATCH] Update docs --- docs/graphql/types/accessqueryinput.doc.html | 672 +++++++++ docs/graphql/types/accessqueryresult.doc.html | 672 +++++++++ docs/graphql/types/accesstype.doc.html | 1198 ++++++++-------- docs/graphql/types/adminfieldsinput.doc.html | 1198 ++++++++-------- docs/graphql/types/billinginterval.doc.html | 1198 ++++++++-------- docs/graphql/types/boolean.doc.html | 1198 ++++++++-------- docs/graphql/types/cachecontrol.doc.html | 672 +++++++++ docs/graphql/types/cachecontrolscope.doc.html | 672 +++++++++ .../types/certificationrequest.doc.html | 1198 ++++++++-------- .../types/certificationrequestinput.doc.html | 1198 ++++++++-------- .../types/certificationrequestresult.doc.html | 1198 ++++++++-------- .../types/certificationrequeststatus.doc.html | 1198 ++++++++-------- docs/graphql/types/codinglanguage.doc.html | 673 +++++++++ docs/graphql/types/codingscore.doc.html | 1198 ++++++++-------- .../codingscoreconfigurationinput.doc.html | 1198 ++++++++-------- docs/graphql/types/codingsolution.doc.html | 1198 ++++++++-------- .../coefficientconfigurationinput.doc.html | 1198 ++++++++-------- docs/graphql/types/company.doc.html | 1200 ++++++++-------- docs/graphql/types/companyfeature.doc.html | 1198 ++++++++-------- docs/graphql/types/companyfeatures.doc.html | 1198 ++++++++-------- .../types/companyfeaturestatus.doc.html | 1198 ++++++++-------- docs/graphql/types/companyplan.doc.html | 1198 ++++++++-------- docs/graphql/types/companyplaninput.doc.html | 1198 ++++++++-------- .../types/companyplansettingsinput.doc.html | 1198 ++++++++-------- docs/graphql/types/companytest.doc.html | 1198 ++++++++-------- .../graphql/types/companytestsession.doc.html | 1198 ++++++++-------- docs/graphql/types/contact.doc.html | 1198 ++++++++-------- docs/graphql/types/cost.doc.html | 1198 ++++++++-------- docs/graphql/types/country.doc.html | 1198 ++++++++-------- .../createcertificationrequestinput.doc.html | 1198 ++++++++-------- .../types/createcompanytestinput.doc.html | 1198 ++++++++-------- docs/graphql/types/createquizinput.doc.html | 1198 ++++++++-------- .../types/createstandardtaskinput.doc.html | 1198 ++++++++-------- .../types/createtaskoptionsinput.doc.html | 1198 ++++++++-------- docs/graphql/types/creditcard.doc.html | 1198 ++++++++-------- docs/graphql/types/creditcardbrand.doc.html | 1198 ++++++++-------- .../types/customfeaturesinput.doc.html | 1198 ++++++++-------- docs/graphql/types/deprecated.doc.html | 1198 ++++++++-------- docs/graphql/types/directive.spec.html | 1198 ++++++++-------- .../graphql/types/directivelocation.spec.html | 1198 ++++++++-------- .../types/editcompanytestinput.doc.html | 1198 ++++++++-------- docs/graphql/types/editquizinput.doc.html | 1198 ++++++++-------- .../types/editstandardtaskinput.doc.html | 1198 ++++++++-------- docs/graphql/types/enumvalue.spec.html | 1198 ++++++++-------- docs/graphql/types/field.spec.html | 1198 ++++++++-------- docs/graphql/types/float.doc.html | 1198 ++++++++-------- docs/graphql/types/freeformsolution.doc.html | 1198 ++++++++-------- docs/graphql/types/frontendlibrary.doc.html | 672 +++++++++ .../types/frontendlibraryinput.doc.html | 674 +++++++++ .../types/frontendscriptlanguage.doc.html | 673 +++++++++ .../types/frontendstylelanguage.doc.html | 673 +++++++++ docs/graphql/types/id.doc.html | 1200 ++++++++-------- docs/graphql/types/include.doc.html | 1198 ++++++++-------- docs/graphql/types/index.html | 1176 ++++++++-------- docs/graphql/types/inputvalue.spec.html | 1198 ++++++++-------- docs/graphql/types/int.doc.html | 1198 ++++++++-------- docs/graphql/types/invoice.doc.html | 1198 ++++++++-------- docs/graphql/types/language.doc.html | 1199 ++++++++-------- docs/graphql/types/languagetimelimit.doc.html | 672 +++++++++ docs/graphql/types/liveinterview.doc.html | 1198 ++++++++-------- .../types/liveinterviewfeedback.doc.html | 1198 ++++++++-------- .../graphql/types/liveinterviewinput.doc.html | 1198 ++++++++-------- .../types/liveinterviewrating.doc.html | 1198 ++++++++-------- .../types/liveinterviewstatus.doc.html | 1198 ++++++++-------- docs/graphql/types/mutation.doc.html | 672 +++++++++ docs/graphql/types/plagiarismlabel.doc.html | 1198 ++++++++-------- docs/graphql/types/planbillingperiod.doc.html | 1198 ++++++++-------- docs/graphql/types/plantype.doc.html | 1198 ++++++++-------- docs/graphql/types/product.doc.html | 1198 ++++++++-------- docs/graphql/types/query.doc.html | 672 +++++++++ docs/graphql/types/quizoptioninput.doc.html | 1198 ++++++++-------- docs/graphql/types/quizsolution.doc.html | 1198 ++++++++-------- docs/graphql/types/ratelimit.doc.html | 1198 ++++++++-------- docs/graphql/types/role.doc.html | 1198 ++++++++-------- docs/graphql/types/rootmutation.doc.html | 593 -------- docs/graphql/types/rootquery.doc.html | 593 -------- docs/graphql/types/schema.spec.html | 1198 ++++++++-------- docs/graphql/types/scorerange.doc.html | 673 +++++++++ docs/graphql/types/scorerangeinput.doc.html | 672 +++++++++ docs/graphql/types/scorerangelabel.doc.html | 673 +++++++++ .../types/scorerangelabelinput.doc.html | 672 +++++++++ docs/graphql/types/serviceplan.doc.html | 1198 ++++++++-------- docs/graphql/types/serviceplanstatus.doc.html | 1198 ++++++++-------- docs/graphql/types/skilltype.doc.html | 1198 ++++++++-------- docs/graphql/types/skip.doc.html | 1198 ++++++++-------- .../types/slotconfigurationinput.doc.html | 1198 ++++++++-------- docs/graphql/types/solutionsource.doc.html | 1198 ++++++++-------- docs/graphql/types/standardizedtest.doc.html | 1200 ++++++++-------- .../types/standardizedtesttype.doc.html | 1198 ++++++++-------- docs/graphql/types/string.doc.html | 1202 +++++++++-------- docs/graphql/types/task.doc.html | 1198 ++++++++-------- .../types/taskinputargumentinfo.doc.html | 1198 ++++++++-------- docs/graphql/types/taskoutputinfo.doc.html | 1198 ++++++++-------- docs/graphql/types/taskslotinput.doc.html | 1198 ++++++++-------- docs/graphql/types/tasksolution.doc.html | 1198 ++++++++-------- docs/graphql/types/test.doc.html | 1198 ++++++++-------- docs/graphql/types/testcaseinput.doc.html | 1198 ++++++++-------- docs/graphql/types/testsession.doc.html | 1198 ++++++++-------- .../types/testsessionfeedback.doc.html | 1198 ++++++++-------- docs/graphql/types/testsessioninput.doc.html | 1198 ++++++++-------- docs/graphql/types/testsessionresult.doc.html | 1198 ++++++++-------- docs/graphql/types/testsessionstatus.doc.html | 1198 ++++++++-------- docs/graphql/types/testsessiontask.doc.html | 1198 ++++++++-------- .../types/testsessiontaskresult.doc.html | 1198 ++++++++-------- docs/graphql/types/testtaker.doc.html | 1198 ++++++++-------- docs/graphql/types/timestamp.doc.html | 1198 ++++++++-------- docs/graphql/types/type.spec.html | 1198 ++++++++-------- docs/graphql/types/typekind.spec.html | 1198 ++++++++-------- .../types/updatefrontendtaskinput.doc.html | 672 +++++++++ docs/graphql/types/upload.doc.html | 673 +++++++++ .../types/usednumericfeatures.doc.html | 1198 ++++++++-------- docs/graphql/types/user.doc.html | 1198 ++++++++-------- docs/graphql/types/usercompanyfields.doc.html | 1198 ++++++++-------- docs/graphql/types/userprofile.doc.html | 1198 ++++++++-------- docs/graphql/types/userskill.doc.html | 1198 ++++++++-------- 115 files changed, 72805 insertions(+), 54284 deletions(-) create mode 100644 docs/graphql/types/accessqueryinput.doc.html create mode 100644 docs/graphql/types/accessqueryresult.doc.html create mode 100644 docs/graphql/types/cachecontrol.doc.html create mode 100644 docs/graphql/types/cachecontrolscope.doc.html create mode 100644 docs/graphql/types/codinglanguage.doc.html create mode 100644 docs/graphql/types/frontendlibrary.doc.html create mode 100644 docs/graphql/types/frontendlibraryinput.doc.html create mode 100644 docs/graphql/types/frontendscriptlanguage.doc.html create mode 100644 docs/graphql/types/frontendstylelanguage.doc.html create mode 100644 docs/graphql/types/languagetimelimit.doc.html create mode 100644 docs/graphql/types/mutation.doc.html create mode 100644 docs/graphql/types/query.doc.html delete mode 100644 docs/graphql/types/rootmutation.doc.html delete mode 100644 docs/graphql/types/rootquery.doc.html create mode 100644 docs/graphql/types/scorerange.doc.html create mode 100644 docs/graphql/types/scorerangeinput.doc.html create mode 100644 docs/graphql/types/scorerangelabel.doc.html create mode 100644 docs/graphql/types/scorerangelabelinput.doc.html create mode 100644 docs/graphql/types/updatefrontendtaskinput.doc.html create mode 100644 docs/graphql/types/upload.doc.html diff --git a/docs/graphql/types/accessqueryinput.doc.html b/docs/graphql/types/accessqueryinput.doc.html new file mode 100644 index 00000000..687086fb --- /dev/null +++ b/docs/graphql/types/accessqueryinput.doc.html @@ -0,0 +1,672 @@ + + + + + + + + + + + AccessQueryInput | CodeSignal GraphQL API + + + + +
+
+
+ +
+
+ +
+

INPUT_OBJECT

+

AccessQueryInput

+
+
+
+
+
+

+ + link + + GraphQL Schema definition +

+
1input AccessQueryInput {
4
2# The type of access being checked.
3type: AccessType!
8
5# The identifier of the resource related to the access check, if a single ID is
6# required.
7resourceId: ID
12
9# The identifiers of the multiple resources related to the access check, if
10# multiple are required.
11resourceIds: [ID]
13}
+
+
+
+
+

+ + link + + Required by +

+ +
+
+ +
+ + + + diff --git a/docs/graphql/types/accessqueryresult.doc.html b/docs/graphql/types/accessqueryresult.doc.html new file mode 100644 index 00000000..346f28e5 --- /dev/null +++ b/docs/graphql/types/accessqueryresult.doc.html @@ -0,0 +1,672 @@ + + + + + + + + + + + AccessQueryResult | CodeSignal GraphQL API + + + + +
+
+
+ +
+
+ +
+

OBJECT

+

AccessQueryResult

+
+
+
+
+
+

+ + link + + GraphQL Schema definition +

+
1type AccessQueryResult {
2
3# The type of access being checked.
4type: AccessType!
5
6# The identifier of the resource related to the access check, if a single ID is
7# required.
8resourceId: ID
9
10# The identifiers of the multiple resources related to the access check, if
11# multiple are required.
12resourceIds: [ID]
13
14# Whether access is granted.
15hasAccess: Boolean
16
17}
+
+
+
+
+

+ + link + + Required by +

+ +
+
+ +
+ + + + diff --git a/docs/graphql/types/accesstype.doc.html b/docs/graphql/types/accesstype.doc.html index 379ceeb7..f4e24a84 100644 --- a/docs/graphql/types/accesstype.doc.html +++ b/docs/graphql/types/accesstype.doc.html @@ -23,568 +23,648 @@
-
-
- -
-
- -
-

ENUM

-

AccessType

-
-
-
-
-
-

- - link - - GraphQL Schema definition -

-
1enum AccessType {
2
3certification_any_read
4
5certification_any_write
6
7company_read
8
9company_test_read
10
11company_test_session_read
12
13interview_create
14
15interview_read
16
17product_view
18}
-
-
-
- -
- +
+
+ +
+
+ +
+

ENUM

+

AccessType

+
+
+ +
+
+

+ + link + + GraphQL Schema definition +

+
1enum AccessType {
2
3certification_any_read
4
5certification_any_write
6
7certification_invitation_write
8
9company_read
10
11company_test_read
12
13company_test_session_read
14
15interview_create
16
17interview_read
18
19product_view
20
21file_upload
22
23# Query by company test ID and invitation ID
24company_test_invitation_write
25}
+
+
+
+ +
+
diff --git a/docs/graphql/types/adminfieldsinput.doc.html b/docs/graphql/types/adminfieldsinput.doc.html index 8b644531..9ac31525 100644 --- a/docs/graphql/types/adminfieldsinput.doc.html +++ b/docs/graphql/types/adminfieldsinput.doc.html @@ -23,568 +23,648 @@
-
-
- -
-
- -
-

INPUT_OBJECT

-

AdminFieldsInput

-
-
-
-
-
-

- - link - - GraphQL Schema definition -

-
1input AdminFieldsInput {
3
2showCodingScore: Boolean
5
4codingScoreConfiguration: CodingScoreConfigurationInput
6}
-
-
-
- -
- +
+
+ +
+
+ +
+

INPUT_OBJECT

+

AdminFieldsInput

+
+
+ +
+
+

+ + link + + GraphQL Schema definition +

+
1input AdminFieldsInput {
3
2showCodingScore: Boolean
5
4codingScoreConfiguration: CodingScoreConfigurationInput
6}
+
+
+
+ +
+
diff --git a/docs/graphql/types/billinginterval.doc.html b/docs/graphql/types/billinginterval.doc.html index 73956b76..62830124 100644 --- a/docs/graphql/types/billinginterval.doc.html +++ b/docs/graphql/types/billinginterval.doc.html @@ -23,569 +23,649 @@
-
-
- -
-
- -
-

ENUM

-

BillingInterval

-

The unit of time used to determine a billing period.

-
-
-
-
-
-

- - link - - GraphQL Schema definition -

-
1enum BillingInterval {
2
3month
4
5year
6}
-
-
-
- -
-
-
-

- Generated with graphqldoc 2.5.2 -

+
+
+ +
+
+
+
+

ENUM

+

BillingInterval

+

The unit of time used to determine a billing period.

-
+ + +
+
+

+ + link + + GraphQL Schema definition +

+
1enum BillingInterval {
2
3month
4
5year
6}
+
+
+
+ +
+
diff --git a/docs/graphql/types/boolean.doc.html b/docs/graphql/types/boolean.doc.html index 48ff2efd..5498d45e 100644 --- a/docs/graphql/types/boolean.doc.html +++ b/docs/graphql/types/boolean.doc.html @@ -23,573 +23,653 @@
-
-
- -
-
- -
-

SCALAR

-

Boolean

-

The Boolean scalar type represents true or false.

+
+
+ +
+
+
+
+

SCALAR

+

Boolean

+

The Boolean scalar type represents true or false.

-
-
-
-
-

- - link - - GraphQL Schema definition -

-
1scalar Boolean
-
-
-
- +
+
+ -
- + + +
diff --git a/docs/graphql/types/cachecontrol.doc.html b/docs/graphql/types/cachecontrol.doc.html new file mode 100644 index 00000000..2e407d0d --- /dev/null +++ b/docs/graphql/types/cachecontrol.doc.html @@ -0,0 +1,672 @@ + + + + + + + + + + + cacheControl | CodeSignal GraphQL API + + + + +
+
+
+ +
+
+ +
+

+

cacheControl

+
+
+
+
+
+

+ + link + + GraphQL Schema definition +

+
1directive @cacheControl(maxAge: Int, scope: CacheControlScope) on FIELD_DEFINITION | OBJECT | INTERFACE
+
+
+
+
+

+ + link + + Required by +

+
This element is not required by anyone
+
+
+ +
+ + + + diff --git a/docs/graphql/types/cachecontrolscope.doc.html b/docs/graphql/types/cachecontrolscope.doc.html new file mode 100644 index 00000000..1c262405 --- /dev/null +++ b/docs/graphql/types/cachecontrolscope.doc.html @@ -0,0 +1,672 @@ + + + + + + + + + + + CacheControlScope | CodeSignal GraphQL API + + + + +
+
+
+ +
+
+ +
+

ENUM

+

CacheControlScope

+
+
+
+
+
+

+ + link + + GraphQL Schema definition +

+
1enum CacheControlScope {
2
3PUBLIC
4
5PRIVATE
6}
+
+
+
+
+

+ + link + + Required by +

+
This element is not required by anyone
+
+
+ +
+ + + + diff --git a/docs/graphql/types/certificationrequest.doc.html b/docs/graphql/types/certificationrequest.doc.html index c6ad9fa2..f2da514f 100644 --- a/docs/graphql/types/certificationrequest.doc.html +++ b/docs/graphql/types/certificationrequest.doc.html @@ -23,570 +23,650 @@
-
-
- -
-
- -
-

OBJECT

-

CertificationRequest

-

A request for a standardized assessment from a company. A certification request is uniquely identified +

+
+ +
+
+
+
+

OBJECT

+

CertificationRequest

+

A request for a standardized assessment from a company. A certification request is uniquely identified by its ID, or by the (companyId, testId, candidateEmail) triplet.

-
-
-
-
-

- - link - - GraphQL Schema definition -

-
1type CertificationRequest {
2
3# Unique ID of the request.
4id: ID!
5
6# ID of the company that sent the request.
7companyId: ID!
8
9# Company that sent the request.
10company: Company
11
12# The ID of the standardized test.
13testId: ID!
14
15# The standardized test which result the candidate is expected to share.
16test: StandardizedTest
17
18# The status of the last request sent to this user.
19lastStatus: CertificationRequestStatus!
20
21# The email of the candidate.
22candidateEmail: String!
23
24# The full name of the candidate.
25candidateName: String!
26
27# The best result among the results the candidate shared in response to the
28# request.
29bestResult: CertificationRequestResult
30
31# The URL the candidate can follow to take the assessment. Provided only if
32# lastStatus is "pending".
33invitationUrl: String
34
35}
-
-
-
- -
- + + +
+
+

+ + link + + GraphQL Schema definition +

+
1type CertificationRequest {
2
3# Unique ID of the request.
4id: ID!
5
6# ID of the company that sent the request.
7companyId: ID!
8
9# Company that sent the request.
10company: Company
11
12# The ID of the standardized test.
13testId: ID!
14
15# The standardized test which result the candidate is expected to share.
16test: StandardizedTest
17
18# The status of the last request sent to this user.
19lastStatus: CertificationRequestStatus!
20
21# The email of the candidate.
22candidateEmail: String!
23
24# The full name of the candidate.
25candidateName: String!
26
27# The best result among the results the candidate shared in response to the
28# request.
29bestResult: CertificationRequestResult
30
31# The URL the candidate can follow to take the assessment. Provided only if
32# lastStatus is "pending".
33invitationUrl: String
34
35}
+
+
+
+
+

+ + link + + Required by +

+ +
+
+
diff --git a/docs/graphql/types/certificationrequestinput.doc.html b/docs/graphql/types/certificationrequestinput.doc.html index 71470a2b..9f74ea86 100644 --- a/docs/graphql/types/certificationrequestinput.doc.html +++ b/docs/graphql/types/certificationrequestinput.doc.html @@ -23,568 +23,648 @@
-
-
- -
-
- -
-

INPUT_OBJECT

-

CertificationRequestInput

-
-
-
-
-
-

- - link - - GraphQL Schema definition -

-
1input CertificationRequestInput {
3
2requestId: ID
5
4companyId: ID
7
6testId: ID
9
8candidateEmail: String
10}
-
-
-
- -
- +
+
+ +
+
+ +
+

INPUT_OBJECT

+

CertificationRequestInput

+
+
+ +
+
+

+ + link + + GraphQL Schema definition +

+
1input CertificationRequestInput {
3
2requestId: ID
5
4companyId: ID
7
6testId: ID
9
8candidateEmail: String
10}
+
+
+
+
+

+ + link + + Required by +

+ +
+
+
diff --git a/docs/graphql/types/certificationrequestresult.doc.html b/docs/graphql/types/certificationrequestresult.doc.html index d83478b5..f7db8a59 100644 --- a/docs/graphql/types/certificationrequestresult.doc.html +++ b/docs/graphql/types/certificationrequestresult.doc.html @@ -23,570 +23,650 @@
-
-
- -
-
- -
-

OBJECT

-

CertificationRequestResult

-
-
-
-
-
-

- - link - - GraphQL Schema definition -

-
1type CertificationRequestResult {
2
3codingScore: CodingScore
4
5date: Timestamp
6
7}
-
-
-
- + +
+

OBJECT

+

CertificationRequestResult

+
+
+
+
+
+

+ + link + + GraphQL Schema definition +

+
1type CertificationRequestResult {
2
3codingScore: CodingScore
4
5date: Timestamp
6
7}
+
+
+
+ -
- + + +
diff --git a/docs/graphql/types/certificationrequeststatus.doc.html b/docs/graphql/types/certificationrequeststatus.doc.html index 4bc44da8..9371c783 100644 --- a/docs/graphql/types/certificationrequeststatus.doc.html +++ b/docs/graphql/types/certificationrequeststatus.doc.html @@ -23,570 +23,650 @@
-
-
- -
-
- -
-

ENUM

-

CertificationRequestStatus

-
-
-
-
-
-

- - link - - GraphQL Schema definition -

-
1enum CertificationRequestStatus {
2
3shared
4
5rejected
6
7expired
8
9pending
10}
-
-
-
- + +
+

ENUM

+

CertificationRequestStatus

+
+
+
+
+
+

+ + link + + GraphQL Schema definition +

+
1enum CertificationRequestStatus {
2
3shared
4
5rejected
6
7expired
8
9pending
10}
+
+
+
+ -
- + + +
diff --git a/docs/graphql/types/codinglanguage.doc.html b/docs/graphql/types/codinglanguage.doc.html new file mode 100644 index 00000000..f617bbc3 --- /dev/null +++ b/docs/graphql/types/codinglanguage.doc.html @@ -0,0 +1,673 @@ + + + + + + + + + + + CodingLanguage | CodeSignal GraphQL API + + + + +
+
+
+ +
+
+ +
+

ENUM

+

CodingLanguage

+

A supported standard coding language.

+
+
+
+
+
+

+ + link + + GraphQL Schema definition +

+
1enum CodingLanguage {
2
3clj
4
5coffee
6
7lisp
8
9c
10
11cpp
12
13cs
14
15d
16
17dart
18
19exs
20
21erl
22
23pas
24
25for
26
27fs
28
29go
30
31groovy
32
33hs
34
35java
36
37js
38
39jl
40
41kt
42
43lua
44
45nim
46
47objc
48
49ocaml
50
51octave
52
53perl
54
55php
56
57py
58
59py3
60
61r
62
63rb
64
65rs
66
67scala
68
69st
70
71swift
72
73tcl
74
75ts
76
77vb
78}
+
+
+
+ +
+ +
+ + + + diff --git a/docs/graphql/types/codingscore.doc.html b/docs/graphql/types/codingscore.doc.html index ae74dd3d..2e0d461b 100644 --- a/docs/graphql/types/codingscore.doc.html +++ b/docs/graphql/types/codingscore.doc.html @@ -23,569 +23,649 @@
-
-
- -
-
- -
-

SCALAR

-

CodingScore

-

A coding score is a number in range [300, 850] used to measure candidate's coding abilities.

-
-
-
-
-
-

- - link - - GraphQL Schema definition -

-
1scalar CodingScore
-
-
-
-
-

- - link - - Required by -

- -
-
-
-
-

- Generated with graphqldoc 2.5.2 -

+
+
+ +
+
+
+
+

SCALAR

+

CodingScore

+

A coding score is a number in range [300, 850] used to measure candidate's coding abilities.

-
+ + +
+
+

+ + link + + GraphQL Schema definition +

+
1scalar CodingScore
+
+
+
+
+

+ + link + + Required by +

+ +
+
+
diff --git a/docs/graphql/types/codingscoreconfigurationinput.doc.html b/docs/graphql/types/codingscoreconfigurationinput.doc.html index e7f9721b..6f592748 100644 --- a/docs/graphql/types/codingscoreconfigurationinput.doc.html +++ b/docs/graphql/types/codingscoreconfigurationinput.doc.html @@ -23,568 +23,648 @@
-
-
- -
-
- -
-

INPUT_OBJECT

-

CodingScoreConfigurationInput

-
-
-
-
-
-

- - link - - GraphQL Schema definition -

-
1input CodingScoreConfigurationInput {
3
2slotConfiguration: [SlotConfigurationInput]!
5
4coefficients: CoefficientConfigurationInput
6}
-
-
-
-
-

- - link - - Required by -

- -
-
- +
+
+ +
+
+ +
+

INPUT_OBJECT

+

CodingScoreConfigurationInput

+
+
+ +
+
+

+ + link + + GraphQL Schema definition +

+
1input CodingScoreConfigurationInput {
3
2slotConfiguration: [SlotConfigurationInput]!
5
4coefficients: CoefficientConfigurationInput
6}
+
+
+
+
+

+ + link + + Required by +

+ +
+
+
diff --git a/docs/graphql/types/codingsolution.doc.html b/docs/graphql/types/codingsolution.doc.html index 0431bb18..0d27a51c 100644 --- a/docs/graphql/types/codingsolution.doc.html +++ b/docs/graphql/types/codingsolution.doc.html @@ -23,569 +23,649 @@
-
-
- -
-
- -
-

OBJECT

-

CodingSolution

-

Solution submitted to a coding task.

-
-
-
-
-
-

- - link - - GraphQL Schema definition -

-
1type CodingSolution implements TaskSolution {
2
3id: ID!
4
5plagiarismLabel: PlagiarismLabel
6
7# Files submitted as a solution.
8sources: [SolutionSource]!
9
10# A standalone URL to the solution.
11url: String!
12
13}
-
-
-
-
-

- - link - - Required by -

-
This element is not required by anyone
-
-
-
-
-

- Generated with graphqldoc 2.5.2 -

+
+
+ +
+
+
+
+

OBJECT

+

CodingSolution

+

Solution submitted to a coding task.

-
+ + +
+
+

+ + link + + GraphQL Schema definition +

+
1type CodingSolution implements TaskSolution {
2
3id: ID!
4
5plagiarismLabel: PlagiarismLabel
6
7# Files submitted as a solution.
8sources: [SolutionSource]!
9
10# A standalone URL to the solution.
11url: String!
12
13}
+
+
+
+
+

+ + link + + Required by +

+
This element is not required by anyone
+
+
+
diff --git a/docs/graphql/types/coefficientconfigurationinput.doc.html b/docs/graphql/types/coefficientconfigurationinput.doc.html index b5e9a4cf..0bac3574 100644 --- a/docs/graphql/types/coefficientconfigurationinput.doc.html +++ b/docs/graphql/types/coefficientconfigurationinput.doc.html @@ -23,568 +23,648 @@
-
-
- -
-
- -
-

INPUT_OBJECT

-

CoefficientConfigurationInput

-
-
-
-
-
-

- - link - - GraphQL Schema definition -

-
1input CoefficientConfigurationInput {
3
2maxAverageScore: Float!
5
4maxVariationCoefficient: Float!
7
6maxQuizScore: Float!
9
8quizAverageSolveTime: Int!
10}
-
-
-
- -
- +
+
+ +
+
+ +
+

INPUT_OBJECT

+

CoefficientConfigurationInput

+
+
+ +
+
+

+ + link + + GraphQL Schema definition +

+
1input CoefficientConfigurationInput {
3
2maxAverageScore: Float!
5
4maxVariationCoefficient: Float!
7
6maxQuizScore: Float!
9
8quizAverageSolveTime: Int!
10}
+
+
+
+ +
+
diff --git a/docs/graphql/types/company.doc.html b/docs/graphql/types/company.doc.html index c8b89025..81a5f9a7 100644 --- a/docs/graphql/types/company.doc.html +++ b/docs/graphql/types/company.doc.html @@ -23,571 +23,651 @@
-
-
- -
-
- -
-

OBJECT

-

Company

-

A company is an organization of user accounts that have access to the assessment platform.

+
+
+ +
+
+
+
+

OBJECT

+

Company

+

A company is an organization of user accounts that have access to the assessment platform.

-
-
-
-
-

- - link - - GraphQL Schema definition -

-
1type Company {
2
3id: ID!
4
5# A unique, human-readable identifier for the company.
6alias: String!
7
8# The display name of the company.
9name: String!
10
11# The link to the logo of the company.
12logo: String!
13
14# The status of the company.
15status: String!
16
17# The user ids of the company's contacts.
18contacts: [Contact]!
19
20# This field is used by CodeSignal admins only.
21notes: String!
22
23# Whether the company profile page is enabled for candidates
24companyProfileEnabled: Boolean!
25
26# The plans to which a company is subscribed
27plans: [CompanyPlan]!
28
29# Custom feature values for this company, which will override plan feature values.
30customFeatures: CompanyFeatures!
31
32# This company's usage of each numeric feature.
33usedNumericFeatures: UsedNumericFeatures!
34
35# This company's stripe customer ID.
36stripeCustomerId: String
37
38}
-
-
-
-
-

- - link - - Required by -

-
  • +

    + + link + + GraphQL Schema definition +

    +
    1type Company {
    2
    3id: ID!
    4
    5# A unique, human-readable identifier for the company.
    6alias: String!
    7
    8# The display name of the company.
    9name: String!
    10
    11# The link to the logo of the company.
    12logo: String!
    13
    14# The status of the company.
    15status: String!
    16
    17# The user ids of the company's contacts.
    18contacts: [Contact]!
    19
    20# This field is used by CodeSignal admins only.
    21notes: String!
    22
    23# Whether the company profile page is enabled for candidates
    24companyProfileEnabled: Boolean!
    25
    26# The plans to which a company is subscribed
    27plans: [CompanyPlan]!
    28
    29# Custom feature values for this company, which will override plan feature values.
    30customFeatures: CompanyFeatures!
    31
    32# This company's usage of each numeric feature.
    33usedNumericFeatures: UsedNumericFeatures!
    34
    35# This company's stripe customer ID.
    36stripeCustomerId: String
    37
    38}
    +
+
+
+ -
- +by its ID, or by the (companyId, testId, candidateEmail) triplet.
  • CompanyTestA non-standardized test owned by a particular company.
  • LiveInterviewA live interview defines a collaboration programming session.
  • Mutation
  • Query
  • + + +
  • diff --git a/docs/graphql/types/companyfeature.doc.html b/docs/graphql/types/companyfeature.doc.html index 8e905383..61380d22 100644 --- a/docs/graphql/types/companyfeature.doc.html +++ b/docs/graphql/types/companyfeature.doc.html @@ -23,569 +23,649 @@
    -
    -
    - -
    -
    - -
    -

    OBJECT

    -

    CompanyFeature

    -

    A feature that can be enabled for a given company.

    -
    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1type CompanyFeature {
    2
    3# Unique identifier for this company feature.
    4key: ID
    5
    6# Display name for this company feature.
    7title: String
    8
    9# Status of this company feature.
    10status: CompanyFeatureStatus
    11
    12}
    -
    -
    -
    - -
    -
    -
    -

    - Generated with graphqldoc 2.5.2 -

    +
    +
    + +
    +
    +
    +
    +

    OBJECT

    +

    CompanyFeature

    +

    A feature that can be enabled for a given company.

    -
    + + +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1type CompanyFeature {
    2
    3# Unique identifier for this company feature.
    4key: ID
    5
    6# Display name for this company feature.
    7title: String
    8
    9# Status of this company feature.
    10status: CompanyFeatureStatus
    11
    12}
    +
    +
    +
    +
    +

    + + link + + Required by +

    + +
    +
    +
    diff --git a/docs/graphql/types/companyfeatures.doc.html b/docs/graphql/types/companyfeatures.doc.html index a5653e83..8a40abb7 100644 --- a/docs/graphql/types/companyfeatures.doc.html +++ b/docs/graphql/types/companyfeatures.doc.html @@ -23,569 +23,649 @@
    -
    -
    - -
    -
    - -
    -

    OBJECT

    -

    CompanyFeatures

    -

    Features that can be set on a service plan or a company.

    -
    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1type CompanyFeatures {
    2
    3# The number of permitted user licenses.
    4numLicenses: Int
    5
    6# The number of certification credits available on a plan. One credit is used to
    7# send one certification request.
    8certifyCredits: Int
    9
    10# The lifetime of user passwords in days after which they will expire and require
    11# to be changed. Setting this number to 0 will disable the expiration.
    12passwordExpirationDays: Int
    13
    14# If true, candidates are not prompted to leave feedback in CodeSignal after an
    15# interview.
    16skipInterviewFeedback: Boolean
    17
    18# If true, feedback fileds are disabled for interviewer.
    19skipInterviewerFeedback: Boolean
    20
    21# If true, interviewers can select filesystem-enabled/multi-file tasks during an
    22# interview.
    23liveFilesystem: Boolean
    24
    25# If true, users can create/copy a public URL for inviting test-takers to complete
    26# a certified test.
    27publicCertificationLink: Boolean
    28
    29# If true, ATS integrations are enabled.
    30atsIntegration: Boolean
    31
    32# If true, API integration is enabled.
    33apiIntegration: Boolean
    34
    35# If true, SSO is enabled.
    36sso: Boolean
    37
    38# If true, the company requests will not be proctored.
    39shouldBypassProctoring: Boolean
    40
    41# List of certification tests that company has access to.
    42certificationTests: [StandardizedTest]
    43
    44# List of task sets that company has access to.
    45taskSets: [String]
    46
    47}
    -
    -
    -
    - -
    -
    -
    -

    - Generated with graphqldoc 2.5.2 -

    +
    +
    + +
    +
    +
    +
    +

    OBJECT

    +

    CompanyFeatures

    +

    Features that can be set on a service plan or a company.

    -
    + + +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1type CompanyFeatures {
    2
    3# The number of permitted user licenses.
    4numLicenses: Int
    5
    6# The number of certification credits available on a plan. One credit is used to
    7# send one certification request.
    8certifyCredits: Int
    9
    10# The lifetime of user passwords in days after which they will expire and require
    11# to be changed. Setting this number to 0 will disable the expiration.
    12passwordExpirationDays: Int
    13
    14# If true, candidates are not prompted to leave feedback in CodeSignal after an
    15# interview.
    16skipInterviewFeedback: Boolean
    17
    18# If true, feedback fileds are disabled for interviewer.
    19skipInterviewerFeedback: Boolean
    20
    21# If true, interviewers can select filesystem-enabled/multi-file tasks during an
    22# interview.
    23liveFilesystem: Boolean
    24
    25# If true, users can create/copy a public URL for inviting test-takers to complete
    26# a certified test.
    27publicCertificationLink: Boolean
    28
    29# If true, ATS integrations are enabled.
    30atsIntegration: Boolean
    31
    32# If true, API integration is enabled.
    33apiIntegration: Boolean
    34
    35# If true, SSO is enabled.
    36sso: Boolean
    37
    38# If true, the company requests will not be proctored.
    39shouldBypassProctoring: Boolean
    40
    41# List of certification tests that company has access to.
    42certificationTests: [StandardizedTest]
    43
    44# List of task sets that company has access to.
    45taskSets: [String]
    46
    47}
    +
    +
    +
    + +
    +
    diff --git a/docs/graphql/types/companyfeaturestatus.doc.html b/docs/graphql/types/companyfeaturestatus.doc.html index 2ad0752c..b409d333 100644 --- a/docs/graphql/types/companyfeaturestatus.doc.html +++ b/docs/graphql/types/companyfeaturestatus.doc.html @@ -23,568 +23,648 @@
    -
    -
    - -
    -
    - -
    -

    ENUM

    -

    CompanyFeatureStatus

    -
    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1enum CompanyFeatureStatus {
    2
    3enabled
    4
    5disabled
    6}
    -
    -
    -
    - -
    - +
    +
    + +
    +
    + +
    +

    ENUM

    +

    CompanyFeatureStatus

    +
    +
    + +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1enum CompanyFeatureStatus {
    2
    3enabled
    4
    5disabled
    6}
    +
    +
    +
    + +
    +
    diff --git a/docs/graphql/types/companyplan.doc.html b/docs/graphql/types/companyplan.doc.html index ee18628d..dadcdf31 100644 --- a/docs/graphql/types/companyplan.doc.html +++ b/docs/graphql/types/companyplan.doc.html @@ -23,569 +23,649 @@
    -
    -
    - -
    -
    - -
    -

    OBJECT

    -

    CompanyPlan

    -

    A company plan is a grouping of information about a company's service plan and billing periods for that plan.

    -
    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1type CompanyPlan {
    2
    3servicePlan: ServicePlan
    4
    5startDate: Timestamp
    6
    7expireDate: Timestamp
    8
    9newServicePlan: ServicePlan
    10
    11nextInvoice: Invoice
    12
    13paymentSource: CreditCard
    14
    15}
    -
    -
    -
    - -
    -
    -
    -

    - Generated with graphqldoc 2.5.2 -

    +
    +
    + +
    +
    +
    +
    +

    OBJECT

    +

    CompanyPlan

    +

    A company plan is a grouping of information about a company's service plan and billing periods for that plan.

    -
    + + +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1type CompanyPlan {
    2
    3servicePlan: ServicePlan
    4
    5startDate: Timestamp
    6
    7expireDate: Timestamp
    8
    9newServicePlan: ServicePlan
    10
    11nextInvoice: Invoice
    12
    13paymentSource: CreditCard
    14
    15}
    +
    +
    +
    + +
    +
    diff --git a/docs/graphql/types/companyplaninput.doc.html b/docs/graphql/types/companyplaninput.doc.html index 5da30dc7..a53293d1 100644 --- a/docs/graphql/types/companyplaninput.doc.html +++ b/docs/graphql/types/companyplaninput.doc.html @@ -23,569 +23,649 @@
    -
    -
    - -
    -
    - -
    -

    INPUT_OBJECT

    -

    CompanyPlanInput

    -

    Information about a plan that will be assigned to a company.

    -
    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1input CompanyPlanInput {
    3
    2planKey: ID!
    5
    4startDate: Timestamp
    7
    6expireDate: Timestamp
    9
    8newPlanKey: ID
    10}
    -
    -
    -
    - -
    -
    -
    -

    - Generated with graphqldoc 2.5.2 -

    +
    +
    + +
    +
    +
    +
    +

    INPUT_OBJECT

    +

    CompanyPlanInput

    +

    Information about a plan that will be assigned to a company.

    -
    + + +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1input CompanyPlanInput {
    3
    2planKey: ID!
    5
    4startDate: Timestamp
    7
    6expireDate: Timestamp
    9
    8newPlanKey: ID
    10}
    +
    +
    +
    + +
    +
    diff --git a/docs/graphql/types/companyplansettingsinput.doc.html b/docs/graphql/types/companyplansettingsinput.doc.html index b93166c8..9976badd 100644 --- a/docs/graphql/types/companyplansettingsinput.doc.html +++ b/docs/graphql/types/companyplansettingsinput.doc.html @@ -23,569 +23,649 @@
    -
    -
    - -
    -
    - -
    -

    INPUT_OBJECT

    -

    CompanyPlanSettingsInput

    -

    Input type for mutating a company's plans and custom features.

    -
    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1input CompanyPlanSettingsInput {
    4
    2# Custom features to set on the company, which will override plan settings.
    3customFeatures: CustomFeaturesInput!
    7
    5# Plans to assign to the company.
    6plans: [CompanyPlanInput]!
    8}
    -
    -
    -
    - -
    -
    -
    -

    - Generated with graphqldoc 2.5.2 -

    +
    +
    + +
    +
    +
    +
    +

    INPUT_OBJECT

    +

    CompanyPlanSettingsInput

    +

    Input type for mutating a company's plans and custom features.

    -
    + + +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1input CompanyPlanSettingsInput {
    4
    2# Custom features to set on the company, which will override plan settings.
    3customFeatures: CustomFeaturesInput!
    7
    5# Plans to assign to the company.
    6plans: [CompanyPlanInput]!
    8}
    +
    +
    +
    +
    +

    + + link + + Required by +

    + +
    +
    +
    diff --git a/docs/graphql/types/companytest.doc.html b/docs/graphql/types/companytest.doc.html index 6820e39d..b27bc3e9 100644 --- a/docs/graphql/types/companytest.doc.html +++ b/docs/graphql/types/companytest.doc.html @@ -23,569 +23,649 @@
    -
    -
    - -
    -
    - -
    -

    OBJECT

    -

    CompanyTest

    -

    A non-standardized test owned by a particular company.

    -
    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1type CompanyTest implements Test {
    2
    3# Company test ID.
    4id: ID!
    5
    6# The display name of the test.
    7title: String!
    8
    9# A message shown to users before they begin an assessment created from the test.
    10introMessage: String!
    11
    12# A message shown to users after they finish an assessment created from the test.
    13outroMessage: String!
    14
    15# The maximum time allowed to take the test, in milliseconds.
    16duration: Int!
    17
    18# The company that owns this test.
    19company: Company!
    20
    21# Test session fetched by its unique ID.
    22#
    23# Arguments
    24# id: The ID of the test session to return.
    25testSession(id: ID!): CompanyTestSession
    26
    27# A list of all test sessions of this test.
    28# Use 'first' and 'offset' arguments to limit results returned.
    29testSessions(first: Int, offset: Int): [CompanyTestSession]
    30
    31}
    -
    -
    -
    - -
    -
    -
    -

    - Generated with graphqldoc 2.5.2 -

    +
    +
    + +
    +
    +
    +
    +

    OBJECT

    +

    CompanyTest

    +

    A non-standardized test owned by a particular company.

    -
    + + +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1type CompanyTest implements Test {
    2
    3# Company test ID.
    4id: ID!
    5
    6# The display name of the test.
    7title: String!
    8
    9# The internal description of the test.
    10internalDescription: String!
    11
    12# A message shown to users before they begin an assessment created from the test.
    13introMessage: String!
    14
    15# A message shown to users after they finish an assessment created from the test.
    16outroMessage: String!
    17
    18# The maximum time allowed to take the test, in milliseconds.
    19duration: Int!
    20
    21# The company that owns this test.
    22company: Company!
    23
    24# Test labels
    25labels: [String]
    26
    27# Test session fetched by its unique ID.
    28#
    29# Arguments
    30# id: The ID of the test session to return.
    31testSession(id: ID!): CompanyTestSession
    32
    33# A list of all test sessions of this test.
    34# Use 'first' and 'offset' arguments to limit results returned.
    35testSessions(first: Int, offset: Int): [CompanyTestSession]
    36
    37# A list of score range labels.
    38scoreRangeLabels: [ScoreRangeLabel]
    39
    40}
    +
    +
    +
    + +
    +
    diff --git a/docs/graphql/types/companytestsession.doc.html b/docs/graphql/types/companytestsession.doc.html index 7981faa1..14ee3399 100644 --- a/docs/graphql/types/companytestsession.doc.html +++ b/docs/graphql/types/companytestsession.doc.html @@ -23,569 +23,649 @@
    -
    -
    - -
    -
    - -
    -

    OBJECT

    -

    CompanyTestSession

    -

    An session of a company test.

    -
    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1type CompanyTestSession implements TestSession {
    2
    3id: ID!
    4
    5# Associated company test from which this test session was created.
    6test: CompanyTest
    7
    8status: TestSessionStatus!
    9
    10testTaker: TestTaker!
    11
    12maxScore: Int!
    13
    14# When the test-taker actually began the test session.
    15startDate: Timestamp
    16
    17# When the test-taker completed the test session.
    18finishDate: Timestamp
    19
    20# The test-taker's feedback after completing the test session.
    21feedback: TestSessionFeedback
    22
    23result: TestSessionResult
    24
    25tasks: [TestSessionTask]!
    26
    27# Arguments
    28# taskId: Unite task ID.
    29task(taskId: ID): TestSessionTask
    30
    31# The URL the candidate can follow to take the assessment.
    32invitationUrl: String
    33
    34}
    -
    -
    -
    - -
    -
    -
    -

    - Generated with graphqldoc 2.5.2 -

    +
    +
    + +
    +
    +
    +
    +

    OBJECT

    +

    CompanyTestSession

    +

    An session of a company test.

    -
    + + +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1type CompanyTestSession implements TestSession {
    2
    3id: ID!
    4
    5# Associated company test from which this test session was created.
    6test: CompanyTest
    7
    8status: TestSessionStatus!
    9
    10testTaker: TestTaker!
    11
    12maxScore: Int!
    13
    14# When the test-taker actually began the test session.
    15startDate: Timestamp
    16
    17# When the test-taker completed the test session.
    18finishDate: Timestamp
    19
    20# The test-taker's feedback after completing the test session.
    21feedback: TestSessionFeedback
    22
    23result: TestSessionResult
    24
    25tasks: [TestSessionTask]!
    26
    27# Arguments
    28# taskId: Unique task ID.
    29task(taskId: ID): TestSessionTask
    30
    31# The URL the candidate can follow to take the assessment.
    32invitationUrl: String
    33
    34}
    +
    +
    +
    + +
    +
    diff --git a/docs/graphql/types/contact.doc.html b/docs/graphql/types/contact.doc.html index eac6b5c8..405a70a5 100644 --- a/docs/graphql/types/contact.doc.html +++ b/docs/graphql/types/contact.doc.html @@ -23,569 +23,649 @@
    -
    -
    - -
    -
    - -
    -

    OBJECT

    -

    Contact

    -

    A company contact

    -
    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1type Contact {
    2
    3# The ID of the contact. (Not a CodeSignal user ID.)
    4id: ID
    5
    6}
    -
    -
    -
    - -
    -
    -
    -

    - Generated with graphqldoc 2.5.2 -

    +
    +
    + +
    +
    +
    +
    +

    OBJECT

    +

    Contact

    +

    A company contact

    -
    + + +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1type Contact {
    2
    3# The ID of the contact. (Not a CodeSignal user ID.)
    4id: ID
    5
    6}
    +
    +
    +
    + +
    +
    diff --git a/docs/graphql/types/cost.doc.html b/docs/graphql/types/cost.doc.html index 28b8ef1a..1788c91f 100644 --- a/docs/graphql/types/cost.doc.html +++ b/docs/graphql/types/cost.doc.html @@ -23,568 +23,648 @@
    -
    -
    - -
    -
    - -
    -

    -

    cost

    -
    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1directive @cost(multipliers: [String], useMultipliers: Boolean, complexity: Int!) on FIELD_DEFINITION | OBJECT
    -
    -
    -
    -
    -

    - - link - - Required by -

    -
    This element is not required by anyone
    -
    -
    - +
    +
    + +
    +
    + +
    +

    +

    cost

    +
    +
    + +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1directive @cost(multipliers: [String], useMultipliers: Boolean, complexity: Int!) on FIELD_DEFINITION | OBJECT
    +
    +
    +
    +
    +

    + + link + + Required by +

    +
    This element is not required by anyone
    +
    +
    +
    diff --git a/docs/graphql/types/country.doc.html b/docs/graphql/types/country.doc.html index c227d3b3..d6295533 100644 --- a/docs/graphql/types/country.doc.html +++ b/docs/graphql/types/country.doc.html @@ -23,570 +23,650 @@
    -
    -
    - -
    -
    - -
    -

    ENUM

    -

    Country

    -

    Alpha-2 ISO code of a country. +

    +
    + +
    +
    +
    +
    +

    ENUM

    +

    Country

    + -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1enum Country {
    2
    3AF
    4
    5AX
    6
    7AL
    8
    9DZ
    10
    11AS
    12
    13AD
    14
    15AO
    16
    17AI
    18
    19AQ
    20
    21AG
    22
    23AR
    24
    25AM
    26
    27AW
    28
    29AU
    30
    31AT
    32
    33AZ
    34
    35BS
    36
    37BH
    38
    39BD
    40
    41BB
    42
    43BY
    44
    45BE
    46
    47BZ
    48
    49BJ
    50
    51BM
    52
    53BT
    54
    55BO
    56
    57BQ
    58
    59BA
    60
    61BW
    62
    63BV
    64
    65BR
    66
    67IO
    68
    69BN
    70
    71BG
    72
    73BF
    74
    75BI
    76
    77KH
    78
    79CM
    80
    81CA
    82
    83CV
    84
    85KY
    86
    87CF
    88
    89TD
    90
    91CL
    92
    93CN
    94
    95CX
    96
    97CC
    98
    99CO
    100
    101KM
    102
    103CG
    104
    105CD
    106
    107CK
    108
    109CR
    110
    111CI
    112
    113HR
    114
    115CU
    116
    117CW
    118
    119CY
    120
    121CZ
    122
    123DK
    124
    125DJ
    126
    127DM
    128
    129DO
    130
    131EC
    132
    133EG
    134
    135SV
    136
    137GQ
    138
    139ER
    140
    141EE
    142
    143ET
    144
    145FK
    146
    147FO
    148
    149FJ
    150
    151FI
    152
    153FR
    154
    155GF
    156
    157PF
    158
    159TF
    160
    161GA
    162
    163GM
    164
    165GE
    166
    167DE
    168
    169GH
    170
    171GI
    172
    173GR
    174
    175GL
    176
    177GD
    178
    179GP
    180
    181GU
    182
    183GT
    184
    185GG
    186
    187GN
    188
    189GW
    190
    191GY
    192
    193HT
    194
    195HM
    196
    197VA
    198
    199HN
    200
    201HK
    202
    203HU
    204
    205IS
    206
    207IN
    208
    209ID
    210
    211IR
    212
    213IQ
    214
    215IE
    216
    217IM
    218
    219IL
    220
    221IT
    222
    223JM
    224
    225JP
    226
    227JE
    228
    229JO
    230
    231KZ
    232
    233KE
    234
    235KI
    236
    237KP
    238
    239KR
    240
    241KW
    242
    243KG
    244
    245LA
    246
    247LV
    248
    249LB
    250
    251LS
    252
    253LR
    254
    255LY
    256
    257LI
    258
    259LT
    260
    261LU
    262
    263MO
    264
    265MK
    266
    267MG
    268
    269MW
    270
    271MY
    272
    273MV
    274
    275ML
    276
    277MT
    278
    279MH
    280
    281MQ
    282
    283MR
    284
    285MU
    286
    287YT
    288
    289MX
    290
    291FM
    292
    293MD
    294
    295MC
    296
    297MN
    298
    299ME
    300
    301MS
    302
    303MA
    304
    305MZ
    306
    307MM
    308
    309NA
    310
    311NR
    312
    313NP
    314
    315NL
    316
    317NC
    318
    319NZ
    320
    321NI
    322
    323NE
    324
    325NG
    326
    327NU
    328
    329NF
    330
    331MP
    332
    333NO
    334
    335OM
    336
    337PK
    338
    339PW
    340
    341PS
    342
    343PA
    344
    345PG
    346
    347PY
    348
    349PE
    350
    351PH
    352
    353PN
    354
    355PL
    356
    357PT
    358
    359PR
    360
    361QA
    362
    363RE
    364
    365RO
    366
    367RU
    368
    369RW
    370
    371BL
    372
    373SH
    374
    375KN
    376
    377LC
    378
    379MF
    380
    381PM
    382
    383VC
    384
    385WS
    386
    387SM
    388
    389ST
    390
    391SA
    392
    393SN
    394
    395RS
    396
    397SC
    398
    399SL
    400
    401SG
    402
    403SX
    404
    405SK
    406
    407SI
    408
    409SB
    410
    411SO
    412
    413ZA
    414
    415GS
    416
    417SS
    418
    419ES
    420
    421LK
    422
    423SD
    424
    425SR
    426
    427SJ
    428
    429SZ
    430
    431SE
    432
    433CH
    434
    435SY
    436
    437TW
    438
    439TJ
    440
    441TZ
    442
    443TH
    444
    445TL
    446
    447TG
    448
    449TK
    450
    451TO
    452
    453TT
    454
    455TN
    456
    457TR
    458
    459TM
    460
    461TC
    462
    463TV
    464
    465UG
    466
    467UA
    468
    469AE
    470
    471GB
    472
    473US
    474
    475UM
    476
    477UY
    478
    479UZ
    480
    481VU
    482
    483VE
    484
    485VN
    486
    487VG
    488
    489VI
    490
    491WF
    492
    493EH
    494
    495YE
    496
    497ZM
    498
    499ZW
    500}
    -
    -
    -
    -
    -

    - - link - - Required by -

    - -
    -
    - + + +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1enum Country {
    2
    3AF
    4
    5AX
    6
    7AL
    8
    9DZ
    10
    11AS
    12
    13AD
    14
    15AO
    16
    17AI
    18
    19AQ
    20
    21AG
    22
    23AR
    24
    25AM
    26
    27AW
    28
    29AU
    30
    31AT
    32
    33AZ
    34
    35BS
    36
    37BH
    38
    39BD
    40
    41BB
    42
    43BY
    44
    45BE
    46
    47BZ
    48
    49BJ
    50
    51BM
    52
    53BT
    54
    55BO
    56
    57BQ
    58
    59BA
    60
    61BW
    62
    63BV
    64
    65BR
    66
    67IO
    68
    69BN
    70
    71BG
    72
    73BF
    74
    75BI
    76
    77KH
    78
    79CM
    80
    81CA
    82
    83CV
    84
    85KY
    86
    87CF
    88
    89TD
    90
    91CL
    92
    93CN
    94
    95CX
    96
    97CC
    98
    99CO
    100
    101KM
    102
    103CG
    104
    105CD
    106
    107CK
    108
    109CR
    110
    111CI
    112
    113HR
    114
    115CU
    116
    117CW
    118
    119CY
    120
    121CZ
    122
    123DK
    124
    125DJ
    126
    127DM
    128
    129DO
    130
    131EC
    132
    133EG
    134
    135SV
    136
    137GQ
    138
    139ER
    140
    141EE
    142
    143ET
    144
    145FK
    146
    147FO
    148
    149FJ
    150
    151FI
    152
    153FR
    154
    155GF
    156
    157PF
    158
    159TF
    160
    161GA
    162
    163GM
    164
    165GE
    166
    167DE
    168
    169GH
    170
    171GI
    172
    173GR
    174
    175GL
    176
    177GD
    178
    179GP
    180
    181GU
    182
    183GT
    184
    185GG
    186
    187GN
    188
    189GW
    190
    191GY
    192
    193HT
    194
    195HM
    196
    197VA
    198
    199HN
    200
    201HK
    202
    203HU
    204
    205IS
    206
    207IN
    208
    209ID
    210
    211IR
    212
    213IQ
    214
    215IE
    216
    217IM
    218
    219IL
    220
    221IT
    222
    223JM
    224
    225JP
    226
    227JE
    228
    229JO
    230
    231KZ
    232
    233KE
    234
    235KI
    236
    237KP
    238
    239KR
    240
    241KW
    242
    243KG
    244
    245LA
    246
    247LV
    248
    249LB
    250
    251LS
    252
    253LR
    254
    255LY
    256
    257LI
    258
    259LT
    260
    261LU
    262
    263MO
    264
    265MK
    266
    267MG
    268
    269MW
    270
    271MY
    272
    273MV
    274
    275ML
    276
    277MT
    278
    279MH
    280
    281MQ
    282
    283MR
    284
    285MU
    286
    287YT
    288
    289MX
    290
    291FM
    292
    293MD
    294
    295MC
    296
    297MN
    298
    299ME
    300
    301MS
    302
    303MA
    304
    305MZ
    306
    307MM
    308
    309NA
    310
    311NR
    312
    313NP
    314
    315NL
    316
    317NC
    318
    319NZ
    320
    321NI
    322
    323NE
    324
    325NG
    326
    327NU
    328
    329NF
    330
    331MP
    332
    333NO
    334
    335OM
    336
    337PK
    338
    339PW
    340
    341PS
    342
    343PA
    344
    345PG
    346
    347PY
    348
    349PE
    350
    351PH
    352
    353PN
    354
    355PL
    356
    357PT
    358
    359PR
    360
    361QA
    362
    363RE
    364
    365RO
    366
    367RU
    368
    369RW
    370
    371BL
    372
    373SH
    374
    375KN
    376
    377LC
    378
    379MF
    380
    381PM
    382
    383VC
    384
    385WS
    386
    387SM
    388
    389ST
    390
    391SA
    392
    393SN
    394
    395RS
    396
    397SC
    398
    399SL
    400
    401SG
    402
    403SX
    404
    405SK
    406
    407SI
    408
    409SB
    410
    411SO
    412
    413ZA
    414
    415GS
    416
    417SS
    418
    419ES
    420
    421LK
    422
    423SD
    424
    425SR
    426
    427SJ
    428
    429SZ
    430
    431SE
    432
    433CH
    434
    435SY
    436
    437TW
    438
    439TJ
    440
    441TZ
    442
    443TH
    444
    445TL
    446
    447TG
    448
    449TK
    450
    451TO
    452
    453TT
    454
    455TN
    456
    457TR
    458
    459TM
    460
    461TC
    462
    463TV
    464
    465UG
    466
    467UA
    468
    469AE
    470
    471GB
    472
    473US
    474
    475UM
    476
    477UY
    478
    479UZ
    480
    481VU
    482
    483VE
    484
    485VN
    486
    487VG
    488
    489VI
    490
    491WF
    492
    493EH
    494
    495YE
    496
    497ZM
    498
    499ZW
    500}
    +
    +
    +
    +
    +

    + + link + + Required by +

    + +
    +
    +
    diff --git a/docs/graphql/types/createcertificationrequestinput.doc.html b/docs/graphql/types/createcertificationrequestinput.doc.html index e1e6b356..9040b747 100644 --- a/docs/graphql/types/createcertificationrequestinput.doc.html +++ b/docs/graphql/types/createcertificationrequestinput.doc.html @@ -23,568 +23,648 @@
    -
    -
    - -
    -
    - -
    -

    INPUT_OBJECT

    -

    CreateCertificationRequestInput

    -
    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1input CreateCertificationRequestInput {
    4
    2# The name of the candidate.
    3candidateName: String!
    7
    5# Candidate email.
    6candidateEmail: String!
    10
    8# ID of the certification test.
    9testId: ID!
    13
    11# ID of the company. If not provided, your company ID will be implicitly used.
    12companyId: ID
    14}
    -
    -
    -
    - -
    - +
    +
    + +
    +
    + +
    +

    INPUT_OBJECT

    +

    CreateCertificationRequestInput

    +
    +
    + +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1input CreateCertificationRequestInput {
    4
    2# The name of the candidate.
    3candidateName: String!
    7
    5# Candidate email.
    6candidateEmail: String!
    10
    8# ID of the certification test.
    9testId: ID!
    13
    11# ID of the company. If not provided, your company ID will be implicitly used.
    12companyId: ID
    14}
    +
    +
    +
    +
    +

    + + link + + Required by +

    + +
    +
    +
    diff --git a/docs/graphql/types/createcompanytestinput.doc.html b/docs/graphql/types/createcompanytestinput.doc.html index aeede961..0b80c8dc 100644 --- a/docs/graphql/types/createcompanytestinput.doc.html +++ b/docs/graphql/types/createcompanytestinput.doc.html @@ -23,568 +23,648 @@
    -
    -
    - -
    -
    - -
    -

    INPUT_OBJECT

    -

    CreateCompanyTestInput

    -
    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1input CreateCompanyTestInput {
    4
    2# A message shown to users before they begin an assessment created from the test.
    3introMessage: String!
    7
    5# A message shown to users after they finish an assessment created from the test.
    6outroMessage: String!
    10
    8# Duration of the test in milliseconds. Should be at least 5 minutes.
    9duration: Int!
    13
    11# The title of the test.
    12title: String!
    16
    14# A list a task slots.
    15tasks: [TaskSlotInput]!
    19
    17# The ID of the company that owns the test
    18companyId: ID
    22
    20# The subject line shown in the test invitation email.
    21emailSubject: String
    25
    23# The message shown in the test invitation email.
    24emailMessage: String
    28
    26# The default expiration time of a test invitation in milliseconds.
    27defaultExpiration: Int
    31
    29# Time zone database name, e.g. America/Los_Angeles.
    30timeZone: String
    35
    32# The CodeSignal user ID of the default sender of test invitations (used when
    33# invitations are sent from an applicant tracking system).
    34defaultSender: ID
    38
    36# When set to true, the summary section will be hidden in the screen report.
    37hideBasicInfo: Boolean
    41
    39# Additional fields used by CodeSignal admins only.
    40adminFields: AdminFieldsInput
    42}
    -
    -
    -
    - -
    - +
    +
    + +
    +
    + +
    +

    INPUT_OBJECT

    +

    CreateCompanyTestInput

    +
    +
    + +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1input CreateCompanyTestInput {
    4
    2# The internal description of the test.
    3internalDescription: String
    7
    5# A message shown to users before they begin an assessment created from the test.
    6introMessage: String!
    10
    8# A message shown to users after they finish an assessment created from the test.
    9outroMessage: String!
    13
    11# Duration of the test in milliseconds. Should be at least 5 minutes.
    12duration: Int!
    16
    14# The title of the test.
    15title: String!
    19
    17# A list a task slots.
    18tasks: [TaskSlotInput]!
    22
    20# The ID of the company that owns the test
    21companyId: ID
    25
    23# The subject line shown in the test invitation email.
    24emailSubject: String
    28
    26# The message shown in the test invitation email.
    27emailMessage: String
    31
    29# The default expiration time of a test invitation in milliseconds.
    30defaultExpiration: Int
    34
    32# Time zone database name, e.g. America/Los_Angeles.
    33timeZone: String
    38
    35# The CodeSignal user ID of the default sender of test invitations (used when
    36# invitations are sent from an applicant tracking system).
    37defaultSender: ID
    41
    39# Test labels
    40labels: [String]
    45
    42# Automatically assign a label when the candidate scores within a given inclusive
    43# range.
    44scoreRangeLabels: [ScoreRangeLabelInput]
    48
    46# When set to true, the summary section will be hidden in the screen report.
    47hideBasicInfo: Boolean
    51
    49# Additional fields used by CodeSignal admins only.
    50adminFields: AdminFieldsInput
    52}
    +
    +
    +
    +
    +

    + + link + + Required by +

    + +
    +
    +
    diff --git a/docs/graphql/types/createquizinput.doc.html b/docs/graphql/types/createquizinput.doc.html index bd6f13ed..192f23cc 100644 --- a/docs/graphql/types/createquizinput.doc.html +++ b/docs/graphql/types/createquizinput.doc.html @@ -23,568 +23,648 @@
    -
    -
    - -
    -
    - -
    -

    INPUT_OBJECT

    -

    CreateQuizInput

    -
    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1input CreateQuizInput {
    4
    2# Task name.
    3name: String!
    7
    5# Task description.
    6description: String!
    10
    8# The options for this quiz task.
    9options: [QuizOptionInput]!
    13
    11# Whether the task allows selecting more than one option.
    12multipleChoice: Boolean!
    14}
    -
    -
    -
    - -
    - +
    +
    + +
    +
    + +
    +

    INPUT_OBJECT

    +

    CreateQuizInput

    +
    +
    + +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1input CreateQuizInput {
    4
    2# Unique task name.
    3name: String!
    7
    5# The display title of the task.
    6title: String
    10
    8# Task description.
    9description: String!
    13
    11# The options for this quiz task.
    12options: [QuizOptionInput]!
    16
    14# Whether the task allows selecting more than one option.
    15multipleSelect: Boolean!
    17}
    +
    +
    +
    +
    +

    + + link + + Required by +

    + +
    +
    +
    diff --git a/docs/graphql/types/createstandardtaskinput.doc.html b/docs/graphql/types/createstandardtaskinput.doc.html index 46928913..1bf42b55 100644 --- a/docs/graphql/types/createstandardtaskinput.doc.html +++ b/docs/graphql/types/createstandardtaskinput.doc.html @@ -23,568 +23,648 @@
    -
    -
    - -
    -
    - -
    -

    INPUT_OBJECT

    -

    CreateStandardTaskInput

    -
    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1input CreateStandardTaskInput {
    4
    2# Task Name.
    3name: String!
    7
    5# Task description.
    6description: String!
    10
    8# A list of input formats.
    9inputFormat: [TaskInputArgumentInfo]!
    13
    11# Output format.
    12outputFormat: TaskOutputInfo!
    16
    14# A list of test cases.
    15testcases: [TestcaseInput]!
    19
    17# The number of tests that will be made visible to the test-taker.
    18sampleTestCount: Int
    20}
    -
    -
    -
    - -
    - +
    +
    + +
    +
    + +
    +

    INPUT_OBJECT

    +

    CreateStandardTaskInput

    +
    +
    + +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1input CreateStandardTaskInput {
    7
    2# Unique task name, which will also be used as the name of the function signature
    3# in the code.
    4# Has to be a valid identifier - should start with a letter and should not contain
    5# spaces.
    6name: String!
    10
    8# The title of the task is the more user-friendly version of the task name.
    9title: String
    12
    11description: String
    14
    13inputFormat: [TaskInputArgumentInfo]
    16
    15outputFormat: TaskOutputInfo
    18
    17testcases: [TestcaseInput]
    21
    19# The number of testcases that will be made visible to the test-taker.
    20sampleTestCount: Int
    25
    22# The list of all the languages that are allowed to be used in this task,
    23# or an empty list to allow all possible languages.
    24allowedLanguages: [CodingLanguage]
    33
    26# A list that describes customized execution time limits for one or more
    27# languages.
    28# If a language is not specified in the list, its execution time limit will be set
    29# to the default.
    30# In particular, you can pass an empty list to reset the time limits for all
    31# languages to the default.
    32timeLimits: [LanguageTimeLimit]
    34}
    +
    +
    +
    +
    +

    + + link + + Required by +

    + +
    +
    +
    diff --git a/docs/graphql/types/createtaskoptionsinput.doc.html b/docs/graphql/types/createtaskoptionsinput.doc.html index 9865091a..b0557324 100644 --- a/docs/graphql/types/createtaskoptionsinput.doc.html +++ b/docs/graphql/types/createtaskoptionsinput.doc.html @@ -23,568 +23,648 @@
    -
    -
    - -
    -
    - -
    -

    INPUT_OBJECT

    -

    CreateTaskOptionsInput

    -
    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1input CreateTaskOptionsInput {
    6
    2# The ID of the company that the task should be associated with.
    3# Can be provided only when the requestor has permissions to create tasks for
    4# other companies
    5companyId: ID
    7}
    -
    -
    -
    - -
    - +
    +
    + +
    +
    + +
    +

    INPUT_OBJECT

    +

    CreateTaskOptionsInput

    +
    +
    + +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1input CreateTaskOptionsInput {
    6
    2# The ID of the company that the task should be associated with.
    3# Can be provided only when the requestor has permissions to create tasks for
    4# other companies
    5companyId: ID
    7}
    +
    +
    +
    +
    +

    + + link + + Required by +

    + +
    +
    +
    diff --git a/docs/graphql/types/creditcard.doc.html b/docs/graphql/types/creditcard.doc.html index a47b1771..2ef74cb9 100644 --- a/docs/graphql/types/creditcard.doc.html +++ b/docs/graphql/types/creditcard.doc.html @@ -23,568 +23,648 @@
    -
    -
    - -
    -
    - -
    -

    OBJECT

    -

    CreditCard

    -
    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1type CreditCard {
    2
    3id: ID
    4
    5lastFour: String
    6
    7expireMonth: Int
    8
    9expireYear: Int
    10
    11brand: CreditCardBrand
    12
    13}
    -
    -
    -
    - -
    - +
    +
    + +
    +
    + +
    +

    OBJECT

    +

    CreditCard

    +
    +
    + +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1type CreditCard {
    2
    3id: ID
    4
    5lastFour: String
    6
    7expireMonth: Int
    8
    9expireYear: Int
    10
    11brand: CreditCardBrand
    12
    13}
    +
    +
    +
    + +
    +
    diff --git a/docs/graphql/types/creditcardbrand.doc.html b/docs/graphql/types/creditcardbrand.doc.html index 0b97b819..1797ced7 100644 --- a/docs/graphql/types/creditcardbrand.doc.html +++ b/docs/graphql/types/creditcardbrand.doc.html @@ -23,568 +23,648 @@
    -
    -
    - -
    -
    - -
    -

    ENUM

    -

    CreditCardBrand

    -
    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1enum CreditCardBrand {
    2
    3american_express
    4
    5diners_club
    6
    7discover
    8
    9jcb
    10
    11mastercard
    12
    13unionpay
    14
    15visa
    16
    17unknown
    18}
    -
    -
    -
    -
    -

    - - link - - Required by -

    - -
    -
    - +
    +
    + +
    +
    + +
    +

    ENUM

    +

    CreditCardBrand

    +
    +
    + +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1enum CreditCardBrand {
    2
    3american_express
    4
    5diners_club
    6
    7discover
    8
    9jcb
    10
    11mastercard
    12
    13unionpay
    14
    15visa
    16
    17unknown
    18}
    +
    +
    +
    +
    +

    + + link + + Required by +

    + +
    +
    +
    diff --git a/docs/graphql/types/customfeaturesinput.doc.html b/docs/graphql/types/customfeaturesinput.doc.html index 2b676d5d..512969a6 100644 --- a/docs/graphql/types/customfeaturesinput.doc.html +++ b/docs/graphql/types/customfeaturesinput.doc.html @@ -23,569 +23,649 @@
    -
    -
    - -
    -
    - -
    -

    INPUT_OBJECT

    -

    CustomFeaturesInput

    -

    Features that can be set on a company. See CompanyFeatures type for full descriptions.

    -
    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1input CustomFeaturesInput {
    3
    2numLicenses: Int
    5
    4certifyCredits: Int
    7
    6passwordExpirationDays: Int
    9
    8skipInterviewFeedback: Boolean
    11
    10skipInterviewerFeedback: Boolean
    13
    12liveFilesystem: Boolean
    15
    14publicCertificationLink: Boolean
    17
    16atsIntegration: Boolean
    19
    18apiIntegration: Boolean
    21
    20sso: Boolean
    23
    22shouldBypassProctoring: Boolean
    25
    24certificationTestIds: [ID]
    27
    26taskSets: [String]
    28}
    -
    -
    -
    - -
    -
    -
    -

    - Generated with graphqldoc 2.5.2 -

    +
    +
    + +
    +
    +
    +
    +

    INPUT_OBJECT

    +

    CustomFeaturesInput

    +

    Features that can be set on a company. See CompanyFeatures type for full descriptions.

    -
    + + +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1input CustomFeaturesInput {
    3
    2numLicenses: Int
    5
    4certifyCredits: Int
    7
    6passwordExpirationDays: Int
    9
    8skipInterviewFeedback: Boolean
    11
    10skipInterviewerFeedback: Boolean
    13
    12liveFilesystem: Boolean
    15
    14publicCertificationLink: Boolean
    17
    16atsIntegration: Boolean
    19
    18apiIntegration: Boolean
    21
    20sso: Boolean
    23
    22shouldBypassProctoring: Boolean
    25
    24certificationTestIds: [ID]
    27
    26taskSets: [String]
    28}
    +
    +
    +
    + +
    +
    diff --git a/docs/graphql/types/deprecated.doc.html b/docs/graphql/types/deprecated.doc.html index 2e1abaa0..3ada8c81 100644 --- a/docs/graphql/types/deprecated.doc.html +++ b/docs/graphql/types/deprecated.doc.html @@ -23,569 +23,649 @@
    -
    -
    - -
    -
    - -
    -

    -

    deprecated

    -

    Marks an element of a GraphQL schema as no longer supported.

    -
    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1directive @deprecated(reason: String) on FIELD_DEFINITION | ENUM_VALUE
    -
    -
    -
    -
    -

    - - link - - Required by -

    -
    This element is not required by anyone
    -
    -
    -
    -
    -

    - Generated with graphqldoc 2.5.2 -

    +
    +
    + +
    +
    +
    +
    +

    +

    deprecated

    +

    Marks an element of a GraphQL schema as no longer supported.

    -
    + + +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1directive @deprecated(reason: String) on FIELD_DEFINITION | ENUM_VALUE
    +
    +
    +
    +
    +

    + + link + + Required by +

    +
    This element is not required by anyone
    +
    +
    +
    diff --git a/docs/graphql/types/directive.spec.html b/docs/graphql/types/directive.spec.html index 73ee4177..3a485aaa 100644 --- a/docs/graphql/types/directive.spec.html +++ b/docs/graphql/types/directive.spec.html @@ -23,570 +23,650 @@
    -
    -
    - -
    -
    - -
    -

    OBJECT

    -

    __Directive

    -

    A Directive provides a way to describe alternate runtime execution and type validation behavior in a GraphQL document.

    +
    +
    + +
    +
    +
    +
    +

    OBJECT

    +

    __Directive

    +

    A Directive provides a way to describe alternate runtime execution and type validation behavior in a GraphQL document.

    In some cases, you need to provide options to alter GraphQL's execution behavior in ways field arguments will not suffice, such as conditionally including or skipping a field. Directives provide this by describing additional information to the executor.

    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1type __Directive {
    2
    3name: String!
    4
    5description: String
    6
    7locations: [__DirectiveLocation!]!
    8
    9args: [__InputValue!]!
    10
    11}
    -
    -
    -
    - -
    - + + +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1type __Directive {
    2
    3name: String!
    4
    5description: String
    6
    7locations: [__DirectiveLocation!]!
    8
    9args: [__InputValue!]!
    10
    11}
    +
    +
    +
    + +
    +
    diff --git a/docs/graphql/types/directivelocation.spec.html b/docs/graphql/types/directivelocation.spec.html index d832f177..837d2c21 100644 --- a/docs/graphql/types/directivelocation.spec.html +++ b/docs/graphql/types/directivelocation.spec.html @@ -23,573 +23,653 @@
    -
    -
    - -
    -
    - -
    -

    ENUM

    -

    __DirectiveLocation

    -

    A Directive can be adjacent to many parts of the GraphQL language, a __DirectiveLocation describes one such possible adjacencies.

    +
    +
    + +
    +
    +
    +
    +

    ENUM

    +

    __DirectiveLocation

    +

    A Directive can be adjacent to many parts of the GraphQL language, a __DirectiveLocation describes one such possible adjacencies.

    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1enum __DirectiveLocation {
    2
    3# Location adjacent to a query operation.
    4QUERY
    5
    6# Location adjacent to a mutation operation.
    7MUTATION
    8
    9# Location adjacent to a subscription operation.
    10SUBSCRIPTION
    11
    12# Location adjacent to a field.
    13FIELD
    14
    15# Location adjacent to a fragment definition.
    16FRAGMENT_DEFINITION
    17
    18# Location adjacent to a fragment spread.
    19FRAGMENT_SPREAD
    20
    21# Location adjacent to an inline fragment.
    22INLINE_FRAGMENT
    23
    24# Location adjacent to a variable definition.
    25VARIABLE_DEFINITION
    26
    27# Location adjacent to a schema definition.
    28SCHEMA
    29
    30# Location adjacent to a scalar definition.
    31SCALAR
    32
    33# Location adjacent to an object type definition.
    34OBJECT
    35
    36# Location adjacent to a field definition.
    37FIELD_DEFINITION
    38
    39# Location adjacent to an argument definition.
    40ARGUMENT_DEFINITION
    41
    42# Location adjacent to an interface definition.
    43INTERFACE
    44
    45# Location adjacent to a union definition.
    46UNION
    47
    48# Location adjacent to an enum definition.
    49ENUM
    50
    51# Location adjacent to an enum value definition.
    52ENUM_VALUE
    53
    54# Location adjacent to an input object type definition.
    55INPUT_OBJECT
    56
    57# Location adjacent to an input object field definition.
    58INPUT_FIELD_DEFINITION
    59}
    -
    -
    -
    -
    -

    - - link - - Required by -

    -
    • +

      + + link + + GraphQL Schema definition +

      +
      1enum __DirectiveLocation {
      2
      3# Location adjacent to a query operation.
      4QUERY
      5
      6# Location adjacent to a mutation operation.
      7MUTATION
      8
      9# Location adjacent to a subscription operation.
      10SUBSCRIPTION
      11
      12# Location adjacent to a field.
      13FIELD
      14
      15# Location adjacent to a fragment definition.
      16FRAGMENT_DEFINITION
      17
      18# Location adjacent to a fragment spread.
      19FRAGMENT_SPREAD
      20
      21# Location adjacent to an inline fragment.
      22INLINE_FRAGMENT
      23
      24# Location adjacent to a variable definition.
      25VARIABLE_DEFINITION
      26
      27# Location adjacent to a schema definition.
      28SCHEMA
      29
      30# Location adjacent to a scalar definition.
      31SCALAR
      32
      33# Location adjacent to an object type definition.
      34OBJECT
      35
      36# Location adjacent to a field definition.
      37FIELD_DEFINITION
      38
      39# Location adjacent to an argument definition.
      40ARGUMENT_DEFINITION
      41
      42# Location adjacent to an interface definition.
      43INTERFACE
      44
      45# Location adjacent to a union definition.
      46UNION
      47
      48# Location adjacent to an enum definition.
      49ENUM
      50
      51# Location adjacent to an enum value definition.
      52ENUM_VALUE
      53
      54# Location adjacent to an input object type definition.
      55INPUT_OBJECT
      56
      57# Location adjacent to an input object field definition.
      58INPUT_FIELD_DEFINITION
      59}
      +
    +
    +
    + -
    - + + +
    diff --git a/docs/graphql/types/editcompanytestinput.doc.html b/docs/graphql/types/editcompanytestinput.doc.html index 6ab9a5c8..7391faf6 100644 --- a/docs/graphql/types/editcompanytestinput.doc.html +++ b/docs/graphql/types/editcompanytestinput.doc.html @@ -23,568 +23,648 @@
    -
    -
    - -
    -
    - -
    -

    INPUT_OBJECT

    -

    EditCompanyTestInput

    -
    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1input EditCompanyTestInput {
    4
    2# A message shown to users before they begin an assessment created from the test.
    3introMessage: String
    7
    5# A message shown to users after they finish an assessment created from the test.
    6outroMessage: String!
    10
    8# Duration of the test in milliseconds. Should be at least 5 minutes.
    9duration: Int
    13
    11# The title of the test.
    12title: String
    16
    14# A list a task slots.
    15tasks: [TaskSlotInput]
    19
    17# The subject line shown in the test invitation email.
    18emailSubject: String
    22
    20# The message shown in the test invitation email.
    21emailMessage: String
    25
    23# The default expiration time of a test invitation in milliseconds.
    24defaultExpiration: Int
    28
    26# Time zone database name, e.g. America/Los_Angeles.
    27timeZone: String
    32
    29# The CodeSignal user ID of the default sender of test invitations (used when
    30# invitations are sent from an applicant tracking system).
    31defaultSender: ID
    36
    33# When set to true, basic information will be hidden in the screen report,
    34# including candidate information, solved tasks, etc.
    35hideBasicInfo: Boolean
    39
    37# Additional fields used by CodeSignal admins only.
    38adminFields: AdminFieldsInput
    40}
    -
    -
    -
    - -
    - +
    +
    + +
    +
    + +
    +

    INPUT_OBJECT

    +

    EditCompanyTestInput

    +
    +
    + +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1input EditCompanyTestInput {
    4
    2# The internal description of the test.
    3internalDescription: String
    7
    5# A message shown to users before they begin an assessment created from the test.
    6introMessage: String
    10
    8# A message shown to users after they finish an assessment created from the test.
    9outroMessage: String
    13
    11# Duration of the test in milliseconds. Should be at least 5 minutes.
    12duration: Int
    16
    14# The title of the test.
    15title: String
    19
    17# A list a task slots.
    18tasks: [TaskSlotInput]
    22
    20# The subject line shown in the test invitation email.
    21emailSubject: String
    25
    23# The message shown in the test invitation email.
    24emailMessage: String
    28
    26# The default expiration time of a test invitation in milliseconds.
    27defaultExpiration: Int
    31
    29# Time zone database name, e.g. America/Los_Angeles.
    30timeZone: String
    35
    32# The CodeSignal user ID of the default sender of test invitations (used when
    33# invitations are sent from an applicant tracking system).
    34defaultSender: ID
    38
    36# Test labels
    37labels: [String]
    42
    39# Automatically assign a label when the candidate scores within a given inclusive
    40# range.
    41scoreRangeLabels: [ScoreRangeLabelInput]
    46
    43# When set to true, basic information will be hidden in the screen report,
    44# including candidate information, solved tasks, etc.
    45hideBasicInfo: Boolean
    49
    47# Additional fields used by CodeSignal admins only.
    48adminFields: AdminFieldsInput
    50}
    +
    +
    +
    +
    +

    + + link + + Required by +

    + +
    +
    +
    diff --git a/docs/graphql/types/editquizinput.doc.html b/docs/graphql/types/editquizinput.doc.html index c79b08fc..f3f13d39 100644 --- a/docs/graphql/types/editquizinput.doc.html +++ b/docs/graphql/types/editquizinput.doc.html @@ -23,568 +23,648 @@
    -
    -
    - -
    -
    - -
    -

    INPUT_OBJECT

    -

    EditQuizInput

    -
    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1input EditQuizInput {
    4
    2# Task description.
    3description: String
    7
    5# The options for this quiz task.
    6options: [QuizOptionInput]
    10
    8# Whether the task allows selecting more than one option.
    9multipleChoice: Boolean
    11}
    -
    -
    -
    - -
    - +
    +
    + +
    +
    + +
    +

    INPUT_OBJECT

    +

    EditQuizInput

    +
    +
    + +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1input EditQuizInput {
    4
    2# The display title of the task.
    3title: String
    7
    5# Task description.
    6description: String
    10
    8# The options for this quiz task.
    9options: [QuizOptionInput]
    13
    11# Whether the task allows selecting more than one option.
    12multipleSelect: Boolean
    14}
    +
    +
    +
    +
    +

    + + link + + Required by +

    + +
    +
    +
    diff --git a/docs/graphql/types/editstandardtaskinput.doc.html b/docs/graphql/types/editstandardtaskinput.doc.html index 0c952ea1..681bae9a 100644 --- a/docs/graphql/types/editstandardtaskinput.doc.html +++ b/docs/graphql/types/editstandardtaskinput.doc.html @@ -23,568 +23,648 @@
    -
    -
    - -
    -
    - -
    -

    INPUT_OBJECT

    -

    EditStandardTaskInput

    -
    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1input EditStandardTaskInput {
    4
    2# Task description.
    3description: String
    7
    5# A list of input formats.
    6inputFormat: [TaskInputArgumentInfo]
    10
    8# Output format.
    9outputFormat: TaskOutputInfo
    13
    11# A list of test cases.
    12testcases: [TestcaseInput]
    16
    14# The number of tests that will be made visible to the test-taker.
    15sampleTestCount: Int
    17}
    -
    -
    -
    - -
    - +
    +
    + +
    +
    + +
    +

    INPUT_OBJECT

    +

    EditStandardTaskInput

    +
    +
    + +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1input EditStandardTaskInput {
    4
    2# The title of the task is the more user-friendly version of the task name.
    3title: String
    6
    5description: String
    8
    7inputFormat: [TaskInputArgumentInfo]
    10
    9outputFormat: TaskOutputInfo
    12
    11testcases: [TestcaseInput]
    15
    13# The number of testcases that will be made visible to the test-taker.
    14sampleTestCount: Int
    19
    16# The list of all the languages that are allowed to be used in this task,
    17# or an empty list to allow all possible languages.
    18allowedLanguages: [CodingLanguage]
    27
    20# A list that describes customized execution time limits for one or more
    21# languages.
    22# If a language is not specified in the list, its execution time limit will be set
    23# to the default.
    24# In particular, you can pass an empty list to reset the time limits for all
    25# languages to the default.
    26timeLimits: [LanguageTimeLimit]
    28}
    +
    +
    +
    +
    +

    + + link + + Required by +

    + +
    +
    +
    diff --git a/docs/graphql/types/enumvalue.spec.html b/docs/graphql/types/enumvalue.spec.html index 7e254a54..8ec9c2b6 100644 --- a/docs/graphql/types/enumvalue.spec.html +++ b/docs/graphql/types/enumvalue.spec.html @@ -23,573 +23,653 @@
    -
    -
    - -
    -
    - -
    -

    OBJECT

    -

    __EnumValue

    -

    One possible value for a given Enum. Enum values are unique values, not a placeholder for a string or numeric value. However an Enum value is returned in a JSON response as a string.

    +
    +
    + +
    +
    +
    +
    +

    OBJECT

    +

    __EnumValue

    +

    One possible value for a given Enum. Enum values are unique values, not a placeholder for a string or numeric value. However an Enum value is returned in a JSON response as a string.

    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1type __EnumValue {
    2
    3name: String!
    4
    5description: String
    6
    7isDeprecated: Boolean!
    8
    9deprecationReason: String
    10
    11}
    -
    -
    -
    -
    -

    - - link - - Required by -

    -
    +
    +
    + -
    - + + +
    diff --git a/docs/graphql/types/field.spec.html b/docs/graphql/types/field.spec.html index 049e520e..0256acd4 100644 --- a/docs/graphql/types/field.spec.html +++ b/docs/graphql/types/field.spec.html @@ -23,573 +23,653 @@
    -
    -
    - -
    -
    - -
    -

    OBJECT

    -

    __Field

    -

    Object and Interface types are described by a list of Fields, each of which has a name, potentially a list of arguments, and a return type.

    +
    +
    + +
    +
    +
    +
    +

    OBJECT

    +

    __Field

    +

    Object and Interface types are described by a list of Fields, each of which has a name, potentially a list of arguments, and a return type.

    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1type __Field {
    2
    3name: String!
    4
    5description: String
    6
    7args: [__InputValue!]!
    8
    9type: __Type!
    10
    11isDeprecated: Boolean!
    12
    13deprecationReason: String
    14
    15}
    -
    -
    -
    -
    -

    - - link - - Required by -

    -
    +
    +
    + -
    - + + +
    diff --git a/docs/graphql/types/float.doc.html b/docs/graphql/types/float.doc.html index a678cef0..2e47249c 100644 --- a/docs/graphql/types/float.doc.html +++ b/docs/graphql/types/float.doc.html @@ -23,569 +23,649 @@
    -
    -
    - -
    -
    - -
    -

    SCALAR

    -

    Float

    -

    The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

    -
    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1scalar Float
    -
    -
    -
    - -
    -
    -
    -

    - Generated with graphqldoc 2.5.2 -

    +
    +
    + +
    +
    +
    +
    +

    SCALAR

    +

    Float

    +

    The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

    -
    + + +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1scalar Float
    +
    +
    +
    + +
    +
    diff --git a/docs/graphql/types/freeformsolution.doc.html b/docs/graphql/types/freeformsolution.doc.html index 1f7a6509..36b2f032 100644 --- a/docs/graphql/types/freeformsolution.doc.html +++ b/docs/graphql/types/freeformsolution.doc.html @@ -23,569 +23,649 @@
    -
    -
    - -
    -
    - -
    -

    OBJECT

    -

    FreeFormSolution

    -

    Solution submitted to a free-form task.

    -
    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1type FreeFormSolution implements TaskSolution {
    2
    3id: ID!
    4
    5# Answer written in a free format.
    6answer: String!
    7
    8}
    -
    -
    -
    -
    -

    - - link - - Required by -

    -
    This element is not required by anyone
    -
    -
    -
    -
    -

    - Generated with graphqldoc 2.5.2 -

    +
    +
    + +
    +
    +
    +
    +

    OBJECT

    +

    FreeFormSolution

    +

    Solution submitted to a free-form task.

    -
    + + +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1type FreeFormSolution implements TaskSolution {
    2
    3id: ID!
    4
    5# Answer written in a free format.
    6answer: String!
    7
    8}
    +
    +
    +
    +
    +

    + + link + + Required by +

    +
    This element is not required by anyone
    +
    +
    +
    diff --git a/docs/graphql/types/frontendlibrary.doc.html b/docs/graphql/types/frontendlibrary.doc.html new file mode 100644 index 00000000..d85887fd --- /dev/null +++ b/docs/graphql/types/frontendlibrary.doc.html @@ -0,0 +1,672 @@ + + + + + + + + + + + FrontendLibrary | CodeSignal GraphQL API + + + + +
    +
    +
    + +
    +
    + +
    +

    OBJECT

    +

    FrontendLibrary

    +
    +
    +
    +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1type FrontendLibrary {
    2
    3name: String!
    4
    5}
    +
    +
    +
    +
    +

    + + link + + Required by +

    +
    This element is not required by anyone
    +
    +
    + +
    + + + + diff --git a/docs/graphql/types/frontendlibraryinput.doc.html b/docs/graphql/types/frontendlibraryinput.doc.html new file mode 100644 index 00000000..469a7b0d --- /dev/null +++ b/docs/graphql/types/frontendlibraryinput.doc.html @@ -0,0 +1,674 @@ + + + + + + + + + + + FrontendLibraryInput | CodeSignal GraphQL API + + + + +
    +
    +
    + +
    +
    + +
    +

    INPUT_OBJECT

    +

    FrontendLibraryInput

    +

    Front-end libraries included in the task. +This can be used to enable the use of React or other front-end frameworks in the task.

    +
    +
    +
    +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1input FrontendLibraryInput {
    5
    2# Unique name of the front-end library that will be included in the task.
    3# Currently the only supported value is "react".
    4name: String!
    6}
    +
    +
    +
    +
    +

    + + link + + Required by +

    + +
    +
    + +
    + + + + diff --git a/docs/graphql/types/frontendscriptlanguage.doc.html b/docs/graphql/types/frontendscriptlanguage.doc.html new file mode 100644 index 00000000..fa81fb86 --- /dev/null +++ b/docs/graphql/types/frontendscriptlanguage.doc.html @@ -0,0 +1,673 @@ + + + + + + + + + + + FrontendScriptLanguage | CodeSignal GraphQL API + + + + +
    +
    +
    + +
    +
    + +
    +

    ENUM

    +

    FrontendScriptLanguage

    +

    A supported front-end scripting language.

    +
    +
    +
    +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1enum FrontendScriptLanguage {
    2
    3js
    4
    5jsx
    6}
    +
    +
    +
    +
    +

    + + link + + Required by +

    + +
    +
    + +
    + + + + diff --git a/docs/graphql/types/frontendstylelanguage.doc.html b/docs/graphql/types/frontendstylelanguage.doc.html new file mode 100644 index 00000000..9b140f95 --- /dev/null +++ b/docs/graphql/types/frontendstylelanguage.doc.html @@ -0,0 +1,673 @@ + + + + + + + + + + + FrontendStyleLanguage | CodeSignal GraphQL API + + + + +
    +
    +
    + +
    +
    + +
    +

    ENUM

    +

    FrontendStyleLanguage

    +

    A supported front-end styling language.

    +
    +
    +
    +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1enum FrontendStyleLanguage {
    2
    3css
    4
    5scss
    6
    7less
    8}
    +
    +
    +
    +
    +

    + + link + + Required by +

    + +
    +
    + +
    + + + + diff --git a/docs/graphql/types/id.doc.html b/docs/graphql/types/id.doc.html index 83384933..a5578df6 100644 --- a/docs/graphql/types/id.doc.html +++ b/docs/graphql/types/id.doc.html @@ -23,573 +23,653 @@
    -
    -
    - -
    -
    - -
    -

    SCALAR

    -

    ID

    -

    The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

    +
    +
    + +
    +
    +
    +
    +

    SCALAR

    +

    ID

    +

    The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1scalar ID
    -
    -
    -
    -
    -

    - - link - - Required by -

    -
    +
    +
    +
    +

    + + link + + Required by +

    + -
    -
    - + + +
    diff --git a/docs/graphql/types/include.doc.html b/docs/graphql/types/include.doc.html index 5125e308..179c6163 100644 --- a/docs/graphql/types/include.doc.html +++ b/docs/graphql/types/include.doc.html @@ -23,569 +23,649 @@
    -
    -
    - -
    -
    - -
    -

    -

    include

    -

    Directs the executor to include this field or fragment only when the if argument is true.

    -
    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1directive @include(if: Boolean!) on FIELD | FRAGMENT_SPREAD | INLINE_FRAGMENT
    -
    -
    -
    -
    -

    - - link - - Required by -

    -
    This element is not required by anyone
    -
    -
    -
    -
    -

    - Generated with graphqldoc 2.5.2 -

    +
    +
    + +
    +
    +
    +
    +

    +

    include

    +

    Directs the executor to include this field or fragment only when the if argument is true.

    -
    + + +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1directive @include(if: Boolean!) on FIELD | FRAGMENT_SPREAD | INLINE_FRAGMENT
    +
    +
    +
    +
    +

    + + link + + Required by +

    +
    This element is not required by anyone
    +
    +
    +
    diff --git a/docs/graphql/types/index.html b/docs/graphql/types/index.html index 170f40ba..dd56467f 100644 --- a/docs/graphql/types/index.html +++ b/docs/graphql/types/index.html @@ -23,557 +23,637 @@
    -
    -
    - -
    -
    - -
    - -

    CodeSignal GraphQL API

    -
    The most advanced technical assessment platform.
    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1schema {
    2
    3# All possible read-only queries.
    4query: RootQuery
    5
    6# All possible mutations.
    7mutation: RootMutation
    8}
    -
    -
    - +
    +
    + +
    +
    + +
    + +

    CodeSignal GraphQL API

    +
    The most advanced technical assessment platform.
    +
    + +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1schema {
    2
    3query: Query
    4
    5mutation: Mutation
    6}
    +
    +
    +
    diff --git a/docs/graphql/types/inputvalue.spec.html b/docs/graphql/types/inputvalue.spec.html index 0b1023cc..8aad1523 100644 --- a/docs/graphql/types/inputvalue.spec.html +++ b/docs/graphql/types/inputvalue.spec.html @@ -23,560 +23,640 @@
    -
    -
    - -
    -
    - -
    -

    OBJECT

    -

    __InputValue

    -

    Arguments provided to Fields or Directives and the input fields of an InputObject are represented as Input Values which describe their type and optionally a default value.

    +
    +
    + +
    +
    +
    +
    +

    OBJECT

    +

    __InputValue

    +

    Arguments provided to Fields or Directives and the input fields of an InputObject are represented as Input Values which describe their type and optionally a default value.

    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1type __InputValue {
    2
    3name: String!
    4
    5description: String
    6
    7type: __Type!
    8
    9# A GraphQL-formatted string representing the default value for this input value.
    10defaultValue: String
    11
    12}
    -
    -
    -
    -
    -

    - - link - - Required by -

    -
    • +

      + + link + + GraphQL Schema definition +

      +
      1type __InputValue {
      2
      3name: String!
      4
      5description: String
      6
      7type: __Type!
      8
      9# A GraphQL-formatted string representing the default value for this input value.
      10defaultValue: String
      11
      12}
      +
    +
    +
    + -
    - + + +
    diff --git a/docs/graphql/types/int.doc.html b/docs/graphql/types/int.doc.html index d5d48e14..3071a4e9 100644 --- a/docs/graphql/types/int.doc.html +++ b/docs/graphql/types/int.doc.html @@ -23,571 +23,651 @@
    -
    -
    - -
    -
    - -
    -

    SCALAR

    -

    Int

    -

    The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

    +
    +
    + +
    +
    +
    +
    +

    SCALAR

    +

    Int

    +

    The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1scalar Int
    -
    -
    -
    - +
    +
    +
    +

    + + link + + Required by +

    + -
    -
    - + + +
    diff --git a/docs/graphql/types/invoice.doc.html b/docs/graphql/types/invoice.doc.html index 027a7146..3be9f0cd 100644 --- a/docs/graphql/types/invoice.doc.html +++ b/docs/graphql/types/invoice.doc.html @@ -23,569 +23,649 @@
    -
    -
    - -
    -
    - -
    -

    OBJECT

    -

    Invoice

    -

    The invoice associated with a service plan.

    -
    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1type Invoice {
    2
    3# The amount due for the invoice
    4amountDue: Int
    5
    6# The date payment charged / will be charged
    7chargeDate: Timestamp
    8
    9}
    -
    -
    -
    - -
    -
    -
    -

    - Generated with graphqldoc 2.5.2 -

    +
    +
    + +
    +
    +
    +
    +

    OBJECT

    +

    Invoice

    +

    The invoice associated with a service plan.

    -
    + + +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1type Invoice {
    2
    3# The amount due for the invoice
    4amountDue: Int
    5
    6# The date payment charged / will be charged
    7chargeDate: Timestamp
    8
    9}
    +
    +
    +
    + +
    +
    diff --git a/docs/graphql/types/language.doc.html b/docs/graphql/types/language.doc.html index 3106b4b5..37ff0f6a 100644 --- a/docs/graphql/types/language.doc.html +++ b/docs/graphql/types/language.doc.html @@ -23,570 +23,651 @@
    -
    -
    - -
    -
    - -
    -

    ENUM

    -

    Language

    -
    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1enum Language {
    2
    3clj
    4
    5coffee
    6
    7lisp
    8
    9c
    10
    11cpp
    12
    13cs
    14
    15d
    16
    17dart
    18
    19exs
    20
    21erl
    22
    23pas
    24
    25for
    26
    27fs
    28
    29go
    30
    31groovy
    32
    33hs
    34
    35java
    36
    37js
    38
    39jl
    40
    41kt
    42
    43lua
    44
    45nim
    46
    47objc
    48
    49ocaml
    50
    51octave
    52
    53perl
    54
    55php
    56
    57py
    58
    59py3
    60
    61r
    62
    63rb
    64
    65rs
    66
    67scala
    68
    69st
    70
    71swift
    72
    73tcl
    74
    75ts
    76
    77vb
    78
    79mysql
    80
    81psql
    82
    83sh
    84
    85mongodb
    86}
    -
    -
    -
    - + +
    +

    ENUM

    +

    Language

    +

    A supported standard coding or a front-end language.

    +
    +
    +
    +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1enum Language {
    2
    3clj
    4
    5coffee
    6
    7lisp
    8
    9c
    10
    11cpp
    12
    13cs
    14
    15d
    16
    17dart
    18
    19exs
    20
    21erl
    22
    23pas
    24
    25for
    26
    27fs
    28
    29go
    30
    31groovy
    32
    33hs
    34
    35java
    36
    37js
    38
    39jl
    40
    41kt
    42
    43lua
    44
    45nim
    46
    47objc
    48
    49ocaml
    50
    51octave
    52
    53perl
    54
    55php
    56
    57py
    58
    59py3
    60
    61r
    62
    63rb
    64
    65rs
    66
    67scala
    68
    69st
    70
    71swift
    72
    73tcl
    74
    75ts
    76
    77vb
    78
    79html
    80
    81css
    82
    83scss
    84
    85less
    86
    87jsx
    88}
    +
    +
    +
    + -
    - + + +
    diff --git a/docs/graphql/types/languagetimelimit.doc.html b/docs/graphql/types/languagetimelimit.doc.html new file mode 100644 index 00000000..25805127 --- /dev/null +++ b/docs/graphql/types/languagetimelimit.doc.html @@ -0,0 +1,672 @@ + + + + + + + + + + + LanguageTimeLimit | CodeSignal GraphQL API + + + + +
    +
    +
    + +
    +
    + +
    +

    INPUT_OBJECT

    +

    LanguageTimeLimit

    +
    +
    +
    +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1input LanguageTimeLimit {
    3
    2language: CodingLanguage
    7
    4# Execution time limit in milliseconds for the specified language.
    5# Allowed values are from 500 to 20000 inclusive.
    6time: Int
    8}
    +
    +
    +
    + +
    + +
    + + + + diff --git a/docs/graphql/types/liveinterview.doc.html b/docs/graphql/types/liveinterview.doc.html index 87783ce8..bb786088 100644 --- a/docs/graphql/types/liveinterview.doc.html +++ b/docs/graphql/types/liveinterview.doc.html @@ -23,569 +23,649 @@
    -
    -
    - -
    -
    - -
    -

    OBJECT

    -

    LiveInterview

    -

    A live interview defines a collaboration programming session.

    -
    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1type LiveInterview {
    2
    3# Live interview ID.
    4id: ID!
    5
    6# Email of the candidate.
    7candidateEmail: String
    8
    9# Full name of the candidate.
    10candidateName: String
    11
    12# Status of the live interview.
    13status: LiveInterviewStatus!
    14
    15# Interviewer's feedback about the candidate.
    16feedback: LiveInterviewFeedback
    17
    18# The date the interview started.
    19startDate: Timestamp
    20
    21# The date the interview finished.
    22finishDate: Timestamp
    23
    24# Direct link to the interview.
    25url: String!
    26
    27# The company that owns this live interview.
    28company: Company!
    29
    30}
    -
    -
    -
    - -
    -
    -
    -

    - Generated with graphqldoc 2.5.2 -

    +
    +
    + +
    +
    +
    +
    +

    OBJECT

    +

    LiveInterview

    +

    A live interview defines a collaboration programming session.

    -
    + + +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1type LiveInterview {
    2
    3# Live interview ID.
    4id: ID!
    5
    6# Email of the candidate.
    7candidateEmail: String
    8
    9# Full name of the candidate.
    10candidateName: String
    11
    12# Status of the live interview.
    13status: LiveInterviewStatus!
    14
    15# Interviewer's feedback about the candidate.
    16feedback: LiveInterviewFeedback
    17
    18# The date the interview started.
    19startDate: Timestamp
    20
    21# The date the interview finished.
    22finishDate: Timestamp
    23
    24# Direct link to the interview.
    25url: String!
    26
    27# The company that owns this live interview.
    28company: Company!
    29
    30}
    +
    +
    +
    +
    +

    + + link + + Required by +

    + +
    +
    +
    diff --git a/docs/graphql/types/liveinterviewfeedback.doc.html b/docs/graphql/types/liveinterviewfeedback.doc.html index 9e3786fe..f8fda2af 100644 --- a/docs/graphql/types/liveinterviewfeedback.doc.html +++ b/docs/graphql/types/liveinterviewfeedback.doc.html @@ -23,568 +23,648 @@
    -
    -
    - -
    -
    - -
    -

    OBJECT

    -

    LiveInterviewFeedback

    -
    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1type LiveInterviewFeedback {
    2
    3# Overall notes about the candidates.
    4notes: String!
    5
    6# Overall recommendation about the candidate.
    7recommendation: LiveInterviewRating!
    8
    9coding: LiveInterviewRating
    10
    11communication: LiveInterviewRating
    12
    13problemSolving: LiveInterviewRating
    14
    15systemDesign: LiveInterviewRating
    16
    17}
    -
    -
    -
    - -
    - +
    +
    + +
    +
    + +
    +

    OBJECT

    +

    LiveInterviewFeedback

    +
    +
    + +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1type LiveInterviewFeedback {
    2
    3# Overall notes about the candidates.
    4notes: String!
    5
    6# Overall recommendation about the candidate.
    7recommendation: LiveInterviewRating!
    8
    9coding: LiveInterviewRating
    10
    11communication: LiveInterviewRating
    12
    13problemSolving: LiveInterviewRating
    14
    15systemDesign: LiveInterviewRating
    16
    17}
    +
    +
    +
    + +
    +
    diff --git a/docs/graphql/types/liveinterviewinput.doc.html b/docs/graphql/types/liveinterviewinput.doc.html index 60aaf1be..2aca4852 100644 --- a/docs/graphql/types/liveinterviewinput.doc.html +++ b/docs/graphql/types/liveinterviewinput.doc.html @@ -23,568 +23,648 @@
    -
    -
    - -
    -
    - -
    -

    INPUT_OBJECT

    -

    LiveInterviewInput

    -
    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1input LiveInterviewInput {
    4
    2# The email address of the candidate.
    3candidateEmail: String
    7
    5# The name of the candidate.
    6candidateName: String
    8}
    -
    -
    -
    - -
    - +
    +
    + +
    +
    + +
    +

    INPUT_OBJECT

    +

    LiveInterviewInput

    +
    +
    + +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1input LiveInterviewInput {
    4
    2# The email address of the candidate.
    3candidateEmail: String
    7
    5# The name of the candidate.
    6candidateName: String
    8}
    +
    +
    +
    +
    +

    + + link + + Required by +

    + +
    +
    +
    diff --git a/docs/graphql/types/liveinterviewrating.doc.html b/docs/graphql/types/liveinterviewrating.doc.html index ba939cb2..bdb0f633 100644 --- a/docs/graphql/types/liveinterviewrating.doc.html +++ b/docs/graphql/types/liveinterviewrating.doc.html @@ -23,569 +23,649 @@
    -
    -
    - -
    -
    - -
    -

    SCALAR

    -

    LiveInterviewRating

    -

    An integer used to rate candidate's performance on the scale from 1 to 4.

    -
    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1scalar LiveInterviewRating
    -
    -
    -
    -
    -

    - - link - - Required by -

    - -
    -
    -
    -
    -

    - Generated with graphqldoc 2.5.2 -

    +
    +
    + +
    +
    +
    +
    +

    SCALAR

    +

    LiveInterviewRating

    +

    An integer used to rate candidate's performance on the scale from 1 to 4.

    -
    + + +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1scalar LiveInterviewRating
    +
    +
    +
    +
    +

    + + link + + Required by +

    + +
    +
    +
    diff --git a/docs/graphql/types/liveinterviewstatus.doc.html b/docs/graphql/types/liveinterviewstatus.doc.html index 866d0d72..29fb424d 100644 --- a/docs/graphql/types/liveinterviewstatus.doc.html +++ b/docs/graphql/types/liveinterviewstatus.doc.html @@ -23,569 +23,649 @@
    -
    -
    - -
    -
    - -
    -

    ENUM

    -

    LiveInterviewStatus

    -

    Possible status of live interviews.

    -
    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1enum LiveInterviewStatus {
    2
    3pending
    4
    5active
    6
    7over
    8}
    -
    -
    -
    - -
    -
    -
    -

    - Generated with graphqldoc 2.5.2 -

    +
    +
    + +
    +
    +
    +
    +

    ENUM

    +

    LiveInterviewStatus

    +

    Possible status of live interviews.

    -
    + + +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1enum LiveInterviewStatus {
    2
    3pending
    4
    5active
    6
    7over
    8}
    +
    +
    +
    + +
    +
    diff --git a/docs/graphql/types/mutation.doc.html b/docs/graphql/types/mutation.doc.html new file mode 100644 index 00000000..57b89f87 --- /dev/null +++ b/docs/graphql/types/mutation.doc.html @@ -0,0 +1,672 @@ + + + + + + + + + + + Mutation | CodeSignal GraphQL API + + + + +
    +
    +
    + +
    +
    + +
    +

    OBJECT

    +

    Mutation

    +
    +
    +
    +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1type Mutation {
    2
    3# Set customized initial source code that will be presented when solving the task.
    4# Returns the modified task.
    5setTaskInitialSource(
    6id: ID!,
    7language: Language!,
    8source: String!
    9): Task
    10
    11# Reset the initial source code of the task to the default value for the given
    12# language.
    13# Returns the modified task.
    14unsetTaskInitialSource(id: ID!, language: Language!): Task
    15
    16# Creates a quiz task with one or more correct options.
    17createQuizTask(
    18taskFields: CreateQuizInput!,
    19options: CreateTaskOptionsInput
    20): Task
    21
    22# Edits a quiz task with the given ID.
    23editQuizTask(id: ID!, taskFields: EditQuizInput!): Task
    24
    25# Creates a task with a function as an entry point that receives input and returns
    26# the output.
    27createStandardTask(
    28taskFields: CreateStandardTaskInput!,
    29options: CreateTaskOptionsInput
    30): Task
    31
    32# Edits a standard task with the given ID.
    33editStandardTask(id: ID!, taskFields: EditStandardTaskInput!): Task
    34
    35# Update one or more front-end task parameters by the task ID
    36updateFrontendTask(id: ID!, patch: UpdateFrontendTaskInput): Task
    37
    38# Creates a company test.
    39createCompanyTest(testFields: CreateCompanyTestInput!): CompanyTest
    40
    41# Edits a company test with the given ID.
    42editCompanyTest(id: ID!, testFields: EditCompanyTestInput!): CompanyTest
    43
    44# Edits a company's service plans and custom features.
    45editCompanyPlanSettings(
    46companyId: ID!,
    47planSettings: CompanyPlanSettingsInput!
    48): Company
    49
    50# Allow retakes of a company test.
    51# Only accept 0 or 1 as retakeAllowanceCount.
    52setCompanyTestRetakeAllowances(
    53userId: ID,
    54username: String,
    55testId: ID!,
    56retakeAllowanceCount: Int!
    57): Int
    58
    59# Creates a live interview.
    60createLiveInterview(interviewFields: LiveInterviewInput): LiveInterview
    61
    62# Edit a live interview with a given ID.
    63editLiveInterview(id: ID!, interviewFields: LiveInterviewInput!): LiveInterview
    64
    65# Creates or updates a role with the given key.
    66saveRole(key: ID!, title: String!, permissions: [String]!): Role
    67
    68# Deletes the role with the given key.
    69deleteRole(key: ID!): ID!
    70
    71createCompanyTestSession(
    72sessionFields: TestSessionInput!
    73): CompanyTestSession
    74
    75createCertificationRequest(
    76requestFields: CreateCertificationRequestInput!
    77): CertificationRequest
    78
    79}
    +
    +
    +
    +
    +

    + + link + + Required by +

    +
    This element is not required by anyone
    +
    +
    + +
    + + + + diff --git a/docs/graphql/types/plagiarismlabel.doc.html b/docs/graphql/types/plagiarismlabel.doc.html index 435018d9..dd3e9cf7 100644 --- a/docs/graphql/types/plagiarismlabel.doc.html +++ b/docs/graphql/types/plagiarismlabel.doc.html @@ -23,569 +23,649 @@
    -
    -
    - -
    -
    - -
    -

    ENUM

    -

    PlagiarismLabel

    -

    A label given to a plagiarized solution.

    -
    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1enum PlagiarismLabel {
    2
    3none
    4
    5low
    6
    7medium
    8
    9high
    10}
    -
    -
    -
    - -
    -
    -
    -

    - Generated with graphqldoc 2.5.2 -

    +
    +
    + +
    +
    +
    +
    +

    ENUM

    +

    PlagiarismLabel

    +

    A label given to a plagiarized solution.

    -
    + + +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1enum PlagiarismLabel {
    2
    3none
    4
    5low
    6
    7medium
    8
    9high
    10}
    +
    +
    +
    + +
    +
    diff --git a/docs/graphql/types/planbillingperiod.doc.html b/docs/graphql/types/planbillingperiod.doc.html index dcf25add..1daad955 100644 --- a/docs/graphql/types/planbillingperiod.doc.html +++ b/docs/graphql/types/planbillingperiod.doc.html @@ -23,569 +23,649 @@
    -
    -
    - -
    -
    - -
    -

    OBJECT

    -

    PlanBillingPeriod

    -

    The abstract billing period associated with a service plan.

    -
    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1type PlanBillingPeriod {
    2
    3# The billing interval: month or year
    4interval: BillingInterval
    5
    6# The number of "interval" units per billing period. i.e., if count is 2 and the
    7# interval is monthly, then
    8# billing will be every 2 months.
    9count: Int
    10
    11}
    -
    -
    -
    - -
    -
    -
    -

    - Generated with graphqldoc 2.5.2 -

    +
    +
    + +
    +
    +
    +
    +

    OBJECT

    +

    PlanBillingPeriod

    +

    The abstract billing period associated with a service plan.

    -
    + + +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1type PlanBillingPeriod {
    2
    3# The billing interval: month or year
    4interval: BillingInterval
    5
    6# The number of "interval" units per billing period. i.e., if count is 2 and the
    7# interval is monthly, then
    8# billing will be every 2 months.
    9count: Int
    10
    11}
    +
    +
    +
    + +
    +
    diff --git a/docs/graphql/types/plantype.doc.html b/docs/graphql/types/plantype.doc.html index 26cfb39e..9eca0f2a 100644 --- a/docs/graphql/types/plantype.doc.html +++ b/docs/graphql/types/plantype.doc.html @@ -23,569 +23,649 @@
    -
    -
    - -
    -
    - -
    -

    ENUM

    -

    PlanType

    -

    The type of a service plan.

    -
    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1enum PlanType {
    2
    3enterprise
    4
    5self_service
    6
    7demo
    8}
    -
    -
    -
    - -
    -
    -
    -

    - Generated with graphqldoc 2.5.2 -

    +
    +
    + +
    +
    +
    +
    +

    ENUM

    +

    PlanType

    +

    The type of a service plan.

    -
    + + +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1enum PlanType {
    2
    3enterprise
    4
    5self_service
    6
    7demo
    8}
    +
    +
    +
    + +
    +
    diff --git a/docs/graphql/types/product.doc.html b/docs/graphql/types/product.doc.html index 554c8394..5bc1ff48 100644 --- a/docs/graphql/types/product.doc.html +++ b/docs/graphql/types/product.doc.html @@ -23,569 +23,649 @@
    -
    -
    - -
    -
    - -
    -

    ENUM

    -

    Product

    -

    CodeSignal's assessment products.

    -
    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1enum Product {
    2
    3attract
    4
    5test
    6
    7certify
    8
    9interview
    10}
    -
    -
    -
    - -
    -
    -
    -

    - Generated with graphqldoc 2.5.2 -

    +
    +
    + +
    +
    +
    +
    +

    ENUM

    +

    Product

    +

    CodeSignal's assessment products.

    -
    + + +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1enum Product {
    2
    3attract
    4
    5test
    6
    7certify
    8
    9interview
    10}
    +
    +
    +
    + +
    +
    diff --git a/docs/graphql/types/query.doc.html b/docs/graphql/types/query.doc.html new file mode 100644 index 00000000..023c7b75 --- /dev/null +++ b/docs/graphql/types/query.doc.html @@ -0,0 +1,672 @@ + + + + + + + + + + + Query | CodeSignal GraphQL API + + + + +
    +
    +
    + +
    +
    + +
    +

    OBJECT

    +

    Query

    +
    +
    +
    +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1type Query {
    2
    3# Query a task by ID.
    4task(id: ID!): Task
    5
    6# Query a company by ID.
    7#
    8# Arguments
    9# id: The ID of the company to return.
    10company(id: ID!): Company
    11
    12# Query all companies.
    13companies: [Company]
    14
    15# Query all company features.
    16companyFeatures: [CompanyFeature]
    17
    18# Query a company test by ID.
    19#
    20# Arguments
    21# id: The ID of the company test to return.
    22companyTest(id: ID!): CompanyTest
    23
    24# Query a company test session by ID.
    25#
    26# Arguments
    27# id: The ID of the company test session to return.
    28companyTestSession(id: ID!): CompanyTestSession
    29
    30# Query all company test sessions associated with a given company test ID.
    31#
    32# Arguments
    33# companyTestId: The ID of the company test whose sessions should
    34# be returned.
    35# first: Use 'first' and 'offset' arguments to limit results
    36# returned
    37companyTestSessions(companyTestId: ID!, first: Int, offset: Int): [CompanyTestSession]!
    38
    39# Query a live interview by ID.
    40#
    41# Arguments
    42# liveInterviewId: The ID of the live interview.
    43liveInterview(liveInterviewId: ID!): LiveInterview
    44
    45# Query all live interviews associated with a given candidate email.
    46#
    47# Arguments
    48# candidateEmail: Email of the candidate associated with the
    49# interivew.
    50# first: Use 'first' and 'offset' arguments to limit results
    51# returned.
    52liveInterviews(candidateEmail: String!, first: Int, offset: Int): [LiveInterview]!
    53
    54# Query all roles.
    55roles: [Role]
    56
    57# Query a specific role by key.
    58role(key: ID!): Role
    59
    60# Query all service plans filtered by the give params.
    61#
    62# Arguments
    63# products: Array of CodeSignal assessment products.
    64# types: Array of plan types.
    65# statuses: Array of plan statuses.
    66servicePlans(
    67products: [Product],
    68types: [PlanType],
    69statuses: [ServicePlanStatus]
    70): [ServicePlan]
    71
    72# Query a standardized test by ID.
    73#
    74# Arguments
    75# id: The ID of the test to return.
    76standardizedTest(id: ID!): StandardizedTest
    77
    78# Returns user either by ID or by username. Exactly one field (either userId or
    79# username) is required.
    80#
    81# Arguments
    82# userId: Unique user ID.
    83# username: Username unique for each user.
    84user(userId: ID, username: String): User
    85
    86# Performs an access check for the current user or API key.
    87#
    88# Arguments
    89# type: The type of access being checked.
    90# resourceId: The identifier of the resource related to the
    91# access check, if a single ID is required.
    92# resourceIds: The identifiers of the multiple resources related
    93# to the access check, if required.
    94hasAccess(type: AccessType!, resourceId: ID, resourceIds: [ID]): Boolean
    95
    96# Performs multiple access checks for the current user or API key. Using hasAccess
    97# is preferable due to simplicity and
    98# better support for client-side caching of results, but hasAccessList can be used
    99# when the number of queries is variable
    100# and not known in advance.
    101hasAccessList(accessQueries: [AccessQueryInput]!): [AccessQueryResult]
    102
    103# Given the input, returns the corresponding certification request. There are
    104# three ways to query for the request:
    105# * by unique request ID;
    106# * by candidate email and test ID (your company ID will be used implicitly);
    107# * by candidate email, test ID and company ID.
    108certificationRequest(
    109requestFields: CertificationRequestInput!
    110): CertificationRequest
    111
    112}
    +
    +
    +
    +
    +

    + + link + + Required by +

    +
    This element is not required by anyone
    +
    +
    + +
    + + + + diff --git a/docs/graphql/types/quizoptioninput.doc.html b/docs/graphql/types/quizoptioninput.doc.html index 0d7bd9e8..a9e84862 100644 --- a/docs/graphql/types/quizoptioninput.doc.html +++ b/docs/graphql/types/quizoptioninput.doc.html @@ -23,568 +23,648 @@
    -
    -
    - -
    -
    - -
    -

    INPUT_OBJECT

    -

    QuizOptionInput

    -
    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1input QuizOptionInput {
    4
    2# The text that will be displayed for this option.
    3description: String!
    7
    5# Whether this option is correct.
    6isCorrect: Boolean
    8}
    -
    -
    -
    - -
    - +
    +
    + +
    +
    + +
    +

    INPUT_OBJECT

    +

    QuizOptionInput

    +
    +
    + +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1input QuizOptionInput {
    4
    2# The text that will be displayed for this option.
    3description: String!
    7
    5# Whether this option is correct.
    6isCorrect: Boolean
    8}
    +
    +
    +
    + +
    +
    diff --git a/docs/graphql/types/quizsolution.doc.html b/docs/graphql/types/quizsolution.doc.html index 42a20894..9b1cc325 100644 --- a/docs/graphql/types/quizsolution.doc.html +++ b/docs/graphql/types/quizsolution.doc.html @@ -23,569 +23,649 @@
    -
    -
    - -
    -
    - -
    -

    OBJECT

    -

    QuizSolution

    -

    Solution submitted to a quiz task.

    -
    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1type QuizSolution implements TaskSolution {
    2
    3id: ID!
    4
    5# The options submitted as an answer.
    6answer: [String]!
    7
    8}
    -
    -
    -
    -
    -

    - - link - - Required by -

    -
    This element is not required by anyone
    -
    -
    -
    -
    -

    - Generated with graphqldoc 2.5.2 -

    +
    +
    + +
    +
    +
    +
    +

    OBJECT

    +

    QuizSolution

    +

    Solution submitted to a quiz task.

    -
    + + +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1type QuizSolution implements TaskSolution {
    2
    3id: ID!
    4
    5# The options submitted as an answer.
    6answer: [String]!
    7
    8}
    +
    +
    +
    +
    +

    + + link + + Required by +

    +
    This element is not required by anyone
    +
    +
    +
    diff --git a/docs/graphql/types/ratelimit.doc.html b/docs/graphql/types/ratelimit.doc.html index ba010596..9177e66e 100644 --- a/docs/graphql/types/ratelimit.doc.html +++ b/docs/graphql/types/ratelimit.doc.html @@ -23,568 +23,648 @@
    -
    -
    - -
    -
    - -
    -

    -

    rateLimit

    -
    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1directive @rateLimit(max: Int, window: String, message: String, identityArgs: [String]) on FIELD_DEFINITION
    -
    -
    -
    -
    -

    - - link - - Required by -

    -
    This element is not required by anyone
    -
    -
    - +
    +
    + +
    +
    + +
    +

    +

    rateLimit

    +
    +
    + +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1directive @rateLimit(max: Int, window: String, message: String, identityArgs: [String]) on FIELD_DEFINITION
    +
    +
    +
    +
    +

    + + link + + Required by +

    +
    This element is not required by anyone
    +
    +
    +
    diff --git a/docs/graphql/types/role.doc.html b/docs/graphql/types/role.doc.html index b8a9fc89..a34cb44d 100644 --- a/docs/graphql/types/role.doc.html +++ b/docs/graphql/types/role.doc.html @@ -23,569 +23,649 @@
    -
    -
    - -
    -
    - -
    -

    OBJECT

    -

    Role

    -

    Roles contain permissions that allow certain actions.

    -
    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1type Role {
    2
    3# A unique, human-readable identifier.
    4key: String
    5
    6# The display name of the role.
    7title: String
    8
    9# The permissions granted by this role.
    10permissions: [String]
    11
    12}
    -
    -
    -
    - -
    -
    -
    -

    - Generated with graphqldoc 2.5.2 -

    +
    +
    + +
    +
    +
    +
    +

    OBJECT

    +

    Role

    +

    Roles contain permissions that allow certain actions.

    -
    + + +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1type Role {
    2
    3# A unique, human-readable identifier.
    4key: String
    5
    6# The display name of the role.
    7title: String
    8
    9# The permissions granted by this role.
    10permissions: [String]
    11
    12}
    +
    +
    +
    +
    +

    + + link + + Required by +

    + +
    +
    +
    diff --git a/docs/graphql/types/rootmutation.doc.html b/docs/graphql/types/rootmutation.doc.html deleted file mode 100644 index 9bb396b7..00000000 --- a/docs/graphql/types/rootmutation.doc.html +++ /dev/null @@ -1,593 +0,0 @@ - - - - - - - - - - - RootMutation | CodeSignal GraphQL API - - - - -
    -
    -
    - -
    -
    - -
    -

    OBJECT

    -

    RootMutation

    -

    All possible mutations.

    -
    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1type RootMutation {
    2
    3# Creates a company test.
    4createCompanyTest(testFields: CreateCompanyTestInput!): CompanyTest
    5
    6# Edits a company test with the given ID.
    7editCompanyTest(id: ID!, testFields: EditCompanyTestInput!): CompanyTest
    8
    9# Creates a task with a function as an entry point that receives input and returns
    10# the output.
    11createStandardTask(
    12taskFields: CreateStandardTaskInput!,
    13options: CreateTaskOptionsInput
    14): Task
    15
    16# Edits a standard task with the given ID.
    17editStandardTask(id: ID!, taskFields: EditStandardTaskInput!): Task
    18
    19# Creates a quiz task with one ore more correct options.
    20createQuizTask(
    21taskFields: CreateQuizInput!,
    22options: CreateTaskOptionsInput
    23): Task
    24
    25# Edits a quiz task with the given ID.
    26editQuizTask(id: ID!, taskFields: EditQuizInput!): Task
    27
    28# Edits a company's service plans and custom features.
    29editCompanyPlanSettings(
    30companyId: ID!,
    31planSettings: CompanyPlanSettingsInput!
    32): Company
    33
    34# Allow retakes of a company test.
    35# Only accept 0 or 1 as retakeAllowanceCount.
    36setCompanyTestRetakeAllowances(
    37userId: ID,
    38username: String,
    39testId: ID!,
    40retakeAllowanceCount: Int!
    41): Int
    42
    43# Creates a live interview.
    44createLiveInterview(interviewFields: LiveInterviewInput): LiveInterview
    45
    46# Edit a live interview with a given ID.
    47editLiveInterview(id: ID!, interviewFields: LiveInterviewInput!): LiveInterview
    48
    49# Creates or updates a role with the given key.
    50saveRole(key: ID!, title: String!, permissions: [String]!): Role
    51
    52# Deletes the role with the given key.
    53deleteRole(key: ID!): ID!
    54
    55createCompanyTestSession(
    56sessionFields: TestSessionInput!
    57): CompanyTestSession
    58
    59createCertificationRequest(
    60requestFields: CreateCertificationRequestInput!
    61): CertificationRequest
    62
    63}
    -
    -
    -
    -
    -

    - - link - - Required by -

    -
    This element is not required by anyone
    -
    -
    - -
    - - - - diff --git a/docs/graphql/types/rootquery.doc.html b/docs/graphql/types/rootquery.doc.html deleted file mode 100644 index bd12d2d4..00000000 --- a/docs/graphql/types/rootquery.doc.html +++ /dev/null @@ -1,593 +0,0 @@ - - - - - - - - - - - RootQuery | CodeSignal GraphQL API - - - - -
    -
    -
    - -
    -
    - -
    -

    OBJECT

    -

    RootQuery

    -

    All possible read-only queries.

    -
    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1type RootQuery {
    2
    3# Query a company by ID.
    4#
    5# Arguments
    6# id: The ID of the company to return.
    7company(id: ID!): Company
    8
    9# Query all companies.
    10companies: [Company]
    11
    12# Query all company features.
    13companyFeatures: [CompanyFeature]
    14
    15# Query a company test by ID.
    16#
    17# Arguments
    18# id: The ID of the company test to return.
    19companyTest(id: ID!): CompanyTest
    20
    21# Query a company test session by ID.
    22#
    23# Arguments
    24# id: The ID of the company test session to return.
    25companyTestSession(id: ID!): CompanyTestSession
    26
    27# Query all company test sessions associated with a given company test ID.
    28#
    29# Arguments
    30# companyTestId: The ID of the company test whose sessions should
    31# be returned.
    32# first: Use 'first' and 'offset' arguments to limit results
    33# returned
    34companyTestSessions(companyTestId: ID!, first: Int, offset: Int): [CompanyTestSession]!
    35
    36# Query a live interview by ID.
    37#
    38# Arguments
    39# liveInterviewId: The ID of the live interview.
    40liveInterview(liveInterviewId: ID!): LiveInterview
    41
    42# Query all live interviews associated with a given candidate email.
    43#
    44# Arguments
    45# candidateEmail: Email of the candidate associated with the
    46# interivew.
    47# first: Use 'first' and 'offset' arguments to limit results
    48# returned.
    49liveInterviews(candidateEmail: String!, first: Int, offset: Int): [LiveInterview]!
    50
    51# Query all roles.
    52roles: [Role]
    53
    54# Query a specific role by key.
    55role(key: ID!): Role
    56
    57# Query all service plans filtered by the give params.
    58#
    59# Arguments
    60# products: Array of CodeSignal assessment products.
    61# types: Array of plan types.
    62# statuses: Array of plan statuses.
    63servicePlans(
    64products: [Product],
    65types: [PlanType],
    66statuses: [ServicePlanStatus]
    67): [ServicePlan]
    68
    69# Query a standardized test by ID.
    70#
    71# Arguments
    72# id: The ID of the test to return.
    73standardizedTest(id: ID!): StandardizedTest
    74
    75# Query a task by ID.
    76#
    77# Arguments
    78# id: The ID of the task to return.
    79task(id: ID!): Task
    80
    81# Returns user either by ID or by username. Exactly one field (either userId or
    82# username) is required.
    83#
    84# Arguments
    85# userId: Unique user ID.
    86# username: Username unique for each user.
    87user(userId: ID, username: String): User
    88
    89# Performs an access check for the current user or API key.
    90#
    91# Arguments
    92# type: The type of access being checked.
    93# resourceId: The identifier of the resource related to the
    94# access check, if any.
    95hasAccess(type: AccessType!, resourceId: ID): Boolean
    96
    97# Given the input, returns the corresponding certification request. There are
    98# three ways to query for the request:
    99# * by unique request ID;
    100# * by candidate email and test ID (your company ID will be used implicitly);
    101# * by candidate email, test ID and company ID.
    102certificationRequest(
    103requestFields: CertificationRequestInput!
    104): CertificationRequest
    105
    106}
    -
    -
    -
    -
    -

    - - link - - Required by -

    -
    This element is not required by anyone
    -
    -
    - -
    - - - - diff --git a/docs/graphql/types/schema.spec.html b/docs/graphql/types/schema.spec.html index 88b77842..8d13b62c 100644 --- a/docs/graphql/types/schema.spec.html +++ b/docs/graphql/types/schema.spec.html @@ -23,569 +23,649 @@
    -
    -
    - -
    -
    - -
    -

    OBJECT

    -

    __Schema

    -

    A GraphQL Schema defines the capabilities of a GraphQL server. It exposes all available types and directives on the server, as well as the entry points for query, mutation, and subscription operations.

    -
    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1type __Schema {
    2
    3# A list of all types supported by this server.
    4types: [__Type!]!
    5
    6# The type that query operations will be rooted at.
    7queryType: __Type!
    8
    9# If this server supports mutation, the type that mutation operations will be
    10# rooted at.
    11mutationType: __Type
    12
    13# If this server support subscription, the type that subscription operations will
    14# be rooted at.
    15subscriptionType: __Type
    16
    17# A list of all directives supported by this server.
    18directives: [__Directive!]!
    19
    20}
    -
    -
    -
    -
    -

    - - link - - Required by -

    -
    This element is not required by anyone
    -
    -
    -
    -
    -

    - Generated with graphqldoc 2.5.2 -

    +
    +
    + +
    +
    +
    +
    +

    OBJECT

    +

    __Schema

    +

    A GraphQL Schema defines the capabilities of a GraphQL server. It exposes all available types and directives on the server, as well as the entry points for query, mutation, and subscription operations.

    -
    + + +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1type __Schema {
    2
    3# A list of all types supported by this server.
    4types: [__Type!]!
    5
    6# The type that query operations will be rooted at.
    7queryType: __Type!
    8
    9# If this server supports mutation, the type that mutation operations will be
    10# rooted at.
    11mutationType: __Type
    12
    13# If this server support subscription, the type that subscription operations will
    14# be rooted at.
    15subscriptionType: __Type
    16
    17# A list of all directives supported by this server.
    18directives: [__Directive!]!
    19
    20}
    +
    +
    +
    +
    +

    + + link + + Required by +

    +
    This element is not required by anyone
    +
    +
    +
    diff --git a/docs/graphql/types/scorerange.doc.html b/docs/graphql/types/scorerange.doc.html new file mode 100644 index 00000000..5df08c0b --- /dev/null +++ b/docs/graphql/types/scorerange.doc.html @@ -0,0 +1,673 @@ + + + + + + + + + + + ScoreRange | CodeSignal GraphQL API + + + + +
    +
    +
    + +
    +
    + +
    +

    OBJECT

    +

    ScoreRange

    +

    Score range of result labels. Boundaries are inclusive.

    +
    +
    +
    +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1type ScoreRange {
    2
    3min: Int
    4
    5max: Int
    6
    7}
    +
    +
    +
    + +
    + +
    + + + + diff --git a/docs/graphql/types/scorerangeinput.doc.html b/docs/graphql/types/scorerangeinput.doc.html new file mode 100644 index 00000000..c8596781 --- /dev/null +++ b/docs/graphql/types/scorerangeinput.doc.html @@ -0,0 +1,672 @@ + + + + + + + + + + + ScoreRangeInput | CodeSignal GraphQL API + + + + +
    +
    +
    + +
    +
    + +
    +

    INPUT_OBJECT

    +

    ScoreRangeInput

    +
    +
    +
    +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1input ScoreRangeInput {
    3
    2min: Int
    5
    4max: Int
    6}
    +
    +
    +
    +
    +

    + + link + + Required by +

    + +
    +
    + +
    + + + + diff --git a/docs/graphql/types/scorerangelabel.doc.html b/docs/graphql/types/scorerangelabel.doc.html new file mode 100644 index 00000000..5e54a835 --- /dev/null +++ b/docs/graphql/types/scorerangelabel.doc.html @@ -0,0 +1,673 @@ + + + + + + + + + + + ScoreRangeLabel | CodeSignal GraphQL API + + + + +
    +
    +
    + +
    +
    + +
    +

    OBJECT

    +

    ScoreRangeLabel

    +

    Automatically assign a label when the candidate scores within a given inclusive range.

    +
    +
    +
    +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1type ScoreRangeLabel {
    2
    3# Result label to apply to assessments in the score range.
    4label: String!
    5
    6scoreRange: ScoreRange!
    7
    8}
    +
    +
    +
    + +
    + +
    + + + + diff --git a/docs/graphql/types/scorerangelabelinput.doc.html b/docs/graphql/types/scorerangelabelinput.doc.html new file mode 100644 index 00000000..712842ad --- /dev/null +++ b/docs/graphql/types/scorerangelabelinput.doc.html @@ -0,0 +1,672 @@ + + + + + + + + + + + ScoreRangeLabelInput | CodeSignal GraphQL API + + + + +
    +
    +
    + +
    +
    + +
    +

    INPUT_OBJECT

    +

    ScoreRangeLabelInput

    +
    +
    +
    +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1input ScoreRangeLabelInput {
    3
    2label: String!
    5
    4scoreRange: ScoreRangeInput!
    6}
    +
    +
    +
    + +
    + +
    + + + + diff --git a/docs/graphql/types/serviceplan.doc.html b/docs/graphql/types/serviceplan.doc.html index cef9622c..187ec521 100644 --- a/docs/graphql/types/serviceplan.doc.html +++ b/docs/graphql/types/serviceplan.doc.html @@ -23,569 +23,649 @@
    -
    -
    - -
    -
    - -
    -

    OBJECT

    -

    ServicePlan

    -

    A service plan represents a level of functionality and service associated with a CodeSignal product.

    -
    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1type ServicePlan {
    2
    3key: ID
    4
    5product: Product
    6
    7title: String
    8
    9type: PlanType
    10
    11billingPeriod: PlanBillingPeriod
    12
    13price: Int
    14
    15status: String
    16
    17features: CompanyFeatures
    18
    19stripePlanId: String
    20
    21}
    -
    -
    -
    - -
    -
    -
    -

    - Generated with graphqldoc 2.5.2 -

    +
    +
    + +
    +
    +
    +
    +

    OBJECT

    +

    ServicePlan

    +

    A service plan represents a level of functionality and service associated with a CodeSignal product.

    -
    + + +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1type ServicePlan {
    2
    3key: ID
    4
    5product: Product
    6
    7title: String
    8
    9type: PlanType
    10
    11billingPeriod: PlanBillingPeriod
    12
    13price: Int
    14
    15status: String
    16
    17features: CompanyFeatures
    18
    19stripePlanId: String
    20
    21}
    +
    +
    +
    + +
    +
    diff --git a/docs/graphql/types/serviceplanstatus.doc.html b/docs/graphql/types/serviceplanstatus.doc.html index 00e36146..1d93f63b 100644 --- a/docs/graphql/types/serviceplanstatus.doc.html +++ b/docs/graphql/types/serviceplanstatus.doc.html @@ -23,568 +23,648 @@
    -
    -
    - -
    -
    - -
    -

    ENUM

    -

    ServicePlanStatus

    -
    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1enum ServicePlanStatus {
    2
    3enabled
    4
    5deprecated
    6
    7disabled
    8}
    -
    -
    -
    - -
    - +
    +
    + +
    +
    + +
    +

    ENUM

    +

    ServicePlanStatus

    +
    +
    + +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1enum ServicePlanStatus {
    2
    3enabled
    4
    5deprecated
    6
    7disabled
    8}
    +
    +
    +
    +
    +

    + + link + + Required by +

    + +
    +
    +
    diff --git a/docs/graphql/types/skilltype.doc.html b/docs/graphql/types/skilltype.doc.html index c78d51c2..7845180d 100644 --- a/docs/graphql/types/skilltype.doc.html +++ b/docs/graphql/types/skilltype.doc.html @@ -23,568 +23,648 @@
    -
    -
    - -
    -
    - -
    -

    ENUM

    -

    SkillType

    -
    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1enum SkillType {
    2
    3language
    4
    5tool
    6}
    -
    -
    -
    - -
    - +
    +
    + +
    +
    + +
    +

    ENUM

    +

    SkillType

    +
    +
    + +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1enum SkillType {
    2
    3language
    4
    5tool
    6}
    +
    +
    +
    + +
    +
    diff --git a/docs/graphql/types/skip.doc.html b/docs/graphql/types/skip.doc.html index 8f39433d..7c5659d7 100644 --- a/docs/graphql/types/skip.doc.html +++ b/docs/graphql/types/skip.doc.html @@ -23,569 +23,649 @@
    -
    -
    - -
    -
    - -
    -

    -

    skip

    -

    Directs the executor to skip this field or fragment when the if argument is true.

    -
    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1directive @skip(if: Boolean!) on FIELD | FRAGMENT_SPREAD | INLINE_FRAGMENT
    -
    -
    -
    -
    -

    - - link - - Required by -

    -
    This element is not required by anyone
    -
    -
    -
    -
    -

    - Generated with graphqldoc 2.5.2 -

    +
    +
    + +
    +
    +
    +
    +

    +

    skip

    +

    Directs the executor to skip this field or fragment when the if argument is true.

    -
    + + +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1directive @skip(if: Boolean!) on FIELD | FRAGMENT_SPREAD | INLINE_FRAGMENT
    +
    +
    +
    +
    +

    + + link + + Required by +

    +
    This element is not required by anyone
    +
    +
    +
    diff --git a/docs/graphql/types/slotconfigurationinput.doc.html b/docs/graphql/types/slotconfigurationinput.doc.html index faf3a75d..70e96d24 100644 --- a/docs/graphql/types/slotconfigurationinput.doc.html +++ b/docs/graphql/types/slotconfigurationinput.doc.html @@ -23,568 +23,648 @@
    -
    -
    - -
    -
    - -
    -

    INPUT_OBJECT

    -

    SlotConfigurationInput

    -
    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1input SlotConfigurationInput {
    3
    2codingDifficulty: Float!
    5
    4problemSolvingDifficulty: Float!
    7
    6averageSolveTime: Int!
    9
    8taskGroupId: Int!
    10}
    -
    -
    -
    - -
    - +
    +
    + +
    +
    + +
    +

    INPUT_OBJECT

    +

    SlotConfigurationInput

    +
    +
    + +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1input SlotConfigurationInput {
    3
    2codingDifficulty: Float!
    5
    4problemSolvingDifficulty: Float!
    7
    6averageSolveTime: Int!
    9
    8taskGroupId: Int!
    10}
    +
    +
    +
    + +
    +
    diff --git a/docs/graphql/types/solutionsource.doc.html b/docs/graphql/types/solutionsource.doc.html index 50986e18..49183b96 100644 --- a/docs/graphql/types/solutionsource.doc.html +++ b/docs/graphql/types/solutionsource.doc.html @@ -23,569 +23,649 @@
    -
    -
    - -
    -
    - -
    -

    OBJECT

    -

    SolutionSource

    -

    A file submitted as a solution to a coding task.

    -
    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1type SolutionSource {
    2
    3# File contents.
    4source: String!
    5
    6# File extension, also used as a coding language.
    7language: String!
    8
    9}
    -
    -
    -
    - -
    -
    -
    -

    - Generated with graphqldoc 2.5.2 -

    +
    +
    + +
    +
    +
    +
    +

    OBJECT

    +

    SolutionSource

    +

    A file submitted as a solution to a coding task.

    -
    + + +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1type SolutionSource {
    2
    3# File contents.
    4source: String!
    5
    6# File extension, also used as a coding language.
    7language: String!
    8
    9}
    +
    +
    +
    + +
    +
    diff --git a/docs/graphql/types/standardizedtest.doc.html b/docs/graphql/types/standardizedtest.doc.html index f17d7c5d..bb49433d 100644 --- a/docs/graphql/types/standardizedtest.doc.html +++ b/docs/graphql/types/standardizedtest.doc.html @@ -23,571 +23,651 @@
    -
    -
    - -
    -
    - -
    -

    OBJECT

    -

    StandardizedTest

    -

    A standardized test that is not restricted to a particular company.

    +
    +
    + +
    +
    +
    +
    +

    OBJECT

    +

    StandardizedTest

    +

    A standardized test that is not restricted to a particular company.

    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1type StandardizedTest implements Test {
    2
    3# Standardized test ID.
    4id: ID!
    5
    6# The display name of the test.
    7title: String!
    8
    9# A message shown to users before they begin an assessment created from the test.
    10introMessage: String!
    11
    12# A message shown to users after they finish an assessment created from the test.
    13outroMessage: String!
    14
    15# The maximum time allowed to take the test, in milliseconds.
    16duration: Int!
    17
    18# The type of standardized test.
    19type: StandardizedTestType!
    20
    21}
    -
    -
    -
    -
    -

    - - link - - Required by -

    -
    • +

      + + link + + GraphQL Schema definition +

      +
      1type StandardizedTest implements Test {
      2
      3# Standardized test ID.
      4id: ID!
      5
      6# The display name of the test.
      7title: String!
      8
      9# The internal description of the test.
      10internalDescription: String!
      11
      12# A message shown to users before they begin an assessment created from the test.
      13introMessage: String!
      14
      15# A message shown to users after they finish an assessment created from the test.
      16outroMessage: String!
      17
      18# The maximum time allowed to take the test, in milliseconds.
      19duration: Int!
      20
      21# Test labels
      22labels: [String]
      23
      24# The type of standardized test.
      25type: StandardizedTestType!
      26
      27}
      +
    +
    +
    + -
    - +by its ID, or by the (companyId, testId, candidateEmail) triplet.
  • CompanyFeaturesFeatures that can be set on a service plan or a company.
  • Query
  • + + +
  • diff --git a/docs/graphql/types/standardizedtesttype.doc.html b/docs/graphql/types/standardizedtesttype.doc.html index f605416f..63dc94d6 100644 --- a/docs/graphql/types/standardizedtesttype.doc.html +++ b/docs/graphql/types/standardizedtesttype.doc.html @@ -23,569 +23,649 @@
    -
    -
    - -
    -
    - -
    -

    ENUM

    -

    StandardizedTestType

    -

    The types of standardized tests.

    -
    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1enum StandardizedTestType {
    2
    3# Generates certified, proctored test results.
    4certification
    5
    6# Not proctored and not certified.
    7practice
    8}
    -
    -
    -
    - -
    -
    -
    -

    - Generated with graphqldoc 2.5.2 -

    +
    +
    + +
    +
    +
    +
    +

    ENUM

    +

    StandardizedTestType

    +

    The types of standardized tests.

    -
    + + +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1enum StandardizedTestType {
    2
    3# Generates certified, proctored test results.
    4certification
    5
    6# Not proctored and not certified.
    7practice
    8}
    +
    +
    +
    + +
    +
    diff --git a/docs/graphql/types/string.doc.html b/docs/graphql/types/string.doc.html index e1e7e14b..822d6f62 100644 --- a/docs/graphql/types/string.doc.html +++ b/docs/graphql/types/string.doc.html @@ -23,562 +23,644 @@
    -
    -
    - -
    -
    - -
    -

    SCALAR

    -

    String

    -

    The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

    +
    +
    + +
    +
    +
    +
    +

    SCALAR

    +

    String

    +

    The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1scalar String
    -
    -
    -
    -
    -

    - - link - - Required by -

    -
    +
    +
    +
    +

    + + link + + Required by +

    + -
    -
    - + + +
    diff --git a/docs/graphql/types/task.doc.html b/docs/graphql/types/task.doc.html index 71a02001..ada1c757 100644 --- a/docs/graphql/types/task.doc.html +++ b/docs/graphql/types/task.doc.html @@ -23,569 +23,649 @@
    -
    -
    - -
    -
    - -
    -

    OBJECT

    -

    Task

    -

    A question that may be asked during an assessment.

    -
    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1type Task {
    2
    3# Unique identifier.
    4id: ID!
    5
    6# The display name of the task.
    7title: String!
    8
    9# The text of the question that will be shown to the user.
    10description: String!
    11
    12}
    -
    -
    -
    - -
    -
    -
    -

    - Generated with graphqldoc 2.5.2 -

    +
    +
    + +
    +
    +
    +
    +

    OBJECT

    +

    Task

    +

    A question that may be asked during an assessment.

    -
    + + +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1type Task {
    2
    3# Unique identifier.
    4id: ID!
    5
    6# The display name of the task.
    7title: String!
    8
    9# The text of the question that will be shown to the user.
    10description: String!
    11
    12}
    +
    +
    +
    + +
    +
    diff --git a/docs/graphql/types/taskinputargumentinfo.doc.html b/docs/graphql/types/taskinputargumentinfo.doc.html index 0f4dd6dd..76eab559 100644 --- a/docs/graphql/types/taskinputargumentinfo.doc.html +++ b/docs/graphql/types/taskinputargumentinfo.doc.html @@ -23,568 +23,648 @@
    -
    -
    - -
    -
    - -
    -

    INPUT_OBJECT

    -

    TaskInputArgumentInfo

    -
    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1input TaskInputArgumentInfo {
    29
    2# A type of input/output arguments for a task.
    3# Can have one of the following values:
    4# - boolean
    5# - char
    6# - float
    7# - integer
    8# - integer64
    9# - string
    10# - array.boolean
    11# - array.char
    12# - array.float
    13# - array.integer
    14# - array.integer64
    15# - array.string
    16# - linkedlist.boolean
    17# - linkedlist.char
    18# - linkedlist.float
    19# - linkedlist.integer
    20# - linkedlist.integer64
    21# - linkedlist.string
    22# - array.array.boolean
    23# - array.array.char
    24# - array.array.float
    25# - array.array.integer
    26# - array.array.integer64
    27# - array.array.string
    28type: String!
    31
    30name: String!
    33
    32description: String
    34}
    -
    -
    -
    - -
    - +
    +
    + +
    +
    + +
    +

    INPUT_OBJECT

    +

    TaskInputArgumentInfo

    +
    +
    + +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1input TaskInputArgumentInfo {
    29
    2# The type of an input parameter.
    3# Can have one of the following values:
    4# - boolean
    5# - char
    6# - float
    7# - integer
    8# - integer64
    9# - string
    10# - array.boolean
    11# - array.char
    12# - array.float
    13# - array.integer
    14# - array.integer64
    15# - array.string
    16# - linkedlist.boolean
    17# - linkedlist.char
    18# - linkedlist.float
    19# - linkedlist.integer
    20# - linkedlist.integer64
    21# - linkedlist.string
    22# - array.array.boolean
    23# - array.array.char
    24# - array.array.float
    25# - array.array.integer
    26# - array.array.integer64
    27# - array.array.string
    28type: String!
    31
    30name: String!
    33
    32description: String
    34}
    +
    +
    +
    + +
    +
    diff --git a/docs/graphql/types/taskoutputinfo.doc.html b/docs/graphql/types/taskoutputinfo.doc.html index 0e489a86..2be2300c 100644 --- a/docs/graphql/types/taskoutputinfo.doc.html +++ b/docs/graphql/types/taskoutputinfo.doc.html @@ -23,568 +23,648 @@
    -
    -
    - -
    -
    - -
    -

    INPUT_OBJECT

    -

    TaskOutputInfo

    -
    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1input TaskOutputInfo {
    29
    2# A type of input/output arguments for a task.
    3# Can have one of the following values:
    4# - boolean
    5# - char
    6# - float
    7# - integer
    8# - integer64
    9# - string
    10# - array.boolean
    11# - array.char
    12# - array.float
    13# - array.integer
    14# - array.integer64
    15# - array.string
    16# - linkedlist.boolean
    17# - linkedlist.char
    18# - linkedlist.float
    19# - linkedlist.integer
    20# - linkedlist.integer64
    21# - linkedlist.string
    22# - array.array.boolean
    23# - array.array.char
    24# - array.array.float
    25# - array.array.integer
    26# - array.array.integer64
    27# - array.array.string
    28type: String!
    31
    30description: String
    32}
    -
    -
    -
    - -
    - +
    +
    + +
    +
    + +
    +

    INPUT_OBJECT

    +

    TaskOutputInfo

    +
    +
    + +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1input TaskOutputInfo {
    29
    2# The type of the output value returned as a result.
    3# Can have one of the following values:
    4# - boolean
    5# - char
    6# - float
    7# - integer
    8# - integer64
    9# - string
    10# - array.boolean
    11# - array.char
    12# - array.float
    13# - array.integer
    14# - array.integer64
    15# - array.string
    16# - linkedlist.boolean
    17# - linkedlist.char
    18# - linkedlist.float
    19# - linkedlist.integer
    20# - linkedlist.integer64
    21# - linkedlist.string
    22# - array.array.boolean
    23# - array.array.char
    24# - array.array.float
    25# - array.array.integer
    26# - array.array.integer64
    27# - array.array.string
    28type: String!
    31
    30description: String
    32}
    +
    +
    +
    + +
    +
    diff --git a/docs/graphql/types/taskslotinput.doc.html b/docs/graphql/types/taskslotinput.doc.html index 808c8c43..860591eb 100644 --- a/docs/graphql/types/taskslotinput.doc.html +++ b/docs/graphql/types/taskslotinput.doc.html @@ -23,570 +23,650 @@
    -
    -
    - -
    -
    - -
    -

    INPUT_OBJECT

    -

    TaskSlotInput

    -

    A task slot represents a pool of similar questions. +

    +
    + +
    +
    +
    +
    +

    INPUT_OBJECT

    +

    TaskSlotInput

    +

    A task slot represents a pool of similar questions. During a test session, exactly one task will be randomly chosen from each task slot.

    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1input TaskSlotInput {
    4
    2# The IDs of the tasks that may be randomly selected from this slot.
    3taskIds: [ID]!
    7
    5# The languages available to use for a task selected from this slot.
    6availableLanguages: [Language]
    11
    8# The maximum score that can be achieved by correctly solving a task from this
    9# slot.
    10score: Int!
    12}
    -
    -
    -
    - -
    - + + +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1input TaskSlotInput {
    4
    2# The IDs of the tasks that may be randomly selected from this slot.
    3taskIds: [ID]!
    7
    5# The languages available to use for a task selected from this slot.
    6availableLanguages: [Language]
    11
    8# The maximum score that can be achieved by correctly solving a task from this
    9# slot.
    10score: Int!
    12}
    +
    +
    +
    + +
    +
    diff --git a/docs/graphql/types/tasksolution.doc.html b/docs/graphql/types/tasksolution.doc.html index d13969a5..c67c14c1 100644 --- a/docs/graphql/types/tasksolution.doc.html +++ b/docs/graphql/types/tasksolution.doc.html @@ -23,569 +23,649 @@
    -
    -
    - -
    -
    - -
    -

    INTERFACE

    -

    TaskSolution

    -

    Solution submitted to a task.

    -
    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1interface TaskSolution {
    2
    3id: ID!
    4
    5}
    -
    -
    -
    - -
    -
    -
    -

    - Generated with graphqldoc 2.5.2 -

    +
    +
    + +
    +
    +
    +
    +

    INTERFACE

    +

    TaskSolution

    +

    Solution submitted to a task.

    -
    + + +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1interface TaskSolution {
    2
    3id: ID!
    4
    5}
    +
    +
    +
    + +
    +
    diff --git a/docs/graphql/types/test.doc.html b/docs/graphql/types/test.doc.html index f8f2af88..e299e76e 100644 --- a/docs/graphql/types/test.doc.html +++ b/docs/graphql/types/test.doc.html @@ -23,569 +23,649 @@
    -
    -
    - -
    -
    - -
    -

    INTERFACE

    -

    Test

    -

    A test defines a set of tasks that a user may be invited to solve as part of an assessment.

    -
    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1interface Test {
    2
    3# Test ID.
    4id: ID!
    5
    6# The display name of the test.
    7title: String!
    8
    9# A message shown to users before they begin an assessment created from the test.
    10introMessage: String!
    11
    12# A message shown to users after they finish an assessment created from the test.
    13outroMessage: String!
    14
    15# The maximum time allowed to take the test, in milliseconds.
    16duration: Int!
    17
    18}
    -
    -
    -
    - -
    -
    -
    -

    - Generated with graphqldoc 2.5.2 -

    +
    +
    + +
    +
    +
    +
    +

    INTERFACE

    +

    Test

    +

    A test defines a set of tasks that a user may be invited to solve as part of an assessment.

    -
    + + +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1interface Test {
    2
    3# Test ID.
    4id: ID!
    5
    6# The display name of the test.
    7title: String!
    8
    9# The internal description of the test.
    10internalDescription: String!
    11
    12# A message shown to users before they begin an assessment created from the test.
    13introMessage: String!
    14
    15# A message shown to users after they finish an assessment created from the test.
    16outroMessage: String!
    17
    18# The maximum time allowed to take the test, in milliseconds.
    19duration: Int!
    20
    21# Test labels
    22labels: [String]
    23
    24}
    +
    +
    +
    + +
    +
    diff --git a/docs/graphql/types/testcaseinput.doc.html b/docs/graphql/types/testcaseinput.doc.html index 3026c9e0..852ae81d 100644 --- a/docs/graphql/types/testcaseinput.doc.html +++ b/docs/graphql/types/testcaseinput.doc.html @@ -23,569 +23,649 @@
    -
    -
    - -
    -
    - -
    -

    INPUT_OBJECT

    -

    TestcaseInput

    -

    A testcase consists of a list of input values and an expected output for them.

    -
    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1input TestcaseInput {
    6
    2# A list of input arguments where each value is a JSON formatted string.
    3# Each input value in the list should match the corresponding type specified in
    4# the inputTypes list.
    5input: [String]
    10
    7# The output value as a JSON formatted string.
    8# The output value should match the type specified by outputType.
    9output: String
    11}
    -
    -
    -
    - -
    -
    -
    -

    - Generated with graphqldoc 2.5.2 -

    +
    +
    + +
    +
    +
    +
    +

    INPUT_OBJECT

    +

    TestcaseInput

    +

    A testcase consists of a list of input values and an expected output for them.

    -
    + + +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1input TestcaseInput {
    6
    2# A list of input arguments where each value is a JSON-formatted string.
    3# Each input value in the list should match the corresponding type specified in
    4# the inputTypes list.
    5input: [String]
    10
    7# The output value as a JSON-formatted string.
    8# The output value should match the type specified by outputType.
    9output: String
    11}
    +
    +
    +
    + +
    +
    diff --git a/docs/graphql/types/testsession.doc.html b/docs/graphql/types/testsession.doc.html index 58eada50..354a8f16 100644 --- a/docs/graphql/types/testsession.doc.html +++ b/docs/graphql/types/testsession.doc.html @@ -23,569 +23,649 @@
    -
    -
    - -
    -
    - -
    -

    INTERFACE

    -

    TestSession

    -

    An session of a test.

    -
    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1interface TestSession {
    2
    3id: ID!
    4
    5# Associated test from which this test session was created.
    6test: Test
    7
    8status: TestSessionStatus!
    9
    10testTaker: TestTaker!
    11
    12maxScore: Int!
    13
    14# When the test-taker actually began the test session.
    15startDate: Timestamp
    16
    17# When the test-taker completed the test session.
    18finishDate: Timestamp
    19
    20# The test-taker's feedback after completing the test session.
    21feedback: TestSessionFeedback
    22
    23result: TestSessionResult
    24
    25tasks: [TestSessionTask]!
    26
    27# Arguments
    28# taskId: Unite task ID.
    29task(taskId: ID): TestSessionTask
    30
    31# The URL the candidate can follow to take the assessment.
    32invitationUrl: String
    33
    34}
    -
    -
    -
    - -
    -
    -
    -

    - Generated with graphqldoc 2.5.2 -

    +
    +
    + +
    +
    +
    +
    +

    INTERFACE

    +

    TestSession

    +

    An session of a test.

    -
    + + +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1interface TestSession {
    2
    3id: ID!
    4
    5# Associated test from which this test session was created.
    6test: Test
    7
    8status: TestSessionStatus!
    9
    10testTaker: TestTaker!
    11
    12maxScore: Int!
    13
    14# When the test-taker actually began the test session.
    15startDate: Timestamp
    16
    17# When the test-taker completed the test session.
    18finishDate: Timestamp
    19
    20# The test-taker's feedback after completing the test session.
    21feedback: TestSessionFeedback
    22
    23result: TestSessionResult
    24
    25tasks: [TestSessionTask]!
    26
    27# Arguments
    28# taskId: Unique task ID.
    29task(taskId: ID): TestSessionTask
    30
    31# The URL the candidate can follow to take the assessment.
    32invitationUrl: String
    33
    34}
    +
    +
    +
    + +
    +
    diff --git a/docs/graphql/types/testsessionfeedback.doc.html b/docs/graphql/types/testsessionfeedback.doc.html index 190faeaf..8bb8662b 100644 --- a/docs/graphql/types/testsessionfeedback.doc.html +++ b/docs/graphql/types/testsessionfeedback.doc.html @@ -23,569 +23,649 @@
    -
    -
    - -
    -
    - -
    -

    OBJECT

    -

    TestSessionFeedback

    -

    Feedback about a test.

    -
    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1type TestSessionFeedback {
    2
    3# Free-text feedback.
    4notes: String
    5
    6# A numeric rating of the questions within the test, from 1 to 4 inclusive.
    7questions: Int
    8
    9}
    -
    -
    -
    - -
    -
    -
    -

    - Generated with graphqldoc 2.5.2 -

    +
    +
    + +
    +
    +
    +
    +

    OBJECT

    +

    TestSessionFeedback

    +

    Feedback about a test.

    -
    + + +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1type TestSessionFeedback {
    2
    3# Free-text feedback.
    4notes: String
    5
    6# A numeric rating of the questions within the test, from 1 to 4 inclusive.
    7questions: Int
    8
    9}
    +
    +
    +
    + +
    +
    diff --git a/docs/graphql/types/testsessioninput.doc.html b/docs/graphql/types/testsessioninput.doc.html index 78c414d4..215f44b0 100644 --- a/docs/graphql/types/testsessioninput.doc.html +++ b/docs/graphql/types/testsessioninput.doc.html @@ -23,568 +23,648 @@
    -
    -
    - -
    -
    - -
    -

    INPUT_OBJECT

    -

    TestSessionInput

    -
    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1input TestSessionInput {
    4
    2# The first name of the candidate.
    3candidateFirstName: String!
    7
    5# The last name of the candidate.
    6candidateLastName: String!
    10
    8# The email address of the candidate.
    9candidateEmail: String!
    13
    11# The ID of the company test for which the session should be created.
    12testId: ID!
    14}
    -
    -
    -
    - -
    - +
    +
    + +
    +
    + +
    +

    INPUT_OBJECT

    +

    TestSessionInput

    +
    +
    + +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1input TestSessionInput {
    4
    2# The first name of the candidate.
    3candidateFirstName: String!
    7
    5# The last name of the candidate.
    6candidateLastName: String!
    10
    8# The email address of the candidate.
    9candidateEmail: String!
    13
    11# The ID of the company test for which the session should be created.
    12testId: ID!
    14}
    +
    +
    +
    +
    +

    + + link + + Required by +

    + +
    +
    +
    diff --git a/docs/graphql/types/testsessionresult.doc.html b/docs/graphql/types/testsessionresult.doc.html index ddf871bf..b4e79da2 100644 --- a/docs/graphql/types/testsessionresult.doc.html +++ b/docs/graphql/types/testsessionresult.doc.html @@ -23,569 +23,649 @@
    -
    -
    - -
    -
    - -
    -

    OBJECT

    -

    TestSessionResult

    -

    The result of a completed test session.

    -
    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1type TestSessionResult {
    2
    3# The numeric score the test-taker achieved, out of the total max score of the
    4# test session.
    5score: Int!
    6
    7# A list of test-taker's result per task.
    8taskResults: [TestSessionTaskResult]!
    9
    10# Result of an individual task. Either taskId or ID needs to be provided, but not
    11# both.
    12#
    13# Arguments
    14# taskId: The ID of the task.
    15# id: The ID of user's solution.
    16taskResult(taskId: ID, id: ID): TestSessionTaskResult
    17
    18}
    -
    -
    -
    - -
    -
    -
    -

    - Generated with graphqldoc 2.5.2 -

    +
    +
    + +
    +
    +
    +
    +

    OBJECT

    +

    TestSessionResult

    +

    The result of a completed test session.

    -
    + + +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1type TestSessionResult {
    2
    3# The numeric score the test-taker achieved, out of the total max score of the
    4# test session.
    5score: Int!
    6
    7# A list of test-taker's result per task.
    8taskResults: [TestSessionTaskResult]!
    9
    10# Result of an individual task. Either taskId or ID needs to be provided, but not
    11# both.
    12#
    13# Arguments
    14# taskId: The ID of the task.
    15# id: The ID of user's solution.
    16taskResult(taskId: ID, id: ID): TestSessionTaskResult
    17
    18}
    +
    +
    +
    + +
    +
    diff --git a/docs/graphql/types/testsessionstatus.doc.html b/docs/graphql/types/testsessionstatus.doc.html index b8fa4f63..84d6e935 100644 --- a/docs/graphql/types/testsessionstatus.doc.html +++ b/docs/graphql/types/testsessionstatus.doc.html @@ -23,569 +23,649 @@
    -
    -
    - -
    -
    - -
    -

    ENUM

    -

    TestSessionStatus

    -

    The status of a test session.

    -
    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1enum TestSessionStatus {
    2
    3# The test session has been created but not started.
    4pending
    5
    6# The test-taker has started the test session.
    7active
    8
    9# The test session has been completed by the test-taker.
    10over
    11
    12# The test session has been deleted.
    13deleted
    14
    15# The test session has expired after not being started for a certain amount of
    16# time.
    17expired
    18}
    -
    -
    -
    - -
    -
    -
    -

    - Generated with graphqldoc 2.5.2 -

    +
    +
    + +
    +
    +
    +
    +

    ENUM

    +

    TestSessionStatus

    +

    The status of a test session.

    -
    + + +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1enum TestSessionStatus {
    2
    3# The test session has been created but not started.
    4pending
    5
    6# The test-taker has started the test session.
    7active
    8
    9# The test session has been completed by the test-taker.
    10over
    11
    12# The test session has been deleted.
    13deleted
    14
    15# The test session has expired after not being started for a certain amount of
    16# time.
    17expired
    18}
    +
    +
    +
    + +
    +
    diff --git a/docs/graphql/types/testsessiontask.doc.html b/docs/graphql/types/testsessiontask.doc.html index 3e531e7a..171a8eac 100644 --- a/docs/graphql/types/testsessiontask.doc.html +++ b/docs/graphql/types/testsessiontask.doc.html @@ -23,569 +23,649 @@
    -
    -
    - -
    -
    - -
    -

    OBJECT

    -

    TestSessionTask

    -

    A task given to the test taker in a test instance.

    -
    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1type TestSessionTask {
    2
    3# Maxium possible score for the task.
    4maxScore: Int!
    5
    6task: Task
    7
    8}
    -
    -
    -
    - -
    -
    -
    -

    - Generated with graphqldoc 2.5.2 -

    +
    +
    + +
    +
    +
    +
    +

    OBJECT

    +

    TestSessionTask

    +

    A task given to the test taker in a test instance.

    -
    + + +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1type TestSessionTask {
    2
    3# Maxium possible score for the task.
    4maxScore: Int!
    5
    6task: Task
    7
    8}
    +
    +
    +
    + +
    +
    diff --git a/docs/graphql/types/testsessiontaskresult.doc.html b/docs/graphql/types/testsessiontaskresult.doc.html index 190f304c..c47f5945 100644 --- a/docs/graphql/types/testsessiontaskresult.doc.html +++ b/docs/graphql/types/testsessiontaskresult.doc.html @@ -23,569 +23,649 @@
    -
    -
    - -
    -
    - -
    -

    OBJECT

    -

    TestSessionTaskResult

    -

    Result of a test session's task.

    -
    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1type TestSessionTaskResult {
    2
    3sessionTask: TestSessionTask!
    4
    5# Score received for the solution.
    6score: Int
    7
    8solution: TaskSolution
    9
    10# A link to the coding replay.
    11replayUrl: String
    12
    13}
    -
    -
    -
    - -
    -
    -
    -

    - Generated with graphqldoc 2.5.2 -

    +
    +
    + +
    +
    +
    +
    +

    OBJECT

    +

    TestSessionTaskResult

    +

    Result of a test session's task.

    -
    + + +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1type TestSessionTaskResult {
    2
    3sessionTask: TestSessionTask!
    4
    5# Score received for the solution.
    6score: Int
    7
    8solution: TaskSolution
    9
    10# A link to the coding replay.
    11replayUrl: String
    12
    13}
    +
    +
    +
    + +
    +
    diff --git a/docs/graphql/types/testtaker.doc.html b/docs/graphql/types/testtaker.doc.html index ae30a2be..474b67dd 100644 --- a/docs/graphql/types/testtaker.doc.html +++ b/docs/graphql/types/testtaker.doc.html @@ -23,569 +23,649 @@
    -
    -
    - -
    -
    - -
    -

    OBJECT

    -

    TestTaker

    -

    Identifying information associated with a test session's test-taker.

    -
    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1type TestTaker {
    2
    3email: String
    4
    5firstName: String
    6
    7lastName: String
    8
    9}
    -
    -
    -
    - -
    -
    -
    -

    - Generated with graphqldoc 2.5.2 -

    +
    +
    + +
    +
    +
    +
    +

    OBJECT

    +

    TestTaker

    +

    Identifying information associated with a test session's test-taker.

    -
    + + +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1type TestTaker {
    2
    3email: String
    4
    5firstName: String
    6
    7lastName: String
    8
    9}
    +
    +
    +
    + +
    +
    diff --git a/docs/graphql/types/timestamp.doc.html b/docs/graphql/types/timestamp.doc.html index 4f3b03fc..45457a60 100644 --- a/docs/graphql/types/timestamp.doc.html +++ b/docs/graphql/types/timestamp.doc.html @@ -23,569 +23,649 @@
    -
    -
    - -
    -
    - -
    -

    SCALAR

    -

    Timestamp

    -

    Number of milliseconds since 1 Jan 1970 / 00:00:00 UTC.

    -
    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1scalar Timestamp
    -
    -
    -
    - -
    -
    -
    -

    - Generated with graphqldoc 2.5.2 -

    +
    +
    + +
    +
    +
    +
    +

    SCALAR

    +

    Timestamp

    +

    Number of milliseconds since 1 Jan 1970 / 00:00:00 UTC.

    -
    + + +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1scalar Timestamp
    +
    +
    +
    + +
    +
    diff --git a/docs/graphql/types/type.spec.html b/docs/graphql/types/type.spec.html index cc1a758c..804441eb 100644 --- a/docs/graphql/types/type.spec.html +++ b/docs/graphql/types/type.spec.html @@ -23,574 +23,654 @@
    -
    -
    - -
    -
    - -
    -

    OBJECT

    -

    __Type

    -

    The fundamental unit of any GraphQL Schema is the type. There are many kinds of types in GraphQL as represented by the __TypeKind enum.

    +
    +
    + +
    +
    +
    +
    +

    OBJECT

    +

    __Type

    +

    The fundamental unit of any GraphQL Schema is the type. There are many kinds of types in GraphQL as represented by the __TypeKind enum.

    Depending on the kind of a type, certain fields describe information about that type. Scalar types provide no information beyond a name and description, while Enum types provide their values. Object and Interface types provide the fields they describe. Abstract types, Union and Interface, provide the Object types possible at runtime. List and NonNull types compose other types.

    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1type __Type {
    2
    3kind: __TypeKind!
    4
    5name: String
    6
    7description: String
    8
    9fields(includeDeprecated: Boolean): [__Field!]
    10
    11interfaces: [__Type!]
    12
    13possibleTypes: [__Type!]
    14
    15enumValues(includeDeprecated: Boolean): [__EnumValue!]
    16
    17inputFields: [__InputValue!]
    18
    19ofType: __Type
    20
    21}
    -
    -
    -
    - +
    +
    + -
    - + + +
    diff --git a/docs/graphql/types/typekind.spec.html b/docs/graphql/types/typekind.spec.html index e75ffa39..ca3c4f61 100644 --- a/docs/graphql/types/typekind.spec.html +++ b/docs/graphql/types/typekind.spec.html @@ -23,573 +23,653 @@
    -
    -
    - -
    -
    - -
    -

    ENUM

    -

    __TypeKind

    -

    An enum describing what kind of type a given __Type is.

    +
    +
    + +
    +
    +
    +
    +

    ENUM

    +

    __TypeKind

    +

    An enum describing what kind of type a given __Type is.

    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1enum __TypeKind {
    2
    3# Indicates this type is a scalar.
    4SCALAR
    5
    6# Indicates this type is an object. `fields` and `interfaces` are valid fields.
    7OBJECT
    8
    9# Indicates this type is an interface. `fields` and `possibleTypes` are valid
    10# fields.
    11INTERFACE
    12
    13# Indicates this type is a union. `possibleTypes` is a valid field.
    14UNION
    15
    16# Indicates this type is an enum. `enumValues` is a valid field.
    17ENUM
    18
    19# Indicates this type is an input object. `inputFields` is a valid field.
    20INPUT_OBJECT
    21
    22# Indicates this type is a list. `ofType` is a valid field.
    23LIST
    24
    25# Indicates this type is a non-null. `ofType` is a valid field.
    26NON_NULL
    27}
    -
    -
    -
    -
    -

    - - link - - Required by -

    -
    • +

      + + link + + GraphQL Schema definition +

      +
      1enum __TypeKind {
      2
      3# Indicates this type is a scalar.
      4SCALAR
      5
      6# Indicates this type is an object. `fields` and `interfaces` are valid fields.
      7OBJECT
      8
      9# Indicates this type is an interface. `fields` and `possibleTypes` are valid
      10# fields.
      11INTERFACE
      12
      13# Indicates this type is a union. `possibleTypes` is a valid field.
      14UNION
      15
      16# Indicates this type is an enum. `enumValues` is a valid field.
      17ENUM
      18
      19# Indicates this type is an input object. `inputFields` is a valid field.
      20INPUT_OBJECT
      21
      22# Indicates this type is a list. `ofType` is a valid field.
      23LIST
      24
      25# Indicates this type is a non-null. `ofType` is a valid field.
      26NON_NULL
      27}
      +
    +
    +
    + -
    - + + +
    diff --git a/docs/graphql/types/updatefrontendtaskinput.doc.html b/docs/graphql/types/updatefrontendtaskinput.doc.html new file mode 100644 index 00000000..cea7d6dd --- /dev/null +++ b/docs/graphql/types/updatefrontendtaskinput.doc.html @@ -0,0 +1,672 @@ + + + + + + + + + + + UpdateFrontendTaskInput | CodeSignal GraphQL API + + + + +
    +
    +
    + +
    +
    + +
    +

    INPUT_OBJECT

    +

    UpdateFrontendTaskInput

    +
    +
    +
    +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1input UpdateFrontendTaskInput {
    3
    2includedLibraries: [FrontendLibraryInput]
    8
    4# The list of styling languages that are allowed to be used in this task,
    5# or an empty list to allow all possible styling languages.
    6# Should always be specified together with "allowedScriptLanguages".
    7allowedStyleLanguages: [FrontendStyleLanguage]
    13
    9# The list of scripting languages that are allowed to be used in this task,
    10# or an empty list to allow all possible scripting languages.
    11# Should always be specified together with "allowedStyleLanguages".
    12allowedScriptLanguages: [FrontendScriptLanguage]
    14}
    +
    +
    +
    +
    +

    + + link + + Required by +

    + +
    +
    + +
    + + + + diff --git a/docs/graphql/types/upload.doc.html b/docs/graphql/types/upload.doc.html new file mode 100644 index 00000000..27a6ed97 --- /dev/null +++ b/docs/graphql/types/upload.doc.html @@ -0,0 +1,673 @@ + + + + + + + + + + + Upload | CodeSignal GraphQL API + + + + +
    +
    +
    + +
    +
    + +
    +

    SCALAR

    +

    Upload

    +

    The Upload scalar type represents a file upload.

    +
    +
    +
    +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1scalar Upload
    +
    +
    +
    +
    +

    + + link + + Required by +

    +
    This element is not required by anyone
    +
    +
    + +
    + + + + diff --git a/docs/graphql/types/usednumericfeatures.doc.html b/docs/graphql/types/usednumericfeatures.doc.html index 1e5c879c..66641f83 100644 --- a/docs/graphql/types/usednumericfeatures.doc.html +++ b/docs/graphql/types/usednumericfeatures.doc.html @@ -23,569 +23,649 @@
    -
    -
    - -
    -
    - -
    -

    OBJECT

    -

    UsedNumericFeatures

    -

    How many of each numeric feature a company has used. (See CompanyFeatures for a description of the numeric features.)

    -
    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1type UsedNumericFeatures {
    2
    3numLicenses: Int!
    4
    5certifyCredits: Int!
    6
    7}
    -
    -
    -
    - -
    -
    -
    -

    - Generated with graphqldoc 2.5.2 -

    +
    +
    + +
    +
    +
    +
    +

    OBJECT

    +

    UsedNumericFeatures

    +

    How many of each numeric feature a company has used. (See CompanyFeatures for a description of the numeric features.)

    -
    + + +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1type UsedNumericFeatures {
    2
    3numLicenses: Int!
    4
    5certifyCredits: Int!
    6
    7}
    +
    +
    +
    + +
    +
    diff --git a/docs/graphql/types/user.doc.html b/docs/graphql/types/user.doc.html index 13916582..f254c253 100644 --- a/docs/graphql/types/user.doc.html +++ b/docs/graphql/types/user.doc.html @@ -23,568 +23,648 @@
    -
    -
    - -
    -
    - -
    -

    OBJECT

    -

    User

    -
    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1type User {
    2
    3id: ID!
    4
    5country: Country
    6
    7username: String!
    8
    9profile: UserProfile!
    10
    11clientData: UserCompanyFields
    12
    13}
    -
    -
    -
    - -
    - +
    +
    + +
    +
    + +
    +

    OBJECT

    +

    User

    +
    +
    + +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1type User {
    2
    3id: ID!
    4
    5country: Country
    6
    7username: String!
    8
    9profile: UserProfile!
    10
    11clientData: UserCompanyFields
    12
    13}
    +
    +
    +
    +
    +

    + + link + + Required by +

    + +
    +
    +
    diff --git a/docs/graphql/types/usercompanyfields.doc.html b/docs/graphql/types/usercompanyfields.doc.html index 07e5c846..9f140054 100644 --- a/docs/graphql/types/usercompanyfields.doc.html +++ b/docs/graphql/types/usercompanyfields.doc.html @@ -23,568 +23,648 @@
    -
    -
    - -
    -
    - -
    -

    OBJECT

    -

    UserCompanyFields

    -
    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1type UserCompanyFields {
    2
    3role: String
    4
    5}
    -
    -
    -
    -
    -

    - - link - - Required by -

    - -
    -
    - +
    +
    + +
    +
    + +
    +

    OBJECT

    +

    UserCompanyFields

    +
    +
    + +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1type UserCompanyFields {
    2
    3role: String
    4
    5}
    +
    +
    +
    +
    +

    + + link + + Required by +

    + +
    +
    +
    diff --git a/docs/graphql/types/userprofile.doc.html b/docs/graphql/types/userprofile.doc.html index 610ac4a7..8e4b65da 100644 --- a/docs/graphql/types/userprofile.doc.html +++ b/docs/graphql/types/userprofile.doc.html @@ -23,569 +23,649 @@
    -
    -
    - -
    -
    - -
    -

    OBJECT

    -

    UserProfile

    -

    User profile data that can be protected by privacy settings.

    -
    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1type UserProfile {
    2
    3avatarUrl: String
    4
    5name: String
    6
    7email: String
    8
    9# List of job roles user is proficient at.
    10roles: [String]
    11
    12# User's location.
    13location: String
    14
    15# Years of experience given as a range.
    16experience: String
    17
    18phone: String
    19
    20linkedinUrl: String
    21
    22githubUrl: String
    23
    24skills: [UserSkill]
    25
    26}
    -
    -
    -
    -
    -

    - - link - - Required by -

    - -
    -
    -
    -
    -

    - Generated with graphqldoc 2.5.2 -

    +
    +
    + +
    +
    +
    +
    +

    OBJECT

    +

    UserProfile

    +

    User profile data that can be protected by privacy settings.

    -
    + + +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1type UserProfile {
    2
    3avatarUrl: String
    4
    5name: String
    6
    7email: String
    8
    9# List of job roles user is proficient at.
    10roles: [String]
    11
    12# User's location.
    13location: String
    14
    15# Years of experience given as a range.
    16experience: String
    17
    18phone: String
    19
    20linkedinUrl: String
    21
    22githubUrl: String
    23
    24skills: [UserSkill]
    25
    26}
    +
    +
    +
    +
    +

    + + link + + Required by +

    + +
    +
    +
    diff --git a/docs/graphql/types/userskill.doc.html b/docs/graphql/types/userskill.doc.html index 92657310..4cf64a80 100644 --- a/docs/graphql/types/userskill.doc.html +++ b/docs/graphql/types/userskill.doc.html @@ -23,569 +23,649 @@
    -
    -
    - -
    -
    - -
    -

    OBJECT

    -

    UserSkill

    -

    A language or a tool the user is comfortable with.

    -
    -
    -
    -
    -
    -

    - - link - - GraphQL Schema definition -

    -
    1type UserSkill {
    2
    3name: String!
    4
    5type: SkillType!
    6
    7}
    -
    -
    -
    - -
    -
    -
    -

    - Generated with graphqldoc 2.5.2 -

    +
    +
    + +
    +
    +
    +
    +

    OBJECT

    +

    UserSkill

    +

    A language or a tool the user is comfortable with.

    -
    + + +
    +
    +

    + + link + + GraphQL Schema definition +

    +
    1type UserSkill {
    2
    3name: String!
    4
    5type: SkillType!
    6
    7}
    +
    +
    +
    + +
    +