Note This repository is automatically generated from the main parser monorepo. Please submit any issues or pull requests there.

ojs-types

Some typescript types for OJS api responses

ojs-types
- Contents
- What is this?
- When should I use this?
- Install
- Use
- API
- Syntax tree
- Types
- Compatibility
- Security
- Related
- Contribute
- License

What is this?

When should I use this?

Install

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

Use

API

`Announcement`

Properties

`\_href?`

string

Format: uri

Description

The URL to this announcement in the REST API.

Defined in: lib/types.ts:6

`assocId?`

number

Description

The journal, press or preprint server ID.

Defined in: lib/types.ts:8

`assocType?`

number

Description

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

`dateExpire?`

string

Description

(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

`datePosted?`

string

Description

The date this announcement was posted.

Defined in: lib/types.ts:14

`description?`

LocaleObject

Defined in: lib/types.ts:15

`descriptionShort?`

LocaleObject

Defined in: lib/types.ts:16

`id?`

number

Defined in: lib/types.ts:17

`title?`

LocaleObject

Defined in: lib/types.ts:18

`typeId?`

number

Description

(Optional) One of the announcement type ids.

Defined in: lib/types.ts:20

`AnnouncementEditable`

Properties

`assocId?`

number

Description

The journal, press or preprint server ID.

Defined in: lib/types.ts:781

`assocType?`

number

Description

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

`dateExpire?`

string

Description

(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

`datePosted?`

string

Description

The date this announcement was posted.

Defined in: lib/types.ts:787

`description?`

LocaleObject

Defined in: lib/types.ts:788

`descriptionShort?`

LocaleObject

Defined in: lib/types.ts:789

`id?`

number

Defined in: lib/types.ts:790

`title?`

LocaleObject

Defined in: lib/types.ts:791

`typeId?`

number

Description

(Optional) One of the announcement type ids.

Defined in: lib/types.ts:793

`AnnouncementSummary`

Properties

`\_href?`

string

Format: uri

Description

The URL to this announcement in the REST API.

Defined in: lib/types.ts:800

`assocId?`

number

Description

The journal, press or preprint server ID.

Defined in: lib/types.ts:802

`assocType?`

number

Description

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

`dateExpire?`

string

Description

(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

`datePosted?`

string

Description

The date this announcement was posted.

Defined in: lib/types.ts:808

`description?`

LocaleObject

Defined in: lib/types.ts:809

`descriptionShort?`

LocaleObject

Defined in: lib/types.ts:810

`id?`

number

Defined in: lib/types.ts:811

`title?`

LocaleObject

Defined in: lib/types.ts:812

`typeId?`

number

Description

(Optional) One of the announcement type ids.

Defined in: lib/types.ts:814

`Author`

Properties

`affiliation?`

LocaleObject

Defined in: lib/types.ts:23

`biography?`

LocaleObject

Defined in: lib/types.ts:24

`country?`

string

Defined in: lib/types.ts:25

`email?`

string

Defined in: lib/types.ts:26

`familyName?`

LocaleObject

Defined in: lib/types.ts:27

`givenName?`

LocaleObject

Defined in: lib/types.ts:28

`id?`

number

Defined in: lib/types.ts:29

`includeInBrowse?`

boolean

Description

Whether or not to include this contributor in author lists when the publication appears in search results, tables of content and catalog entries.

Default

true

Defined in: lib/types.ts:34

`orcid?`

string

Description

The ORCID of this contributor. See: https://orcid.org/

Defined in: lib/types.ts:36

`preferredPublicName?`

LocaleObject

Defined in: lib/types.ts:37

`publicationId?`

number

Defined in: lib/types.ts:38

`seq?`

number

Description

The order in which this contributor should appear in a list of contriibutors.

Defined in: lib/types.ts:40

`submissionLocale?`

string

Description

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

`url?`

string

Description

An optional URL to this contributor's webpage.

Defined in: lib/types.ts:44

`userGroupId?`

number

Description

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

`AuthorEditable`

Properties

`affiliation?`

LocaleObject

Defined in: lib/types.ts:817

`biography?`

LocaleObject

Defined in: lib/types.ts:818

`country?`

string

Defined in: lib/types.ts:819

`email?`

string

Defined in: lib/types.ts:820

`familyName?`

LocaleObject

Defined in: lib/types.ts:821

`givenName?`

LocaleObject

Defined in: lib/types.ts:822

`id?`

number

Defined in: lib/types.ts:823

`includeInBrowse?`

boolean

Description

Whether or not to include this contributor in author lists when the publication appears in search results, tables of content and catalog entries.

Default

true

Defined in: lib/types.ts:828

`orcid?`

string

Description

The ORCID of this contributor. See: https://orcid.org/

Defined in: lib/types.ts:830

`preferredPublicName?`

LocaleObject

Defined in: lib/types.ts:831

`publicationId?`

number

Defined in: lib/types.ts:832

`seq?`

number

Description

The order in which this contributor should appear in a list of contriibutors.

Defined in: lib/types.ts:834

`url?`

string

Description

An optional URL to this contributor's webpage.

Defined in: lib/types.ts:836

`userGroupId?`

number

Description

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

`AuthorSummary`

Properties

`affiliation?`

LocaleObject

Defined in: lib/types.ts:841

`email?`

string

Defined in: lib/types.ts:842

`familyName?`

LocaleObject

Defined in: lib/types.ts:843

`givenName?`

LocaleObject

Defined in: lib/types.ts:844

`id?`

number

Defined in: lib/types.ts:845

`includeInBrowse?`

boolean

Description

Whether or not to include this contributor in author lists when the publication appears in search results, tables of content and catalog entries.

Default

true

Defined in: lib/types.ts:850

`orcid?`

string

Description

The ORCID of this contributor. See: https://orcid.org/

Defined in: lib/types.ts:852

`preferredPublicName?`

LocaleObject

Defined in: lib/types.ts:853

`publicationId?`

number

Defined in: lib/types.ts:854

`seq?`

number

Description

The order in which this contributor should appear in a list of contriibutors.

Defined in: lib/types.ts:856

`submissionLocale?`

string

Description

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

`userGroupId?`

number

Description

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

`Context`

Properties

`\_href?`

string

Format: uri

Defined in: lib/types.ts:50

`abbreviation?`

LocaleObject

Defined in: lib/types.ts:51

`about?`

LocaleObject

Defined in: lib/types.ts:52

`acronym?`

LocaleObject

Defined in: lib/types.ts:53

`additionalHomeContent?`

LocaleObject

Defined in: lib/types.ts:54

`agencies?`

string

Description

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

`announcementsIntroduction?`

LocaleObject

Defined in: lib/types.ts:57

`authorGuidelines?`

LocaleObject

Defined in: lib/types.ts:58

`authorInformation?`

LocaleObject

Defined in: lib/types.ts:59

`citations?`

string

Description

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

`clockssLicense?`

LocaleObject

Defined in: lib/types.ts:62

`competingInterests?`

LocaleObject

Defined in: lib/types.ts:63

`contactAffiliation?`

LocaleObject

Defined in: lib/types.ts:64

`contactEmail?`

string

Defined in: lib/types.ts:65

`contactName?`

string

Defined in: lib/types.ts:66

`contactPhone?`

string

Defined in: lib/types.ts:67

`copyrightHolderOther?`

LocaleObject

Defined in: lib/types.ts:68

`copyrightHolderType?`

string

Defined in: lib/types.ts:69

`copyrightNotice?`

LocaleObject

Defined in: lib/types.ts:70

`copyrightYearBasis?`

string

Default

issue

Defined in: lib/types.ts:72

`coverage?`

string

Description

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

`currency?`

string

Defined in: lib/types.ts:75

`customHeaders?`

LocaleObject

Defined in: lib/types.ts:76

`dateFormatLong?`

LocaleObject

Defined in: lib/types.ts:77

`dateFormatShort?`

LocaleObject

Defined in: lib/types.ts:78

`datetimeFormatLong?`

LocaleObject

Defined in: lib/types.ts:79

`datetimeFormatShort?`

LocaleObject

Defined in: lib/types.ts:80

`defaultMetricType?`

string

Defined in: lib/types.ts:81

`defaultReviewMode?`

number

Default

Defined in: lib/types.ts:83

`delayedOpenAccessDuration?`

number

Defined in: lib/types.ts:84

`delayedOpenAccessPolicy?`

LocaleObject

Defined in: lib/types.ts:85

`description?`

LocaleObject

Defined in: lib/types.ts:86

`disableBulkEmailUserGroups?`

number[]

Description

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

`disableSubmissions?`

boolean

Default

false

Defined in: lib/types.ts:90

`disableUserReg?`

boolean

Defined in: lib/types.ts:91

`disciplines?`

string

Description

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

`editorialTeam?`

LocaleObject

Defined in: lib/types.ts:94

`emailSignature?`

string

Defined in: lib/types.ts:95

`enableAnnouncements?`

boolean

Defined in: lib/types.ts:96

`enableClockss?`

boolean

Defined in: lib/types.ts:97

`enableLockss?`

boolean

Defined in: lib/types.ts:98

`enableOai?`

boolean

Default

Defined in: lib/types.ts:100

`enableOpenAccessNotification?`

boolean

Defined in: lib/types.ts:101

`enablePublisherId?`

string[]

Defined in: lib/types.ts:102

`enableSubscriptionOnlinePaymentNotificationPurchaseIndividual?`

boolean

Defined in: lib/types.ts:103

`enableSubscriptionOnlinePaymentNotificationPurchaseInstitutional?`

boolean

Defined in: lib/types.ts:104

`enableSubscriptionOnlinePaymentNotificationRenewIndividual?`

boolean

Defined in: lib/types.ts:105

`enableSubscriptionOnlinePaymentNotificationRenewInstitutional?`

boolean

Defined in: lib/types.ts:106

`enabled?`

boolean

Defined in: lib/types.ts:107

`envelopeSender?`

string

Defined in: lib/types.ts:108

`favicon?`

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;
}

Type declaration

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

`homepageImage?`

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;
}

Type declaration

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

`id?`

number

Defined in: lib/types.ts:149

`itemsPerPage?`

number

Default

Defined in: lib/types.ts:151

`journalThumbnail?`

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;
}

