Note This repository is automatically generated from the main parser monorepo. Please submit any issues or pull requests there.
Some typescript types for OJS api responses
This package is ESM only. In Node.js (version 12.20+, 14.14+, 16.0+, 18.0+), install as
pnpm add ojs-api
# or with yarn
# yarn add ojs-api
# or with npm
# npm install ojs-api
string
Format: uri
The URL to this announcement in the REST API.
Defined in: lib/types.ts:6
number
The journal, press or preprint server ID.
Defined in: lib/types.ts:8
number
The assoc object. This should always be ASSOC_TYPE_JOURNAL
(OJS), ASSOC_TYPE_PRESS
(OMP) or ASSOC_TYPE_SERVER
(OPS).
Defined in: lib/types.ts:10
string
(Optional) The date that this announcement expires, if one is set. This is typically used to express closing dates for calls for papers.
Defined in: lib/types.ts:12
string
The date this announcement was posted.
Defined in: lib/types.ts:14
Defined in: lib/types.ts:15
Defined in: lib/types.ts:16
number
Defined in: lib/types.ts:17
Defined in: lib/types.ts:18
number
(Optional) One of the announcement type ids.
Defined in: lib/types.ts:20
number
The journal, press or preprint server ID.
Defined in: lib/types.ts:781
number
The assoc object. This should always be ASSOC_TYPE_JOURNAL
(OJS), ASSOC_TYPE_PRESS
(OMP) or ASSOC_TYPE_SERVER
(OPS).
Defined in: lib/types.ts:783
string
(Optional) The date that this announcement expires, if one is set. This is typically used to express closing dates for calls for papers.
Defined in: lib/types.ts:785
string
The date this announcement was posted.
Defined in: lib/types.ts:787
Defined in: lib/types.ts:788
Defined in: lib/types.ts:789
number
Defined in: lib/types.ts:790
Defined in: lib/types.ts:791
number
(Optional) One of the announcement type ids.
Defined in: lib/types.ts:793
string
Format: uri
The URL to this announcement in the REST API.
Defined in: lib/types.ts:800
number
The journal, press or preprint server ID.
Defined in: lib/types.ts:802
number
The assoc object. This should always be ASSOC_TYPE_JOURNAL
(OJS), ASSOC_TYPE_PRESS
(OMP) or ASSOC_TYPE_SERVER
(OPS).
Defined in: lib/types.ts:804
string
(Optional) The date that this announcement expires, if one is set. This is typically used to express closing dates for calls for papers.
Defined in: lib/types.ts:806
string
The date this announcement was posted.
Defined in: lib/types.ts:808
Defined in: lib/types.ts:809
Defined in: lib/types.ts:810
number
Defined in: lib/types.ts:811
Defined in: lib/types.ts:812
number
(Optional) One of the announcement type ids.
Defined in: lib/types.ts:814
Defined in: lib/types.ts:23
Defined in: lib/types.ts:24
string
Defined in: lib/types.ts:25
string
Defined in: lib/types.ts:26
Defined in: lib/types.ts:27
Defined in: lib/types.ts:28
number
Defined in: lib/types.ts:29
boolean
Whether or not to include this contributor in author lists when the publication appears in search results, tables of content and catalog entries.
true
Defined in: lib/types.ts:34
string
The ORCID of this contributor. See: https://orcid.org/
Defined in: lib/types.ts:36
Defined in: lib/types.ts:37
number
Defined in: lib/types.ts:38
number
The order in which this contributor should appear in a list of contriibutors.
Defined in: lib/types.ts:40
string
The primary locale of the submission this author is attached to. This locale is used as the fallback when a language is missing from a multilingual property.
Defined in: lib/types.ts:42
string
An optional URL to this contributor's webpage.
Defined in: lib/types.ts:44
number
in which user group should this contributor be identified. Usually one of the author roles, such as Author or Translator.
Defined in: lib/types.ts:46
Defined in: lib/types.ts:817
Defined in: lib/types.ts:818
string
Defined in: lib/types.ts:819
string
Defined in: lib/types.ts:820
Defined in: lib/types.ts:821
Defined in: lib/types.ts:822
number
Defined in: lib/types.ts:823
boolean
Whether or not to include this contributor in author lists when the publication appears in search results, tables of content and catalog entries.
true
Defined in: lib/types.ts:828
string
The ORCID of this contributor. See: https://orcid.org/
Defined in: lib/types.ts:830
Defined in: lib/types.ts:831
number
Defined in: lib/types.ts:832
number
The order in which this contributor should appear in a list of contriibutors.
Defined in: lib/types.ts:834
string
An optional URL to this contributor's webpage.
Defined in: lib/types.ts:836
number
in which user group should this contributor be identified. Usually one of the author roles, such as Author or Translator.
Defined in: lib/types.ts:838
Defined in: lib/types.ts:841
string
Defined in: lib/types.ts:842
Defined in: lib/types.ts:843
Defined in: lib/types.ts:844
number
Defined in: lib/types.ts:845
boolean
Whether or not to include this contributor in author lists when the publication appears in search results, tables of content and catalog entries.
true
Defined in: lib/types.ts:850
string
The ORCID of this contributor. See: https://orcid.org/
Defined in: lib/types.ts:852
Defined in: lib/types.ts:853
number
Defined in: lib/types.ts:854
number
The order in which this contributor should appear in a list of contriibutors.
Defined in: lib/types.ts:856
string
The primary locale of the submission this author is attached to. This locale is used as the fallback when a language is missing from a multilingual property.
Defined in: lib/types.ts:858
number
in which user group should this contributor be identified. Usually one of the author roles, such as Author or Translator.
Defined in: lib/types.ts:860
string
Format: uri
Defined in: lib/types.ts:50
Defined in: lib/types.ts:51
Defined in: lib/types.ts:52
Defined in: lib/types.ts:53
Defined in: lib/types.ts:54
string
Enable agencies metadata. 0
is disabled. enable
will make it available in the workflow. request
will allow an author to enter a value during submission. require
will require that the author enter a value during submission.
Defined in: lib/types.ts:56
Defined in: lib/types.ts:57
Defined in: lib/types.ts:58
Defined in: lib/types.ts:59
string
Enable citations metadata. 0
is disabled. enable
will make it available in the workflow. request
will allow an author to enter a value during submission. require
will require that the author enter a value during submission.
Defined in: lib/types.ts:61
Defined in: lib/types.ts:62
Defined in: lib/types.ts:63
Defined in: lib/types.ts:64
string
Defined in: lib/types.ts:65
string
Defined in: lib/types.ts:66
string
Defined in: lib/types.ts:67
Defined in: lib/types.ts:68
string
Defined in: lib/types.ts:69
Defined in: lib/types.ts:70
string
issue
Defined in: lib/types.ts:72
string
Enable coverage metadata. 0
is disabled. enable
will make it available in the workflow. request
will allow an author to enter a value during submission. require
will require that the author enter a value during submission.
Defined in: lib/types.ts:74
string
Defined in: lib/types.ts:75
Defined in: lib/types.ts:76
Defined in: lib/types.ts:77
Defined in: lib/types.ts:78
Defined in: lib/types.ts:79
Defined in: lib/types.ts:80
string
Defined in: lib/types.ts:81
number
2
Defined in: lib/types.ts:83
number
Defined in: lib/types.ts:84
Defined in: lib/types.ts:85
Defined in: lib/types.ts:86
number
[]
User groups that a manager will be prevented from sending bulk email to using the notify feature. Only the admin may edit this property.
Defined in: lib/types.ts:88
boolean
false
Defined in: lib/types.ts:90
boolean
Defined in: lib/types.ts:91
string
Enable disciplines metadata. 0
is disabled. enable
will make it available in the workflow. request
will allow an author to enter a value during submission. require
will require that the author enter a value during submission.
Defined in: lib/types.ts:93
Defined in: lib/types.ts:94
string
Defined in: lib/types.ts:95
boolean
Defined in: lib/types.ts:96
boolean
Defined in: lib/types.ts:97
boolean
Defined in: lib/types.ts:98
boolean
1
Defined in: lib/types.ts:100
boolean
Defined in: lib/types.ts:101
string
[]
Defined in: lib/types.ts:102
boolean
Defined in: lib/types.ts:103
boolean
Defined in: lib/types.ts:104
boolean
Defined in: lib/types.ts:105
boolean
Defined in: lib/types.ts:106
boolean
Defined in: lib/types.ts:107
string
Defined in: lib/types.ts:108
object
{
en_US?: {
altText?: string;
dateUploaded?: string;
height?: number;
name?: string;
uploadName?: string;
width?: number;
};
fr_CA?: {
altText?: string;
dateUploaded?: string;
height?: number;
name?: string;
uploadName?: string;
width?: number;
};
properties?: unknown;
type?: unknown;
}
Member | Type |
---|---|
en_US ? |
object |
en_US.altText ? |
string |
en_US.dateUploaded ? |
string |
en_US.height ? |
number |
en_US.name ? |
string |
en_US.uploadName ? |
string |
en_US.width ? |
number |
fr_CA ? |
object |
fr_CA.altText ? |
string |
fr_CA.dateUploaded ? |
string |
fr_CA.height ? |
number |
fr_CA.name ? |
string |
fr_CA.uploadName ? |
string |
fr_CA.width ? |
number |
properties ? |
unknown |
type ? |
unknown |
Defined in: lib/types.ts:109
object
{
en_US?: {
altText?: string;
dateUploaded?: string;
height?: number;
name?: string;
uploadName?: string;
width?: number;
};
fr_CA?: {
altText?: string;
dateUploaded?: string;
height?: number;
name?: string;
uploadName?: string;
width?: number;
};
properties?: unknown;
type?: unknown;
}
Member | Type |
---|---|
en_US ? |
object |
en_US.altText ? |
string |
en_US.dateUploaded ? |
string |
en_US.height ? |
number |
en_US.name ? |
string |
en_US.uploadName ? |
string |
en_US.width ? |
number |
fr_CA ? |
object |
fr_CA.altText ? |
string |
fr_CA.dateUploaded ? |
string |
fr_CA.height ? |
number |
fr_CA.name ? |
string |
fr_CA.uploadName ? |
string |
fr_CA.width ? |
number |
properties ? |
unknown |
type ? |
unknown |
Defined in: lib/types.ts:129
number
Defined in: lib/types.ts:149
number
25
Defined in: lib/types.ts:151
object
{
en_US?: {
altText?: string;
dateUploaded?: string;
height?: number;
name?: string;
uploadName?: string;
width?: number;
};
fr_CA?: {
altText?: string;
dateUploaded?: string;
height?: number;
name?: string;
uploadName?: string;
width?: number;
};
properties?: unknown;
type?: unknown;
}
Member | Type |
---|---|
en_US ? |
object |
en_US.altText ? |
string |
en_US.dateUploaded ? |
string |
en_US.height ? |
number |
en_US.name ? |
string |
en_US.uploadName ? |
string |
en_US.width ? |
number |
fr_CA ? |
object |
fr_CA.altText ? |
string |
fr_CA.dateUploaded ? |
string |
fr_CA.height ? |
number |
fr_CA.name ? |
string |
fr_CA.uploadName ? |
string |
fr_CA.width ? |
number |
properties ? |
unknown |
type ? |
unknown |
Defined in: lib/types.ts:152
string
Enable keywords metadata. 0
is disabled. enable
will make it available in the workflow. request
will allow an author to enter a value during submission. require
will require that the author enter a value during submission.
request
Defined in: lib/types.ts:176
string
Enable languages metadata. 0
is disabled. enable
will make it available in the workflow. request
will allow an author to enter a value during submission. require
will require that the author enter a value during submission.
Defined in: lib/types.ts:178
Defined in: lib/types.ts:179
Defined in: lib/types.ts:180
string
Defined in: lib/types.ts:181
Defined in: lib/types.ts:182
string
Defined in: lib/types.ts:183
number
0
Defined in: lib/types.ts:185
Defined in: lib/types.ts:186
Defined in: lib/types.ts:187
Defined in: lib/types.ts:188
number
Defined in: lib/types.ts:189
number
Defined in: lib/types.ts:190
number
Defined in: lib/types.ts:191
number
Defined in: lib/types.ts:192
number
Defined in: lib/types.ts:193
number
10
Defined in: lib/types.ts:195
number
Defined in: lib/types.ts:196
number
Defined in: lib/types.ts:197
number
4
Defined in: lib/types.ts:199
number
4
Defined in: lib/types.ts:201
string
Defined in: lib/types.ts:202
Defined in: lib/types.ts:203
Defined in: lib/types.ts:204
object
{
en_US?: {
altText?: string;
dateUploaded?: string;
height?: number;
name?: string;
uploadName?: string;
width?: number;
};
fr_CA?: {
altText?: string;
dateUploaded?: string;
height?: number;
name?: string;
uploadName?: string;
width?: number;
};
properties?: unknown;
type?: unknown;
}
Member | Type |
---|---|
en_US ? |
object |
en_US.altText ? |
string |
en_US.dateUploaded ? |
string |
en_US.height ? |
number |
en_US.name ? |
string |
en_US.uploadName ? |
string |
en_US.width ? |
number |
fr_CA ? |
object |
fr_CA.altText ? |
string |
fr_CA.dateUploaded ? |
string |
fr_CA.height ? |
number |
fr_CA.name ? |
string |
fr_CA.uploadName ? |
string |
fr_CA.width ? |
number |
properties ? |
unknown |
type ? |
unknown |
Defined in: lib/types.ts:205
string
Defined in: lib/types.ts:225
boolean
Defined in: lib/types.ts:226
string
Defined in: lib/types.ts:227
string
Defined in: lib/types.ts:228
Defined in: lib/types.ts:229
number
0
Defined in: lib/types.ts:231
Defined in: lib/types.ts:232
Defined in: lib/types.ts:233
string
Defined in: lib/types.ts:234
number
Defined in: lib/types.ts:235
number
0
Defined in: lib/types.ts:237
Defined in: lib/types.ts:238
boolean
Defined in: lib/types.ts:239
Defined in: lib/types.ts:240
number
Defined in: lib/types.ts:241
boolean
Defined in: lib/types.ts:242
boolean
Defined in: lib/types.ts:243
Defined in: lib/types.ts:244
boolean
Defined in: lib/types.ts:245
boolean
Defined in: lib/types.ts:246
boolean
Defined in: lib/types.ts:247
boolean
Defined in: lib/types.ts:248
Defined in: lib/types.ts:249
boolean
Defined in: lib/types.ts:250
string
Enable rights metadata. 0
is disabled. enable
will make it available in the workflow. request
will allow an author to enter a value during submission. require
will require that the author enter a value during submission.
Defined in: lib/types.ts:252
Defined in: lib/types.ts:253
number
Defined in: lib/types.ts:254
boolean
Defined in: lib/types.ts:255
string
[]
Defined in: lib/types.ts:256
string
Enable source metadata. 0
is disabled. enable
will make it available in the workflow. request
will allow an author to enter a value during submission. require
will require that the author enter a value during submission.
Defined in: lib/types.ts:258
object
{
dateUploaded?: string;
name?: string;
uploadName?: string;
}
Member | Type |
---|---|
dateUploaded ? |
string |
name ? |
string |
uploadName ? |
string |
Defined in: lib/types.ts:259
string
Enable subjects metadata. 0
is disabled. enable
will make it available in the workflow. request
will allow an author to enter a value during submission. require
will require that the author enter a value during submission.
Defined in: lib/types.ts:265
{
content
?:string
;order
?:number
; }[]
[ { "order": 1, "content": { "defaultLocaleKey": "default.contextSettings.checklist.notPreviouslyPublished" } }, { "order": 2, "content": { "defaultLocaleKey": "default.contextSettings.checklist.fileFormat" } }, { "order": 3, "content": { "defaultLocaleKey": "default.contextSettings.checklist.addressesLinked" } }, { "order": 4, "content": { "defaultLocaleKey": "default.contextSettings.checklist.submissionAppearance" } }, { "order": 5, "content": { "defaultLocaleKey": "default.contextSettings.checklist.bibliographicRequirements" } } ]
Defined in: lib/types.ts:300
number
Defined in: lib/types.ts:304
Defined in: lib/types.ts:305
Defined in: lib/types.ts:306
Defined in: lib/types.ts:307
string
Defined in: lib/types.ts:308
boolean
Defined in: lib/types.ts:309
string
Defined in: lib/types.ts:310
string
Defined in: lib/types.ts:311
string
Defined in: lib/types.ts:312
string
Defined in: lib/types.ts:313
string
Defined in: lib/types.ts:314
string
Defined in: lib/types.ts:315
string
[]
Defined in: lib/types.ts:316
string
[]
Defined in: lib/types.ts:317
string
[]
Defined in: lib/types.ts:318
string
default
Defined in: lib/types.ts:320
Defined in: lib/types.ts:321
string
Enable types metadata. 0
is disabled. enable
will make it available in the workflow. request
will allow an author to enter a value during submission. require
will require that the author enter a value during submission.
Defined in: lib/types.ts:323
string
Defined in: lib/types.ts:324
string
Defined in: lib/types.ts:325
Defined in: lib/types.ts:863
Defined in: lib/types.ts:864
Defined in: lib/types.ts:865
Defined in: lib/types.ts:866
string
Enable agencies metadata. 0
is disabled. enable
will make it available in the workflow. request
will allow an author to enter a value during submission. require
will require that the author enter a value during submission.
Defined in: lib/types.ts:868
Defined in: lib/types.ts:869
Defined in: lib/types.ts:870
Defined in: lib/types.ts:871
string
Enable citations metadata. 0
is disabled. enable
will make it available in the workflow. request
will allow an author to enter a value during submission. require
will require that the author enter a value during submission.
Defined in: lib/types.ts:873
Defined in: lib/types.ts:874
Defined in: lib/types.ts:875
Defined in: lib/types.ts:876
string
Defined in: lib/types.ts:877
string
Defined in: lib/types.ts:878
string
Defined in: lib/types.ts:879
Defined in: lib/types.ts:880
string
Defined in: lib/types.ts:881
Defined in: lib/types.ts:882
string
issue
Defined in: lib/types.ts:884
string
Enable coverage metadata. 0
is disabled. enable
will make it available in the workflow. request
will allow an author to enter a value during submission. require
will require that the author enter a value during submission.
Defined in: lib/types.ts:886
string
Defined in: lib/types.ts:887
Defined in: lib/types.ts:888
Defined in: lib/types.ts:889
Defined in: lib/types.ts:890
Defined in: lib/types.ts:891
Defined in: lib/types.ts:892
string
Defined in: lib/types.ts:893
number
2
Defined in: lib/types.ts:895
number
Defined in: lib/types.ts:896
Defined in: lib/types.ts:897
Defined in: lib/types.ts:898
number
[]
User groups that a manager will be prevented from sending bulk email to using the notify feature. Only the admin may edit this property.
Defined in: lib/types.ts:900
boolean
false
Defined in: lib/types.ts:902
boolean
Defined in: lib/types.ts:903
string
Enable disciplines metadata. 0
is disabled. enable
will make it available in the workflow. request
will allow an author to enter a value during submission. require
will require that the author enter a value during submission.
Defined in: lib/types.ts:905
Defined in: lib/types.ts:906
string
Defined in: lib/types.ts:907
boolean
Defined in: lib/types.ts:908
boolean
Defined in: lib/types.ts:909
boolean
Defined in: lib/types.ts:910
boolean
1
Defined in: lib/types.ts:912
boolean
Defined in: lib/types.ts:913
string
[]
Defined in: lib/types.ts:914
boolean
Defined in: lib/types.ts:915
boolean
Defined in: lib/types.ts:916
boolean
Defined in: lib/types.ts:917
boolean
Defined in: lib/types.ts:918
boolean
Defined in: lib/types.ts:919
string
Defined in: lib/types.ts:920
object
{
en_US?: {
altText?: string;
dateUploaded?: string;
height?: number;
name?: string;
temporaryFileId?: number;
uploadName?: string;
width?: number;
};
fr_CA?: {
altText?: string;
dateUploaded?: string;
height?: number;
name?: string;
temporaryFileId?: number;
uploadName?: string;
width?: number;
};
properties?: unknown;
type?: unknown;
}
Member | Type |
---|---|
en_US ? |
object |
en_US.altText ? |
string |
en_US.dateUploaded ? |
string |
en_US.height ? |
number |
en_US.name ? |
string |
en_US.temporaryFileId ? |
number |
en_US.uploadName ? |
string |
en_US.width ? |
number |
fr_CA ? |
object |
fr_CA.altText ? |
string |
fr_CA.dateUploaded ? |
string |
fr_CA.height ? |
number |
fr_CA.name ? |
string |
fr_CA.temporaryFileId ? |
number |
fr_CA.uploadName ? |
string |
fr_CA.width ? |
number |
properties ? |
unknown |
type ? |
unknown |
Defined in: lib/types.ts:921
object
{
en_US?: {
altText?: string;
dateUploaded?: string;
height?: number;
name?: string;
temporaryFileId?: number;
uploadName?: string;
width?: number;
};
fr_CA?: {
altText?: string;
dateUploaded?: string;
height?: number;
name?: string;
temporaryFileId?: number;
uploadName?: string;
width?: number;
};
properties?: unknown;
type?: unknown;
}
Member | Type |
---|---|
en_US ? |
object |
en_US.altText ? |
string |
en_US.dateUploaded ? |
string |
en_US.height ? |
number |
en_US.name ? |
string |
en_US.temporaryFileId ? |
number |
en_US.uploadName ? |
string |
en_US.width ? |
number |
fr_CA ? |
object |
fr_CA.altText ? |
string |
fr_CA.dateUploaded ? |
string |
fr_CA.height ? |
number |
fr_CA.name ? |
string |
fr_CA.temporaryFileId ? |
number |
fr_CA.uploadName ? |
string |
fr_CA.width ? |
number |
properties ? |
unknown |
type ? |
unknown |
Defined in: lib/types.ts:943
number
25
Defined in: lib/types.ts:966
object
{
en_US?: {
altText?: string;
dateUploaded?: string;
height?: number;
name?: string;
temporaryFileId?: number;
uploadName?: string;
width?: number;
};
fr_CA?: {
altText?: string;
dateUploaded?: string;
height?: number;
name?: string;
temporaryFileId?: number;
uploadName?: string;
width?: number;
};
properties?: unknown;
type?: unknown;
}
Member | Type |
---|---|
en_US ? |
object |
en_US.altText ? |
string |
en_US.dateUploaded ? |
string |
en_US.height ? |
number |
en_US.name ? |
string |
en_US.temporaryFileId ? |
number |
en_US.uploadName ? |
string |
en_US.width ? |
number |
fr_CA ? |
object |
fr_CA.altText ? |
string |
fr_CA.dateUploaded ? |
string |
fr_CA.height ? |
number |
fr_CA.name ? |
string |
fr_CA.temporaryFileId ? |
number |
fr_CA.uploadName ? |
string |
fr_CA.width ? |
number |
properties ? |
unknown |
type ? |
unknown |
Defined in: lib/types.ts:967
string
Enable keywords metadata. 0
is disabled. enable
will make it available in the workflow. request
will allow an author to enter a value during submission. require
will require that the author enter a value during submission.
request
Defined in: lib/types.ts:993
string
Enable languages metadata. 0
is disabled. enable
will make it available in the workflow. request
will allow an author to enter a value during submission. require
will require that the author enter a value during submission.
Defined in: lib/types.ts:995
Defined in: lib/types.ts:996
Defined in: lib/types.ts:997
string
Defined in: lib/types.ts:998
Defined in: lib/types.ts:999
string
Defined in: lib/types.ts:1000
number
0
Defined in: lib/types.ts:1002
Defined in: lib/types.ts:1003
Defined in: lib/types.ts:1004
Defined in: lib/types.ts:1005
number
Defined in: lib/types.ts:1006
number
Defined in: lib/types.ts:1007
number
Defined in: lib/types.ts:1008
number
Defined in: lib/types.ts:1009
number
Defined in: lib/types.ts:1010
number
10
Defined in: lib/types.ts:1012
number
Defined in: lib/types.ts:1013
number
Defined in: lib/types.ts:1014
number
4
Defined in: lib/types.ts:1016
number
4
Defined in: lib/types.ts:1018
string
Defined in: lib/types.ts:1019
Defined in: lib/types.ts:1020
Defined in: lib/types.ts:1021
object
{
en_US?: {
altText?: string;
dateUploaded?: string;
height?: number;
name?: string;
temporaryFileId?: number;
uploadName?: string;
width?: number;
};
fr_CA?: {
altText?: string;
dateUploaded?: string;
height?: number;
name?: string;
temporaryFileId?: number;
uploadName?: string;
width?: number;
};
properties?: unknown;
type?: unknown;
}
Member | Type |
---|---|
en_US ? |
object |
en_US.altText ? |
string |
en_US.dateUploaded ? |
string |
en_US.height ? |
number |
en_US.name ? |
string |
en_US.temporaryFileId ? |
number |
en_US.uploadName ? |
string |
en_US.width ? |
number |
fr_CA ? |
object |
fr_CA.altText ? |
string |
fr_CA.dateUploaded ? |
string |
fr_CA.height ? |
number |
fr_CA.name ? |
string |
fr_CA.temporaryFileId ? |
number |
fr_CA.uploadName ? |
string |
fr_CA.width ? |
number |
properties ? |
unknown |
type ? |
unknown |
Defined in: lib/types.ts:1022
string
Defined in: lib/types.ts:1044
boolean
Defined in: lib/types.ts:1045
string
Defined in: lib/types.ts:1046
string
Defined in: lib/types.ts:1047
Defined in: lib/types.ts:1048
number
0
Defined in: lib/types.ts:1050
Defined in: lib/types.ts:1051
Defined in: lib/types.ts:1052
string
Defined in: lib/types.ts:1053
number
Defined in: lib/types.ts:1054
number
0
Defined in: lib/types.ts:1056
Defined in: lib/types.ts:1057
boolean
Defined in: lib/types.ts:1058
Defined in: lib/types.ts:1059
number
Defined in: lib/types.ts:1060
boolean
Defined in: lib/types.ts:1061
boolean
Defined in: lib/types.ts:1062
Defined in: lib/types.ts:1063
boolean
Defined in: lib/types.ts:1064
boolean
Defined in: lib/types.ts:1065
boolean
Defined in: lib/types.ts:1066
boolean
Defined in: lib/types.ts:1067
Defined in: lib/types.ts:1068
boolean
Defined in: lib/types.ts:1069
string
Enable rights metadata. 0
is disabled. enable
will make it available in the workflow. request
will allow an author to enter a value during submission. require
will require that the author enter a value during submission.
Defined in: lib/types.ts:1071
Defined in: lib/types.ts:1072
number
Defined in: lib/types.ts:1073
boolean
Defined in: lib/types.ts:1074
string
[]
Defined in: lib/types.ts:1075
string
Enable source metadata. 0
is disabled. enable
will make it available in the workflow. request
will allow an author to enter a value during submission. require
will require that the author enter a value during submission.
Defined in: lib/types.ts:1077
object
{
dateUploaded?: string;
name?: string;
temporaryFileId?: number;
uploadName?: string;
}
Member | Type |
---|---|
dateUploaded ? |
string |
name ? |
string |
temporaryFileId ? |
number |
uploadName ? |
string |
Defined in: lib/types.ts:1078
string
Enable subjects metadata. 0
is disabled. enable
will make it available in the workflow. request
will allow an author to enter a value during submission. require
will require that the author enter a value during submission.
Defined in: lib/types.ts:1085
{
content
?:string
;order
?:number
; }[]
[ { "order": 1, "content": { "defaultLocaleKey": "default.contextSettings.checklist.notPreviouslyPublished" } }, { "order": 2, "content": { "defaultLocaleKey": "default.contextSettings.checklist.fileFormat" } }, { "order": 3, "content": { "defaultLocaleKey": "default.contextSettings.checklist.addressesLinked" } }, { "order": 4, "content": { "defaultLocaleKey": "default.contextSettings.checklist.submissionAppearance" } }, { "order": 5, "content": { "defaultLocaleKey": "default.contextSettings.checklist.bibliographicRequirements" } } ]
Defined in: lib/types.ts:1120
number
Defined in: lib/types.ts:1124
Defined in: lib/types.ts:1125
Defined in: lib/types.ts:1126
Defined in: lib/types.ts:1127
string
Defined in: lib/types.ts:1128
boolean
Defined in: lib/types.ts:1129
string
Defined in: lib/types.ts:1130
string
Defined in: lib/types.ts:1131
string
Defined in: lib/types.ts:1132
string
Defined in: lib/types.ts:1133
string
Defined in: lib/types.ts:1134
string
Defined in: lib/types.ts:1135
string
[]
Defined in: lib/types.ts:1136
string
[]
Defined in: lib/types.ts:1137
string
[]
Defined in: lib/types.ts:1138
string
default
Defined in: lib/types.ts:1140
Defined in: lib/types.ts:1141
string
Enable types metadata. 0
is disabled. enable
will make it available in the workflow. request
will allow an author to enter a value during submission. require
will require that the author enter a value during submission.
Defined in: lib/types.ts:1143
string
Defined in: lib/types.ts:1144
string
Format: uri
Defined in: lib/types.ts:1148
Defined in: lib/types.ts:1149
Defined in: lib/types.ts:1150
Defined in: lib/types.ts:1151
boolean
Defined in: lib/types.ts:1152
number
Defined in: lib/types.ts:1153
object
{
en_US?: {
};
fr_CA?: {
};
properties?: unknown;
type?: unknown;
}
Member | Type |
---|---|
en_US ? |
{ } |
fr_CA ? |
{ } |
properties ? |
unknown |
type ? |
unknown |
Defined in: lib/types.ts:1154
Defined in: lib/types.ts:1160
number
Defined in: lib/types.ts:1161
string
Defined in: lib/types.ts:1162
string
Defined in: lib/types.ts:1163
string
Format: uri
Defined in: lib/types.ts:334
Defined in: lib/types.ts:335
boolean
Can this email template be disabled in the context settings area? Default is true
.
Defined in: lib/types.ts:337
boolean
Can this email template be edited in the context settings area? Default is true
.
Defined in: lib/types.ts:339
number
The ID of the context (journal/press) this email is related to. Only used for custom email templates. Default is null
.
Defined in: lib/types.ts:341
Defined in: lib/types.ts:342
boolean
Is this email template enabled? Default is true
.
Defined in: lib/types.ts:344
number
The ROLE_ID_*
of the user who will send this email.
Defined in: lib/types.ts:346
number
The email template ID.
Defined in: lib/types.ts:348
string
A unique key for this email template.
Defined in: lib/types.ts:350
number
The WORKFLOW_STAGE_ID_*
that email template is associated with or null
if it is not associated with a stage.
Defined in: lib/types.ts:352
Defined in: lib/types.ts:353
number
The ROLE_ID_*
of the user who will receive this email.
Defined in: lib/types.ts:355
Defined in: lib/types.ts:1166
number
The ID of the context (journal/press) this email is related to. Only used for custom email templates. Default is null
.
Defined in: lib/types.ts:1168
boolean
Is this email template enabled? Default is true
.
Defined in: lib/types.ts:1170
string
A unique key for this email template.
Defined in: lib/types.ts:1172
Defined in: lib/types.ts:1173
string
Format: uri
Defined in: lib/types.ts:1177
Defined in: lib/types.ts:1178
boolean
Can this email template be disabled in the context settings area? Default is true
.
Defined in: lib/types.ts:1180
boolean
Can this email template be edited in the context settings area? Default is true
.
Defined in: lib/types.ts:1182
number
The ID of the context (journal/press) this email is related to. Only used for custom email templates. Default is null
.
Defined in: lib/types.ts:1184
Defined in: lib/types.ts:1185
boolean
Is this email template enabled? Default is true
.
Defined in: lib/types.ts:1187
number
The ROLE_ID_*
of the user who will send this email.
Defined in: lib/types.ts:1189
number
The email template ID.
Defined in: lib/types.ts:1191
string
A unique key for this email template.
Defined in: lib/types.ts:1193
number
The WORKFLOW_STAGE_ID_*
that email template is associated with or null
if it is not associated with a stage.
Defined in: lib/types.ts:1195
Defined in: lib/types.ts:1196
number
The ROLE_ID_*
of the user who will receive this email.
Defined in: lib/types.ts:1198
A response object that will be returned when the request could not be fulfilled.
string
Defined in: lib/types.ts:329
string
Defined in: lib/types.ts:330
Defined in: lib/types.ts:358
number
Defined in: lib/types.ts:359
boolean
Defined in: lib/types.ts:360
string
A human-readable label for this galley. For the primary article, it is usually indicates the format like PDF, ePub or full text. For supplementary files it often indicates the content, such as source data or interview transcripts.
Defined in: lib/types.ts:362
string
The primary locale of this galley.
Defined in: lib/types.ts:364
string
A unique ID provided by the publisher. It will be used in the publication's URL path instead of the id
when present.
Defined in: lib/types.ts:366
number
Defined in: lib/types.ts:367
number
In what order this galley should appear in lists of galleys for this publication.
Defined in: lib/types.ts:369
number
Defined in: lib/types.ts:370
string
An optional path to use in the URL instead of the ID.
Defined in: lib/types.ts:372
string
The URL where this galley can be viewed or downloaded.
Defined in: lib/types.ts:374
string
An optional URL where the galley can be viewed or downloaded.
Defined in: lib/types.ts:376
boolean
Defined in: lib/types.ts:1201
string
A human-readable label for this galley. For the primary article, it is usually indicates the format like PDF, ePub or full text. For supplementary files it often indicates the content, such as source data or interview transcripts.
Defined in: lib/types.ts:1203
string
The primary locale of this galley.
Defined in: lib/types.ts:1205
string
A unique ID provided by the publisher. It will be used in the publication's URL path instead of the id
when present.
Defined in: lib/types.ts:1207
number
Defined in: lib/types.ts:1208
number
In what order this galley should appear in lists of galleys for this publication.
Defined in: lib/types.ts:1210
number
Defined in: lib/types.ts:1211
string
An optional path to use in the URL instead of the ID.
Defined in: lib/types.ts:1213
string
An optional URL where the galley can be viewed or downloaded.
Defined in: lib/types.ts:1215
Defined in: lib/types.ts:1218
number
Defined in: lib/types.ts:1219
boolean
Defined in: lib/types.ts:1220
string
A human-readable label for this galley. For the primary article, it is usually indicates the format like PDF, ePub or full text. For supplementary files it often indicates the content, such as source data or interview transcripts.
Defined in: lib/types.ts:1222
string
The primary locale of this galley.
Defined in: lib/types.ts:1224
string
A unique ID provided by the publisher. It will be used in the publication's URL path instead of the id
when present.
Defined in: lib/types.ts:1226
number
Defined in: lib/types.ts:1227
number
In what order this galley should appear in lists of galleys for this publication.
Defined in: lib/types.ts:1229
number
Defined in: lib/types.ts:1230
string
The URL where this galley can be viewed or downloaded.
Defined in: lib/types.ts:1232
string
An optional URL where the galley can be viewed or downloaded.
Defined in: lib/types.ts:1234
A response object that will be returned when there are validation errors for the request parameters. Typically used with forms.
{
* "name": [
* "You must provide a name to create a new user."
* ],
* "roles": [
* "You must assign the user to one or more roles."
* ]
* }
string
Defined in: lib/types.ts:393
Defined in: lib/types.ts:394
Defined in: lib/types.ts:395
Defined in: lib/types.ts:396
string
Defined in: lib/types.ts:397
string
Defined in: lib/types.ts:398
Defined in: lib/types.ts:399
string
Defined in: lib/types.ts:400
Galley
[]
Defined in: lib/types.ts:401
number
Defined in: lib/types.ts:402
string
Defined in: lib/types.ts:403
boolean
Defined in: lib/types.ts:404
string
Defined in: lib/types.ts:405
string
Defined in: lib/types.ts:406
string
Defined in: lib/types.ts:407
Defined in: lib/types.ts:408
Defined in: lib/types.ts:409
string
An optional path to use in the URL instead of the ID.
Defined in: lib/types.ts:411
number
Defined in: lib/types.ts:412
number
Defined in: lib/types.ts:413
Defined in: lib/types.ts:1237
Defined in: lib/types.ts:1238
string
Defined in: lib/types.ts:1239
string
Defined in: lib/types.ts:1240
Defined in: lib/types.ts:1241
string
Defined in: lib/types.ts:1242
number
Defined in: lib/types.ts:1243
string
Defined in: lib/types.ts:1244
string
Defined in: lib/types.ts:1245
string
Defined in: lib/types.ts:1246
Defined in: lib/types.ts:1247
string
An optional path to use in the URL instead of the ID.
Defined in: lib/types.ts:1249
number
Defined in: lib/types.ts:1250
number
Defined in: lib/types.ts:1251
string
Defined in: lib/types.ts:1254
Defined in: lib/types.ts:1255
Defined in: lib/types.ts:1256
string
Defined in: lib/types.ts:1257
Defined in: lib/types.ts:1258
Galley
[]
Defined in: lib/types.ts:1259
number
Defined in: lib/types.ts:1260
string
Defined in: lib/types.ts:1261
string
Defined in: lib/types.ts:1262
string
Defined in: lib/types.ts:1263
Defined in: lib/types.ts:1264
number
Defined in: lib/types.ts:1265
number
Defined in: lib/types.ts:1266
Key/value pairs containing data stored by locale key.
{
* "en_US": "Filename",
* "fr_CA": "Nom de fichier"
* }
string
Format: uri
Defined in: lib/types.ts:427
Defined in: lib/types.ts:428
number
0
Defined in: lib/types.ts:430
Author
[]
A list of the authors for this publication.
Defined in: lib/types.ts:432
string
All of the authors rendered with the appropriate separators according to the locale.
Defined in: lib/types.ts:434
string
A shortened version of the authors rendered with the appropriate separators according to the locale.
Defined in: lib/types.ts:436
number
[]
Defined in: lib/types.ts:437
string
[]
Optional metadata that contains an array of references for works cited in this submission. References have been split and parsed from the raw text.
Defined in: lib/types.ts:439
string
Optional metadata that contains references for works cited in this submission as raw text.
Defined in: lib/types.ts:441
Defined in: lib/types.ts:442
number
The copyright year for this publication.
Defined in: lib/types.ts:444
object
{
en_US?: {
altText?: string;
dateUploaded?: string;
uploadName?: string;
};
fr_CA?: {
altText?: string;
dateUploaded?: string;
uploadName?: string;
};
properties?: unknown;
type?: unknown;
}
Member | Type |
---|---|
en_US ? |
object |
en_US.altText ? |
string |
en_US.dateUploaded ? |
string |
en_US.uploadName ? |
string |
fr_CA ? |
object |
fr_CA.altText ? |
string |
fr_CA.dateUploaded ? |
string |
fr_CA.uploadName ? |
string |
properties ? |
unknown |
type ? |
unknown |
Defined in: lib/types.ts:445
Defined in: lib/types.ts:459
string
Defined in: lib/types.ts:460
string
[]
Optional metadata that describes the submission's types of study or branches of knowledge.
Defined in: lib/types.ts:462
Defined in: lib/types.ts:463
Galley
[]
Defined in: lib/types.ts:464
boolean
Whether the contributor details should be displayed for this publication. Commonly used for editorial statements without individual authorship.
false
Defined in: lib/types.ts:469
number
Defined in: lib/types.ts:470
number
Defined in: lib/types.ts:471
string
[]
Optional metadata, usually one- to three-word phrases that are used to indicate the main topics of a submission.
Defined in: lib/types.ts:473
string
[]
Optional metadata that identifies the submission's primary language.
Defined in: lib/types.ts:475
string
Defined in: lib/types.ts:476
string
A URL to a webpage describing the license terms for this publication.
Defined in: lib/types.ts:478
string
The primary locale of the submission this publication is attached to. This locale is used as the fallback when a language is missing from a multilingual property.
Defined in: lib/types.ts:480
string
The pages of the issue in which this article appears if it is published in a physical format.
Defined in: lib/types.ts:482
Defined in: lib/types.ts:483
number
Which contributor
is the primary contact for this publication.
Defined in: lib/types.ts:485
string
A unique ID provided by the publisher. It will be used in the publication's URL path instead of the id
when present.
Defined in: lib/types.ts:487
Defined in: lib/types.ts:488
number
Defined in: lib/types.ts:489
number
0
Defined in: lib/types.ts:491
Defined in: lib/types.ts:492
number
Whether the publication is Queued (not yet scheduled for publication), Declined, Published or Scheduled (scheduled for publication at a future date). One of the STATUS_*
constants. Default is STATUS_QUEUED
.
1
Defined in: lib/types.ts:497
string
[]
Optional metadata that consists of keywords, key phrases or classification codes that describe the submission's topics.
Defined in: lib/types.ts:499
number
Defined in: lib/types.ts:500
Defined in: lib/types.ts:501
string
[]
Optional metadata that indicates the source of research funding or other institutional support.
Defined in: lib/types.ts:503
Defined in: lib/types.ts:504
Defined in: lib/types.ts:505
string
An optional path to use in the URL instead of the ID.
Defined in: lib/types.ts:507
string
The public URL for this publication or where it will be available if it has not yet been published.
Defined in: lib/types.ts:509
number
The version number of this publication. Version numbers should increment by one so that the third publication of a submission will have the version number 3
. Version numbers should typically be set automatically and editorial staff should not be encouraged to modify them.
Defined in: lib/types.ts:511
Defined in: lib/types.ts:1269
number
0
Defined in: lib/types.ts:1271
number
[]
Defined in: lib/types.ts:1272
string
Optional metadata that contains references for works cited in this submission as raw text.
Defined in: lib/types.ts:1274
Defined in: lib/types.ts:1275
number
The copyright year for this publication.
Defined in: lib/types.ts:1277
object
{
en_US?: {
altText?: string;
dateUploaded?: string;
temporaryFileId?: number;
uploadName?: string;
};
fr_CA?: {
altText?: string;
dateUploaded?: string;
temporaryFileId?: number;
uploadName?: string;
};
properties?: unknown;
type?: unknown;
}
Member | Type |
---|---|
en_US ? |
object |
en_US.altText ? |
string |
en_US.dateUploaded ? |
string |
en_US.temporaryFileId ? |
number |
en_US.uploadName ? |
string |
fr_CA ? |
object |
fr_CA.altText ? |
string |
fr_CA.dateUploaded ? |
string |
fr_CA.temporaryFileId ? |
number |
fr_CA.uploadName ? |
string |
properties ? |
unknown |
type ? |
unknown |
Defined in: lib/types.ts:1278
Defined in: lib/types.ts:1294
string
Defined in: lib/types.ts:1295
string
[]
Optional metadata that describes the submission's types of study or branches of knowledge.
Defined in: lib/types.ts:1297
boolean
Whether the contributor details should be displayed for this publication. Commonly used for editorial statements without individual authorship.
false
Defined in: lib/types.ts:1302
number
Defined in: lib/types.ts:1303
string
[]
Optional metadata, usually one- to three-word phrases that are used to indicate the main topics of a submission.
Defined in: lib/types.ts:1305
string
[]
Optional metadata that identifies the submission's primary language.
Defined in: lib/types.ts:1307
string
Defined in: lib/types.ts:1308
string
A URL to a webpage describing the license terms for this publication.
Defined in: lib/types.ts:1310
string
The pages of the issue in which this article appears if it is published in a physical format.
Defined in: lib/types.ts:1312
Defined in: lib/types.ts:1313
number
Which contributor
is the primary contact for this publication.
Defined in: lib/types.ts:1315
string
A unique ID provided by the publisher. It will be used in the publication's URL path instead of the id
when present.
Defined in: lib/types.ts:1317
Defined in: lib/types.ts:1318
number
Defined in: lib/types.ts:1319
number
0
Defined in: lib/types.ts:1321
Defined in: lib/types.ts:1322
number
Whether the publication is Queued (not yet scheduled for publication), Declined, Published or Scheduled (scheduled for publication at a future date). One of the STATUS_*
constants. Default is STATUS_QUEUED
.
1
Defined in: lib/types.ts:1327
string
[]
Optional metadata that consists of keywords, key phrases or classification codes that describe the submission's topics.
Defined in: lib/types.ts:1329
number
Defined in: lib/types.ts:1330
Defined in: lib/types.ts:1331
string
[]
Optional metadata that indicates the source of research funding or other institutional support.
Defined in: lib/types.ts:1333
Defined in: lib/types.ts:1334
Defined in: lib/types.ts:1335
string
An optional path to use in the URL instead of the ID.
Defined in: lib/types.ts:1337
number
The version number of this publication. Version numbers should increment by one so that the third publication of a submission will have the version number 3
. Version numbers should typically be set automatically and editorial staff should not be encouraged to modify them.
Defined in: lib/types.ts:1339
The total abstract and galley views for a published submission.
number
Defined in: lib/types.ts:515
number
Defined in: lib/types.ts:516
number
Defined in: lib/types.ts:518
number
Defined in: lib/types.ts:519
number
Defined in: lib/types.ts:517
object
{
_href?: string;
fullTitle?: LocaleObject;
id?: number;
shortAuthorString?: string;
urlPublished?: string;
urlWorkflow?: string;
}
Member | Type |
---|---|
_href ? |
string |
fullTitle ? |
LocaleObject |
id ? |
number |
shortAuthorString ? |
string |
urlPublished ? |
string |
urlWorkflow ? |
string |
Defined in: lib/types.ts:520
string
Format: uri
Defined in: lib/types.ts:1343
string
All of the authors rendered with the appropriate separators according to the locale.
Defined in: lib/types.ts:1345
string
A shortened version of the authors rendered with the appropriate separators according to the locale.
Defined in: lib/types.ts:1347
number
[]
Defined in: lib/types.ts:1348
object
{
en_US?: {
};
fr_CA?: {
};
properties?: unknown;
type?: unknown;
}
Member | Type |
---|---|
en_US ? |
{ } |
fr_CA ? |
{ } |
properties ? |
unknown |
type ? |
unknown |
Defined in: lib/types.ts:1349
string
Defined in: lib/types.ts:1355
Defined in: lib/types.ts:1356
Galley
[]
Defined in: lib/types.ts:1357
number
Defined in: lib/types.ts:1358
string
The primary locale of the submission this publication is attached to. This locale is used as the fallback when a language is missing from a multilingual property.
Defined in: lib/types.ts:1360
string
The pages of the issue in which this article appears if it is published in a physical format.
Defined in: lib/types.ts:1362
Defined in: lib/types.ts:1363
number
Which contributor
is the primary contact for this publication.
Defined in: lib/types.ts:1365
string
A unique ID provided by the publisher. It will be used in the publication's URL path instead of the id
when present.
Defined in: lib/types.ts:1367
number
Defined in: lib/types.ts:1368
number
Whether the publication is Queued (not yet scheduled for publication), Declined, Published or Scheduled (scheduled for publication at a future date). One of the STATUS_*
constants. Default is STATUS_QUEUED
.
1
Defined in: lib/types.ts:1373
number
Defined in: lib/types.ts:1374
Defined in: lib/types.ts:1375
Defined in: lib/types.ts:1376
string
The public URL for this publication or where it will be available if it has not yet been published.
Defined in: lib/types.ts:1378
number
The version number of this publication. Version numbers should increment by one so that the third publication of a submission will have the version number 3
. Version numbers should typically be set automatically and editorial staff should not be encouraged to modify them.
Defined in: lib/types.ts:1380
number
Defined in: lib/types.ts:530
number
Defined in: lib/types.ts:531
number
Defined in: lib/types.ts:532
string
Defined in: lib/types.ts:533
number
Defined in: lib/types.ts:534
number
Defined in: lib/types.ts:1383
number
Defined in: lib/types.ts:1384
number
Defined in: lib/types.ts:1385
number
Defined in: lib/types.ts:1386
A special representation of a User assigned to a reviewer group. This model presents specific details about review activity.
string
Defined in: lib/types.ts:538
Defined in: lib/types.ts:539
number
Defined in: lib/types.ts:540
string
Defined in: lib/types.ts:541
boolean
Defined in: lib/types.ts:542
string
Defined in: lib/types.ts:543
Defined in: lib/types.ts:544
Defined in: lib/types.ts:545
number
Defined in: lib/types.ts:546
Defined in: lib/types.ts:547
number
Defined in: lib/types.ts:548
number
Defined in: lib/types.ts:550
number
Defined in: lib/types.ts:549
number
Defined in: lib/types.ts:551
string
Defined in: lib/types.ts:552
Defined in: lib/types.ts:555
number
Defined in: lib/types.ts:556
number
Defined in: lib/types.ts:557
Defined in: lib/types.ts:558
Defined in: lib/types.ts:1389
number
Defined in: lib/types.ts:1390
number
Defined in: lib/types.ts:1391
Defined in: lib/types.ts:1392
Defined in: lib/types.ts:1395
number
Defined in: lib/types.ts:1396
number
Defined in: lib/types.ts:1397
Defined in: lib/types.ts:1398
Defined in: lib/types.ts:561
Defined in: lib/types.ts:562
Defined in: lib/types.ts:563
number
[]
Which hosted journals, presses or preprint servers are allowed to send bulk emails.
Defined in: lib/types.ts:565
string
[]
Defined in: lib/types.ts:566
number
Defined in: lib/types.ts:567
Defined in: lib/types.ts:568
object
{
en_US?: {
altText?: string;
dateUploaded?: string;
height?: number;
name?: string;
uploadName?: string;
width?: number;
};
fr_CA?: {
altText?: string;
dateUploaded?: string;
height?: number;
name?: string;
uploadName?: string;
width?: number;
};
properties?: unknown;
type?: unknown;
}
Member | Type |
---|---|
en_US ? |
object |
en_US.altText ? |
string |
en_US.dateUploaded ? |
string |
en_US.height ? |
number |
en_US.name ? |
string |
en_US.uploadName ? |
string |
en_US.width ? |
number |
fr_CA ? |
object |
fr_CA.altText ? |
string |
fr_CA.dateUploaded ? |
string |
fr_CA.height ? |
number |
fr_CA.name ? |
string |
fr_CA.uploadName ? |
string |
fr_CA.width ? |
number |
properties ? |
unknown |
type ? |
unknown |
Defined in: lib/types.ts:569
string
Defined in: lib/types.ts:589
Defined in: lib/types.ts:590
number
Defined in: lib/types.ts:591
string
[]
Defined in: lib/types.ts:592
object
{
dateUploaded?: string;
name?: string;
uploadName?: string;
}
Member | Type |
---|---|
dateUploaded ? |
string |
name ? |
string |
uploadName ? |
string |
Defined in: lib/types.ts:593
string
[]
Defined in: lib/types.ts:598
string
default
Defined in: lib/types.ts:600
Defined in: lib/types.ts:601
Defined in: lib/types.ts:1401
Defined in: lib/types.ts:1402
Defined in: lib/types.ts:1403
number
[]
Which hosted journals, presses or preprint servers are allowed to send bulk emails.
Defined in: lib/types.ts:1405
string
[]
Defined in: lib/types.ts:1406
number
Defined in: lib/types.ts:1407
Defined in: lib/types.ts:1408
object
{
en_US?: {
altText?: string;
dateUploaded?: string;
height?: number;
name?: string;
temporaryFileId?: number;
uploadName?: string;
width?: number;
};
fr_CA?: {
altText?: string;
dateUploaded?: string;
height?: number;
name?: string;
temporaryFileId?: number;
uploadName?: string;
width?: number;
};
properties?: unknown;
type?: unknown;
}
Member | Type |
---|---|
en_US ? |
object |
en_US.altText ? |
string |
en_US.dateUploaded ? |
string |
en_US.height ? |
number |
en_US.name ? |
string |
en_US.temporaryFileId ? |
number |
en_US.uploadName ? |
string |
en_US.width ? |
number |
fr_CA ? |
object |
fr_CA.altText ? |
string |
fr_CA.dateUploaded ? |
string |
fr_CA.height ? |
number |
fr_CA.name ? |
string |
fr_CA.temporaryFileId ? |
number |
fr_CA.uploadName ? |
string |
fr_CA.width ? |
number |
properties ? |
unknown |
type ? |
unknown |
Defined in: lib/types.ts:1409
string
Defined in: lib/types.ts:1431
Defined in: lib/types.ts:1432
number
Defined in: lib/types.ts:1433
string
[]
Defined in: lib/types.ts:1434
object
{
dateUploaded?: string;
name?: string;
temporaryFileId?: number;
uploadName?: string;
}
Member | Type |
---|---|
dateUploaded ? |
string |
name ? |
string |
temporaryFileId ? |
number |
uploadName ? |
string |
Defined in: lib/types.ts:1435
string
[]
Defined in: lib/types.ts:1441
string
default
Defined in: lib/types.ts:1443
Defined in: lib/types.ts:1444
string
Defined in: lib/types.ts:604
number
Defined in: lib/types.ts:605
number
Which publication is the latest published version.
Defined in: lib/types.ts:607
string
The last time activity was recorded related to this submission.
Defined in: lib/types.ts:609
string
Defined in: lib/types.ts:610
number
Defined in: lib/types.ts:611
string
The last time a modification was made to this submission or any of its associated objects.
Defined in: lib/types.ts:613
string
The primary language of this submission.
Defined in: lib/types.ts:615
A list of publications that have been created for this submission.
Defined in: lib/types.ts:617
{
dateDue
?:number
;dateResponseDue
?:number
;id
?:number
;isCurrentUserAssigned
?:number
;reviewRoundId
?:number
;round
?:number
;status
?:number
;statusLabel
?:number
; }[]
Information about pending and completed review assignments.
Defined in: lib/types.ts:619
A list of review rounds that have been opened for this submission.
Defined in: lib/types.ts:630
number
The stage of the editorial workflow that this submission is currently in. One of the WORKFLOW_STAGE_
constants. Default is WORKFLOW_STAGE_SUBMISSION
.
1
Defined in: lib/types.ts:635
{
currentUserAssignedRoles
?:number
[];files
?: {count
?:number
; };id
?:number
;isActiveStage
?:boolean
;label
?:string
;queries
?:unknown
[];status
?:string
;statusId
?:number
; }[]
Key data about the status, files and discussions of each stage.
Defined in: lib/types.ts:637
number
Whether the submission is Published, Declined, Scheduled or Queued (still in the workflow). One of the STATUS_*
constants. Default is STATUS_QUEUED
.
1
Defined in: lib/types.ts:653
string
A human-readable version of the submission's status. It will be Published, Declined, Queued (still in the workflow) or Scheduled.
Defined in: lib/types.ts:655
number
This number tracks a submission's progress before it is submitted to the journal or press. After submission, it will be set to 0
, indicating it is ready for an editor's consideration.
1
Defined in: lib/types.ts:660
string
A URL to the author's editorial workflow.
Defined in: lib/types.ts:662
string
A URL to the editors' and assistants' editorial workflow.
Defined in: lib/types.ts:664
string
A URL to the current publication or where it will be published.
Defined in: lib/types.ts:666
string
A URL to the workflow most appropriate for the current user. It will match the urlAuthorWorkflow
or `urlEditorialWorkflow.
Defined in: lib/types.ts:668
number
Defined in: lib/types.ts:1447
number
Which publication is the latest published version.
Defined in: lib/types.ts:1449
string
The last time activity was recorded related to this submission.
Defined in: lib/types.ts:1451
string
Defined in: lib/types.ts:1452
number
Defined in: lib/types.ts:1453
string
The last time a modification was made to this submission or any of its associated objects.
Defined in: lib/types.ts:1455
string
The primary language of this submission.
Defined in: lib/types.ts:1457
number
The stage of the editorial workflow that this submission is currently in. One of the WORKFLOW_STAGE_
constants. Default is WORKFLOW_STAGE_SUBMISSION
.
1
Defined in: lib/types.ts:1462
number
Whether the submission is Published, Declined, Scheduled or Queued (still in the workflow). One of the STATUS_*
constants. Default is STATUS_QUEUED
.
1
Defined in: lib/types.ts:1467
number
This number tracks a submission's progress before it is submitted to the journal or press. After submission, it will be set to 0
, indicating it is ready for an editor's consideration.
1
Defined in: lib/types.ts:1472
string
Format: uri
Defined in: lib/types.ts:672
number
Used with assocType
to associate this file with an object such as a galley.
Defined in: lib/types.ts:674
number
Used with assocId
to associate this file with an object such as a galley. One of the following constants: ASSOC_TYPE_SUBMISSION_FILE
(dependent files), ASSOC_TYPE_REVIEW_ASSIGNMENT
(files uploaded by a reviewer), ASSOC_TYPE_NOTE
(files uploaded with a discussion), ASSOC_TYPE_REPRESENTATION
(files uploaded to a galley or publication format), ASSOC_TYPE_REVIEW_ROUND
(review files and revisions for a particular review round).
Defined in: lib/types.ts:676
string
A caption for this file. Used with artwork such as images.
Defined in: lib/types.ts:678
string
The copyright owner of this file. Used with artwork such as images.
Defined in: lib/types.ts:680
string
The date this submission file object was created in the system. Set automatically by the software.
Defined in: lib/types.ts:682
Defined in: lib/types.ts:683
string
An attribution for this file, such as a photographer's name. Used with artwork such as images.
Defined in: lib/types.ts:685
string
Public metadata about when this content was created. Used with supplementary files.
Defined in: lib/types.ts:687
Any dependent files, typically images or audio files that are loaded by an HTML file.
Defined in: lib/types.ts:689
Defined in: lib/types.ts:690
string
Defined in: lib/types.ts:691
number
Defined in: lib/types.ts:692
number
Defined in: lib/types.ts:693
number
Defined in: lib/types.ts:694
number
Defined in: lib/types.ts:695
string
The language of this file if it contains text. Used with supplementary files.
Defined in: lib/types.ts:697
string
The primary locale of the submission this file is attached to. This locale is used as the fallback when a language is missing from a multilingual property.
Defined in: lib/types.ts:699
string
Defined in: lib/types.ts:700
Defined in: lib/types.ts:701
string
Defined in: lib/types.ts:702
Defined in: lib/types.ts:703
{
documentType
?:string
;fileId
?:number
;mimetype
?:string
;path
?:string
;url
?:string
; }[]
Previous versions of this file.
Defined in: lib/types.ts:705
Defined in: lib/types.ts:712
number
When a submission file is promoted from one stage to another, this property identifies the source file from which this file was promoted. Default: null
.
Defined in: lib/types.ts:714
Defined in: lib/types.ts:715
Defined in: lib/types.ts:716
number
Defined in: lib/types.ts:717
string
Licensing terms for this file. Used with artwork such as images.
Defined in: lib/types.ts:719
string
When this object was last updated.
Defined in: lib/types.ts:721
number
Defined in: lib/types.ts:722
string
Defined in: lib/types.ts:723
boolean
Defined in: lib/types.ts:724
number
Used with assocType
to associate this file with an object such as a galley.
Defined in: lib/types.ts:1517
number
Used with assocId
to associate this file with an object such as a galley. One of the following constants: ASSOC_TYPE_SUBMISSION_FILE
(dependent files), ASSOC_TYPE_REVIEW_ASSIGNMENT
(files uploaded by a reviewer), ASSOC_TYPE_NOTE
(files uploaded with a discussion), ASSOC_TYPE_REPRESENTATION
(files uploaded to a galley or publication format), ASSOC_TYPE_REVIEW_ROUND
(review files and revisions for a particular review round).
Defined in: lib/types.ts:1519
string
A caption for this file. Used with artwork such as images.
Defined in: lib/types.ts:1521
string
The copyright owner of this file. Used with artwork such as images.
Defined in: lib/types.ts:1523
string
The date this submission file object was created in the system. Set automatically by the software.
Defined in: lib/types.ts:1525
Defined in: lib/types.ts:1526
string
An attribution for this file, such as a photographer's name. Used with artwork such as images.
Defined in: lib/types.ts:1528
string
Public metadata about when this content was created. Used with supplementary files.
Defined in: lib/types.ts:1530
Defined in: lib/types.ts:1531
string
Format: binary
Defined in: lib/types.ts:1533
number
Defined in: lib/types.ts:1534
number
Defined in: lib/types.ts:1535
number
Defined in: lib/types.ts:1536
string
The language of this file if it contains text. Used with supplementary files.
Defined in: lib/types.ts:1538
Defined in: lib/types.ts:1539
Defined in: lib/types.ts:1540
Defined in: lib/types.ts:1541
number
When a submission file is promoted from one stage to another, this property identifies the source file from which this file was promoted. Default: null
.
Defined in: lib/types.ts:1543
Defined in: lib/types.ts:1544
Defined in: lib/types.ts:1545
number
Defined in: lib/types.ts:1546
string
Licensing terms for this file. Used with artwork such as images.
Defined in: lib/types.ts:1548
string
When this object was last updated.
Defined in: lib/types.ts:1550
number
Defined in: lib/types.ts:1551
boolean
Defined in: lib/types.ts:1552
string
Format: uri
Defined in: lib/types.ts:1556
number
Used with assocType
to associate this file with an object such as a galley.
Defined in: lib/types.ts:1558
number
Used with assocId
to associate this file with an object such as a galley. One of the following constants: ASSOC_TYPE_SUBMISSION_FILE
(dependent files), ASSOC_TYPE_REVIEW_ASSIGNMENT
(files uploaded by a reviewer), ASSOC_TYPE_NOTE
(files uploaded with a discussion), ASSOC_TYPE_REPRESENTATION
(files uploaded to a galley or publication format), ASSOC_TYPE_REVIEW_ROUND
(review files and revisions for a particular review round).
Defined in: lib/types.ts:1560
string
A caption for this file. Used with artwork such as images.
Defined in: lib/types.ts:1562
string
The copyright owner of this file. Used with artwork such as images.
Defined in: lib/types.ts:1564
string
The date this submission file object was created in the system. Set automatically by the software.
Defined in: lib/types.ts:1566
Defined in: lib/types.ts:1567
string
An attribution for this file, such as a photographer's name. Used with artwork such as images.
Defined in: lib/types.ts:1569
string
Public metadata about when this content was created. Used with supplementary files.
Defined in: lib/types.ts:1571
Defined in: lib/types.ts:1572
string
Defined in: lib/types.ts:1573
number
Defined in: lib/types.ts:1574
number
Defined in: lib/types.ts:1575
number
Defined in: lib/types.ts:1576
number
Defined in: lib/types.ts:1577
string
The language of this file if it contains text. Used with supplementary files.
Defined in: lib/types.ts:1579
string
The primary locale of the submission this file is attached to. This locale is used as the fallback when a language is missing from a multilingual property.
Defined in: lib/types.ts:1581
string
Defined in: lib/types.ts:1582
Defined in: lib/types.ts:1583
string
Defined in: lib/types.ts:1584
Defined in: lib/types.ts:1585
Defined in: lib/types.ts:1586
number
When a submission file is promoted from one stage to another, this property identifies the source file from which this file was promoted. Default: null
.
Defined in: lib/types.ts:1588
Defined in: lib/types.ts:1589
Defined in: lib/types.ts:1590
number
Defined in: lib/types.ts:1591
string
Licensing terms for this file. Used with artwork such as images.
Defined in: lib/types.ts:1593
string
When this object was last updated.
Defined in: lib/types.ts:1595
number
Defined in: lib/types.ts:1596
string
Defined in: lib/types.ts:1597
boolean
Defined in: lib/types.ts:1598
string
Defined in: lib/types.ts:1475
number
Defined in: lib/types.ts:1476
number
Which publication is the latest published version.
Defined in: lib/types.ts:1478
string
The last time activity was recorded related to this submission.
Defined in: lib/types.ts:1480
string
Defined in: lib/types.ts:1481
number
Defined in: lib/types.ts:1482
string
The last time a modification was made to this submission or any of its associated objects.
Defined in: lib/types.ts:1484
string
The primary language of this submission.
Defined in: lib/types.ts:1486
A list of publications that have been created for this submission.
Defined in: lib/types.ts:1488
number
The stage of the editorial workflow that this submission is currently in. One of the WORKFLOW_STAGE_
constants. Default is WORKFLOW_STAGE_SUBMISSION
.
1
Defined in: lib/types.ts:1493
number
Whether the submission is Published, Declined, Scheduled or Queued (still in the workflow). One of the STATUS_*
constants. Default is STATUS_QUEUED
.
1
Defined in: lib/types.ts:1498
string
A human-readable version of the submission's status. It will be Published, Declined, Queued (still in the workflow) or Scheduled.
Defined in: lib/types.ts:1500
number
This number tracks a submission's progress before it is submitted to the journal or press. After submission, it will be set to 0
, indicating it is ready for an editor's consideration.
1
Defined in: lib/types.ts:1505
string
A URL to the author's editorial workflow.
Defined in: lib/types.ts:1507
string
A URL to the editors' and assistants' editorial workflow.
Defined in: lib/types.ts:1509
string
A URL to the current publication or where it will be published.
Defined in: lib/types.ts:1511
string
A URL to the workflow most appropriate for the current user. It will match the urlAuthorWorkflow
or `urlEditorialWorkflow.
Defined in: lib/types.ts:1513
A theme with values for any of its theme options. The theme is provided in the themePluginPath
key. Other keys may or may not exist depending on what options have been defined by that theme.
string
Defined in: lib/types.ts:729
string
Defined in: lib/types.ts:728
string
Defined in: lib/types.ts:732
string
Defined in: lib/types.ts:733
number
Defined in: lib/types.ts:734
string
Defined in: lib/types.ts:737
Defined in: lib/types.ts:738
number
Defined in: lib/types.ts:739
string
Defined in: lib/types.ts:740
string
Defined in: lib/types.ts:741
Defined in: lib/types.ts:742
string
Defined in: lib/types.ts:743
string
Defined in: lib/types.ts:744
string
Defined in: lib/types.ts:745
string
Defined in: lib/types.ts:746
boolean
Defined in: lib/types.ts:747
string
Defined in: lib/types.ts:748
string
Defined in: lib/types.ts:749
Defined in: lib/types.ts:750
string
Defined in: lib/types.ts:751
Defined in: lib/types.ts:752
Defined in: lib/types.ts:753
Defined in: lib/types.ts:754
number
Defined in: lib/types.ts:755
Defined in: lib/types.ts:756
string
Defined in: lib/types.ts:757
boolean
Defined in: lib/types.ts:758
string
Defined in: lib/types.ts:759
string
Defined in: lib/types.ts:760
Defined in: lib/types.ts:761
string
Defined in: lib/types.ts:762
string
Defined in: lib/types.ts:763
Defined in: lib/types.ts:1601
number
Defined in: lib/types.ts:1602
string
Defined in: lib/types.ts:1603
string
Defined in: lib/types.ts:1604
Defined in: lib/types.ts:1605
string
Defined in: lib/types.ts:1606
string
Defined in: lib/types.ts:1607
string
Defined in: lib/types.ts:1608
string
Defined in: lib/types.ts:1609
boolean
Defined in: lib/types.ts:1610
string
Defined in: lib/types.ts:1611
string
Defined in: lib/types.ts:1612
Defined in: lib/types.ts:1613
Defined in: lib/types.ts:1614
Defined in: lib/types.ts:1615
string
Defined in: lib/types.ts:1616
boolean
Defined in: lib/types.ts:1617
string
Defined in: lib/types.ts:1618
string
Defined in: lib/types.ts:1619
Defined in: lib/types.ts:1620
string
Defined in: lib/types.ts:1621
string
Defined in: lib/types.ts:1622
Defined in: lib/types.ts:766
number
Defined in: lib/types.ts:767
Defined in: lib/types.ts:768
boolean
Defined in: lib/types.ts:769
boolean
Defined in: lib/types.ts:770
number
Defined in: lib/types.ts:771
boolean
Defined in: lib/types.ts:772
Defined in: lib/types.ts:1635
number
Defined in: lib/types.ts:1636
Defined in: lib/types.ts:1637
boolean
Defined in: lib/types.ts:1638
boolean
Defined in: lib/types.ts:1639
number
Defined in: lib/types.ts:1640
boolean
Defined in: lib/types.ts:1641
A user's review interests.
number
Defined in: lib/types.ts:776
string
Defined in: lib/types.ts:777
string
Defined in: lib/types.ts:1625
boolean
Defined in: lib/types.ts:1626
string
Defined in: lib/types.ts:1627
string
Defined in: lib/types.ts:1628
Defined in: lib/types.ts:1629
number
Defined in: lib/types.ts:1630
string
Defined in: lib/types.ts:1631
string
Defined in: lib/types.ts:1632
GPL-3.0-or-later © Thomas F. K. Jorna