pygleif.v2¶

Client¶

`client.GleifClient`([transport])	High-level client for the GLEIF API v1.0.
`client.SearchType`(*values)	Fields supported by the completion and search endpoints.
`client.ExportFormat`(*values)	File formats supported by the LEI record export endpoint.
`base.Transport`([base_url])	Perform GET requests against the GLEIF JSON API, sync or async.
`base.HttpErrorCodes`(*values)	Relevant HTTP error codes returned by the GLEIF API.

Errors¶

`error.PyGLEIFError`	Base error for v2.
`error.PyGLEIFApiError`	Raised for HTTP / transport failures against the GLEIF API.
`error.PyGLEIFNotFoundError`	Raised when a requested resource does not exist (HTTP 404).
`error.PyGLEIFRateLimitError`	Raised when the GLEIF rate limit is exceeded (HTTP 429).

Models¶

Pydantic v2-bound models for the full GLEIF API v1.0 surface.

Covers the resources exposed by https://api.gleif.org/api/v1:

lei-records -> GLEIFResponse, SearchResponse
lei-records/{lei}/isins -> IsinResponse
lei-records/{lei}/*-relationship(s) -> RelationshipResponse, RelationshipListResponse
lei-records/{lei}/*-reporting-exception -> ReportingExceptionResponse
lei-records/{lei}/field-modifications -> FieldModificationResponse
fuzzycompletions -> FuzzyCompletionResponse
autocompletions -> AutocompletionResponse
fields -> FieldsResponse, FieldResponse
lei-issuers -> LeiIssuersResponse, LeiIssuerResponse
vlei-issuers -> VLeiIssuersResponse, VLeiIssuerResponse
reference data (countries, entity-legal-forms, official-organizational-roles, jurisdictions, regions, registration-authorities, registration-agents) -> typed *Response / list envelopes built on ResourceData

The JSON API responses use camelCase keys; models accept both camelCase (via the alias generator) and snake_case (populate_by_name). Keys the API serves in kebab-case (e.g. managing-lou) carry explicit aliases.

class pygleif.v2.api.models.BaseSchema[source]¶

Base schema with camelCase aliasing for GLEIF JSON API payloads.

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.ValidatedAt(*, id, other)[source]¶

Represent validated-at information.

Parameters:

id (str)
other (str | None)

id: str¶

other: str | None¶

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.Registration(*, corroborationLevel, initialRegistrationDate, lastUpdateDate, managingLou, nextRenewalDate, otherValidationAuthorities, status, validatedAs=None, validatedAt)[source]¶

Represent registration information.

Parameters:

corroborationLevel (str)
initialRegistrationDate (datetime)
lastUpdateDate (datetime)
managingLou (str)
nextRenewalDate (datetime)
otherValidationAuthorities (list[Any])
status (str)
validatedAs (str | None)
validatedAt (ValidatedAt)

corroboration_level: str¶

initial_registration_date: datetime¶

last_update_date: datetime¶

managing_lou: str¶

next_renewal_date: datetime¶

other_validation_authorities: list[Any]¶

status: str¶

validated_as: str | None¶

validated_at: ValidatedAt¶

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.GeneralEntity(*, lei, name)[source]¶

Represent a general entity.

Parameters:

lei (str | None)
name (str | None)

lei: str | None¶

name: str | None¶

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.Address(*, language, addressLines, addressNumber, addressNumberWithinBuilding, mailRouting, city, region, country, postalCode)[source]¶

Represent an address.

Parameters:

language (str | None)
addressLines (list[str])
addressNumber (str | None)
addressNumberWithinBuilding (str | None)
mailRouting (str | None)
city (str)
region (str | None)
country (str)
postalCode (str | None)

language: str | None¶

address_lines: list[str]¶

address_number: str | None¶

address_number_within_building: str | None¶

mail_routing: str | None¶

city: str¶

region: str | None¶

country: str¶

postal_code: str | None¶

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.Expiration(*, date, reason)[source]¶

Represent expiration data.

Parameters:

date (str | None)
reason (str | None)

date: str | None¶

reason: str | None¶

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.LegalForm(*, id, other)[source]¶

Represent the legal form.

Parameters:

id (str | None)
other (str | None)

id: str | None¶

other: str | None¶

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.Name(*, name, language=None, type=None)[source]¶

Represent a name.

Parameters:

name (str | None)
language (str | None)
type (str | None)

name: str | None¶

language: str | None¶

type: str | None¶

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.RegisteredAt(*, id, other)[source]¶

Represent registered-at information.

Parameters:

id (str)
other (str | None)

id: str¶

other: str | None¶

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.Entity(*, associatedEntity, category, creationDate, eventGroups, expiration, headquartersAddress, jurisdiction, legalAddress, legalForm, legalName, otherAddresses, otherNames, registeredAs=None, registeredAt, status, successorEntities, subCategory=None, successorEntity, transliteradedOtherNames=None)[source]¶

Represent entity information.

Parameters:

associatedEntity (GeneralEntity)
category (str)
creationDate (str | None)
eventGroups (list[Any])
expiration (Expiration)
headquartersAddress (Address)
jurisdiction (str)
legalAddress (Address)
legalForm (LegalForm)
legalName (Name)
otherAddresses (list[Any])
otherNames (list[Name])
registeredAs (str | None)
registeredAt (RegisteredAt)
status (str)
successorEntities (list[Any])
subCategory (str | None)
successorEntity (GeneralEntity)
transliteradedOtherNames (list[Any] | None)

associated_entity: GeneralEntity¶

category: str¶

creation_date: str | None¶

event_groups: list[Any]¶

expiration: Expiration¶

headquarters_address: Address¶

jurisdiction: str¶

legal_address: Address¶

legal_form: LegalForm¶

legal_name: Name¶

other_addresses: list[Any]¶

other_names: list[Name]¶

registered_as: str | None¶

registered_at: RegisteredAt¶

status: str¶

successor_entities: list[Any]¶

sub_category: str | None¶

successor_entity: GeneralEntity¶

transliteraded_other_names: list[Any] | None¶

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.Attributes(*, bic, lei, entity, registration)[source]¶

Represent attribute information.

Parameters:

bic (list[str] | None)
lei (str)
entity (Entity)
registration (Registration)

bic: list[str] | None¶

lei: str¶

entity: Entity¶

registration: Registration¶

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.LinkData(*, self=None, related=None, relationship_record=None, relationship_records=None, lei_record=None, reporting_exception=None)[source]¶

Represent a link.

Parameters:

self (str | None)
related (str | None)
relationship_record (str | None)
relationship_records (str | None)
lei_record (str | None)
reporting_exception (str | None)

self: str | None¶

related: str | None¶

relationship_record: str | None¶

relationship_records: str | None¶

lei_record: str | None¶

reporting_exception: str | None¶

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.ResourceIdentifier(*, type=None, id=None)[source]¶

A JSON:API resource identifier (type + id).

Parameters:

type (str | None)
id (str | None)

type: str | None¶

id: str | None¶

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.Links(*, links, data=None)[source]¶

Represent a JSON:API relationship object (links plus identifier).

Parameters:

links (LinkData)
data (ResourceIdentifier | None)

links: LinkData¶

data: ResourceIdentifier | None¶

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.Relationships(*, managing_lou=None, lei_issuer=None, field_modifications=None, direct_parent=None, ultimate_parent=None, direct_children=None, ultimate_children=None, isins=None)[source]¶

Represent relationships between records.

The API serves these keys in kebab-case (managing-lou etc.), hence the explicit aliases.

Parameters:

managing_lou (Links | None)
lei_issuer (Links | None)
field_modifications (Links | None)
direct_parent (Links | None)
ultimate_parent (Links | None)
direct_children (Links | None)
ultimate_children (Links | None)
isins (Links | None)

managing_lou: Links | None¶

lei_issuer: Links | None¶

field_modifications: Links | None¶

direct_parent: Links | None¶

ultimate_parent: Links | None¶

direct_children: Links | None¶

ultimate_children: Links | None¶

isins: Links | None¶

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.Data(*, id, type, attributes, links, relationships)[source]¶

Represent an LEI record data object.

Parameters:

id (str)
type (str)
attributes (Attributes)
links (LinkData)
relationships (Relationships)

id: str¶

type: str¶

attributes: Attributes¶

links: LinkData¶

relationships: Relationships¶

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

pygleif.v2.api.models.LeiRecord¶: Preferred v2 name for a single LEI record.

class pygleif.v2.api.models.GoldenCopy(*, publishDate)[source]¶

Represent golden copy information.

Parameters:: publishDate (datetime)

publish_date: datetime¶

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.Pagination(*, currentPage, perPage, to=None, total, lastPage)[source]¶

Represent response pagination.

Parameters:

currentPage (int)
perPage (int)
to (int | None)
total (int)
lastPage (int)

current_page: int¶

per_page: int¶

to: int | None¶

total: int¶

last_page: int¶

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_post_init(context, /)¶

This function is meant to behave like a BaseModel method to initialize private attributes.

It takes context as an argument since that’s what pydantic-core passes when calling it.

Args:: self: The BaseModel instance. context: The context.

Parameters:

self (BaseModel)
context (Any)

Return type:

None

class pygleif.v2.api.models.Meta(*, goldenCopy=None, pagination=None)[source]¶

Represent meta information.

Parameters:

goldenCopy (GoldenCopy | None)
pagination (Pagination | None)

golden_copy: GoldenCopy | None¶

pagination: Pagination | None¶

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.GLEIFResponse(*, meta, data)[source]¶

Single LEI record response (/lei-records/{lei}).

Parameters:

meta (Meta)
data (Data)

meta: Meta¶

data: Data¶

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.SearchResponse(*, meta, data)[source]¶

Search / list response (/lei-records).

Parameters:

meta (Meta)
data (list[Data])

meta: Meta¶

data: list[Data]¶

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.IsinAttributes(*, lei, isin)[source]¶

Attributes of an ISIN-LEI mapping.

Parameters:

lei (str)
isin (str)

lei: str¶

isin: str¶

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.IsinData(*, type, id, attributes)[source]¶

A single ISIN-LEI mapping record.

Parameters:

type (str)
id (str)
attributes (IsinAttributes)

type: str¶

id: str¶

attributes: IsinAttributes¶

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.IsinResponse(*, meta, data)[source]¶

ISIN mapping list response.

Parameters:

meta (Meta)
data (list[IsinData])

meta: Meta¶

data: list[IsinData]¶

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.CompletionRelationships(*, lei_records=None)[source]¶

Relationships of a completion result (link to the LEI record).

Parameters:: lei_records (Links | None)

lei_records: Links | None¶

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.FuzzyCompletionAttributes(*, value=None)[source]¶

Attributes of a fuzzy completion result.

Parameters:: value (str | None)

value: str | None¶

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.FuzzyCompletion(*, type, attributes, relationships=None)[source]¶

A single fuzzy completion match.

Parameters:

type (str)
attributes (FuzzyCompletionAttributes)
relationships (CompletionRelationships | None)

type: str¶

attributes: FuzzyCompletionAttributes¶

relationships: CompletionRelationships | None¶

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.FuzzyCompletionResponse(*, data)[source]¶

Fuzzy completion list response.

Parameters:: data (list[FuzzyCompletion])

data: list[FuzzyCompletion]¶

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.AutocompletionAttributes(*, value=None, highlighting=None)[source]¶

Attributes of an autocompletion suggestion.

Parameters:

value (str | None)
highlighting (str | None)

value: str | None¶

highlighting: str | None¶

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.Autocompletion(*, type, attributes, relationships=None)[source]¶

A single autocompletion suggestion.

Parameters:

type (str)
attributes (AutocompletionAttributes)
relationships (CompletionRelationships | None)

type: str¶

attributes: AutocompletionAttributes¶

relationships: CompletionRelationships | None¶

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.AutocompletionResponse(*, data)[source]¶

Autocompletion list response.

Parameters:: data (list[Autocompletion])

data: list[Autocompletion]¶

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.FieldAttributes(*, key=None, field=None, label=None, dataType=None, enum=None, resource=None, sortable=None, operators=None, contexts=None, xpath=None)[source]¶

Metadata describing a single LEI data field.

Parameters:

key (str | None)
field (str | None)
label (str | None)
dataType (str | None)
enum (list[Any] | None)
resource (str | None)
sortable (bool | None)
operators (list[str] | None)
contexts (list[Any] | None)
xpath (str | None)

key: str | None¶

field: str | None¶

label: str | None¶

data_type: str | None¶

enum: list[Any] | None¶

resource: str | None¶

sortable: bool | None¶

operators: list[str] | None¶

contexts: list[Any] | None¶

xpath: str | None¶

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.FieldDescriptor(*, type, id, attributes)[source]¶

A single field descriptor from the /fields endpoint.

Parameters:

type (str)
id (str)
attributes (FieldAttributes)

type: str¶

id: str¶

attributes: FieldAttributes¶

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.FieldsResponse(*, meta=None, data)[source]¶

Fields metadata list response.

Parameters:

meta (Meta | None)
data (list[FieldDescriptor])

meta: Meta | None¶

data: list[FieldDescriptor]¶

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.FieldResponse(*, data)[source]¶

Single field metadata response (/fields/{id}).

Parameters:: data (FieldDescriptor)

data: FieldDescriptor¶

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.ResourceData(*, type, id, attributes, links=None)[source]¶

A JSON:API data object with resource-specific typed attributes.

Parameters:

type (str)
id (str)
attributes (AttributesT)
links (LinkData | None)

type: str¶

id: str¶

attributes: AttributesT¶

links: LinkData | None¶

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.ResourceResponse(*, meta=None, data)[source]¶

Single-resource response envelope.

Parameters:

meta (Meta | None)
data (ResourceData[TypeVar])

meta: Meta | None¶

data: ResourceData[AttributesT]¶

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.ResourceListResponse(*, meta=None, data)[source]¶

Resource list response envelope.

Parameters:

meta (Meta | None)
data (list[ResourceData[TypeVar]])

meta: Meta | None¶

data: list[ResourceData[AttributesT]]¶

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.RelationshipNode(*, id=None, type=None)[source]¶

Start or end node of a relationship record.

Parameters:

id (str | None)
type (str | None)

id: str | None¶

type: str | None¶

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.RelationshipPeriod(*, startDate=None, endDate=None, type=None)[source]¶

Validity period reported for a relationship.

Parameters:

startDate (datetime | None)
endDate (datetime | None)
type (str | None)

start_date: datetime | None¶

end_date: datetime | None¶

type: str | None¶

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.RelationshipDetail(*, startNode=None, endNode=None, type=None, status=None, periods=<factory>)[source]¶

The reported relationship between two LEI records.

Parameters:

startNode (RelationshipNode | None)
endNode (RelationshipNode | None)
type (str | None)
status (str | None)
periods (list[RelationshipPeriod])

start_node: RelationshipNode | None¶

end_node: RelationshipNode | None¶

type: str | None¶

status: str | None¶

periods: list[RelationshipPeriod]¶

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.RelationshipRegistration(*, initialRegistrationDate=None, lastUpdateDate=None, status=None, nextRenewalDate=None, managingLou=None, corroborationLevel=None, corroborationDocuments=None, corroborationReference=None)[source]¶

Registration details of a relationship record.

Parameters:

initialRegistrationDate (datetime | None)
lastUpdateDate (datetime | None)
status (str | None)
nextRenewalDate (datetime | None)
managingLou (str | None)
corroborationLevel (str | None)
corroborationDocuments (str | None)
corroborationReference (str | None)

initial_registration_date: datetime | None¶

last_update_date: datetime | None¶

status: str | None¶

next_renewal_date: datetime | None¶

managing_lou: str | None¶

corroboration_level: str | None¶

corroboration_documents: str | None¶

corroboration_reference: str | None¶

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.RelationshipAttributes(*, validFrom=None, validTo=None, relationship=None, registration=None)[source]¶

Attributes of a relationship record.

Parameters:

validFrom (datetime | None)
validTo (datetime | None)
relationship (RelationshipDetail | None)
registration (RelationshipRegistration | None)

valid_from: datetime | None¶

valid_to: datetime | None¶

relationship: RelationshipDetail | None¶

registration: RelationshipRegistration | None¶

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.RelationshipData(*, type, id, attributes, links=None)[source]¶

A single relationship record.

Parameters:

type (str)
id (str)
attributes (AttributesT)
links (LinkData | None)

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.RelationshipResponse(*, meta=None, data)[source]¶

Single relationship record response.

Parameters:

meta (Meta | None)
data (ResourceData[TypeVar])

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.RelationshipListResponse(*, meta=None, data)[source]¶

Relationship record list response.

Parameters:

meta (Meta | None)
data (list[ResourceData[TypeVar]])

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.ReportingExceptionAttributes(*, validFrom=None, validTo=None, lei=None, category=None, reason=None, reference=None)[source]¶

Attributes of a Level 2 reporting exception.

Parameters:

validFrom (datetime | None)
validTo (datetime | None)
lei (str | None)
category (str | None)
reason (str | None)
reference (str | None)

valid_from: datetime | None¶

valid_to: datetime | None¶

lei: str | None¶

category: str | None¶

reason: str | None¶

reference: str | None¶

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.ReportingExceptionData(*, type, id, attributes, links=None)[source]¶

A single reporting exception record.

Parameters:

type (str)
id (str)
attributes (AttributesT)
links (LinkData | None)

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.ReportingExceptionResponse(*, meta=None, data)[source]¶

Reporting exception response.

Parameters:

meta (Meta | None)
data (ResourceData[TypeVar])

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.FieldModificationAttributes(*, lei=None, recordType=None, modificationType=None, field=None, date=None, valueOld=None, valueNew=None, context=None)[source]¶

A single historical change to an LEI record field.

Parameters:

lei (str | None)
recordType (str | None)
modificationType (str | None)
field (str | None)
date (datetime | None)
valueOld (Any)
valueNew (Any)
context (Any)

lei: str | None¶

record_type: str | None¶

modification_type: str | None¶

field: str | None¶

date: datetime | None¶

value_old: Any¶

value_new: Any¶

context: Any¶

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.FieldModificationData(*, type, id, attributes, links=None)[source]¶

A single field modification record.

Parameters:

type (str)
id (str)
attributes (AttributesT)
links (LinkData | None)

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.FieldModificationResponse(*, meta=None, data)[source]¶

Field modification list response.

Parameters:

meta (Meta | None)
data (list[ResourceData[TypeVar]])

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.LeiIssuerAttributes(*, lei=None, name=None, marketingName=None, reportingName=None, website=None, organizationType=None, shortDescription=None, legalDomicile=None, accreditationDate=None)[source]¶

Attributes of an LEI issuer (Local Operating Unit).

Parameters:

lei (str | None)
name (str | None)
marketingName (str | None)
reportingName (str | None)
website (str | None)
organizationType (str | None)
shortDescription (str | None)
legalDomicile (str | None)
accreditationDate (str | None)

lei: str | None¶

name: str | None¶

marketing_name: str | None¶

reporting_name: str | None¶

website: str | None¶

organization_type: str | None¶

short_description: str | None¶

legal_domicile: str | None¶

accreditation_date: str | None¶

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.LeiIssuerData(*, type, id, attributes, links=None)[source]¶

A single LEI issuer record.

Parameters:

type (str)
id (str)
attributes (AttributesT)
links (LinkData | None)

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.LeiIssuerResponse(*, meta=None, data)[source]¶

Single LEI issuer response.

Parameters:

meta (Meta | None)
data (ResourceData[TypeVar])

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.LeiIssuersResponse(*, meta=None, data)[source]¶

LEI issuer list response.

Parameters:

meta (Meta | None)
data (list[ResourceData[TypeVar]])

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.LeiIssuerJurisdictionAttributes(*, countryCode=None, accreditedAs=None, startDate=None, endDate=None)[source]¶

Jurisdiction an LEI issuer is accredited for.

Parameters:

countryCode (str | None)
accreditedAs (str | None)
startDate (str | None)
endDate (str | None)

country_code: str | None¶

accredited_as: str | None¶

start_date: str | None¶

end_date: str | None¶

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.LeiIssuerJurisdictionsResponse(*, meta=None, data)[source]¶

LEI issuer accredited jurisdiction list response.

Parameters:

meta (Meta | None)
data (list[ResourceData[TypeVar]])

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.VLeiIssuerAttributes(*, lei=None, name=None, website=None, marketingName=None, qualificationDate=None)[source]¶

Attributes of a qualified vLEI issuing organization.

Parameters:

lei (str | None)
name (str | None)
website (str | None)
marketingName (str | None)
qualificationDate (str | None)

lei: str | None¶

name: str | None¶

website: str | None¶

marketing_name: str | None¶

qualification_date: str | None¶

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.VLeiIssuerData(*, type, id, attributes, links=None)[source]¶

A single vLEI issuer record.

Parameters:

type (str)
id (str)
attributes (AttributesT)
links (LinkData | None)

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.VLeiIssuerResponse(*, meta=None, data)[source]¶

Single vLEI issuer response.

Parameters:

meta (Meta | None)
data (ResourceData[TypeVar])

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.VLeiIssuersResponse(*, meta=None, data)[source]¶

vLEI issuer list response.

Parameters:

meta (Meta | None)
data (list[ResourceData[TypeVar]])

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.CountryAttributes(*, code=None, name=None)[source]¶

ISO 3166 country code entry.

Parameters:

code (str | None)
name (str | None)

code: str | None¶

name: str | None¶

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.CountryData(*, type, id, attributes, links=None)[source]¶

A single country record.

Parameters:

type (str)
id (str)
attributes (AttributesT)
links (LinkData | None)

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.CountryResponse(*, meta=None, data)[source]¶

Single country response.

Parameters:

meta (Meta | None)
data (ResourceData[TypeVar])

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.CountriesResponse(*, meta=None, data)[source]¶

Country list response.

Parameters:

meta (Meta | None)
data (list[ResourceData[TypeVar]])

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.JurisdictionAttributes(*, code=None, name=None)[source]¶

Legal jurisdiction entry (ISO 3166 country / sub-region codes).

Parameters:

code (str | None)
name (str | None)

code: str | None¶

name: str | None¶

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.JurisdictionData(*, type, id, attributes, links=None)[source]¶

A single jurisdiction record.

Parameters:

type (str)
id (str)
attributes (AttributesT)
links (LinkData | None)

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.JurisdictionResponse(*, meta=None, data)[source]¶

Single jurisdiction response.

Parameters:

meta (Meta | None)
data (ResourceData[TypeVar])

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.JurisdictionsResponse(*, meta=None, data)[source]¶

Jurisdiction list response.

Parameters:

meta (Meta | None)
data (list[ResourceData[TypeVar]])

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.RegionAttributes(*, code=None, name=None)[source]¶

ISO 3166 sub-region code entry.

Parameters:

code (str | None)
name (str | None)

code: str | None¶

name: str | None¶

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.RegionData(*, type, id, attributes, links=None)[source]¶

A single region record.

Parameters:

type (str)
id (str)
attributes (AttributesT)
links (LinkData | None)

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.RegionResponse(*, meta=None, data)[source]¶

Single region response.

Parameters:

meta (Meta | None)
data (ResourceData[TypeVar])

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.RegionsResponse(*, meta=None, data)[source]¶

Region list response.

Parameters:

meta (Meta | None)
data (list[ResourceData[TypeVar]])

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.LocalizedName(*, name=None, localName=None, language=None, languageCode=None, transliteratedName=None)[source]¶

Localized name entry used by the ELF and OOR code lists.

Parameters:

name (str | None)
localName (str | None)
language (str | None)
languageCode (str | None)
transliteratedName (str | None)

name: str | None¶

local_name: str | None¶

language: str | None¶

language_code: str | None¶

transliterated_name: str | None¶

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.EntityLegalFormAttributes(*, code=None, country=None, jurisdiction=None, countryCode=None, subdivisionCode=None, dateCreated=None, status=None, names=<factory>)[source]¶

ISO 20275 entity legal form (ELF) code entry.

Parameters:

code (str | None)
country (str | None)
jurisdiction (str | None)
countryCode (str | None)
subdivisionCode (str | None)
dateCreated (str | None)
status (str | None)
names (list[LocalizedName])

code: str | None¶

country: str | None¶

jurisdiction: str | None¶

country_code: str | None¶

subdivision_code: str | None¶

date_created: str | None¶

status: str | None¶

names: list[LocalizedName]¶

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.EntityLegalFormData(*, type, id, attributes, links=None)[source]¶

A single entity legal form record.

Parameters:

type (str)
id (str)
attributes (AttributesT)
links (LinkData | None)

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.EntityLegalFormResponse(*, meta=None, data)[source]¶

Single entity legal form response.

Parameters:

meta (Meta | None)
data (ResourceData[TypeVar])

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.EntityLegalFormsResponse(*, meta=None, data)[source]¶

Entity legal form list response.

Parameters:

meta (Meta | None)
data (list[ResourceData[TypeVar]])

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.OfficialOrganizationalRoleAttributes(*, code=None, country=None, jurisdiction=None, countryCode=None, subdivisionCode=None, dateCreated=None, status=None, elfCode=None, names=<factory>)[source]¶

ISO 5009 official organizational role (OOR) code entry.

Parameters:

code (str | None)
country (str | None)
jurisdiction (str | None)
countryCode (str | None)
subdivisionCode (str | None)
dateCreated (str | None)
status (str | None)
elfCode (str | None)
names (list[LocalizedName])

code: str | None¶

country: str | None¶

jurisdiction: str | None¶

country_code: str | None¶

subdivision_code: str | None¶

date_created: str | None¶

status: str | None¶

elf_code: str | None¶

names: list[LocalizedName]¶

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.OfficialOrganizationalRoleData(*, type, id, attributes, links=None)[source]¶

A single official organizational role record.

Parameters:

type (str)
id (str)
attributes (AttributesT)
links (LinkData | None)

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.OfficialOrganizationalRoleResponse(*, meta=None, data)[source]¶

Single official organizational role response.

Parameters:

meta (Meta | None)
data (ResourceData[TypeVar])

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.OfficialOrganizationalRolesResponse(*, meta=None, data)[source]¶

Official organizational role list response.

Parameters:

meta (Meta | None)
data (list[ResourceData[TypeVar]])

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.RegistrationAuthorityJurisdiction(*, country=None, countryCode=None, jurisdiction=None)[source]¶

Jurisdiction covered by a registration authority.

Parameters:

country (str | None)
countryCode (str | None)
jurisdiction (str | None)

country: str | None¶

country_code: str | None¶

jurisdiction: str | None¶

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.RegistrationAuthorityAttributes(*, code=None, internationalName=None, localName=None, internationalOrganizationName=None, localOrganizationName=None, website=None, jurisdictions=<factory>)[source]¶

GLEIF Registration Authority (RA) code list entry.

Parameters:

code (str | None)
internationalName (str | None)
localName (str | None)
internationalOrganizationName (str | None)
localOrganizationName (str | None)
website (str | None)
jurisdictions (list[RegistrationAuthorityJurisdiction])

code: str | None¶

international_name: str | None¶

local_name: str | None¶

international_organization_name: str | None¶

local_organization_name: str | None¶

website: str | None¶

jurisdictions: list[RegistrationAuthorityJurisdiction]¶

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.RegistrationAuthorityData(*, type, id, attributes, links=None)[source]¶

A single registration authority record.

Parameters:

type (str)
id (str)
attributes (AttributesT)
links (LinkData | None)

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.RegistrationAuthorityResponse(*, meta=None, data)[source]¶

Single registration authority response.

Parameters:

meta (Meta | None)
data (ResourceData[TypeVar])

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.RegistrationAuthoritiesResponse(*, meta=None, data)[source]¶

Registration authority list response.

Parameters:

meta (Meta | None)
data (list[ResourceData[TypeVar]])

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.RegistrationAgentAttributes(*, name=None, lei=None, leiIssuer=None, websites=<factory>)[source]¶

Registration agent entry.

Parameters:

name (str | None)
lei (str | None)
leiIssuer (str | None)
websites (list[str])

name: str | None¶

lei: str | None¶

lei_issuer: str | None¶

websites: list[str]¶

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.RegistrationAgentData(*, type, id, attributes, links=None)[source]¶

A single registration agent record.

Parameters:

type (str)
id (str)
attributes (AttributesT)
links (LinkData | None)

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.RegistrationAgentResponse(*, meta=None, data)[source]¶

Single registration agent response.

Parameters:

meta (Meta | None)
data (ResourceData[TypeVar])

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygleif.v2.api.models.RegistrationAgentsResponse(*, meta=None, data)[source]¶

Registration agent list response.

Parameters:

meta (Meta | None)
data (list[ResourceData[TypeVar]])

model_config = {'alias_generator': <function to_camel>, 'populate_by_name': True, 'validate_by_alias': True, 'validate_by_name': True}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].