Type declaration

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

`keywords?`

string

Description

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.

Default

request

Defined in: lib/types.ts:176

`languages?`

string

Description

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

`librarianInformation?`

LocaleObject

Defined in: lib/types.ts:179

`licenseTerms?`

LocaleObject

Defined in: lib/types.ts:180

`licenseUrl?`

string

Defined in: lib/types.ts:181

`lockssLicense?`

LocaleObject

Defined in: lib/types.ts:182

`mailingAddress?`

string

Defined in: lib/types.ts:183

`membershipFee?`

number

Default

Defined in: lib/types.ts:185

`membershipFeeDescription?`

LocaleObject

Defined in: lib/types.ts:186

`membershipFeeName?`

LocaleObject

Defined in: lib/types.ts:187

`name?`

LocaleObject

Defined in: lib/types.ts:188

`numAnnouncementsHomepage?`

number

Defined in: lib/types.ts:189

`numDaysBeforeInviteReminder?`

number

Defined in: lib/types.ts:190

`numDaysBeforeSubmitReminder?`

number

Defined in: lib/types.ts:191

`numMonthsAfterSubscriptionExpiryReminder?`

number

Defined in: lib/types.ts:192

`numMonthsBeforeSubscriptionExpiryReminder?`

number

Defined in: lib/types.ts:193

`numPageLinks?`

number

Default

Defined in: lib/types.ts:195

`numWeeksAfterSubscriptionExpiryReminder?`

number

Defined in: lib/types.ts:196

`numWeeksBeforeSubscriptionExpiryReminder?`

number

Defined in: lib/types.ts:197

`numWeeksPerResponse?`

number

Default

Defined in: lib/types.ts:199

`numWeeksPerReview?`

number

Default

Defined in: lib/types.ts:201

`onlineIssn?`

string

Defined in: lib/types.ts:202

`openAccessPolicy?`

LocaleObject

Defined in: lib/types.ts:203

`pageFooter?`

LocaleObject

Defined in: lib/types.ts:204

`pageHeaderLogoImage?`

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;
}

Type declaration

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

`paymentPluginName?`

string

Defined in: lib/types.ts:225

`paymentsEnabled?`

boolean

Defined in: lib/types.ts:226

`primaryLocale?`

string

Defined in: lib/types.ts:227

`printIssn?`

string

Defined in: lib/types.ts:228

`privacyStatement?`

LocaleObject

Defined in: lib/types.ts:229

`publicationFee?`

number

Default

Defined in: lib/types.ts:231

`publicationFeeDescription?`

LocaleObject

Defined in: lib/types.ts:232

`publicationFeeName?`

LocaleObject

Defined in: lib/types.ts:233

`publisherInstitution?`

string

Defined in: lib/types.ts:234

`publishingMode?`

number

Defined in: lib/types.ts:235

`purchaseArticleFee?`

number

Default

Defined in: lib/types.ts:237

`purchaseArticleFeeDescription?`

LocaleObject

Defined in: lib/types.ts:238

`purchaseArticleFeeEnabled?`

boolean

Defined in: lib/types.ts:239

`purchaseArticleFeeName?`

LocaleObject

Defined in: lib/types.ts:240

`purchaseIssueFee?`

number

Defined in: lib/types.ts:241

`purchaseIssueFeeEnabled?`

boolean

Defined in: lib/types.ts:242

`rateReviewerOnQuality?`

boolean

Defined in: lib/types.ts:243

`readerInformation?`

LocaleObject

Defined in: lib/types.ts:244

`restrictArticleAccess?`

boolean

Defined in: lib/types.ts:245

`restrictOnlyPdf?`

boolean

Defined in: lib/types.ts:246

`restrictReviewerFileAccess?`

boolean

Defined in: lib/types.ts:247

`restrictSiteAccess?`

boolean

Defined in: lib/types.ts:248

`reviewGuidelines?`

LocaleObject

Defined in: lib/types.ts:249

`reviewerAccessKeysEnabled?`

boolean

Defined in: lib/types.ts:250

`rights?`

string

Description

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

`searchDescription?`

LocaleObject

Defined in: lib/types.ts:253

`seq?`

number

Defined in: lib/types.ts:254

`showEnsuringLink?`

boolean

Defined in: lib/types.ts:255

`sidebar?`

string[]

Defined in: lib/types.ts:256

`source?`

string

Description

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

`styleSheet?`

object

{
    dateUploaded?: string;
    name?: string;
    uploadName?: string;
}

Type declaration

Member	Type
`dateUploaded`?	`string`
`name`?	`string`
`uploadName`?	`string`

Defined in: lib/types.ts:259

`subjects?`

string

Description

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

`submissionChecklist?`

{ content?: string; order?: number; }[]

Default

