orcid_api.models package

Submodules

orcid_api.models.activities_summary module

ORCID Member

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: Latest

Generated by: https://github.com/swagger-api/swagger-codegen.git

class orcid_api.models.activities_summary.ActivitiesSummary(last_modified_date=None, educations=None, employments=None, fundings=None, peer_reviews=None, works=None, path=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

property educations

Gets the educations of this ActivitiesSummary.

Returns

The educations of this ActivitiesSummary.

Return type

Educations

property employments

Gets the employments of this ActivitiesSummary.

Returns

The employments of this ActivitiesSummary.

Return type

Employments

property fundings

Gets the fundings of this ActivitiesSummary.

Returns

The fundings of this ActivitiesSummary.

Return type

Fundings

property last_modified_date

Gets the last_modified_date of this ActivitiesSummary.

Returns

The last_modified_date of this ActivitiesSummary.

Return type

LastModifiedDate

property path

Gets the path of this ActivitiesSummary.

Returns

The path of this ActivitiesSummary.

Return type

str

property peer_reviews

Gets the peer_reviews of this ActivitiesSummary.

Returns

The peer_reviews of this ActivitiesSummary.

Return type

PeerReviews

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property works

Gets the works of this ActivitiesSummary.

Returns

The works of this ActivitiesSummary.

Return type

Works

orcid_api.models.address module

ORCID Member

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: Latest

Generated by: https://github.com/swagger-api/swagger-codegen.git

class orcid_api.models.address.Address(created_date=None, last_modified_date=None, source=None, country=None, visibility=None, path=None, put_code=None, display_index=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

property country

Gets the country of this Address.

Returns

The country of this Address.

Return type

Country

property created_date

Gets the created_date of this Address.

Returns

The created_date of this Address.

Return type

CreatedDate

property display_index

Gets the display_index of this Address.

Returns

The display_index of this Address.

Return type

int

property last_modified_date

Gets the last_modified_date of this Address.

Returns

The last_modified_date of this Address.

Return type

LastModifiedDate

property path

Gets the path of this Address.

Returns

The path of this Address.

Return type

str

property put_code

Gets the put_code of this Address.

Returns

The put_code of this Address.

Return type

int

property source

Gets the source of this Address.

Returns

The source of this Address.

Return type

Source

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property visibility

Gets the visibility of this Address.

Returns

The visibility of this Address.

Return type

str

orcid_api.models.amount module

ORCID Member

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: Latest

Generated by: https://github.com/swagger-api/swagger-codegen.git

class orcid_api.models.amount.Amount(value=None, currency_code=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

property currency_code

Gets the currency_code of this Amount.

Returns

The currency_code of this Amount.

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property value

Gets the value of this Amount.

Returns

The value of this Amount.

Return type

str

orcid_api.models.authorization_url module

ORCID Member

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: Latest

Generated by: https://github.com/swagger-api/swagger-codegen.git

class orcid_api.models.authorization_url.AuthorizationUrl(uri=None, path=None, host=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

property host

Gets the host of this AuthorizationUrl.

Returns

The host of this AuthorizationUrl.

Return type

str

property path

Gets the path of this AuthorizationUrl.

Returns

The path of this AuthorizationUrl.

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property uri

Gets the uri of this AuthorizationUrl.

Returns

The uri of this AuthorizationUrl.

Return type

str

orcid_api.models.bulk_element module

ORCID Member

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: Latest

Generated by: https://github.com/swagger-api/swagger-codegen.git

class orcid_api.models.bulk_element.BulkElement

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

orcid_api.models.citation module

ORCID Member

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: Latest

Generated by: https://github.com/swagger-api/swagger-codegen.git

class orcid_api.models.citation.Citation(citation_type=None, citation_value=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

property citation_type

Gets the citation_type of this Citation.

Returns

The citation_type of this Citation.

Return type

str

property citation_value

Gets the citation_value of this Citation.

Returns

The citation_value of this Citation.

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

orcid_api.models.contributor module

ORCID Member

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: Latest

Generated by: https://github.com/swagger-api/swagger-codegen.git

class orcid_api.models.contributor.Contributor(contributor_orcid=None, credit_name=None, contributor_email=None, contributor_attributes=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

property contributor_attributes

Gets the contributor_attributes of this Contributor.

Returns

The contributor_attributes of this Contributor.

Return type

ContributorAttributes

property contributor_email

Gets the contributor_email of this Contributor.

Returns

The contributor_email of this Contributor.

Return type

ContributorEmail

property contributor_orcid

Gets the contributor_orcid of this Contributor.

Returns

The contributor_orcid of this Contributor.

Return type

ContributorOrcid

property credit_name

Gets the credit_name of this Contributor.

Returns

The credit_name of this Contributor.

Return type

CreditName

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

orcid_api.models.contributor_attributes module

ORCID Member

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: Latest

Generated by: https://github.com/swagger-api/swagger-codegen.git

class orcid_api.models.contributor_attributes.ContributorAttributes(contributor_sequence=None, contributor_role=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

property contributor_role

Gets the contributor_role of this ContributorAttributes.

Returns

The contributor_role of this ContributorAttributes.

Return type

str

property contributor_sequence

Gets the contributor_sequence of this ContributorAttributes.

Returns

The contributor_sequence of this ContributorAttributes.

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

orcid_api.models.contributor_email module

ORCID Member

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: Latest

Generated by: https://github.com/swagger-api/swagger-codegen.git

class orcid_api.models.contributor_email.ContributorEmail(value=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property value

Gets the value of this ContributorEmail.

Returns

The value of this ContributorEmail.

Return type

str

orcid_api.models.contributor_orcid module

ORCID Member

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: Latest

Generated by: https://github.com/swagger-api/swagger-codegen.git

class orcid_api.models.contributor_orcid.ContributorOrcid(uri=None, path=None, host=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

property host

Gets the host of this ContributorOrcid.

Returns

The host of this ContributorOrcid.

Return type

str

property path

Gets the path of this ContributorOrcid.

Returns

The path of this ContributorOrcid.

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property uri

Gets the uri of this ContributorOrcid.

Returns

The uri of this ContributorOrcid.

Return type

str

orcid_api.models.country module

ORCID Member

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: Latest

Generated by: https://github.com/swagger-api/swagger-codegen.git

class orcid_api.models.country.Country(value=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property value

Gets the value of this Country.

Returns

The value of this Country.

Return type

str

orcid_api.models.created_date module

ORCID Member

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: Latest

Generated by: https://github.com/swagger-api/swagger-codegen.git

class orcid_api.models.created_date.CreatedDate(value=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property value

Gets the value of this CreatedDate.

Returns

The value of this CreatedDate.

Return type

datetime

orcid_api.models.credit_name module

ORCID Member

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: Latest

Generated by: https://github.com/swagger-api/swagger-codegen.git

class orcid_api.models.credit_name.CreditName(value=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property value

Gets the value of this CreditName.

Returns

The value of this CreditName.

Return type

str

orcid_api.models.day module

ORCID Member

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: Latest

Generated by: https://github.com/swagger-api/swagger-codegen.git

class orcid_api.models.day.Day(value=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property value

Gets the value of this Day.

Returns

The value of this Day.

Return type

str

orcid_api.models.disambiguated_organization module

ORCID Member

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: Latest

Generated by: https://github.com/swagger-api/swagger-codegen.git

class orcid_api.models.disambiguated_organization.DisambiguatedOrganization(disambiguated_organization_identifier=None, disambiguation_source=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

property disambiguated_organization_identifier

Gets the disambiguated_organization_identifier of this DisambiguatedOrganization.

Returns

The disambiguated_organization_identifier of this DisambiguatedOrganization.

Return type

str

property disambiguation_source

Gets the disambiguation_source of this DisambiguatedOrganization.

Returns

The disambiguation_source of this DisambiguatedOrganization.

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

orcid_api.models.education module

ORCID Member

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: Latest

Generated by: https://github.com/swagger-api/swagger-codegen.git

class orcid_api.models.education.Education(created_date=None, last_modified_date=None, source=None, put_code=None, path=None, department_name=None, role_title=None, start_date=None, end_date=None, organization=None, visibility=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

property created_date

Gets the created_date of this Education.

Returns

The created_date of this Education.

Return type

CreatedDate

property department_name

Gets the department_name of this Education.

Returns

The department_name of this Education.

Return type

str

property end_date

Gets the end_date of this Education.

Returns

The end_date of this Education.

Return type

FuzzyDate

property last_modified_date

Gets the last_modified_date of this Education.

Returns

The last_modified_date of this Education.

Return type

LastModifiedDate

property organization

Gets the organization of this Education.

Returns

The organization of this Education.

Return type

Organization

property path

Gets the path of this Education.

Returns

The path of this Education.

Return type

str

property put_code

Gets the put_code of this Education.

Returns

The put_code of this Education.

Return type

int

property role_title

Gets the role_title of this Education.

Returns

The role_title of this Education.

Return type

str

property source

Gets the source of this Education.

Returns

The source of this Education.

Return type

Source

property start_date

Gets the start_date of this Education.

Returns

The start_date of this Education.

Return type

FuzzyDate

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property visibility

Gets the visibility of this Education.

Returns

The visibility of this Education.

Return type

str

orcid_api.models.education_summary module

ORCID Member

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: Latest

Generated by: https://github.com/swagger-api/swagger-codegen.git

class orcid_api.models.education_summary.EducationSummary(created_date=None, last_modified_date=None, source=None, department_name=None, role_title=None, start_date=None, end_date=None, organization=None, visibility=None, put_code=None, path=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

property created_date

Gets the created_date of this EducationSummary.

Returns

The created_date of this EducationSummary.

Return type

CreatedDate

property department_name

Gets the department_name of this EducationSummary.

Returns

The department_name of this EducationSummary.

Return type

str

property end_date

Gets the end_date of this EducationSummary.

Returns

The end_date of this EducationSummary.

Return type

FuzzyDate

property last_modified_date

Gets the last_modified_date of this EducationSummary.

Returns

The last_modified_date of this EducationSummary.

Return type

LastModifiedDate

property organization

Gets the organization of this EducationSummary.

Returns

The organization of this EducationSummary.

Return type

Organization

property path

Gets the path of this EducationSummary.

Returns

The path of this EducationSummary.

Return type

str

property put_code

Gets the put_code of this EducationSummary.

Returns

The put_code of this EducationSummary.

Return type

int

property role_title

Gets the role_title of this EducationSummary.

Returns

The role_title of this EducationSummary.

Return type

str

property source

Gets the source of this EducationSummary.

Returns

The source of this EducationSummary.

Return type

Source

property start_date

Gets the start_date of this EducationSummary.

Returns

The start_date of this EducationSummary.

Return type

FuzzyDate

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property visibility

Gets the visibility of this EducationSummary.

Returns

The visibility of this EducationSummary.

Return type

str

orcid_api.models.educations module

ORCID Member

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: Latest

Generated by: https://github.com/swagger-api/swagger-codegen.git

class orcid_api.models.educations.Educations(last_modified_date=None, education_summary=None, path=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

property education_summary

Gets the education_summary of this Educations.

Returns

The education_summary of this Educations.

Return type

list[EducationSummary]

property last_modified_date

Gets the last_modified_date of this Educations.

Returns

The last_modified_date of this Educations.

Return type

LastModifiedDate

property path

Gets the path of this Educations.

Returns

The path of this Educations.

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

orcid_api.models.employment module

ORCID Member

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: Latest

Generated by: https://github.com/swagger-api/swagger-codegen.git

class orcid_api.models.employment.Employment(created_date=None, last_modified_date=None, source=None, put_code=None, path=None, department_name=None, role_title=None, start_date=None, end_date=None, organization=None, visibility=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

property created_date

Gets the created_date of this Employment.

Returns

The created_date of this Employment.

Return type

CreatedDate

property department_name

Gets the department_name of this Employment.

Returns

The department_name of this Employment.

Return type

str

property end_date

Gets the end_date of this Employment.

Returns

The end_date of this Employment.

Return type

FuzzyDate

property last_modified_date

Gets the last_modified_date of this Employment.

Returns

The last_modified_date of this Employment.

Return type

LastModifiedDate

property organization

Gets the organization of this Employment.

Returns

The organization of this Employment.

Return type

Organization

property path

Gets the path of this Employment.

Returns

The path of this Employment.

Return type

str

property put_code

Gets the put_code of this Employment.

Returns

The put_code of this Employment.

Return type

int

property role_title

Gets the role_title of this Employment.

Returns

The role_title of this Employment.

Return type

str

property source

Gets the source of this Employment.

Returns

The source of this Employment.

Return type

Source

property start_date

Gets the start_date of this Employment.

Returns

The start_date of this Employment.

Return type

FuzzyDate

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property visibility

Gets the visibility of this Employment.

Returns

The visibility of this Employment.

Return type

str

orcid_api.models.employment_summary module

ORCID Member

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: Latest

Generated by: https://github.com/swagger-api/swagger-codegen.git

class orcid_api.models.employment_summary.EmploymentSummary(created_date=None, last_modified_date=None, source=None, department_name=None, role_title=None, start_date=None, end_date=None, organization=None, visibility=None, put_code=None, path=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

property created_date

Gets the created_date of this EmploymentSummary.

Returns

The created_date of this EmploymentSummary.

Return type

CreatedDate

property department_name

Gets the department_name of this EmploymentSummary.

Returns

The department_name of this EmploymentSummary.

Return type

str

property end_date

Gets the end_date of this EmploymentSummary.

Returns

The end_date of this EmploymentSummary.

Return type

FuzzyDate

property last_modified_date

Gets the last_modified_date of this EmploymentSummary.

Returns

The last_modified_date of this EmploymentSummary.

Return type

LastModifiedDate

property organization

Gets the organization of this EmploymentSummary.

Returns

The organization of this EmploymentSummary.

Return type

Organization

property path

Gets the path of this EmploymentSummary.

Returns

The path of this EmploymentSummary.

Return type

str

property put_code

Gets the put_code of this EmploymentSummary.

Returns

The put_code of this EmploymentSummary.

Return type

int

property role_title

Gets the role_title of this EmploymentSummary.

Returns

The role_title of this EmploymentSummary.

Return type

str

property source

Gets the source of this EmploymentSummary.

Returns

The source of this EmploymentSummary.

Return type

Source

property start_date

Gets the start_date of this EmploymentSummary.

Returns

The start_date of this EmploymentSummary.

Return type

FuzzyDate

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property visibility

Gets the visibility of this EmploymentSummary.

Returns

The visibility of this EmploymentSummary.

Return type

str

orcid_api.models.employments module

ORCID Member

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: Latest

Generated by: https://github.com/swagger-api/swagger-codegen.git

class orcid_api.models.employments.Employments(last_modified_date=None, employment_summary=None, path=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

property employment_summary

Gets the employment_summary of this Employments.

Returns

The employment_summary of this Employments.

Return type

list[EmploymentSummary]

property last_modified_date

Gets the last_modified_date of this Employments.

Returns

The last_modified_date of this Employments.

Return type

LastModifiedDate

property path

Gets the path of this Employments.

Returns

The path of this Employments.

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

orcid_api.models.external_i_ds module

ORCID Member

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: Latest

Generated by: https://github.com/swagger-api/swagger-codegen.git

class orcid_api.models.external_i_ds.ExternalIDs(external_id=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

property external_id

Gets the external_id of this ExternalIDs.

Returns

The external_id of this ExternalIDs.

Return type

list[ExternalID]

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

orcid_api.models.external_id module

ORCID Member

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: Latest

Generated by: https://github.com/swagger-api/swagger-codegen.git

class orcid_api.models.external_id.ExternalID(external_id_type=None, external_id_value=None, external_id_url=None, external_id_relationship=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

property external_id_relationship

Gets the external_id_relationship of this ExternalID.

Returns

The external_id_relationship of this ExternalID.

Return type

str

property external_id_type

Gets the external_id_type of this ExternalID.

Returns

The external_id_type of this ExternalID.

Return type

str

property external_id_url

Gets the external_id_url of this ExternalID.

Returns

The external_id_url of this ExternalID.

Return type

Url

property external_id_value

Gets the external_id_value of this ExternalID.

Returns

The external_id_value of this ExternalID.

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

orcid_api.models.funding module

ORCID Member

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: Latest

Generated by: https://github.com/swagger-api/swagger-codegen.git

class orcid_api.models.funding.Funding(created_date=None, last_modified_date=None, source=None, put_code=None, path=None, type=None, organization_defined_type=None, title=None, short_description=None, amount=None, url=None, start_date=None, end_date=None, external_ids=None, contributors=None, organization=None, visibility=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

property amount

Gets the amount of this Funding.

Returns

The amount of this Funding.

Return type

Amount

property contributors

Gets the contributors of this Funding.

Returns

The contributors of this Funding.

Return type

FundingContributors

property created_date

Gets the created_date of this Funding.

Returns

The created_date of this Funding.

Return type

CreatedDate

property end_date

Gets the end_date of this Funding.

Returns

The end_date of this Funding.

Return type

FuzzyDate

property external_ids

Gets the external_ids of this Funding.

Returns

The external_ids of this Funding.

Return type

ExternalIDs

property last_modified_date

Gets the last_modified_date of this Funding.

Returns

The last_modified_date of this Funding.

Return type

LastModifiedDate

property organization

Gets the organization of this Funding.

Returns

The organization of this Funding.

Return type

Organization

property organization_defined_type

Gets the organization_defined_type of this Funding.

Returns

The organization_defined_type of this Funding.

Return type

OrganizationDefinedFundingSubType

property path

Gets the path of this Funding.

Returns

The path of this Funding.

Return type

str

property put_code

Gets the put_code of this Funding.

Returns

The put_code of this Funding.

Return type

int

property short_description

Gets the short_description of this Funding.

Returns

The short_description of this Funding.

Return type

str

property source

Gets the source of this Funding.

Returns

The source of this Funding.

Return type

Source

property start_date

Gets the start_date of this Funding.

Returns

The start_date of this Funding.

Return type

FuzzyDate

property title

Gets the title of this Funding.

Returns

The title of this Funding.

Return type

FundingTitle

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property type

Gets the type of this Funding.

Returns

The type of this Funding.

Return type

str

property url

Gets the url of this Funding.

Returns

The url of this Funding.

Return type

Url

property visibility

Gets the visibility of this Funding.

Returns

The visibility of this Funding.

Return type

str

orcid_api.models.funding_contributor module

ORCID Member

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: Latest

Generated by: https://github.com/swagger-api/swagger-codegen.git

class orcid_api.models.funding_contributor.FundingContributor(contributor_orcid=None, credit_name=None, contributor_email=None, contributor_attributes=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

property contributor_attributes

Gets the contributor_attributes of this FundingContributor.

Returns

The contributor_attributes of this FundingContributor.

Return type

FundingContributorAttributes

property contributor_email

Gets the contributor_email of this FundingContributor.

Returns

The contributor_email of this FundingContributor.

Return type

ContributorEmail

property contributor_orcid

Gets the contributor_orcid of this FundingContributor.

Returns

The contributor_orcid of this FundingContributor.

Return type

ContributorOrcid

property credit_name

Gets the credit_name of this FundingContributor.

Returns

The credit_name of this FundingContributor.

Return type

CreditName

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

orcid_api.models.funding_contributor_attributes module

ORCID Member

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: Latest

Generated by: https://github.com/swagger-api/swagger-codegen.git

class orcid_api.models.funding_contributor_attributes.FundingContributorAttributes(contributor_role=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

property contributor_role

Gets the contributor_role of this FundingContributorAttributes.

Returns

The contributor_role of this FundingContributorAttributes.

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

orcid_api.models.funding_contributors module

ORCID Member

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: Latest

Generated by: https://github.com/swagger-api/swagger-codegen.git

class orcid_api.models.funding_contributors.FundingContributors(contributor=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

property contributor

Gets the contributor of this FundingContributors.

Returns

The contributor of this FundingContributors.

Return type

list[FundingContributor]

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

orcid_api.models.funding_group module

ORCID Member

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: Latest

Generated by: https://github.com/swagger-api/swagger-codegen.git

class orcid_api.models.funding_group.FundingGroup(last_modified_date=None, external_ids=None, funding_summary=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

property external_ids

Gets the external_ids of this FundingGroup.

Returns

The external_ids of this FundingGroup.

Return type

ExternalIDs

property funding_summary

Gets the funding_summary of this FundingGroup.

Returns

The funding_summary of this FundingGroup.

Return type

list[FundingSummary]

property last_modified_date

Gets the last_modified_date of this FundingGroup.

Returns

The last_modified_date of this FundingGroup.

Return type

LastModifiedDate

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

orcid_api.models.funding_summary module

ORCID Member

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: Latest

Generated by: https://github.com/swagger-api/swagger-codegen.git

class orcid_api.models.funding_summary.FundingSummary(created_date=None, last_modified_date=None, source=None, title=None, external_ids=None, type=None, start_date=None, end_date=None, organization=None, visibility=None, put_code=None, path=None, display_index=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

property created_date

Gets the created_date of this FundingSummary.

Returns

The created_date of this FundingSummary.

Return type

CreatedDate

property display_index

Gets the display_index of this FundingSummary.

Returns

The display_index of this FundingSummary.

Return type

str

property end_date

Gets the end_date of this FundingSummary.

Returns

The end_date of this FundingSummary.

Return type

FuzzyDate

property external_ids

Gets the external_ids of this FundingSummary.

Returns

The external_ids of this FundingSummary.

Return type

ExternalIDs

property last_modified_date

Gets the last_modified_date of this FundingSummary.

Returns

The last_modified_date of this FundingSummary.

Return type

LastModifiedDate

property organization

Gets the organization of this FundingSummary.

Returns

The organization of this FundingSummary.

Return type

Organization

property path

Gets the path of this FundingSummary.

Returns

The path of this FundingSummary.

Return type

str

property put_code

Gets the put_code of this FundingSummary.

Returns

The put_code of this FundingSummary.

Return type

int

property source

Gets the source of this FundingSummary.

Returns

The source of this FundingSummary.

Return type

Source

property start_date

Gets the start_date of this FundingSummary.

Returns

The start_date of this FundingSummary.

Return type

FuzzyDate

property title

Gets the title of this FundingSummary.

Returns

The title of this FundingSummary.

Return type

FundingTitle

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property type

Gets the type of this FundingSummary.

Returns

The type of this FundingSummary.

Return type

str

property visibility

Gets the visibility of this FundingSummary.

Returns

The visibility of this FundingSummary.

Return type

str

orcid_api.models.funding_title module

ORCID Member

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: Latest

Generated by: https://github.com/swagger-api/swagger-codegen.git

class orcid_api.models.funding_title.FundingTitle(title=None, translated_title=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

property title

Gets the title of this FundingTitle.

Returns

The title of this FundingTitle.

Return type

Title

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property translated_title

Gets the translated_title of this FundingTitle.

Returns

The translated_title of this FundingTitle.

Return type

TranslatedTitle

orcid_api.models.fundings module

ORCID Member

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: Latest

Generated by: https://github.com/swagger-api/swagger-codegen.git

class orcid_api.models.fundings.Fundings(last_modified_date=None, group=None, path=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

property group

Gets the group of this Fundings.

Returns

The group of this Fundings.

Return type

list[FundingGroup]

property last_modified_date

Gets the last_modified_date of this Fundings.

Returns

The last_modified_date of this Fundings.

Return type

LastModifiedDate

property path

Gets the path of this Fundings.

Returns

The path of this Fundings.

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

orcid_api.models.fuzzy_date module

ORCID Member

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: Latest

Generated by: https://github.com/swagger-api/swagger-codegen.git

class orcid_api.models.fuzzy_date.FuzzyDate(year=None, month=None, day=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

property day

Gets the day of this FuzzyDate.

Returns

The day of this FuzzyDate.

Return type

Day

property month

Gets the month of this FuzzyDate.

Returns

The month of this FuzzyDate.

Return type

Month

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property year

Gets the year of this FuzzyDate.

Returns

The year of this FuzzyDate.

Return type

Year

orcid_api.models.group_id_record module

ORCID Member

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: Latest

Generated by: https://github.com/swagger-api/swagger-codegen.git

class orcid_api.models.group_id_record.GroupIdRecord(name=None, group_id=None, description=None, type=None, put_code=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

property description

Gets the description of this GroupIdRecord.

Returns

The description of this GroupIdRecord.

Return type

str

property group_id

Gets the group_id of this GroupIdRecord.

Returns

The group_id of this GroupIdRecord.

Return type

str

property name

Gets the name of this GroupIdRecord.

Returns

The name of this GroupIdRecord.

Return type

str

property put_code

Gets the put_code of this GroupIdRecord.

Returns

The put_code of this GroupIdRecord.

Return type

int

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property type

Gets the type of this GroupIdRecord.

Returns

The type of this GroupIdRecord.

Return type

str

orcid_api.models.group_id_records module

ORCID Member

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: Latest

Generated by: https://github.com/swagger-api/swagger-codegen.git

class orcid_api.models.group_id_records.GroupIdRecords(last_modified_date=None, total=None, page=None, page_size=None, group_id_record=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

property group_id_record

Gets the group_id_record of this GroupIdRecords.

Returns

The group_id_record of this GroupIdRecords.

Return type

list[GroupIdRecord]

property last_modified_date

Gets the last_modified_date of this GroupIdRecords.

Returns

The last_modified_date of this GroupIdRecords.

Return type

LastModifiedDate

property page

Gets the page of this GroupIdRecords.

Returns

The page of this GroupIdRecords.

Return type

int

property page_size

Gets the page_size of this GroupIdRecords.

Returns

The page_size of this GroupIdRecords.

Return type

int

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property total

Gets the total of this GroupIdRecords.

Returns

The total of this GroupIdRecords.

Return type

int

orcid_api.models.item module

ORCID Member

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: Latest

Generated by: https://github.com/swagger-api/swagger-codegen.git

class orcid_api.models.item.Item(put_code=None, item_type=None, item_name=None, external_id=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

property external_id

Gets the external_id of this Item.

Returns

The external_id of this Item.

Return type

ExternalID

property item_name

Gets the item_name of this Item.

Returns

The item_name of this Item.

Return type

str

property item_type

Gets the item_type of this Item.

Returns

The item_type of this Item.

Return type

str

property put_code

Gets the put_code of this Item.

Returns

The put_code of this Item.

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

orcid_api.models.items module

ORCID Member

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: Latest

Generated by: https://github.com/swagger-api/swagger-codegen.git

class orcid_api.models.items.Items(item=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

property item

Gets the item of this Items.

Returns

The item of this Items.

Return type

list[Item]

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

orcid_api.models.keyword module

ORCID Member

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: Latest

Generated by: https://github.com/swagger-api/swagger-codegen.git

class orcid_api.models.keyword.Keyword(created_date=None, last_modified_date=None, source=None, content=None, visibility=None, path=None, put_code=None, display_index=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

property content

Gets the content of this Keyword.

Returns

The content of this Keyword.

Return type

str

property created_date

Gets the created_date of this Keyword.

Returns

The created_date of this Keyword.

Return type

CreatedDate

property display_index

Gets the display_index of this Keyword.

Returns

The display_index of this Keyword.

Return type

int

property last_modified_date

Gets the last_modified_date of this Keyword.

Returns

The last_modified_date of this Keyword.

Return type

LastModifiedDate

property path

Gets the path of this Keyword.

Returns

The path of this Keyword.

Return type

str

property put_code

Gets the put_code of this Keyword.

Returns

The put_code of this Keyword.

Return type

int

property source

Gets the source of this Keyword.

Returns

The source of this Keyword.

Return type

Source

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property visibility

Gets the visibility of this Keyword.

Returns

The visibility of this Keyword.

Return type

str

orcid_api.models.last_modified_date module

ORCID Member

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: Latest

Generated by: https://github.com/swagger-api/swagger-codegen.git

class orcid_api.models.last_modified_date.LastModifiedDate(value=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property value

Gets the value of this LastModifiedDate.

Returns

The value of this LastModifiedDate.

Return type

datetime

orcid_api.models.month module

ORCID Member

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: Latest

Generated by: https://github.com/swagger-api/swagger-codegen.git

class orcid_api.models.month.Month(value=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property value

Gets the value of this Month.

Returns

The value of this Month.

Return type

str

orcid_api.models.notification module

ORCID Member

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: Latest

Generated by: https://github.com/swagger-api/swagger-codegen.git

class orcid_api.models.notification.Notification(source=None, put_code=None, notification_type=None, created_date=None, sent_date=None, read_date=None, archived_date=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

property archived_date

Gets the archived_date of this Notification.

Returns

The archived_date of this Notification.

Return type

datetime

property created_date

Gets the created_date of this Notification.

Returns

The created_date of this Notification.

Return type

datetime

property notification_type

Gets the notification_type of this Notification.

Returns

The notification_type of this Notification.

Return type

str

property put_code

Gets the put_code of this Notification.

Returns

The put_code of this Notification.

Return type

int

property read_date

Gets the read_date of this Notification.

Returns

The read_date of this Notification.

Return type

datetime

property sent_date

Gets the sent_date of this Notification.

Returns

The sent_date of this Notification.

Return type

datetime

property source

Gets the source of this Notification.

Returns

The source of this Notification.

Return type

Source

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

orcid_api.models.notification_permission module

ORCID Member

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: Latest

Generated by: https://github.com/swagger-api/swagger-codegen.git

class orcid_api.models.notification_permission.NotificationPermission(put_code=None, notification_type=None, authorization_url=None, notification_subject=None, notification_intro=None, items=None, created_date=None, sent_date=None, read_date=None, actioned_date=None, archived_date=None, source=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

property actioned_date

Gets the actioned_date of this NotificationPermission.

Returns

The actioned_date of this NotificationPermission.

Return type

datetime

property archived_date

Gets the archived_date of this NotificationPermission.

Returns

The archived_date of this NotificationPermission.

Return type

datetime

property authorization_url

Gets the authorization_url of this NotificationPermission.

Returns

The authorization_url of this NotificationPermission.

Return type

AuthorizationUrl

property created_date

Gets the created_date of this NotificationPermission.

Returns

The created_date of this NotificationPermission.

Return type

datetime

property items

Gets the items of this NotificationPermission.

Returns

The items of this NotificationPermission.

Return type

Items

property notification_intro

Gets the notification_intro of this NotificationPermission.

Returns

The notification_intro of this NotificationPermission.

Return type

str

property notification_subject

Gets the notification_subject of this NotificationPermission.

Returns

The notification_subject of this NotificationPermission.

Return type

str

property notification_type

Gets the notification_type of this NotificationPermission.

Returns

The notification_type of this NotificationPermission.

Return type

str

property put_code

Gets the put_code of this NotificationPermission.

Returns

The put_code of this NotificationPermission.

Return type

int

property read_date

Gets the read_date of this NotificationPermission.

Returns

The read_date of this NotificationPermission.

Return type

datetime

property sent_date

Gets the sent_date of this NotificationPermission.

Returns

The sent_date of this NotificationPermission.

Return type

datetime

property source

Gets the source of this NotificationPermission.

Returns

The source of this NotificationPermission.

Return type

Source

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

orcid_api.models.organization module

ORCID Member

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: Latest

Generated by: https://github.com/swagger-api/swagger-codegen.git

class orcid_api.models.organization.Organization(name=None, address=None, disambiguated_organization=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

property address

Gets the address of this Organization.

Returns

The address of this Organization.

Return type

OrganizationAddress

property disambiguated_organization

Gets the disambiguated_organization of this Organization.

Returns

The disambiguated_organization of this Organization.

Return type

DisambiguatedOrganization

property name

Gets the name of this Organization.

Returns

The name of this Organization.

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

orcid_api.models.organization_address module

ORCID Member

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: Latest

Generated by: https://github.com/swagger-api/swagger-codegen.git

class orcid_api.models.organization_address.OrganizationAddress(city=None, region=None, country=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

property city

Gets the city of this OrganizationAddress.

Returns

The city of this OrganizationAddress.

Return type

str

property country

Gets the country of this OrganizationAddress.

Returns

The country of this OrganizationAddress.

Return type

str

property region

Gets the region of this OrganizationAddress.

Returns

The region of this OrganizationAddress.

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

orcid_api.models.organization_defined_funding_sub_type module

ORCID Member

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: Latest

Generated by: https://github.com/swagger-api/swagger-codegen.git

class orcid_api.models.organization_defined_funding_sub_type.OrganizationDefinedFundingSubType(value=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property value

Gets the value of this OrganizationDefinedFundingSubType.

Returns

The value of this OrganizationDefinedFundingSubType.

Return type

str

orcid_api.models.other_name module

ORCID Member

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: Latest

Generated by: https://github.com/swagger-api/swagger-codegen.git

class orcid_api.models.other_name.OtherName(created_date=None, last_modified_date=None, source=None, content=None, visibility=None, path=None, put_code=None, display_index=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

property content

Gets the content of this OtherName.

Returns

The content of this OtherName.

Return type

str

property created_date

Gets the created_date of this OtherName.

Returns

The created_date of this OtherName.

Return type

CreatedDate

property display_index

Gets the display_index of this OtherName.

Returns

The display_index of this OtherName.

Return type

int

property last_modified_date

Gets the last_modified_date of this OtherName.

Returns

The last_modified_date of this OtherName.

Return type

LastModifiedDate

property path

Gets the path of this OtherName.

Returns

The path of this OtherName.

Return type

str

property put_code

Gets the put_code of this OtherName.

Returns

The put_code of this OtherName.

Return type

int

property source

Gets the source of this OtherName.

Returns

The source of this OtherName.

Return type

Source

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property visibility

Gets the visibility of this OtherName.

Returns

The visibility of this OtherName.

Return type

str

orcid_api.models.peer_review module

ORCID Member

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: Latest

Generated by: https://github.com/swagger-api/swagger-codegen.git

class orcid_api.models.peer_review.PeerReview(created_date=None, last_modified_date=None, source=None, reviewer_role=None, review_identifiers=None, review_url=None, review_type=None, review_completion_date=None, review_group_id=None, subject_external_identifier=None, subject_container_name=None, subject_type=None, subject_name=None, subject_url=None, convening_organization=None, visibility=None, put_code=None, path=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

property convening_organization

Gets the convening_organization of this PeerReview.

Returns

The convening_organization of this PeerReview.

Return type

object

property created_date

Gets the created_date of this PeerReview.

Returns

The created_date of this PeerReview.

Return type

object

property last_modified_date

Gets the last_modified_date of this PeerReview.

Returns

The last_modified_date of this PeerReview.

Return type

object

property path

Gets the path of this PeerReview.

Returns

The path of this PeerReview.

Return type

str

property put_code

Gets the put_code of this PeerReview.

Returns

The put_code of this PeerReview.

Return type

int

property review_completion_date

Gets the review_completion_date of this PeerReview.

Returns

The review_completion_date of this PeerReview.

Return type

object

property review_group_id

Gets the review_group_id of this PeerReview.

Returns

The review_group_id of this PeerReview.

Return type

str

property review_identifiers

Gets the review_identifiers of this PeerReview.

Returns

The review_identifiers of this PeerReview.

Return type

object

property review_type

Gets the review_type of this PeerReview.

Returns

The review_type of this PeerReview.

Return type

object

property review_url

Gets the review_url of this PeerReview.

Returns

The review_url of this PeerReview.

Return type

object

property reviewer_role

Gets the reviewer_role of this PeerReview.

Returns

The reviewer_role of this PeerReview.

Return type

object

property source

Gets the source of this PeerReview.

Returns

The source of this PeerReview.

Return type

object

property subject_container_name

Gets the subject_container_name of this PeerReview.

Returns

The subject_container_name of this PeerReview.

Return type

object

property subject_external_identifier

Gets the subject_external_identifier of this PeerReview.

Returns

The subject_external_identifier of this PeerReview.

Return type

object

property subject_name

Gets the subject_name of this PeerReview.

Returns

The subject_name of this PeerReview.

Return type

object

property subject_type

Gets the subject_type of this PeerReview.

Returns

The subject_type of this PeerReview.

Return type

object

property subject_url

Gets the subject_url of this PeerReview.

Returns

The subject_url of this PeerReview.

Return type

object

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property visibility

Gets the visibility of this PeerReview.

Returns

The visibility of this PeerReview.

Return type

str

orcid_api.models.peer_review_group module

ORCID Member

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: Latest

Generated by: https://github.com/swagger-api/swagger-codegen.git

class orcid_api.models.peer_review_group.PeerReviewGroup(last_modified_date=None, external_ids=None, peer_review_summary=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

property external_ids

Gets the external_ids of this PeerReviewGroup.

Returns

The external_ids of this PeerReviewGroup.

Return type

ExternalIDs

property last_modified_date

Gets the last_modified_date of this PeerReviewGroup.

Returns

The last_modified_date of this PeerReviewGroup.

Return type

LastModifiedDate

property peer_review_summary

Gets the peer_review_summary of this PeerReviewGroup.

Returns

The peer_review_summary of this PeerReviewGroup.

Return type

list[PeerReviewSummary]

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

orcid_api.models.peer_review_summary module

ORCID Member

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: Latest

Generated by: https://github.com/swagger-api/swagger-codegen.git

class orcid_api.models.peer_review_summary.PeerReviewSummary(created_date=None, last_modified_date=None, source=None, reviewer_role=None, external_ids=None, review_url=None, review_type=None, completion_date=None, review_group_id=None, convening_organization=None, visibility=None, put_code=None, path=None, display_index=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

property completion_date

Gets the completion_date of this PeerReviewSummary.

Returns

The completion_date of this PeerReviewSummary.

Return type

object

property convening_organization

Gets the convening_organization of this PeerReviewSummary.

Returns

The convening_organization of this PeerReviewSummary.

Return type

object

property created_date

Gets the created_date of this PeerReviewSummary.

Returns

The created_date of this PeerReviewSummary.

Return type

object

property display_index

Gets the display_index of this PeerReviewSummary.

Returns

The display_index of this PeerReviewSummary.

Return type

str

property external_ids

Gets the external_ids of this PeerReviewSummary.

Returns

The external_ids of this PeerReviewSummary.

Return type

object

property last_modified_date

Gets the last_modified_date of this PeerReviewSummary.

Returns

The last_modified_date of this PeerReviewSummary.

Return type

object

property path

Gets the path of this PeerReviewSummary.

Returns

The path of this PeerReviewSummary.

Return type

str

property put_code

Gets the put_code of this PeerReviewSummary.

Returns

The put_code of this PeerReviewSummary.

Return type

int

property review_group_id

Gets the review_group_id of this PeerReviewSummary.

Returns

The review_group_id of this PeerReviewSummary.

Return type

str

property review_type

Gets the review_type of this PeerReviewSummary.

Returns

The review_type of this PeerReviewSummary.

Return type

object

property review_url

Gets the review_url of this PeerReviewSummary.

Returns

The review_url of this PeerReviewSummary.

Return type

object

property reviewer_role

Gets the reviewer_role of this PeerReviewSummary.

Returns

The reviewer_role of this PeerReviewSummary.

Return type

object

property source

Gets the source of this PeerReviewSummary.

Returns

The source of this PeerReviewSummary.

Return type

object

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property visibility

Gets the visibility of this PeerReviewSummary.

Returns

The visibility of this PeerReviewSummary.

Return type

str

orcid_api.models.peer_reviews module

ORCID Member

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: Latest

Generated by: https://github.com/swagger-api/swagger-codegen.git

class orcid_api.models.peer_reviews.PeerReviews(last_modified_date=None, group=None, path=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

property group

Gets the group of this PeerReviews.

Returns

The group of this PeerReviews.

Return type

list[object]

property last_modified_date

Gets the last_modified_date of this PeerReviews.

Returns

The last_modified_date of this PeerReviews.

Return type

object

property path

Gets the path of this PeerReviews.

Returns

The path of this PeerReviews.

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

orcid_api.models.person_external_identifier module

ORCID Member

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: Latest

Generated by: https://github.com/swagger-api/swagger-codegen.git

class orcid_api.models.person_external_identifier.PersonExternalIdentifier(created_date=None, last_modified_date=None, source=None, external_id_type=None, external_id_value=None, external_id_url=None, external_id_relationship=None, visibility=None, path=None, put_code=None, display_index=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

property created_date

Gets the created_date of this PersonExternalIdentifier.

Returns

The created_date of this PersonExternalIdentifier.

Return type

CreatedDate

property display_index

Gets the display_index of this PersonExternalIdentifier.

Returns

The display_index of this PersonExternalIdentifier.

Return type

int

property external_id_relationship

Gets the external_id_relationship of this PersonExternalIdentifier.

Returns

The external_id_relationship of this PersonExternalIdentifier.

Return type

str

property external_id_type

Gets the external_id_type of this PersonExternalIdentifier.

Returns

The external_id_type of this PersonExternalIdentifier.

Return type

str

property external_id_url

Gets the external_id_url of this PersonExternalIdentifier.

Returns

The external_id_url of this PersonExternalIdentifier.

Return type

Url

property external_id_value

Gets the external_id_value of this PersonExternalIdentifier.

Returns

The external_id_value of this PersonExternalIdentifier.

Return type

str

property last_modified_date

Gets the last_modified_date of this PersonExternalIdentifier.

Returns

The last_modified_date of this PersonExternalIdentifier.

Return type

LastModifiedDate

property path

Gets the path of this PersonExternalIdentifier.

Returns

The path of this PersonExternalIdentifier.

Return type

str

property put_code

Gets the put_code of this PersonExternalIdentifier.

Returns

The put_code of this PersonExternalIdentifier.

Return type

int

property source

Gets the source of this PersonExternalIdentifier.

Returns

The source of this PersonExternalIdentifier.

Return type

Source

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property visibility

Gets the visibility of this PersonExternalIdentifier.

Returns

The visibility of this PersonExternalIdentifier.

Return type

str

orcid_api.models.publication_date module

ORCID Member

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: Latest

Generated by: https://github.com/swagger-api/swagger-codegen.git

class orcid_api.models.publication_date.PublicationDate(year=None, month=None, day=None, media_type=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

property day

Gets the day of this PublicationDate.

Returns

The day of this PublicationDate.

Return type

Day

property media_type

Gets the media_type of this PublicationDate.

Returns

The media_type of this PublicationDate.

Return type

str

property month

Gets the month of this PublicationDate.

Returns

The month of this PublicationDate.

Return type

Month

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property year

Gets the year of this PublicationDate.

Returns

The year of this PublicationDate.

Return type

Year

orcid_api.models.researcher_url module

ORCID Member

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: Latest

Generated by: https://github.com/swagger-api/swagger-codegen.git

class orcid_api.models.researcher_url.ResearcherUrl(created_date=None, last_modified_date=None, source=None, url_name=None, url=None, visibility=None, path=None, put_code=None, display_index=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

property created_date

Gets the created_date of this ResearcherUrl.

Returns

The created_date of this ResearcherUrl.

Return type

CreatedDate

property display_index

Gets the display_index of this ResearcherUrl.

Returns

The display_index of this ResearcherUrl.

Return type

int

property last_modified_date

Gets the last_modified_date of this ResearcherUrl.

Returns

The last_modified_date of this ResearcherUrl.

Return type

LastModifiedDate

property path

Gets the path of this ResearcherUrl.

Returns

The path of this ResearcherUrl.

Return type

str

property put_code

Gets the put_code of this ResearcherUrl.

Returns

The put_code of this ResearcherUrl.

Return type

int

property source

Gets the source of this ResearcherUrl.

Returns

The source of this ResearcherUrl.

Return type

Source

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property url

Gets the url of this ResearcherUrl.

Returns

The url of this ResearcherUrl.

Return type

Url

property url_name

Gets the url_name of this ResearcherUrl.

Returns

The url_name of this ResearcherUrl.

Return type

str

property visibility

Gets the visibility of this ResearcherUrl.

Returns

The visibility of this ResearcherUrl.

Return type

str

orcid_api.models.source module

ORCID Member

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: Latest

Generated by: https://github.com/swagger-api/swagger-codegen.git

class orcid_api.models.source.Source(source_orcid=None, source_client_id=None, source_name=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

property source_client_id

Gets the source_client_id of this Source.

Returns

The source_client_id of this Source.

Return type

SourceClientId

property source_name

Gets the source_name of this Source.

Returns

The source_name of this Source.

Return type

SourceName

property source_orcid

Gets the source_orcid of this Source.

Returns

The source_orcid of this Source.

Return type

SourceOrcid

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

orcid_api.models.source_client_id module

ORCID Member

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: Latest

Generated by: https://github.com/swagger-api/swagger-codegen.git

class orcid_api.models.source_client_id.SourceClientId(uri=None, path=None, host=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

property host

Gets the host of this SourceClientId.

Returns

The host of this SourceClientId.

Return type

str

property path

Gets the path of this SourceClientId.

Returns

The path of this SourceClientId.

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property uri

Gets the uri of this SourceClientId.

Returns

The uri of this SourceClientId.

Return type

str

orcid_api.models.source_name module

ORCID Member

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: Latest

Generated by: https://github.com/swagger-api/swagger-codegen.git

class orcid_api.models.source_name.SourceName(value=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property value

Gets the value of this SourceName.

Returns

The value of this SourceName.

Return type

str

orcid_api.models.source_orcid module

ORCID Member

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: Latest

Generated by: https://github.com/swagger-api/swagger-codegen.git

class orcid_api.models.source_orcid.SourceOrcid(uri=None, path=None, host=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

property host

Gets the host of this SourceOrcid.

Returns

The host of this SourceOrcid.

Return type

str

property path

Gets the path of this SourceOrcid.

Returns

The path of this SourceOrcid.

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property uri

Gets the uri of this SourceOrcid.

Returns

The uri of this SourceOrcid.

Return type

str

orcid_api.models.subtitle module

ORCID Member

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: Latest

Generated by: https://github.com/swagger-api/swagger-codegen.git

class orcid_api.models.subtitle.Subtitle(value=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property value

Gets the value of this Subtitle.

Returns

The value of this Subtitle.

Return type

str

orcid_api.models.title module

ORCID Member

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: Latest

Generated by: https://github.com/swagger-api/swagger-codegen.git

class orcid_api.models.title.Title(value=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property value

Gets the value of this Title.

Returns

The value of this Title.

Return type

str

orcid_api.models.transient_non_empty_string module

ORCID Member

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: Latest

Generated by: https://github.com/swagger-api/swagger-codegen.git

class orcid_api.models.transient_non_empty_string.TransientNonEmptyString(value=None, transient=False)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property transient

Gets the transient of this TransientNonEmptyString.

Returns

The transient of this TransientNonEmptyString.

Return type

bool

property value

Gets the value of this TransientNonEmptyString.

Returns

The value of this TransientNonEmptyString.

Return type

str

orcid_api.models.translated_title module

ORCID Member

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: Latest

Generated by: https://github.com/swagger-api/swagger-codegen.git

class orcid_api.models.translated_title.TranslatedTitle(value=None, language_code=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

property language_code

Gets the language_code of this TranslatedTitle.

Returns

The language_code of this TranslatedTitle.

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property value

Gets the value of this TranslatedTitle.

Returns

The value of this TranslatedTitle.

Return type

str

orcid_api.models.url module

ORCID Member

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: Latest

Generated by: https://github.com/swagger-api/swagger-codegen.git

class orcid_api.models.url.Url(value=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property value

Gets the value of this Url.

Returns

The value of this Url.

Return type

str

orcid_api.models.work module

ORCID Member

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: Latest

Generated by: https://github.com/swagger-api/swagger-codegen.git

class orcid_api.models.work.Work(created_date=None, last_modified_date=None, source=None, put_code=None, path=None, title=None, journal_title=None, short_description=None, citation=None, type=None, publication_date=None, external_ids=None, url=None, contributors=None, language_code=None, country=None, visibility=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

property citation

Gets the citation of this Work.

Returns

The citation of this Work.

Return type

Citation

property contributors

Gets the contributors of this Work.

Returns

The contributors of this Work.

Return type

object

property country

Gets the country of this Work.

Returns

The country of this Work.

Return type

object

property created_date

Gets the created_date of this Work.

Returns

The created_date of this Work.

Return type

object

property external_ids

Gets the external_ids of this Work.

Returns

The external_ids of this Work.

Return type

object

property journal_title

Gets the journal_title of this Work.

Returns

The journal_title of this Work.

Return type

object

property language_code

Gets the language_code of this Work.

Returns

The language_code of this Work.

Return type

str

property last_modified_date

Gets the last_modified_date of this Work.

Returns

The last_modified_date of this Work.

Return type

object

property path

Gets the path of this Work.

Returns

The path of this Work.

Return type

str

property publication_date

Gets the publication_date of this Work.

Returns

The publication_date of this Work.

Return type

object

property put_code

Gets the put_code of this Work.

Returns

The put_code of this Work.

Return type

int

property short_description

Gets the short_description of this Work.

Returns

The short_description of this Work.

Return type

str

property source

Gets the source of this Work.

Returns

The source of this Work.

Return type

object

property title

Gets the title of this Work.

Returns

The title of this Work.

Return type

object

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property type

Gets the type of this Work.

Returns

The type of this Work.

Return type

object

property url

Gets the url of this Work.

Returns

The url of this Work.

Return type

object

property visibility

Gets the visibility of this Work.

Returns

The visibility of this Work.

Return type

str

orcid_api.models.work_bulk module

ORCID Member

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: Latest

Generated by: https://github.com/swagger-api/swagger-codegen.git

class orcid_api.models.work_bulk.WorkBulk(bulk=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

property bulk

Gets the bulk of this WorkBulk.

Returns

The bulk of this WorkBulk.

Return type

list[BulkElement]

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

orcid_api.models.work_contributors module

ORCID Member

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: Latest

Generated by: https://github.com/swagger-api/swagger-codegen.git

class orcid_api.models.work_contributors.WorkContributors(contributor=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

property contributor

Gets the contributor of this WorkContributors.

Returns

The contributor of this WorkContributors.

Return type

list[Contributor]

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

orcid_api.models.work_group module

ORCID Member

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: Latest

Generated by: https://github.com/swagger-api/swagger-codegen.git

class orcid_api.models.work_group.WorkGroup(last_modified_date=None, external_ids=None, work_summary=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

property external_ids

Gets the external_ids of this WorkGroup.

Returns

The external_ids of this WorkGroup.

Return type

ExternalIDs

property last_modified_date

Gets the last_modified_date of this WorkGroup.

Returns

The last_modified_date of this WorkGroup.

Return type

LastModifiedDate

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property work_summary

Gets the work_summary of this WorkGroup.

Returns

The work_summary of this WorkGroup.

Return type

list[WorkSummary]

orcid_api.models.work_summary module

ORCID Member

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: Latest

Generated by: https://github.com/swagger-api/swagger-codegen.git

class orcid_api.models.work_summary.WorkSummary(put_code=None, created_date=None, last_modified_date=None, source=None, title=None, external_ids=None, type=None, publication_date=None, journal_title=None, visibility=None, path=None, display_index=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

property created_date

Gets the created_date of this WorkSummary.

Returns

The created_date of this WorkSummary.

Return type

object

property display_index

Gets the display_index of this WorkSummary.

Returns

The display_index of this WorkSummary.

Return type

str

property external_ids

Gets the external_ids of this WorkSummary.

Returns

The external_ids of this WorkSummary.

Return type

object

property journal_title

Gets the journal_title of this WorkSummary.

Returns

The journal_title of this WorkSummary.

Return type

object

property last_modified_date

Gets the last_modified_date of this WorkSummary.

Returns

The last_modified_date of this WorkSummary.

Return type

object

property path

Gets the path of this WorkSummary.

Returns

The path of this WorkSummary.

Return type

str

property publication_date

Gets the publication_date of this WorkSummary.

Returns

The publication_date of this WorkSummary.

Return type

object

property put_code

Gets the put_code of this WorkSummary.

Returns

The put_code of this WorkSummary.

Return type

int

property source

Gets the source of this WorkSummary.

Returns

The source of this WorkSummary.

Return type

object

property title

Gets the title of this WorkSummary.

Returns

The title of this WorkSummary.

Return type

object

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property type

Gets the type of this WorkSummary.

Returns

The type of this WorkSummary.

Return type

object

property visibility

Gets the visibility of this WorkSummary.

Returns

The visibility of this WorkSummary.

Return type

str

orcid_api.models.work_title module

ORCID Member

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: Latest

Generated by: https://github.com/swagger-api/swagger-codegen.git

class orcid_api.models.work_title.WorkTitle(title=None, subtitle=None, translated_title=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

property subtitle

Gets the subtitle of this WorkTitle.

Returns

The subtitle of this WorkTitle.

Return type

Subtitle

property title

Gets the title of this WorkTitle.

Returns

The title of this WorkTitle.

Return type

Title

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property translated_title

Gets the translated_title of this WorkTitle.

Returns

The translated_title of this WorkTitle.

Return type

TranslatedTitle

orcid_api.models.works module

ORCID Member

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: Latest

Generated by: https://github.com/swagger-api/swagger-codegen.git

class orcid_api.models.works.Works(last_modified_date=None, group=None, path=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

property group

Gets the group of this Works.

Returns

The group of this Works.

Return type

list[object]

property last_modified_date

Gets the last_modified_date of this Works.

Returns

The last_modified_date of this Works.

Return type

object

property path

Gets the path of this Works.

Returns

The path of this Works.

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

orcid_api.models.year module

ORCID Member

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: Latest

Generated by: https://github.com/swagger-api/swagger-codegen.git

class orcid_api.models.year.Year(value=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually.

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property value

Gets the value of this Year.

Returns

The value of this Year.

Return type

str

Module contents

ORCID Member

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: Latest

Generated by: https://github.com/swagger-api/swagger-codegen.git