diff options
Diffstat (limited to 'python_openapi_client/fatcat_openapi_client/models/release_entity.py')
| -rw-r--r-- | python_openapi_client/fatcat_openapi_client/models/release_entity.py | 76 |
1 files changed, 56 insertions, 20 deletions
diff --git a/python_openapi_client/fatcat_openapi_client/models/release_entity.py b/python_openapi_client/fatcat_openapi_client/models/release_entity.py index 119f5b1d..792cc0f2 100644 --- a/python_openapi_client/fatcat_openapi_client/models/release_entity.py +++ b/python_openapi_client/fatcat_openapi_client/models/release_entity.py @@ -3,10 +3,10 @@ """ fatcat - A scalable, versioned, API-oriented catalog of bibliographic entities and file metadata # noqa: E501 + Fatcat is a scalable, versioned, API-oriented catalog of bibliographic entities and file metadata. # noqa: E501 OpenAPI spec version: 0.3.0 - + Contact: webservices@archive.org Generated by: https://github.com/swagger-api/swagger-codegen.git """ @@ -287,7 +287,7 @@ class ReleaseEntity(object): def license_slug(self): """Gets the license_slug of this ReleaseEntity. # noqa: E501 - Short version of license name. Eg, 'CC-BY' # noqa: E501 + Short string (slug) name of license under which release is openly published (if applicable). # noqa: E501 :return: The license_slug of this ReleaseEntity. # noqa: E501 :rtype: str @@ -298,7 +298,7 @@ class ReleaseEntity(object): def license_slug(self, license_slug): """Sets the license_slug of this ReleaseEntity. - Short version of license name. Eg, 'CC-BY' # noqa: E501 + Short string (slug) name of license under which release is openly published (if applicable). # noqa: E501 :param license_slug: The license_slug of this ReleaseEntity. # noqa: E501 :type: str @@ -310,7 +310,7 @@ class ReleaseEntity(object): def language(self): """Gets the language of this ReleaseEntity. # noqa: E501 - Two-letter RFC1766/ISO639-1 language code, with extensions # noqa: E501 + Primary language of the content of the full release. Two-letter RFC1766/ISO639-1 language code, with some custom extensions/additions. See guide. # noqa: E501 :return: The language of this ReleaseEntity. # noqa: E501 :rtype: str @@ -321,7 +321,7 @@ class ReleaseEntity(object): def language(self, language): """Sets the language of this ReleaseEntity. - Two-letter RFC1766/ISO639-1 language code, with extensions # noqa: E501 + Primary language of the content of the full release. Two-letter RFC1766/ISO639-1 language code, with some custom extensions/additions. See guide. # noqa: E501 :param language: The language of this ReleaseEntity. # noqa: E501 :type: str @@ -333,6 +333,7 @@ class ReleaseEntity(object): def publisher(self): """Gets the publisher of this ReleaseEntity. # noqa: E501 + Name, usually English, of the entity or institution responsible for publication of this release. Not necessarily the imprint/brand. See guide. # noqa: E501 :return: The publisher of this ReleaseEntity. # noqa: E501 :rtype: str @@ -343,6 +344,7 @@ class ReleaseEntity(object): def publisher(self, publisher): """Sets the publisher of this ReleaseEntity. + Name, usually English, of the entity or institution responsible for publication of this release. Not necessarily the imprint/brand. See guide. # noqa: E501 :param publisher: The publisher of this ReleaseEntity. # noqa: E501 :type: str @@ -354,6 +356,7 @@ class ReleaseEntity(object): def version(self): """Gets the version of this ReleaseEntity. # noqa: E501 + For, eg, updated technical reports or software packages, where the version string may be the only field disambiguating between releases. # noqa: E501 :return: The version of this ReleaseEntity. # noqa: E501 :rtype: str @@ -364,6 +367,7 @@ class ReleaseEntity(object): def version(self, version): """Sets the version of this ReleaseEntity. + For, eg, updated technical reports or software packages, where the version string may be the only field disambiguating between releases. # noqa: E501 :param version: The version of this ReleaseEntity. # noqa: E501 :type: str @@ -375,6 +379,7 @@ class ReleaseEntity(object): def number(self): """Gets the number of this ReleaseEntity. # noqa: E501 + For, eg, technical reports, which are published in series or assigned some other institutional or container-specific identifier. # noqa: E501 :return: The number of this ReleaseEntity. # noqa: E501 :rtype: str @@ -385,6 +390,7 @@ class ReleaseEntity(object): def number(self, number): """Sets the number of this ReleaseEntity. + For, eg, technical reports, which are published in series or assigned some other institutional or container-specific identifier. # noqa: E501 :param number: The number of this ReleaseEntity. # noqa: E501 :type: str @@ -396,6 +402,7 @@ class ReleaseEntity(object): def pages(self): """Gets the pages of this ReleaseEntity. # noqa: E501 + Either a single page number (\"first page\") or a range of pages separated by a dash (\"-\"). See guide for details. # noqa: E501 :return: The pages of this ReleaseEntity. # noqa: E501 :rtype: str @@ -406,6 +413,7 @@ class ReleaseEntity(object): def pages(self, pages): """Sets the pages of this ReleaseEntity. + Either a single page number (\"first page\") or a range of pages separated by a dash (\"-\"). See guide for details. # noqa: E501 :param pages: The pages of this ReleaseEntity. # noqa: E501 :type: str @@ -417,6 +425,7 @@ class ReleaseEntity(object): def issue(self): """Gets the issue of this ReleaseEntity. # noqa: E501 + Issue number of volume/container that this release was published in. Sometimes coresponds to a month number in the year, but can be any string. See guide. # noqa: E501 :return: The issue of this ReleaseEntity. # noqa: E501 :rtype: str @@ -427,6 +436,7 @@ class ReleaseEntity(object): def issue(self, issue): """Sets the issue of this ReleaseEntity. + Issue number of volume/container that this release was published in. Sometimes coresponds to a month number in the year, but can be any string. See guide. # noqa: E501 :param issue: The issue of this ReleaseEntity. # noqa: E501 :type: str @@ -438,6 +448,7 @@ class ReleaseEntity(object): def volume(self): """Gets the volume of this ReleaseEntity. # noqa: E501 + Volume number of container that this release was published in. Often corresponds to the \"Nth\" year of publication, but can be any string. See guide. # noqa: E501 :return: The volume of this ReleaseEntity. # noqa: E501 :rtype: str @@ -448,6 +459,7 @@ class ReleaseEntity(object): def volume(self, volume): """Sets the volume of this ReleaseEntity. + Volume number of container that this release was published in. Often corresponds to the \"Nth\" year of publication, but can be any string. See guide. # noqa: E501 :param volume: The volume of this ReleaseEntity. # noqa: E501 :type: str @@ -459,6 +471,7 @@ class ReleaseEntity(object): def ext_ids(self): """Gets the ext_ids of this ReleaseEntity. # noqa: E501 + Set of external identifiers for this release. # noqa: E501 :return: The ext_ids of this ReleaseEntity. # noqa: E501 :rtype: ReleaseExtIds @@ -469,6 +482,7 @@ class ReleaseEntity(object): def ext_ids(self, ext_ids): """Sets the ext_ids of this ReleaseEntity. + Set of external identifiers for this release. # noqa: E501 :param ext_ids: The ext_ids of this ReleaseEntity. # noqa: E501 :type: ReleaseExtIds @@ -482,6 +496,7 @@ class ReleaseEntity(object): def withdrawn_year(self): """Gets the withdrawn_year of this ReleaseEntity. # noqa: E501 + Year corresponding with `withdrawn_date` like `release_year`/`release_date`. # noqa: E501 :return: The withdrawn_year of this ReleaseEntity. # noqa: E501 :rtype: int @@ -492,6 +507,7 @@ class ReleaseEntity(object): def withdrawn_year(self, withdrawn_year): """Sets the withdrawn_year of this ReleaseEntity. + Year corresponding with `withdrawn_date` like `release_year`/`release_date`. # noqa: E501 :param withdrawn_year: The withdrawn_year of this ReleaseEntity. # noqa: E501 :type: int @@ -503,6 +519,7 @@ class ReleaseEntity(object): def withdrawn_date(self): """Gets the withdrawn_date of this ReleaseEntity. # noqa: E501 + Full date when this release was formally withdrawn (if applicable). ISO format, like `release_date`. # noqa: E501 :return: The withdrawn_date of this ReleaseEntity. # noqa: E501 :rtype: date @@ -513,6 +530,7 @@ class ReleaseEntity(object): def withdrawn_date(self, withdrawn_date): """Sets the withdrawn_date of this ReleaseEntity. + Full date when this release was formally withdrawn (if applicable). ISO format, like `release_date`. # noqa: E501 :param withdrawn_date: The withdrawn_date of this ReleaseEntity. # noqa: E501 :type: date @@ -524,6 +542,7 @@ class ReleaseEntity(object): def withdrawn_status(self): """Gets the withdrawn_status of this ReleaseEntity. # noqa: E501 + Type of withdrawl or retraction of this release, if applicable. If release has not been withdrawn, should be `null` (aka, not set, not the string \"null\" or an empty string). # noqa: E501 :return: The withdrawn_status of this ReleaseEntity. # noqa: E501 :rtype: str @@ -534,6 +553,7 @@ class ReleaseEntity(object): def withdrawn_status(self, withdrawn_status): """Sets the withdrawn_status of this ReleaseEntity. + Type of withdrawl or retraction of this release, if applicable. If release has not been withdrawn, should be `null` (aka, not set, not the string \"null\" or an empty string). # noqa: E501 :param withdrawn_status: The withdrawn_status of this ReleaseEntity. # noqa: E501 :type: str @@ -545,6 +565,7 @@ class ReleaseEntity(object): def release_year(self): """Gets the release_year of this ReleaseEntity. # noqa: E501 + Year when this release was formally published. Must match `release_date` if that field is set; this field exists because sometimes only the year is known. # noqa: E501 :return: The release_year of this ReleaseEntity. # noqa: E501 :rtype: int @@ -555,6 +576,7 @@ class ReleaseEntity(object): def release_year(self, release_year): """Sets the release_year of this ReleaseEntity. + Year when this release was formally published. Must match `release_date` if that field is set; this field exists because sometimes only the year is known. # noqa: E501 :param release_year: The release_year of this ReleaseEntity. # noqa: E501 :type: int @@ -566,6 +588,7 @@ class ReleaseEntity(object): def release_date(self): """Gets the release_date of this ReleaseEntity. # noqa: E501 + Full date when this release was formally published. ISO format, like `2019-03-05`. See guide for semantics. # noqa: E501 :return: The release_date of this ReleaseEntity. # noqa: E501 :rtype: date @@ -576,6 +599,7 @@ class ReleaseEntity(object): def release_date(self, release_date): """Sets the release_date of this ReleaseEntity. + Full date when this release was formally published. ISO format, like `2019-03-05`. See guide for semantics. # noqa: E501 :param release_date: The release_date of this ReleaseEntity. # noqa: E501 :type: date @@ -587,6 +611,7 @@ class ReleaseEntity(object): def release_stage(self): """Gets the release_stage of this ReleaseEntity. # noqa: E501 + The stage of publication of this specific release. See guide for valid values and semantics. # noqa: E501 :return: The release_stage of this ReleaseEntity. # noqa: E501 :rtype: str @@ -597,6 +622,7 @@ class ReleaseEntity(object): def release_stage(self, release_stage): """Sets the release_stage of this ReleaseEntity. + The stage of publication of this specific release. See guide for valid values and semantics. # noqa: E501 :param release_stage: The release_stage of this ReleaseEntity. # noqa: E501 :type: str @@ -608,6 +634,7 @@ class ReleaseEntity(object): def release_type(self): """Gets the release_type of this ReleaseEntity. # noqa: E501 + \"Type\" or \"medium\" that this release is published as. See guide for valid values. # noqa: E501 :return: The release_type of this ReleaseEntity. # noqa: E501 :rtype: str @@ -618,6 +645,7 @@ class ReleaseEntity(object): def release_type(self, release_type): """Sets the release_type of this ReleaseEntity. + \"Type\" or \"medium\" that this release is published as. See guide for valid values. # noqa: E501 :param release_type: The release_type of this ReleaseEntity. # noqa: E501 :type: str @@ -629,6 +657,7 @@ class ReleaseEntity(object): def container_id(self): """Gets the container_id of this ReleaseEntity. # noqa: E501 + Used to link this release to a container entity that the release was published as part of. # noqa: E501 :return: The container_id of this ReleaseEntity. # noqa: E501 :rtype: str @@ -639,6 +668,7 @@ class ReleaseEntity(object): def container_id(self, container_id): """Sets the container_id of this ReleaseEntity. + Used to link this release to a container entity that the release was published as part of. # noqa: E501 :param container_id: The container_id of this ReleaseEntity. # noqa: E501 :type: str @@ -650,7 +680,7 @@ class ReleaseEntity(object): def webcaptures(self): """Gets the webcaptures of this ReleaseEntity. # noqa: E501 - Optional; GET-only # noqa: E501 + Complete webcapture entities identified by `webcapture_ids` field. Only included in GET responses when `webcaptures` included in `expand` parameter; ignored in PUT or POST requests. # noqa: E501 :return: The webcaptures of this ReleaseEntity. # noqa: E501 :rtype: list[WebcaptureEntity] @@ -661,7 +691,7 @@ class ReleaseEntity(object): def webcaptures(self, webcaptures): """Sets the webcaptures of this ReleaseEntity. - Optional; GET-only # noqa: E501 + Complete webcapture entities identified by `webcapture_ids` field. Only included in GET responses when `webcaptures` included in `expand` parameter; ignored in PUT or POST requests. # noqa: E501 :param webcaptures: The webcaptures of this ReleaseEntity. # noqa: E501 :type: list[WebcaptureEntity] @@ -673,7 +703,7 @@ class ReleaseEntity(object): def filesets(self): """Gets the filesets of this ReleaseEntity. # noqa: E501 - Optional; GET-only # noqa: E501 + Complete file entities identified by `filesets_ids` field. Only included in GET responses when `filesets` included in `expand` parameter; ignored in PUT or POST requests. # noqa: E501 :return: The filesets of this ReleaseEntity. # noqa: E501 :rtype: list[FilesetEntity] @@ -684,7 +714,7 @@ class ReleaseEntity(object): def filesets(self, filesets): """Sets the filesets of this ReleaseEntity. - Optional; GET-only # noqa: E501 + Complete file entities identified by `filesets_ids` field. Only included in GET responses when `filesets` included in `expand` parameter; ignored in PUT or POST requests. # noqa: E501 :param filesets: The filesets of this ReleaseEntity. # noqa: E501 :type: list[FilesetEntity] @@ -696,7 +726,7 @@ class ReleaseEntity(object): def files(self): """Gets the files of this ReleaseEntity. # noqa: E501 - Optional; GET-only # noqa: E501 + Complete file entities identified by `file_ids` field. Only included in GET responses when `files` included in `expand` parameter; ignored in PUT or POST requests. # noqa: E501 :return: The files of this ReleaseEntity. # noqa: E501 :rtype: list[FileEntity] @@ -707,7 +737,7 @@ class ReleaseEntity(object): def files(self, files): """Sets the files of this ReleaseEntity. - Optional; GET-only # noqa: E501 + Complete file entities identified by `file_ids` field. Only included in GET responses when `files` included in `expand` parameter; ignored in PUT or POST requests. # noqa: E501 :param files: The files of this ReleaseEntity. # noqa: E501 :type: list[FileEntity] @@ -719,7 +749,7 @@ class ReleaseEntity(object): def container(self): """Gets the container of this ReleaseEntity. # noqa: E501 - Optional; GET-only # noqa: E501 + Complete container entity identified by `container_id` field. Only included in GET reponses when `container` included in `expand` parameter; ignored in PUT or POST requests. # noqa: E501 :return: The container of this ReleaseEntity. # noqa: E501 :rtype: ContainerEntity @@ -730,7 +760,7 @@ class ReleaseEntity(object): def container(self, container): """Sets the container of this ReleaseEntity. - Optional; GET-only # noqa: E501 + Complete container entity identified by `container_id` field. Only included in GET reponses when `container` included in `expand` parameter; ignored in PUT or POST requests. # noqa: E501 :param container: The container of this ReleaseEntity. # noqa: E501 :type: ContainerEntity @@ -742,6 +772,7 @@ class ReleaseEntity(object): def work_id(self): """Gets the work_id of this ReleaseEntity. # noqa: E501 + Identifier of work this release is part of. In creation (POST) requests, a work entity will be created automatically if this field is not set. # noqa: E501 :return: The work_id of this ReleaseEntity. # noqa: E501 :rtype: str @@ -752,6 +783,7 @@ class ReleaseEntity(object): def work_id(self, work_id): """Sets the work_id of this ReleaseEntity. + Identifier of work this release is part of. In creation (POST) requests, a work entity will be created automatically if this field is not set. # noqa: E501 :param work_id: The work_id of this ReleaseEntity. # noqa: E501 :type: str @@ -763,7 +795,7 @@ class ReleaseEntity(object): def original_title(self): """Gets the original_title of this ReleaseEntity. # noqa: E501 - Title in original language (or, the language of the full text of this release) # noqa: E501 + Title in original language if `title` field has been translated. See guide for details. # noqa: E501 :return: The original_title of this ReleaseEntity. # noqa: E501 :rtype: str @@ -774,7 +806,7 @@ class ReleaseEntity(object): def original_title(self, original_title): """Sets the original_title of this ReleaseEntity. - Title in original language (or, the language of the full text of this release) # noqa: E501 + Title in original language if `title` field has been translated. See guide for details. # noqa: E501 :param original_title: The original_title of this ReleaseEntity. # noqa: E501 :type: str @@ -786,7 +818,7 @@ class ReleaseEntity(object): def subtitle(self): """Gets the subtitle of this ReleaseEntity. # noqa: E501 - Avoid this field if possible, and merge with title; usually English # noqa: E501 + Subtitle of release. In many cases, better to merge with title than include as separate field (unless combined title would be very long). See guide for details. # noqa: E501 :return: The subtitle of this ReleaseEntity. # noqa: E501 :rtype: str @@ -797,7 +829,7 @@ class ReleaseEntity(object): def subtitle(self, subtitle): """Sets the subtitle of this ReleaseEntity. - Avoid this field if possible, and merge with title; usually English # noqa: E501 + Subtitle of release. In many cases, better to merge with title than include as separate field (unless combined title would be very long). See guide for details. # noqa: E501 :param subtitle: The subtitle of this ReleaseEntity. # noqa: E501 :type: str @@ -809,7 +841,7 @@ class ReleaseEntity(object): def title(self): """Gets the title of this ReleaseEntity. # noqa: E501 - Required for valid entities. The title used in citations and for display; usually English # noqa: E501 + Required for valid entities. The title used in citations and for display. Sometimes the English translation of title e even if release content is not English. # noqa: E501 :return: The title of this ReleaseEntity. # noqa: E501 :rtype: str @@ -820,7 +852,7 @@ class ReleaseEntity(object): def title(self, title): """Sets the title of this ReleaseEntity. - Required for valid entities. The title used in citations and for display; usually English # noqa: E501 + Required for valid entities. The title used in citations and for display. Sometimes the English translation of title e even if release content is not English. # noqa: E501 :param title: The title of this ReleaseEntity. # noqa: E501 :type: str @@ -946,6 +978,7 @@ class ReleaseEntity(object): def extra(self): """Gets the extra of this ReleaseEntity. # noqa: E501 + Free-form JSON metadata that will be stored with the other entity metadata. See guide for (unenforced) schema conventions. # noqa: E501 :return: The extra of this ReleaseEntity. # noqa: E501 :rtype: object @@ -956,6 +989,7 @@ class ReleaseEntity(object): def extra(self, extra): """Sets the extra of this ReleaseEntity. + Free-form JSON metadata that will be stored with the other entity metadata. See guide for (unenforced) schema conventions. # noqa: E501 :param extra: The extra of this ReleaseEntity. # noqa: E501 :type: object @@ -967,6 +1001,7 @@ class ReleaseEntity(object): def edit_extra(self): """Gets the edit_extra of this ReleaseEntity. # noqa: E501 + Free-form JSON metadata that will be stored with specific entity edits (eg, creation/update/delete). # noqa: E501 :return: The edit_extra of this ReleaseEntity. # noqa: E501 :rtype: object @@ -977,6 +1012,7 @@ class ReleaseEntity(object): def edit_extra(self, edit_extra): """Sets the edit_extra of this ReleaseEntity. + Free-form JSON metadata that will be stored with specific entity edits (eg, creation/update/delete). # noqa: E501 :param edit_extra: The edit_extra of this ReleaseEntity. # noqa: E501 :type: object |