[ { "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

`submissionFee?`

number

Defined in: lib/types.ts:304

`submissionFeeDescription?`

LocaleObject

Defined in: lib/types.ts:305

`submissionFeeName?`

LocaleObject

Defined in: lib/types.ts:306

`subscriptionAdditionalInformation?`

LocaleObject

Defined in: lib/types.ts:307

`subscriptionEmail?`

string

Defined in: lib/types.ts:308

`subscriptionExpiryPartial?`

boolean

Defined in: lib/types.ts:309

`subscriptionMailingAddress?`

string

Defined in: lib/types.ts:310

`subscriptionName?`

string

Defined in: lib/types.ts:311

`subscriptionPhone?`

string

Defined in: lib/types.ts:312

`supportEmail?`

string

Defined in: lib/types.ts:313

`supportName?`

string

Defined in: lib/types.ts:314

`supportPhone?`

string

Defined in: lib/types.ts:315

`supportedFormLocales?`

string[]

Defined in: lib/types.ts:316

`supportedLocales?`

string[]

Defined in: lib/types.ts:317

`supportedSubmissionLocales?`

string[]

Defined in: lib/types.ts:318

`themePluginPath?`

string

Default

default

Defined in: lib/types.ts:320

`timeFormat?`

LocaleObject

Defined in: lib/types.ts:321

`type?`

string

Description

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

`url?`

string

Defined in: lib/types.ts:324

`urlPath?`

string

Defined in: lib/types.ts:325

`ContextEditable`

Properties

`abbreviation?`

LocaleObject

Defined in: lib/types.ts:863

`about?`

LocaleObject

Defined in: lib/types.ts:864

`acronym?`

LocaleObject

Defined in: lib/types.ts:865

`additionalHomeContent?`

LocaleObject

Defined in: lib/types.ts:866

`agencies?`

string

Description

Defined in: lib/types.ts:868

`announcementsIntroduction?`

LocaleObject

Defined in: lib/types.ts:869

`authorGuidelines?`

LocaleObject

Defined in: lib/types.ts:870

`authorInformation?`

LocaleObject

Defined in: lib/types.ts:871

`citations?`

string

Description

Defined in: lib/types.ts:873

`clockssLicense?`

LocaleObject

Defined in: lib/types.ts:874

`competingInterests?`

LocaleObject

Defined in: lib/types.ts:875

`contactAffiliation?`

LocaleObject

Defined in: lib/types.ts:876

`contactEmail?`

string

Defined in: lib/types.ts:877

`contactName?`

string

Defined in: lib/types.ts:878

`contactPhone?`

string

Defined in: lib/types.ts:879

`copyrightHolderOther?`

LocaleObject

Defined in: lib/types.ts:880

`copyrightHolderType?`

string

Defined in: lib/types.ts:881

`copyrightNotice?`

LocaleObject

Defined in: lib/types.ts:882

`copyrightYearBasis?`

string

Default

issue

Defined in: lib/types.ts:884

`coverage?`

string

Description

Defined in: lib/types.ts:886

`currency?`

string

Defined in: lib/types.ts:887

`customHeaders?`

LocaleObject

Defined in: lib/types.ts:888

`dateFormatLong?`

LocaleObject

Defined in: lib/types.ts:889

`dateFormatShort?`

LocaleObject

Defined in: lib/types.ts:890

`datetimeFormatLong?`

LocaleObject

Defined in: lib/types.ts:891

`datetimeFormatShort?`

LocaleObject

Defined in: lib/types.ts:892

`defaultMetricType?`

string

Defined in: lib/types.ts:893

`defaultReviewMode?`

number

Default

Defined in: lib/types.ts:895

`delayedOpenAccessDuration?`

number

Defined in: lib/types.ts:896

`delayedOpenAccessPolicy?`

LocaleObject

Defined in: lib/types.ts:897

`description?`

LocaleObject

Defined in: lib/types.ts:898

`disableBulkEmailUserGroups?`

number[]

Description

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

`disableSubmissions?`

boolean

Default

false

Defined in: lib/types.ts:902

`disableUserReg?`

boolean

Defined in: lib/types.ts:903

`disciplines?`

string

Description

Defined in: lib/types.ts:905

`editorialTeam?`

LocaleObject

Defined in: lib/types.ts:906

`emailSignature?`

string

Defined in: lib/types.ts:907

`enableAnnouncements?`

boolean

Defined in: lib/types.ts:908

`enableClockss?`

boolean

Defined in: lib/types.ts:909

`enableLockss?`

boolean

Defined in: lib/types.ts:910

`enableOai?`

boolean

Default

Defined in: lib/types.ts:912

`enableOpenAccessNotification?`

boolean

Defined in: lib/types.ts:913

`enablePublisherId?`

string[]

Defined in: lib/types.ts:914

`enableSubscriptionOnlinePaymentNotificationPurchaseIndividual?`

boolean

Defined in: lib/types.ts:915

`enableSubscriptionOnlinePaymentNotificationPurchaseInstitutional?`

boolean

Defined in: lib/types.ts:916

`enableSubscriptionOnlinePaymentNotificationRenewIndividual?`

boolean

Defined in: lib/types.ts:917

`enableSubscriptionOnlinePaymentNotificationRenewInstitutional?`

boolean

Defined in: lib/types.ts:918

`enabled?`

boolean

Defined in: lib/types.ts:919

`envelopeSender?`

string

Defined in: lib/types.ts:920

`favicon?`

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;
}

Type declaration

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

`homepageImage?`

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;
}

Type declaration

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

`itemsPerPage?`

number

Default

Defined in: lib/types.ts:966

`journalThumbnail?`

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;
}

Type declaration

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

`keywords?`

string

Description

Default

request

Defined in: lib/types.ts:993

`languages?`

string

Description

Defined in: lib/types.ts:995

`librarianInformation?`

LocaleObject

Defined in: lib/types.ts:996

`licenseTerms?`

LocaleObject

Defined in: lib/types.ts:997

`licenseUrl?`

string

Defined in: lib/types.ts:998

`lockssLicense?`

LocaleObject

Defined in: lib/types.ts:999

`mailingAddress?`

string

Defined in: lib/types.ts:1000

`membershipFee?`

number

Default

Defined in: lib/types.ts:1002

`membershipFeeDescription?`

LocaleObject

Defined in: lib/types.ts:1003

`membershipFeeName?`

LocaleObject

Defined in: lib/types.ts:1004

`name?`

LocaleObject

Defined in: lib/types.ts:1005

`numAnnouncementsHomepage?`

number

Defined in: lib/types.ts:1006

`numDaysBeforeInviteReminder?`

number

Defined in: lib/types.ts:1007

`numDaysBeforeSubmitReminder?`

number

Defined in: lib/types.ts:1008

`numMonthsAfterSubscriptionExpiryReminder?`

number

Defined in: lib/types.ts:1009

`numMonthsBeforeSubscriptionExpiryReminder?`

number

Defined in: lib/types.ts:1010

`numPageLinks?`

number

Default

Defined in: lib/types.ts:1012

`numWeeksAfterSubscriptionExpiryReminder?`

number

Defined in: lib/types.ts:1013

`numWeeksBeforeSubscriptionExpiryReminder?`

number

Defined in: lib/types.ts:1014

`numWeeksPerResponse?`

number

Default

Defined in: lib/types.ts:1016

`numWeeksPerReview?`

number

Default

Defined in: lib/types.ts:1018

`onlineIssn?`

string

Defined in: lib/types.ts:1019

`openAccessPolicy?`

LocaleObject

Defined in: lib/types.ts:1020

`pageFooter?`

LocaleObject

Defined in: lib/types.ts:1021

`pageHeaderLogoImage?`

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;
}

Type declaration

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

`paymentPluginName?`

string

Defined in: lib/types.ts:1044

`paymentsEnabled?`

boolean

Defined in: lib/types.ts:1045

`primaryLocale?`

string

Defined in: lib/types.ts:1046

`printIssn?`

string

Defined in: lib/types.ts:1047

`privacyStatement?`

LocaleObject

Defined in: lib/types.ts:1048

`publicationFee?`

number

Default

Defined in: lib/types.ts:1050

`publicationFeeDescription?`

LocaleObject

Defined in: lib/types.ts:1051

`publicationFeeName?`

LocaleObject

Defined in: lib/types.ts:1052

`publisherInstitution?`

string

Defined in: lib/types.ts:1053

`publishingMode?`

number

Defined in: lib/types.ts:1054

`purchaseArticleFee?`

number

Default

Defined in: lib/types.ts:1056

`purchaseArticleFeeDescription?`

LocaleObject

Defined in: lib/types.ts:1057

`purchaseArticleFeeEnabled?`

boolean

Defined in: lib/types.ts:1058

`purchaseArticleFeeName?`

LocaleObject

Defined in: lib/types.ts:1059

`purchaseIssueFee?`

number

Defined in: lib/types.ts:1060

`purchaseIssueFeeEnabled?`

boolean

Defined in: lib/types.ts:1061

`rateReviewerOnQuality?`

boolean

Defined in: lib/types.ts:1062

`readerInformation?`

LocaleObject

Defined in: lib/types.ts:1063

`restrictArticleAccess?`

boolean

Defined in: lib/types.ts:1064

`restrictOnlyPdf?`

boolean

Defined in: lib/types.ts:1065

`restrictReviewerFileAccess?`

boolean

Defined in: lib/types.ts:1066

`restrictSiteAccess?`

boolean

Defined in: lib/types.ts:1067

`reviewGuidelines?`

LocaleObject

Defined in: lib/types.ts:1068

`reviewerAccessKeysEnabled?`

boolean

Defined in: lib/types.ts:1069

`rights?`

string

Description

Defined in: lib/types.ts:1071

`searchDescription?`

LocaleObject

Defined in: lib/types.ts:1072

`seq?`

number

Defined in: lib/types.ts:1073

`showEnsuringLink?`

boolean

Defined in: lib/types.ts:1074

`sidebar?`

string[]

Defined in: lib/types.ts:1075

`source?`

string

Description

Defined in: lib/types.ts:1077

`styleSheet?`

object

{
    dateUploaded?: string;
    name?: string;
    temporaryFileId?: number;
    uploadName?: string;
}

Type declaration

Member	Type
`dateUploaded`?	`string`
`name`?	`string`
`temporaryFileId`?	`number`
`uploadName`?	`string`

Defined in: lib/types.ts:1078

`subjects?`

string

Description

Defined in: lib/types.ts:1085

`submissionChecklist?`

{ content?: string; order?: number; }[]

Default

Defined in: lib/types.ts:1120

`submissionFee?`

number

Defined in: lib/types.ts:1124

`submissionFeeDescription?`

LocaleObject

Defined in: lib/types.ts:1125

`submissionFeeName?`

LocaleObject

Defined in: lib/types.ts:1126

`subscriptionAdditionalInformation?`

LocaleObject

Defined in: lib/types.ts:1127

`subscriptionEmail?`

string

Defined in: lib/types.ts:1128

`subscriptionExpiryPartial?`

boolean

Defined in: lib/types.ts:1129

`subscriptionMailingAddress?`

string

Defined in: lib/types.ts:1130

`subscriptionName?`

string

Defined in: lib/types.ts:1131

`subscriptionPhone?`

string

Defined in: lib/types.ts:1132

`supportEmail?`

string

Defined in: lib/types.ts:1133

`supportName?`

string

Defined in: lib/types.ts:1134

`supportPhone?`

string

Defined in: lib/types.ts:1135

`supportedFormLocales?`

string[]

Defined in: lib/types.ts:1136

`supportedLocales?`

string[]

Defined in: lib/types.ts:1137

`supportedSubmissionLocales?`

string[]

Defined in: lib/types.ts:1138

`themePluginPath?`

string

Default

default

Defined in: lib/types.ts:1140

`timeFormat?`

LocaleObject

Defined in: lib/types.ts:1141

`type?`

string

Description

Defined in: lib/types.ts:1143

`urlPath?`

string

Defined in: lib/types.ts:1144

`ContextSummary`

Properties

`\_href?`

string

Format: uri

Defined in: lib/types.ts:1148

`abbreviation?`

LocaleObject

Defined in: lib/types.ts:1149

`acronym?`

LocaleObject

Defined in: lib/types.ts:1150

`description?`

LocaleObject

Defined in: lib/types.ts:1151

`enabled?`

boolean

Defined in: lib/types.ts:1152

`id?`

number

Defined in: lib/types.ts:1153

`journalThumbnail?`

object

{
    en_US?: {
    };
    fr_CA?: {
    };
    properties?: unknown;
    type?: unknown;
}

Type declaration

Member	Type
`en_US`?	{ }
`fr_CA`?	{ }
`properties`?	`unknown`
`type`?	`unknown`

Defined in: lib/types.ts:1154

`name?`

LocaleObject

Defined in: lib/types.ts:1160

`seq?`

number

Defined in: lib/types.ts:1161

`url?`

string

Defined in: lib/types.ts:1162

`urlPath?`

string

Defined in: lib/types.ts:1163

`EmailTemplate`

Properties

`\_href?`

string

Format: uri

Defined in: lib/types.ts:334

`body?`

LocaleObject

Defined in: lib/types.ts:335

`canDisable?`

boolean

Description

Can this email template be disabled in the context settings area? Default is true.

Defined in: lib/types.ts:337

`canEdit?`

boolean

Description

Can this email template be edited in the context settings area? Default is true.

Defined in: lib/types.ts:339

`contextId?`

number

Description

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

`description?`

LocaleObject

Defined in: lib/types.ts:342

`enabled?`

boolean

Description

Is this email template enabled? Default is true.

Defined in: lib/types.ts:344

`fromRoleId?`

number

Description

The ROLE_ID_* of the user who will send this email.

Defined in: lib/types.ts:346

`id?`

number

Description

The email template ID.

Defined in: lib/types.ts:348

`key?`

string

Description

A unique key for this email template.

Defined in: lib/types.ts:350

`stageId?`

number

Description

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

`subject?`

LocaleObject

Defined in: lib/types.ts:353

`toRoleId?`

number

Description

The ROLE_ID_* of the user who will receive this email.

Defined in: lib/types.ts:355

`EmailTemplateEditable`

Properties

`body?`

LocaleObject

Defined in: lib/types.ts:1166

`contextId?`

number

Description

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

`enabled?`

boolean

Description

Is this email template enabled? Default is true.

Defined in: lib/types.ts:1170

`key?`

string

Description

A unique key for this email template.

Defined in: lib/types.ts:1172

`subject?`

LocaleObject

Defined in: lib/types.ts:1173

`EmailTemplateSummary`

Properties

`\_href?`

string

Format: uri

Defined in: lib/types.ts:1177

`body?`

LocaleObject

Defined in: lib/types.ts:1178

`canDisable?`

boolean

Description

Can this email template be disabled in the context settings area? Default is true.

Defined in: lib/types.ts:1180

`canEdit?`

boolean

Description

Can this email template be edited in the context settings area? Default is true.

Defined in: lib/types.ts:1182

`contextId?`

number

Description

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

`description?`

LocaleObject

Defined in: lib/types.ts:1185

`enabled?`

boolean

Description

Is this email template enabled? Default is true.

Defined in: lib/types.ts:1187

`fromRoleId?`

number

Description

The ROLE_ID_* of the user who will send this email.

Defined in: lib/types.ts:1189

`id?`

number

Description

The email template ID.

Defined in: lib/types.ts:1191

`key?`

string

Description

A unique key for this email template.

Defined in: lib/types.ts:1193

`stageId?`

number

Description

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

`subject?`

LocaleObject

Defined in: lib/types.ts:1196

`toRoleId?`

number

Description

The ROLE_ID_* of the user who will receive this email.

Defined in: lib/types.ts:1198

`ErrorResponse`

Description

A response object that will be returned when the request could not be fulfilled.

Properties

`error?`

string

Defined in: lib/types.ts:329

`errorMessage?`

string

Defined in: lib/types.ts:330

`Galley`

Properties

`file?`

SubmissionFile

Defined in: lib/types.ts:358

`id?`

number

Defined in: lib/types.ts:359

`isApproved?`

boolean

Defined in: lib/types.ts:360

`label?`

string

Description

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

`locale?`

string

Description

The primary locale of this galley.

Defined in: lib/types.ts:364

`pub-id::publisher-id?`

string

Description

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

`publicationId?`

number

Defined in: lib/types.ts:367

`seq?`

number

Description

In what order this galley should appear in lists of galleys for this publication.

Defined in: lib/types.ts:369

`submissionFileId?`

number

Defined in: lib/types.ts:370

`urlPath?`

string

Description

An optional path to use in the URL instead of the ID.

Defined in: lib/types.ts:372

`urlPublished?`

string

Description

The URL where this galley can be viewed or downloaded.

Defined in: lib/types.ts:374

`urlRemote?`

string

Description

An optional URL where the galley can be viewed or downloaded.

Defined in: lib/types.ts:376

`GalleyEditable`

Properties

`isApproved?`

boolean

Defined in: lib/types.ts:1201

`label?`

string

Description

Defined in: lib/types.ts:1203

`locale?`

string

Description

The primary locale of this galley.

Defined in: lib/types.ts:1205

`pub-id::publisher-id?`

string

Description

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

`publicationId?`

number

Defined in: lib/types.ts:1208

`seq?`

number

Description

In what order this galley should appear in lists of galleys for this publication.

Defined in: lib/types.ts:1210

`submissionFileId?`

number

Defined in: lib/types.ts:1211

`urlPath?`

string

Description

An optional path to use in the URL instead of the ID.

Defined in: lib/types.ts:1213

`urlRemote?`

string

Description

An optional URL where the galley can be viewed or downloaded.

Defined in: lib/types.ts:1215

`GalleySummary`

Properties

`file?`

SubmissionFile

Defined in: lib/types.ts:1218

`id?`

number

Defined in: lib/types.ts:1219

`isApproved?`

boolean

Defined in: lib/types.ts:1220

`label?`

string

Description

Defined in: lib/types.ts:1222

`locale?`

string

Description

The primary locale of this galley.

Defined in: lib/types.ts:1224

`pub-id::publisher-id?`

string

Description

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

`publicationId?`

number

Defined in: lib/types.ts:1227

`seq?`

number

Description

In what order this galley should appear in lists of galleys for this publication.

Defined in: lib/types.ts:1229

`submissionFileId?`

number

Defined in: lib/types.ts:1230

`urlPublished?`

string

Description

The URL where this galley can be viewed or downloaded.

Defined in: lib/types.ts:1232

`urlRemote?`

string

Description

An optional URL where the galley can be viewed or downloaded.

Defined in: lib/types.ts:1234

`InvalidParametersResponse`

Description

A response object that will be returned when there are validation errors for the request parameters. Typically used with forms.

Example

{
 *   "name": [
 *     "You must provide a name to create a new user."
 *   ],
 *   "roles": [
 *     "You must assign the user to one or more roles."
 *   ]
 * }

Indexable

`Issue`

Properties

`\_href?`

string

Defined in: lib/types.ts:393

`articles?`

SubmissionSummary[]

Defined in: lib/types.ts:394

`coverImageAltText?`

LocaleObject

Defined in: lib/types.ts:395

`coverImageUrl?`

LocaleObject

Defined in: lib/types.ts:396

`dateNotified?`

string

Defined in: lib/types.ts:397

`datePublished?`

string

Defined in: lib/types.ts:398

`description?`

LocaleObject

Defined in: lib/types.ts:399

`doi?`

string

Defined in: lib/types.ts:400

`galleys?`

Galley[]

Defined in: lib/types.ts:401

`id?`

number

Defined in: lib/types.ts:402

`identification?`

string

Defined in: lib/types.ts:403

`isCurrent?`

boolean

Defined in: lib/types.ts:404

`lastModified?`

string

Defined in: lib/types.ts:405

`number?`

string

Defined in: lib/types.ts:406

`publishedUrl?`

string

Defined in: lib/types.ts:407

`sections?`

SectionSummary[]

Defined in: lib/types.ts:408

`title?`

LocaleObject

Defined in: lib/types.ts:409

`urlPath?`

string

Description

An optional path to use in the URL instead of the ID.

Defined in: lib/types.ts:411

`volume?`

number

Defined in: lib/types.ts:412

`year?`

number

Defined in: lib/types.ts:413

`IssueEditable`

Properties

`coverImageAltText?`

LocaleObject

Defined in: lib/types.ts:1237

`coverImageUrl?`

LocaleObject

Defined in: lib/types.ts:1238

`dateNotified?`

string

Defined in: lib/types.ts:1239

`datePublished?`

string

Defined in: lib/types.ts:1240

`description?`

LocaleObject

Defined in: lib/types.ts:1241

`doi?`

string

Defined in: lib/types.ts:1242

`id?`

number

Defined in: lib/types.ts:1243

`lastModified?`

string

Defined in: lib/types.ts:1244

`number?`

string

Defined in: lib/types.ts:1245

`publishedUrl?`

string

Defined in: lib/types.ts:1246

`title?`

LocaleObject

Defined in: lib/types.ts:1247

`urlPath?`

string

Description

An optional path to use in the URL instead of the ID.

Defined in: lib/types.ts:1249

`volume?`

number

Defined in: lib/types.ts:1250

`year?`

number

Defined in: lib/types.ts:1251

`IssueSummary`

Properties

`\_href?`

string

Defined in: lib/types.ts:1254

`coverImageAltText?`

LocaleObject

Defined in: lib/types.ts:1255

`coverImageUrl?`

LocaleObject

Defined in: lib/types.ts:1256

`datePublished?`

string

Defined in: lib/types.ts:1257

`description?`

LocaleObject

Defined in: lib/types.ts:1258

`galleys?`

Galley[]

Defined in: lib/types.ts:1259

`id?`

number

Defined in: lib/types.ts:1260

`identification?`

string

Defined in: lib/types.ts:1261

`number?`

string

Defined in: lib/types.ts:1262

`publishedUrl?`

string

Defined in: lib/types.ts:1263

`title?`

LocaleObject

Defined in: lib/types.ts:1264

`volume?`

number

Defined in: lib/types.ts:1265

`year?`

number

Defined in: lib/types.ts:1266

`LocaleObject`

Description

Key/value pairs containing data stored by locale key.

Example

{
 *   "en_US": "Filename",
 *   "fr_CA": "Nom de fichier"
 * }

Indexable

`Publication`

Properties

`\_href?`

string

Format: uri

Defined in: lib/types.ts:427

`abstract?`

LocaleObject

Defined in: lib/types.ts:428

`accessStatus?`

number

Default

Defined in: lib/types.ts:430

`authors?`

Author[]

Description

A list of the authors for this publication.

Defined in: lib/types.ts:432

`authorsString?`

string

Description

All of the authors rendered with the appropriate separators according to the locale.

Defined in: lib/types.ts:434

`authorsStringShort?`

string

Description

A shortened version of the authors rendered with the appropriate separators according to the locale.

Defined in: lib/types.ts:436

`categoryIds?`

number[]

Defined in: lib/types.ts:437

`citations?`

string[]

Description

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

`citationsRaw?`

string

Description

Optional metadata that contains references for works cited in this submission as raw text.

Defined in: lib/types.ts:441

`copyrightHolder?`

LocaleObject

Defined in: lib/types.ts:442

`copyrightYear?`

number

Description

The copyright year for this publication.

Defined in: lib/types.ts:444

`coverImage?`

object

{
    en_US?: {
        altText?: string;
        dateUploaded?: string;
        uploadName?: string;
    };
    fr_CA?: {
        altText?: string;
        dateUploaded?: string;
        uploadName?: string;
    };
    properties?: unknown;
    type?: unknown;
}

Type declaration

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

`coverage?`

LocaleObject

Defined in: lib/types.ts:459

`datePublished?`

string

Defined in: lib/types.ts:460

`disciplines?`

string[]

Description

Optional metadata that describes the submission's types of study or branches of knowledge.

Defined in: lib/types.ts:462

`fullTitle?`

LocaleObject

Defined in: lib/types.ts:463

`galleys?`

Galley[]

Defined in: lib/types.ts:464

`hideAuthor?`

boolean

Description

Whether the contributor details should be displayed for this publication. Commonly used for editorial statements without individual authorship.

Default

false

Defined in: lib/types.ts:469

`id?`

number

Defined in: lib/types.ts:470

`issueId?`

number

Defined in: lib/types.ts:471

`keywords?`

string[]

Description

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

`languages?`

string[]

Description

Optional metadata that identifies the submission's primary language.

Defined in: lib/types.ts:475

`lastModified?`

string

Defined in: lib/types.ts:476

`licenseUrl?`

string

Description

A URL to a webpage describing the license terms for this publication.

Defined in: lib/types.ts:478

`locale?`

string

Description

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

`pages?`

string

Description

The pages of the issue in which this article appears if it is published in a physical format.

Defined in: lib/types.ts:482

`prefix?`

LocaleObject

Defined in: lib/types.ts:483

`primaryContactId?`

number

Description

Which contributor is the primary contact for this publication.

Defined in: lib/types.ts:485

`pub-id::publisher-id?`

string

Description

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

`rights?`

LocaleObject

Defined in: lib/types.ts:488

`sectionId?`

number

Defined in: lib/types.ts:489

`seq?`

number

Default

Defined in: lib/types.ts:491

`source?`

LocaleObject

Defined in: lib/types.ts:492

`status?`

number

Description

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.

Default

Defined in: lib/types.ts:497

`subjects?`

string[]

Description

Optional metadata that consists of keywords, key phrases or classification codes that describe the submission's topics.

Defined in: lib/types.ts:499

`submissionId?`

number

Defined in: lib/types.ts:500

`subtitle?`

LocaleObject

Defined in: lib/types.ts:501

`supportingAgencies?`

string[]

Description

Optional metadata that indicates the source of research funding or other institutional support.

Defined in: lib/types.ts:503

`title?`

LocaleObject

Defined in: lib/types.ts:504

`type?`

LocaleObject

Defined in: lib/types.ts:505

`urlPath?`

string

Description

An optional path to use in the URL instead of the ID.

Defined in: lib/types.ts:507

`urlPublished?`

string

Description

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

`version?`

number

Description

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

`PublicationEditable`

Properties

`abstract?`

LocaleObject

Defined in: lib/types.ts:1269

`accessStatus?`

number

Default

Defined in: lib/types.ts:1271

`categoryIds?`

number[]

Defined in: lib/types.ts:1272

`citationsRaw?`

string

Description

Optional metadata that contains references for works cited in this submission as raw text.

Defined in: lib/types.ts:1274

`copyrightHolder?`

LocaleObject

Defined in: lib/types.ts:1275

`copyrightYear?`

number

Description

The copyright year for this publication.

Defined in: lib/types.ts:1277

`coverImage?`

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;
}

Type declaration

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

`coverage?`

LocaleObject

Defined in: lib/types.ts:1294

`datePublished?`

string

Defined in: lib/types.ts:1295

`disciplines?`

string[]

Description

Optional metadata that describes the submission's types of study or branches of knowledge.

Defined in: lib/types.ts:1297

`hideAuthor?`

boolean

Description

Whether the contributor details should be displayed for this publication. Commonly used for editorial statements without individual authorship.

Default

false

Defined in: lib/types.ts:1302

`issueId?`

number

Defined in: lib/types.ts:1303

`keywords?`

string[]

Description

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

`languages?`

string[]

Description

Optional metadata that identifies the submission's primary language.

Defined in: lib/types.ts:1307

`lastModified?`

string

Defined in: lib/types.ts:1308

`licenseUrl?`

string

Description

A URL to a webpage describing the license terms for this publication.

Defined in: lib/types.ts:1310

`pages?`

string

Description

The pages of the issue in which this article appears if it is published in a physical format.

Defined in: lib/types.ts:1312

`prefix?`

LocaleObject

Defined in: lib/types.ts:1313

`primaryContactId?`

number

Description

Which contributor is the primary contact for this publication.

Defined in: lib/types.ts:1315

`pub-id::publisher-id?`

string

Description

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

`rights?`

LocaleObject

Defined in: lib/types.ts:1318

`sectionId?`

number

Defined in: lib/types.ts:1319

`seq?`

number

Default

Defined in: lib/types.ts:1321

`source?`

LocaleObject

Defined in: lib/types.ts:1322

`status?`

number

Description

Default

Defined in: lib/types.ts:1327

`subjects?`

string[]

Description

Optional metadata that consists of keywords, key phrases or classification codes that describe the submission's topics.

Defined in: lib/types.ts:1329

`submissionId?`

number

Defined in: lib/types.ts:1330

`subtitle?`

LocaleObject

Defined in: lib/types.ts:1331

`supportingAgencies?`

string[]

Description

Optional metadata that indicates the source of research funding or other institutional support.

Defined in: lib/types.ts:1333

`title?`

LocaleObject

Defined in: lib/types.ts:1334

`type?`

LocaleObject

Defined in: lib/types.ts:1335

`urlPath?`

string

Description

An optional path to use in the URL instead of the ID.

Defined in: lib/types.ts:1337

`version?`

number

Description

Defined in: lib/types.ts:1339

`PublicationStats`

Description

The total abstract and galley views for a published submission.

Properties

`abstractViews?`

number

Defined in: lib/types.ts:515

`galleyViews?`

number

Defined in: lib/types.ts:516

`htmlViews?`

number

Defined in: lib/types.ts:518

`otherViews?`

number

Defined in: lib/types.ts:519

`pdfViews?`

number

Defined in: lib/types.ts:517

`publication?`

object

{
    _href?: string;
    fullTitle?: LocaleObject;
    id?: number;
    shortAuthorString?: string;
    urlPublished?: string;
    urlWorkflow?: string;
}

Type declaration

Member	Type
`_href`?	`string`
`fullTitle`?	`LocaleObject`
`id`?	`number`
`shortAuthorString`?	`string`
`urlPublished`?	`string`
`urlWorkflow`?	`string`

Defined in: lib/types.ts:520

`PublicationSummary`

Properties

`\_href?`

string

Format: uri

Defined in: lib/types.ts:1343

`authorsString?`

string

Description

All of the authors rendered with the appropriate separators according to the locale.

Defined in: lib/types.ts:1345

`authorsStringShort?`

string

Description

A shortened version of the authors rendered with the appropriate separators according to the locale.

Defined in: lib/types.ts:1347

`categoryIds?`

number[]

Defined in: lib/types.ts:1348

`coverImage?`

object

{
    en_US?: {
    };
    fr_CA?: {
    };
    properties?: unknown;
    type?: unknown;
}

Type declaration

Member	Type
`en_US`?	{ }
`fr_CA`?	{ }
`properties`?	`unknown`
`type`?	`unknown`

Defined in: lib/types.ts:1349

`datePublished?`

string

Defined in: lib/types.ts:1355

`fullTitle?`

LocaleObject

Defined in: lib/types.ts:1356

`galleys?`

Galley[]

Defined in: lib/types.ts:1357

`id?`

number

Defined in: lib/types.ts:1358

`locale?`

string

Description

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

`pages?`

string

Description

The pages of the issue in which this article appears if it is published in a physical format.

Defined in: lib/types.ts:1362

`prefix?`

LocaleObject

Defined in: lib/types.ts:1363

`primaryContactId?`

number

Description

Which contributor is the primary contact for this publication.

Defined in: lib/types.ts:1365

`pub-id::publisher-id?`

string

Description

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

`sectionId?`

number

Defined in: lib/types.ts:1368

`status?`

number

Description

Default

Defined in: lib/types.ts:1373

`submissionId?`

number

Defined in: lib/types.ts:1374

`subtitle?`

LocaleObject

Defined in: lib/types.ts:1375

`title?`

LocaleObject

Defined in: lib/types.ts:1376

`urlPublished?`

string

Description

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

`version?`

number

Description

Defined in: lib/types.ts:1380

`ReviewRound`

Properties

`id?`

number

Defined in: lib/types.ts:530

`round?`

number

Defined in: lib/types.ts:531

`stageId?`

number

Defined in: lib/types.ts:532

`status?`

string

Defined in: lib/types.ts:533

`statusId?`

number

Defined in: lib/types.ts:534

`ReviewRoundEditable`

Properties

`id?`

number

Defined in: lib/types.ts:1383

`round?`

number

Defined in: lib/types.ts:1384

`stageId?`

number

Defined in: lib/types.ts:1385

`statusId?`

number

Defined in: lib/types.ts:1386

`ReviewerSummary`

Description

A special representation of a User assigned to a reviewer group. This model presents specific details about review activity.

Properties

`\_href?`

string

Defined in: lib/types.ts:538

`affiliation?`

LocaleObject

Defined in: lib/types.ts:539

`averageReviewCompletionDays?`

number

Defined in: lib/types.ts:540

`dateLastReviewAssignment?`

string

Defined in: lib/types.ts:541

`disabled?`

boolean

Defined in: lib/types.ts:542

`fullName?`

string

Defined in: lib/types.ts:543

`gossip?`

LocaleObject

Defined in: lib/types.ts:544

`groups?`

UserGroup[]

Defined in: lib/types.ts:545

`id?`

number

Defined in: lib/types.ts:546

`interests?`

UserInterest[]

Defined in: lib/types.ts:547

`reviewsActive?`

number

Defined in: lib/types.ts:548

`reviewsCancelled?`

number

Defined in: lib/types.ts:550

`reviewsCompleted?`

number

Defined in: lib/types.ts:549

`reviewsDeclined?`

number

Defined in: lib/types.ts:551

`userName?`

string

Defined in: lib/types.ts:552

`Section`

Properties

`abbrev?`

LocaleObject

Defined in: lib/types.ts:555

`id?`

number

Defined in: lib/types.ts:556

`seq?`

number

Defined in: lib/types.ts:557

`title?`

LocaleObject

Defined in: lib/types.ts:558

`SectionEditable`

Properties

`abbrev?`

LocaleObject

Defined in: lib/types.ts:1389

`id?`

number

Defined in: lib/types.ts:1390

`seq?`

number

Defined in: lib/types.ts:1391

`title?`

LocaleObject

Defined in: lib/types.ts:1392

`SectionSummary`

Properties

`abbrev?`

LocaleObject

Defined in: lib/types.ts:1395

`id?`

number

Defined in: lib/types.ts:1396

`seq?`

number

Defined in: lib/types.ts:1397

`title?`

LocaleObject

Defined in: lib/types.ts:1398

`Site`

Properties

`about?`

LocaleObject

Defined in: lib/types.ts:561

`contactEmail?`

LocaleObject

Defined in: lib/types.ts:562

`contactName?`

LocaleObject

Defined in: lib/types.ts:563

`enableBulkEmails?`

number[]

Description

Which hosted journals, presses or preprint servers are allowed to send bulk emails.

Defined in: lib/types.ts:565

`installedLocales?`

string[]

Defined in: lib/types.ts:566

`minPasswordLength?`

number

Defined in: lib/types.ts:567

`pageFooter?`

LocaleObject

Defined in: lib/types.ts:568

`pageHeaderTitleImage?`

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;
}

Type declaration

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

`primaryLocale?`

string

Defined in: lib/types.ts:589

`privacyStatement?`

LocaleObject

Defined in: lib/types.ts:590

`redirect?`

number

Defined in: lib/types.ts:591

`sidebar?`

string[]

Defined in: lib/types.ts:592

`styleSheet?`

object

{
    dateUploaded?: string;
    name?: string;
    uploadName?: string;
}

Type declaration

Member	Type
`dateUploaded`?	`string`
`name`?	`string`
`uploadName`?	`string`

Defined in: lib/types.ts:593

`supportedLocales?`

string[]

Defined in: lib/types.ts:598

`themePluginPath?`

string

Default

default

Defined in: lib/types.ts:600

`title?`

LocaleObject

Defined in: lib/types.ts:601

`SiteEditable`

Properties

`about?`

LocaleObject

Defined in: lib/types.ts:1401

`contactEmail?`

LocaleObject

Defined in: lib/types.ts:1402

`contactName?`

LocaleObject

Defined in: lib/types.ts:1403

`enableBulkEmails?`

number[]

Description

Which hosted journals, presses or preprint servers are allowed to send bulk emails.

Defined in: lib/types.ts:1405

`installedLocales?`

string[]

Defined in: lib/types.ts:1406

`minPasswordLength?`

number

Defined in: lib/types.ts:1407

`pageFooter?`

LocaleObject

Defined in: lib/types.ts:1408

`pageHeaderTitleImage?`

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;
}

Type declaration

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

`primaryLocale?`

string

Defined in: lib/types.ts:1431

`privacyStatement?`

LocaleObject

Defined in: lib/types.ts:1432

`redirect?`

number

Defined in: lib/types.ts:1433

`sidebar?`

string[]

Defined in: lib/types.ts:1434

`styleSheet?`

object

{
    dateUploaded?: string;
    name?: string;
    temporaryFileId?: number;
    uploadName?: string;
}

Type declaration

Member	Type
`dateUploaded`?	`string`
`name`?	`string`
`temporaryFileId`?	`number`
`uploadName`?	`string`

Defined in: lib/types.ts:1435

`supportedLocales?`

string[]

Defined in: lib/types.ts:1441

`themePluginPath?`

string

Default

default

Defined in: lib/types.ts:1443

`title?`

LocaleObject

Defined in: lib/types.ts:1444

`Submission`

Properties

`\_href?`

string

Defined in: lib/types.ts:604

`contextId?`

number

Defined in: lib/types.ts:605

`currentPublicationId?`

number

Description

Which publication is the latest published version.

Defined in: lib/types.ts:607

`dateLastActivity?`

string

Description

The last time activity was recorded related to this submission.

Defined in: lib/types.ts:609

`dateSubmitted?`

string

Defined in: lib/types.ts:610

`id?`

number

Defined in: lib/types.ts:611

`lastModified?`

string

Description

The last time a modification was made to this submission or any of its associated objects.

Defined in: lib/types.ts:613

`locale?`

string

Description

The primary language of this submission.

Defined in: lib/types.ts:615

`publications?`

Publication[]

Description

A list of publications that have been created for this submission.

Defined in: lib/types.ts:617

`reviewAssignments?`

{ dateDue?: number; dateResponseDue?: number; id?: number; isCurrentUserAssigned?: number; reviewRoundId?: number; round?: number; status?: number; statusLabel?: number; }[]

Description

Information about pending and completed review assignments.

Defined in: lib/types.ts:619

`reviewRounds?`

ReviewRound[]

Description

A list of review rounds that have been opened for this submission.

Defined in: lib/types.ts:630

`stageId?`

number

Description

The stage of the editorial workflow that this submission is currently in. One of the WORKFLOW_STAGE_ constants. Default is WORKFLOW_STAGE_SUBMISSION.

Default

Defined in: lib/types.ts:635

`stages?`

{ currentUserAssignedRoles?: number[]; files?: { count?: number; }; id?: number; isActiveStage?: boolean; label?: string; queries?: unknown[]; status?: string; statusId?: number; }[]

Description

Key data about the status, files and discussions of each stage.

Defined in: lib/types.ts:637

`status?`

number

Description

Whether the submission is Published, Declined, Scheduled or Queued (still in the workflow). One of the STATUS_* constants. Default is STATUS_QUEUED.

Default

Defined in: lib/types.ts:653

`statusLabel?`

string

Description

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

`submissionProgress?`

number

Description

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.

Default

Defined in: lib/types.ts:660

`urlAuthorWorkflow?`

string

Description

A URL to the author's editorial workflow.

Defined in: lib/types.ts:662

`urlEditorialWorkflow?`

string

Description

A URL to the editors' and assistants' editorial workflow.

Defined in: lib/types.ts:664

`urlPublished?`

string

Description

A URL to the current publication or where it will be published.

Defined in: lib/types.ts:666

`urlWorkflow?`

string

Description

A URL to the workflow most appropriate for the current user. It will match the urlAuthorWorkflow or `urlEditorialWorkflow.

Defined in: lib/types.ts:668

`SubmissionEditable`

Properties

`contextId?`

number

Defined in: lib/types.ts:1447

`currentPublicationId?`

number

Description

Which publication is the latest published version.

Defined in: lib/types.ts:1449

`dateLastActivity?`

string

Description

The last time activity was recorded related to this submission.

Defined in: lib/types.ts:1451

`dateSubmitted?`

string

Defined in: lib/types.ts:1452

`id?`

number

Defined in: lib/types.ts:1453

`lastModified?`

string

Description

The last time a modification was made to this submission or any of its associated objects.

Defined in: lib/types.ts:1455

`locale?`

string

Description

The primary language of this submission.

Defined in: lib/types.ts:1457

`stageId?`

number

Description

The stage of the editorial workflow that this submission is currently in. One of the WORKFLOW_STAGE_ constants. Default is WORKFLOW_STAGE_SUBMISSION.

Default

Defined in: lib/types.ts:1462

`status?`

number

Description

Whether the submission is Published, Declined, Scheduled or Queued (still in the workflow). One of the STATUS_* constants. Default is STATUS_QUEUED.

Default

Defined in: lib/types.ts:1467

`submissionProgress?`

number

Description

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.

Default

Defined in: lib/types.ts:1472

`SubmissionFile`

Properties

`\_href?`

string

Format: uri

Defined in: lib/types.ts:672

`assocId?`

number

Description

Used with assocType to associate this file with an object such as a galley.

Defined in: lib/types.ts:674

`assocType?`

number

Description

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

`caption?`

string

Description

A caption for this file. Used with artwork such as images.

Defined in: lib/types.ts:678

`copyrightOwner?`

string

Description

The copyright owner of this file. Used with artwork such as images.

Defined in: lib/types.ts:680

`createdAt?`

string

Description

The date this submission file object was created in the system. Set automatically by the software.

Defined in: lib/types.ts:682

`creator?`

LocaleObject

Defined in: lib/types.ts:683

`credit?`

string

Description

An attribution for this file, such as a photographer's name. Used with artwork such as images.

Defined in: lib/types.ts:685

`dateCreated?`

string

Description

Public metadata about when this content was created. Used with supplementary files.

Defined in: lib/types.ts:687

`dependentFiles?`

SubmissionFile[]

Description

Any dependent files, typically images or audio files that are loaded by an HTML file.

Defined in: lib/types.ts:689

`description?`

LocaleObject

Defined in: lib/types.ts:690

`documentType?`

string

Defined in: lib/types.ts:691

`fileId?`

number

Defined in: lib/types.ts:692

`fileStage?`

number

Defined in: lib/types.ts:693

`genreId?`

number

Defined in: lib/types.ts:694

`id?`

number

Defined in: lib/types.ts:695

`language?`

string

Description

The language of this file if it contains text. Used with supplementary files.

Defined in: lib/types.ts:697

`locale?`

string

Description

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

`mimetype?`

string

Defined in: lib/types.ts:700

`name?`

LocaleObject

Defined in: lib/types.ts:701

`path?`

string

Defined in: lib/types.ts:702

`publisher?`

LocaleObject

Defined in: lib/types.ts:703

`revisions?`

{ documentType?: string; fileId?: number; mimetype?: string; path?: string; url?: string; }[]

Description

Previous versions of this file.

Defined in: lib/types.ts:705

`source?`

LocaleObject

Defined in: lib/types.ts:712

`sourceSubmissionFileId?`

number

Description

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

`sponsor?`

LocaleObject

Defined in: lib/types.ts:715

`subject?`

LocaleObject

Defined in: lib/types.ts:716

`submissionId?`

number

Defined in: lib/types.ts:717

`terms?`

string

Description

Licensing terms for this file. Used with artwork such as images.

Defined in: lib/types.ts:719

`updatedAt?`

string

Description

When this object was last updated.

Defined in: lib/types.ts:721

`uploaderUserId?`

number

Defined in: lib/types.ts:722

`url?`

string

Defined in: lib/types.ts:723

`viewable?`

boolean

Defined in: lib/types.ts:724

`SubmissionFileEditable`

Properties

`assocId?`

number

Description

Used with assocType to associate this file with an object such as a galley.

Defined in: lib/types.ts:1517

`assocType?`

number

Description

Defined in: lib/types.ts:1519

`caption?`

string

Description

A caption for this file. Used with artwork such as images.

Defined in: lib/types.ts:1521

`copyrightOwner?`

string

Description

The copyright owner of this file. Used with artwork such as images.

Defined in: lib/types.ts:1523

`createdAt?`

string

Description

The date this submission file object was created in the system. Set automatically by the software.

Defined in: lib/types.ts:1525

`creator?`

LocaleObject

Defined in: lib/types.ts:1526

`credit?`

string

Description

An attribution for this file, such as a photographer's name. Used with artwork such as images.

Defined in: lib/types.ts:1528

`dateCreated?`

string

Description

Public metadata about when this content was created. Used with supplementary files.

Defined in: lib/types.ts:1530

`description?`

LocaleObject

Defined in: lib/types.ts:1531

`file?`

string

Format: binary

Defined in: lib/types.ts:1533

`fileId?`

number

Defined in: lib/types.ts:1534

`fileStage?`

number

Defined in: lib/types.ts:1535

`genreId?`

number

Defined in: lib/types.ts:1536

`language?`

string

Description

The language of this file if it contains text. Used with supplementary files.

Defined in: lib/types.ts:1538

`name?`

LocaleObject

Defined in: lib/types.ts:1539

`publisher?`

LocaleObject

Defined in: lib/types.ts:1540

`source?`

LocaleObject

Defined in: lib/types.ts:1541

`sourceSubmissionFileId?`

number

Description

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

`sponsor?`

LocaleObject

Defined in: lib/types.ts:1544

`subject?`

LocaleObject

Defined in: lib/types.ts:1545

`submissionId?`

number

Defined in: lib/types.ts:1546

`terms?`

string

Description

Licensing terms for this file. Used with artwork such as images.

Defined in: lib/types.ts:1548

`updatedAt?`

string

Description

When this object was last updated.

Defined in: lib/types.ts:1550

`uploaderUserId?`

number

Defined in: lib/types.ts:1551

`viewable?`

boolean

Defined in: lib/types.ts:1552

`SubmissionFileSummary`

Properties

`\_href?`

string

Format: uri

Defined in: lib/types.ts:1556

`assocId?`

number

Description

Used with assocType to associate this file with an object such as a galley.

Defined in: lib/types.ts:1558

`assocType?`

number

Description

Defined in: lib/types.ts:1560

`caption?`

string

Description

A caption for this file. Used with artwork such as images.

Defined in: lib/types.ts:1562

`copyrightOwner?`

string

Description

The copyright owner of this file. Used with artwork such as images.

Defined in: lib/types.ts:1564

`createdAt?`

string

Description

The date this submission file object was created in the system. Set automatically by the software.

Defined in: lib/types.ts:1566

`creator?`

LocaleObject

Defined in: lib/types.ts:1567

`credit?`

string

Description

An attribution for this file, such as a photographer's name. Used with artwork such as images.

Defined in: lib/types.ts:1569

`dateCreated?`

string

Description

Public metadata about when this content was created. Used with supplementary files.

Defined in: lib/types.ts:1571

`description?`

LocaleObject

Defined in: lib/types.ts:1572

`documentType?`

string

Defined in: lib/types.ts:1573

`fileId?`

number

Defined in: lib/types.ts:1574

`fileStage?`

number

Defined in: lib/types.ts:1575

`genreId?`

number

Defined in: lib/types.ts:1576

`id?`

number

Defined in: lib/types.ts:1577

`language?`

string

Description

The language of this file if it contains text. Used with supplementary files.

Defined in: lib/types.ts:1579

`locale?`

string

Description

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

`mimetype?`

string

Defined in: lib/types.ts:1582

`name?`

LocaleObject

Defined in: lib/types.ts:1583

`path?`

string

Defined in: lib/types.ts:1584

`publisher?`

LocaleObject

Defined in: lib/types.ts:1585

`source?`

LocaleObject

Defined in: lib/types.ts:1586

`sourceSubmissionFileId?`

number

Description

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

`sponsor?`

LocaleObject

Defined in: lib/types.ts:1589

`subject?`

LocaleObject

Defined in: lib/types.ts:1590

`submissionId?`

number

Defined in: lib/types.ts:1591

`terms?`

string

Description

Licensing terms for this file. Used with artwork such as images.

Defined in: lib/types.ts:1593

`updatedAt?`

string

Description

When this object was last updated.

Defined in: lib/types.ts:1595

`uploaderUserId?`

number

Defined in: lib/types.ts:1596

`url?`

string

Defined in: lib/types.ts:1597

`viewable?`

boolean

Defined in: lib/types.ts:1598

`SubmissionSummary`

Properties

`\_href?`

string

Defined in: lib/types.ts:1475

`contextId?`

number

Defined in: lib/types.ts:1476

`currentPublicationId?`

number

Description

Which publication is the latest published version.

Defined in: lib/types.ts:1478

`dateLastActivity?`

string

Description

The last time activity was recorded related to this submission.

Defined in: lib/types.ts:1480

`dateSubmitted?`

string

Defined in: lib/types.ts:1481

`id?`

number

Defined in: lib/types.ts:1482

`lastModified?`

string

Description

The last time a modification was made to this submission or any of its associated objects.

Defined in: lib/types.ts:1484

`locale?`

string

Description

The primary language of this submission.

Defined in: lib/types.ts:1486

`publications?`

Publication[]

Description

A list of publications that have been created for this submission.

Defined in: lib/types.ts:1488

`stageId?`

number

Description

The stage of the editorial workflow that this submission is currently in. One of the WORKFLOW_STAGE_ constants. Default is WORKFLOW_STAGE_SUBMISSION.

Default

Defined in: lib/types.ts:1493

`status?`

number

Description

Whether the submission is Published, Declined, Scheduled or Queued (still in the workflow). One of the STATUS_* constants. Default is STATUS_QUEUED.

Default

Defined in: lib/types.ts:1498

`statusLabel?`

string

Description

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

`submissionProgress?`

number

Description

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.

Default

Defined in: lib/types.ts:1505

`urlAuthorWorkflow?`

string

Description

A URL to the author's editorial workflow.

Defined in: lib/types.ts:1507

`urlEditorialWorkflow?`

string

Description

A URL to the editors' and assistants' editorial workflow.

Defined in: lib/types.ts:1509

`urlPublished?`

string

Description

A URL to the current publication or where it will be published.

Defined in: lib/types.ts:1511

`urlWorkflow?`

string

Description

A URL to the workflow most appropriate for the current user. It will match the urlAuthorWorkflow or `urlEditorialWorkflow.

Defined in: lib/types.ts:1513

`ThemeOptions`

Description

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.