3.1.1.4. nordigen_cli.models package

3.1.1.4.1. Submodules

3.1.1.4.2. nordigen_cli.models.mixins module

class nordigen_cli.models.mixins.BaseMixin(*, id: str, metadata: dict[str, Any])

Bases: BaseModel

id: str

metadata: Annotated[dict[str, Any], FieldInfo(annotation=NoneType, required=True, description='messages from unit tests')]

model_config: ClassVar[ConfigDict] = {'extra': 'forbid', 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class nordigen_cli.models.mixins.BaseRootMixin(*, mymeta: ~typing.Annotated[dict[str, ~typing.Any] | None, <nordigen_cli.models.mixins.OmitIfNone object at 0x7fb0c0f8d4f0>] = None)

Bases: NoSerializeNoneModel

accept(visitor, /, *args, **kwargs)

model_config: ClassVar[ConfigDict] = {'extra': 'forbid', 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

mymeta: OmitIfNone object at 0x7fb0c0f8d4f0>]

class nordigen_cli.models.mixins.DisplayField

Bases: object

class nordigen_cli.models.mixins.MetaMixin(*, messages: dict[str, Any])

Bases: BaseModel

messages: Annotated[dict[str, Any], FieldInfo(annotation=NoneType, required=True, description='messages from unit tests')]

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class nordigen_cli.models.mixins.NoSerializeNoneModel

Bases: BaseModel

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

serialize_as(simplified_type: bool | None = False)

class nordigen_cli.models.mixins.OmitIfNone

Bases: object

class nordigen_cli.models.mixins.ReprAdapter

Bases: BaseModel

classmethod from_model(model: BaseModel) → ReprAdapter | list[ReprAdapter] | list[BaseModel] | dict[str, Any]

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class nordigen_cli.models.mixins.ReprMgr

Bases: object

classmethod adapt(data: BaseModel | Any)

mappings: dict[type[BaseModel], type[ReprAdapter]] = {<class 'nordigen_cli.models.model.AccountTransactions'>: <class 'nordigen_cli.models.renderable.ReprAccountTransactions'>, <class 'nordigen_cli.models.model.TransactionSchema'>: <class 'nordigen_cli.models.renderable.ReprTransactionSchema'>}

classmethod register(model: type[BaseModel], formatter: type[ReprAdapter])

3.1.1.4.3. nordigen_cli.models.model module

class nordigen_cli.models.model.Account(*, mymeta: ~typing.Annotated[dict[str, ~typing.Any] | None, <nordigen_cli.models.mixins.OmitIfNone object at 0x7fb0c0f8d4f0>] = None, id: ~uuid.UUID | None = None, created: ~datetime.datetime | None = None, last_accessed: ~datetime.datetime | None = None, iban: str | None = None, bban: str | None = None, status: str | None = None, institution_id: str | None = None, owner_name: str | None = None)

Bases: BaseRootMixin

AccountSerializer.

bban: str | None

created: datetime | None

iban: str | None

id: UUID | None

institution_id: str | None

last_accessed: datetime | None

model_config: ClassVar[ConfigDict] = {'extra': 'forbid', 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

owner_name: str | None

status: str | None

class nordigen_cli.models.model.AccountBalance(*, mymeta: ~typing.Annotated[dict[str, ~typing.Any] | None, <nordigen_cli.models.mixins.OmitIfNone object at 0x7fb0c0f8d4f0>] = None, balances: list[~nordigen_cli.models.model.BalanceSchema] | None = None)

Bases: BaseRootMixin

AccountBalanceSerializer.

balances: list[BalanceSchema] | None

model_config: ClassVar[ConfigDict] = {'extra': 'forbid', 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class nordigen_cli.models.model.AccountDetail(*, mymeta: ~typing.Annotated[dict[str, ~typing.Any] | None, <nordigen_cli.models.mixins.OmitIfNone object at 0x7fb0c0f8d4f0>] = None, account: ~nordigen_cli.models.model.DetailSchema)

Bases: BaseRootMixin

AccountDetailSerializer.

account: DetailSchema

model_config: ClassVar[ConfigDict] = {'extra': 'forbid', 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class nordigen_cli.models.model.AccountSchema(*, mymeta: ~typing.Annotated[dict[str, ~typing.Any] | None, <nordigen_cli.models.mixins.OmitIfNone object at 0x7fb0c0f8d4f0>] = None, iban: str | None = None, bban: str | None = None, pan: str | None = None, maskedPan: str | None = None, msisdn: str | None = None, currency: str | None = None)

Bases: BaseRootMixin

AccountSchema.

bban: str | None

currency: str | None

iban: str | None

maskedPan: str | None

model_config: ClassVar[ConfigDict] = {'extra': 'forbid', 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

msisdn: str | None

pan: str | None

class nordigen_cli.models.model.AccountTransactions(*, mymeta: ~typing.Annotated[dict[str, ~typing.Any] | None, <nordigen_cli.models.mixins.OmitIfNone object at 0x7fb0c0f8d4f0>] = None, transactions: ~nordigen_cli.models.model.BankTransaction)

Bases: BaseRootMixin

AccountTransactionsSerializer.

model_config: ClassVar[ConfigDict] = {'extra': 'forbid', 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

transactions: BankTransaction

class nordigen_cli.models.model.BalanceAmountSchema(*, mymeta: ~typing.Annotated[dict[str, ~typing.Any] | None, <nordigen_cli.models.mixins.OmitIfNone object at 0x7fb0c0f8d4f0>] = None, amount: str, currency: str)

Bases: BaseRootMixin

BalanceAmountSchema.

amount: str

currency: str

model_config: ClassVar[ConfigDict] = {'extra': 'forbid', 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class nordigen_cli.models.model.BalanceSchema(*, mymeta: ~typing.Annotated[dict[str, ~typing.Any] | None, <nordigen_cli.models.mixins.OmitIfNone object at 0x7fb0c0f8d4f0>] = None, balanceAmount: ~nordigen_cli.models.model.BalanceAmountSchema, balanceType: str, creditLimitIncluded: bool | None = None, lastChangeDateTime: str | None = None, referenceDate: str | None = None, lastCommittedTransaction: str | None = None)

Bases: BaseRootMixin

BalanceSchema.

balanceAmount: BalanceAmountSchema

balanceType: str

creditLimitIncluded: bool | None

lastChangeDateTime: str | None

lastCommittedTransaction: str | None

model_config: ClassVar[ConfigDict] = {'extra': 'forbid', 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

referenceDate: str | None

class nordigen_cli.models.model.BankTransaction(*, mymeta: ~typing.Annotated[dict[str, ~typing.Any] | None, <nordigen_cli.models.mixins.OmitIfNone object at 0x7fb0c0f8d4f0>] = None, booked: list[~nordigen_cli.models.model.TransactionSchema], pending: list[~nordigen_cli.models.model.TransactionSchema] | None = None)

Bases: BaseRootMixin

BankTransactionSerializer.

booked: list[TransactionSchema]

model_config: ClassVar[ConfigDict] = {'extra': 'forbid', 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

pending: list[TransactionSchema] | None

class nordigen_cli.models.model.CurrencyExchangeSchema(*, mymeta: ~typing.Annotated[dict[str, ~typing.Any] | None, <nordigen_cli.models.mixins.OmitIfNone object at 0x7fb0c0f8d4f0>] = None, sourceCurrency: str | None = None, exchangeRate: str | None = None, unitCurrency: str | None = None, targetCurrency: str | None = None, quotationDate: str | None = None, contractIdentification: str | None = None)

Bases: BaseRootMixin

CurrencyExchangeSchema.

contractIdentification: str | None

exchangeRate: str | None

model_config: ClassVar[ConfigDict] = {'extra': 'forbid', 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

quotationDate: str | None

sourceCurrency: str | None

targetCurrency: str | None

unitCurrency: str | None

class nordigen_cli.models.model.DetailSchema(*, mymeta: ~typing.Annotated[dict[str, ~typing.Any] | None, <nordigen_cli.models.mixins.OmitIfNone object at 0x7fb0c0f8d4f0>] = None, resourceId: str | None = None, iban: str | None = None, bban: str | None = None, scan: str | None = None, msisdn: str | None = None, currency: str | None = None, ownerName: str | None = None, name: str | None = None, displayName: str | None = None, product: str | None = None, cashAccountType: str | None = None, status: str | None = None, bic: str | None = None, linkedAccounts: str | None = None, maskedPan: str | None = None, usage: str | None = None, details: str | None = None, ownerAddressUnstructured: list[str] | None = None, ownerAddressStructured: ~nordigen_cli.models.model.OwnerAddressStructuredSchema | None = None)

Bases: BaseRootMixin

DetailSchema.

bban: str | None

bic: str | None

cashAccountType: str | None

currency: str | None

details: str | None

displayName: str | None

iban: str | None

linkedAccounts: str | None

maskedPan: str | None

model_config: ClassVar[ConfigDict] = {'extra': 'forbid', 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

msisdn: str | None

name: str | None

ownerAddressStructured: OwnerAddressStructuredSchema | None

ownerAddressUnstructured: list[str] | None

ownerName: str | None

product: str | None

resourceId: str | None

scan: str | None

status: str | None

usage: str | None

class nordigen_cli.models.model.EndUserAgreement(*, mymeta: ~typing.Annotated[dict[str, ~typing.Any] | None, <nordigen_cli.models.mixins.OmitIfNone object at 0x7fb0c0f8d4f0>] = None, id: ~uuid.UUID | None = None, created: ~datetime.datetime | None = None, institution_id: str, max_historical_days: ~typing.Annotated[int, None, ~annotated_types.Interval(gt=None, ge=1, lt=None, le=730), None] | None = 90, access_valid_for_days: ~typing.Annotated[int, None, ~annotated_types.Interval(gt=None, ge=1, lt=None, le=180), None] | None = 90, access_scope: list[str] | None = <factory>, accepted: ~datetime.datetime | None = None)

Bases: BaseRootMixin

Represents an end-user agreement.

accepted: datetime | None

access_scope: Annotated[list[str] | None, FieldInfo(annotation=NoneType, required=False, default_factory=<lambda>, title='Level of information to access (by default all)', description="Array containing one or several values of ['balances', 'details', 'transactions']")]

access_valid_for_days: Annotated[int, None, Interval(gt=None, ge=1, lt=None, le=180), None] | None

created: datetime | None

id: UUID | None

institution_id: str

max_historical_days: Annotated[int, None, Interval(gt=None, ge=1, lt=None, le=730), None] | None

model_config: ClassVar[ConfigDict] = {'extra': 'forbid', 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class nordigen_cli.models.model.EndUserAgreementRequest(*, mymeta: ~typing.Annotated[dict[str, ~typing.Any] | None, <nordigen_cli.models.mixins.OmitIfNone object at 0x7fb0c0f8d4f0>] = None, institution_id: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=None, pattern=None)], max_historical_days: ~typing.Annotated[int, None, ~annotated_types.Interval(gt=None, ge=1, lt=None, le=730), None] | None = 90, access_valid_for_days: ~typing.Annotated[int, None, ~annotated_types.Interval(gt=None, ge=1, lt=None, le=180), None] | None = 90, access_scope: list | None = ['balances', 'details', 'transactions'])

Bases: BaseRootMixin

Represents an end-user agreement.

access_scope: Annotated[list | None, FieldInfo(annotation=NoneType, required=False, default=['balances', 'details', 'transactions'], title='Level of information to access (by default all)', description="Array containing one or several values of ['balances', 'details', 'transactions']")]

access_valid_for_days: Annotated[int, None, Interval(gt=None, ge=1, lt=None, le=180), None] | None

institution_id: Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=None, pattern=None)]

max_historical_days: Annotated[int, None, Interval(gt=None, ge=1, lt=None, le=730), None] | None

model_config: ClassVar[ConfigDict] = {'extra': 'forbid', 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class nordigen_cli.models.model.EnduserAcceptanceDetailsRequest(*, mymeta: ~typing.Annotated[dict[str, ~typing.Any] | None, <nordigen_cli.models.mixins.OmitIfNone object at 0x7fb0c0f8d4f0>] = None, user_agent: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=None, pattern=None)], ip_address: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=None, pattern=None)])

Bases: BaseRootMixin

Represents end-user details.

ip_address: Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=None, pattern=None)]

model_config: ClassVar[ConfigDict] = {'extra': 'forbid', 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

user_agent: Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=None, pattern=None)]

class nordigen_cli.models.model.ErrorResponse(*, mymeta: ~typing.Annotated[dict[str, ~typing.Any] | None, <nordigen_cli.models.mixins.OmitIfNone object at 0x7fb0c0f8d4f0>] = None, summary: str, detail: str, type: str | None = None, status_code: int)

Bases: BaseRootMixin

detail: str

model_config: ClassVar[ConfigDict] = {'extra': 'forbid', 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

status_code: int

summary: str

type: str | None

class nordigen_cli.models.model.Integration(*, mymeta: ~typing.Annotated[dict[str, ~typing.Any] | None, <nordigen_cli.models.mixins.OmitIfNone object at 0x7fb0c0f8d4f0>] = None, id: str, name: str, bic: str | None = None, transaction_total_days: str | None = '90', max_access_valid_for_days: str | None = '180', countries: list[str], logo: str)

Bases: BaseRootMixin

Represents an Integration.

bic: str | None

countries: list[str]

id: str

logo: str

max_access_valid_for_days: str | None

model_config: ClassVar[ConfigDict] = {'extra': 'forbid', 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: str

transaction_total_days: str | None

class nordigen_cli.models.model.IntegrationRetrieve(*, mymeta: ~typing.Annotated[dict[str, ~typing.Any] | None, <nordigen_cli.models.mixins.OmitIfNone object at 0x7fb0c0f8d4f0>] = None, id: str, name: str, bic: str | None = None, transaction_total_days: str | None = '90', max_access_valid_for_days: str | None = None, countries: list[str], logo: str, supported_payments: dict[str, ~typing.Any], supported_features: list, identification_codes: list)

Bases: BaseRootMixin

IntegrationSerializer for Retrieve endpoint.

bic: str | None

countries: list[str]

id: str

identification_codes: list

logo: str

max_access_valid_for_days: str | None

model_config: ClassVar[ConfigDict] = {'extra': 'forbid', 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: str

supported_features: list

supported_payments: dict[str, Any]

transaction_total_days: str | None

class nordigen_cli.models.model.JWTObtainPairRequest(*, mymeta: ~typing.Annotated[dict[str, ~typing.Any] | None, <nordigen_cli.models.mixins.OmitIfNone object at 0x7fb0c0f8d4f0>] = None, secret_id: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=None, pattern=None)], secret_key: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=None, pattern=None)])

Bases: BaseRootMixin

Obtain JWT pair.

model_config: ClassVar[ConfigDict] = {'extra': 'forbid', 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

secret_id: Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=None, pattern=None)]

secret_key: Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=None, pattern=None)]

class nordigen_cli.models.model.JWTRefreshRequest(*, mymeta: ~typing.Annotated[dict[str, ~typing.Any] | None, <nordigen_cli.models.mixins.OmitIfNone object at 0x7fb0c0f8d4f0>] = None, refresh: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=None, pattern=None)])

Bases: BaseRootMixin

Refresh access token.

model_config: ClassVar[ConfigDict] = {'extra': 'forbid', 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

refresh: Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=None, pattern=None)]

class nordigen_cli.models.model.OwnerAddressStructuredSchema(*, mymeta: ~typing.Annotated[dict[str, ~typing.Any] | None, <nordigen_cli.models.mixins.OmitIfNone object at 0x7fb0c0f8d4f0>] = None, streetName: str | None = None, buildingNumber: str | None = None, townName: str | None = None, postCode: str | None = None, country: str | None = None)

Bases: BaseRootMixin

OwnerAddressStructuredSchema.

buildingNumber: str | None

country: str | None

model_config: ClassVar[ConfigDict] = {'extra': 'forbid', 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

postCode: str | None

streetName: str | None

townName: str | None

class nordigen_cli.models.model.PaginatedEndUserAgreementList(*, mymeta: ~typing.Annotated[dict[str, ~typing.Any] | None, <nordigen_cli.models.mixins.OmitIfNone object at 0x7fb0c0f8d4f0>] = None, count: int, next: ~pydantic.networks.AnyUrl | None = None, previous: ~pydantic.networks.AnyUrl | None = None, results: list[~nordigen_cli.models.model.EndUserAgreement])

Bases: BaseRootMixin

count: int

model_config: ClassVar[ConfigDict] = {'extra': 'forbid', 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

next: AnyUrl | None

previous: AnyUrl | None

results: list[EndUserAgreement]

class nordigen_cli.models.model.PaginatedRequisitionList(*, mymeta: ~typing.Annotated[dict[str, ~typing.Any] | None, <nordigen_cli.models.mixins.OmitIfNone object at 0x7fb0c0f8d4f0>] = None, count: int, next: ~pydantic.networks.AnyUrl | None = None, previous: ~pydantic.networks.AnyUrl | None = None, results: list[~nordigen_cli.models.model.Requisition])

Bases: BaseRootMixin

count: int

model_config: ClassVar[ConfigDict] = {'extra': 'forbid', 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

next: AnyUrl | None

previous: AnyUrl | None

results: list[Requisition]

class nordigen_cli.models.model.Requisition(*, mymeta: ~typing.Annotated[dict[str, ~typing.Any] | None, <nordigen_cli.models.mixins.OmitIfNone object at 0x7fb0c0f8d4f0>] = None, id: ~uuid.UUID | None = None, created: ~datetime.datetime | None = None, redirect: ~pydantic.networks.AnyUrl, status: ~nordigen_cli.models.model.StatusEnum | None = None, institution_id: str | None, agreement: ~uuid.UUID | None = None, reference: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=256, pattern=None)] | None = None, accounts: list[~uuid.UUID] | None = None, user_language: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=5, pattern=None)] | None = None, link: ~pydantic.networks.AnyUrl | None = 'https://ob.gocardless.com/psd2/start/3fa85f64-5717-4562-b3fc-2c963f66afa6/{$INSTITUTION_ID}', ssn: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=64, pattern=None)] | None = None, account_selection: bool | None = False, redirect_immediate: bool | None = False)

Bases: BaseRootMixin

RequisitionSerializer.

account_selection: bool | None

accounts: list[UUID] | None

agreement: UUID | None

created: datetime | None

id: UUID | None

institution_id: str | None

link: AnyUrl | None

model_config: ClassVar[ConfigDict] = {'extra': 'forbid', 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

redirect: AnyUrl

redirect_immediate: bool | None

reference: Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=256, pattern=None)] | None

ssn: Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=64, pattern=None)] | None

status: StatusEnum | None

user_language: Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=5, pattern=None)] | None

classmethod validate_empty_agreement(value)

classmethod validate_empty_link(value)

class nordigen_cli.models.model.RequisitionRequest(*, mymeta: ~typing.Annotated[dict[str, ~typing.Any] | None, <nordigen_cli.models.mixins.OmitIfNone object at 0x7fb0c0f8d4f0>] = None, redirect: ~pydantic.networks.AnyUrl, institution_id: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=None, pattern=None)], agreement: ~uuid.UUID | None = None, reference: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=256, pattern=None)] | None = None, user_language: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=5, pattern=None)] | None = None, ssn: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=64, pattern=None)] | None = None, account_selection: bool | None = False, redirect_immediate: bool | None = False)

Bases: BaseRootMixin

RequisitionSerializer.

account_selection: bool | None

agreement: UUID | None

institution_id: Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=None, pattern=None)]

model_config: ClassVar[ConfigDict] = {'extra': 'forbid', 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

redirect: AnyUrl

redirect_immediate: bool | None

reference: Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=256, pattern=None)] | None

ssn: Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=64, pattern=None)] | None

user_language: Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=5, pattern=None)] | None

class nordigen_cli.models.model.SpectacularJWTObtain(*, mymeta: ~typing.Annotated[dict[str, ~typing.Any] | None, <nordigen_cli.models.mixins.OmitIfNone object at 0x7fb0c0f8d4f0>] = None, access: str | None = None, access_expires: int | None = 86400, refresh: str | None = None, refresh_expires: int | None = 2592000)

Bases: BaseRootMixin

Obtain new JWT pair.

access: Annotated[str | None, FieldInfo(annotation=NoneType, required=False, default=None, description='Your access token')]

access_expires: Annotated[int | None, FieldInfo(annotation=NoneType, required=False, default=86400, description='Access token expires in seconds')]

model_config: ClassVar[ConfigDict] = {'extra': 'forbid', 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

refresh: Annotated[str | None, FieldInfo(annotation=NoneType, required=False, default=None, description='Your refresh token')]

refresh_expires: int | None

class nordigen_cli.models.model.SpectacularJWTRefresh(*, mymeta: ~typing.Annotated[dict[str, ~typing.Any] | None, <nordigen_cli.models.mixins.OmitIfNone object at 0x7fb0c0f8d4f0>] = None, access: str | None = None, access_expires: int | None = 86400)

Bases: BaseRootMixin

Refresh Access token.

access: str | None

access_expires: int | None

model_config: ClassVar[ConfigDict] = {'extra': 'forbid', 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class nordigen_cli.models.model.SpectacularRequisition(*, mymeta: ~typing.Annotated[dict[str, ~typing.Any] | None, <nordigen_cli.models.mixins.OmitIfNone object at 0x7fb0c0f8d4f0>] = None, id: ~uuid.UUID | None = None, created: ~datetime.datetime | None = None, redirect: ~pydantic.networks.AnyUrl, status: ~nordigen_cli.models.model.StatusEnum | None = None, institution_id: str, agreement: ~uuid.UUID | None = None, reference: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=256, pattern=None)] | None = None, accounts: list[~uuid.UUID] | None = <factory>, user_language: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=5, pattern=None)] | None = None, link: ~pydantic.networks.AnyUrl | None = 'https://ob.gocardless.com/psd2/start/3fa85f64-5717-4562-b3fc-2c963f66afa6/{$INSTITUTION_ID}', ssn: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=64, pattern=None)] | None = None, account_selection: bool | None = False, redirect_immediate: bool | None = False)

Bases: BaseRootMixin

Create requisition.

account_selection: bool | None

accounts: Annotated[list[UUID] | None, FieldInfo(annotation=NoneType, required=False, default_factory=list, description='array of account IDs retrieved within ascope of this requisition')]

agreement: UUID | None

created: datetime | None

id: UUID | None

institution_id: str

link: AnyUrl | None

model_config: ClassVar[ConfigDict] = {'extra': 'forbid', 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

redirect: AnyUrl

redirect_immediate: bool | None

reference: Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=256, pattern=None)] | None

ssn: Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=64, pattern=None)] | None

status: StatusEnum | None

user_language: Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=None, max_length=5, pattern=None)] | None

class nordigen_cli.models.model.StatusEnum(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

CR = 'CR'

ER = 'ER'

EX = 'EX'

GA = 'GA'

GC = 'GC'

ID = 'ID'

LN = 'LN'

RJ = 'RJ'

SA = 'SA'

SU = 'SU'

UA = 'UA'

class nordigen_cli.models.model.TransactionAmountSchema(*, mymeta: ~typing.Annotated[dict[str, ~typing.Any] | None, <nordigen_cli.models.mixins.OmitIfNone object at 0x7fb0c0f8d4f0>] = None, amount: str, currency: str)

Bases: BaseRootMixin

TransactionAmountSchema.

amount: str

currency: str

model_config: ClassVar[ConfigDict] = {'extra': 'forbid', 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class nordigen_cli.models.model.TransactionSchema(*, mymeta: ~typing.Annotated[dict[str, ~typing.Any] | None, <nordigen_cli.models.mixins.OmitIfNone object at 0x7fb0c0f8d4f0>] = None, transactionId: str | None = None, entryReference: str | None = None, endToEndId: str | None = None, mandateId: str | None = None, checkId: str | None = None, creditorId: str | None = None, bookingDate: str | None = None, valueDate: str | None = None, bookingDateTime: str | None = None, valueDateTime: str | None = None, transactionAmount: ~nordigen_cli.models.model.TransactionAmountSchema, currencyExchange: list[~nordigen_cli.models.model.CurrencyExchangeSchema] | None = None, creditorName: str | None = None, creditorAccount: ~nordigen_cli.models.model.AccountSchema | None = None, ultimateCreditor: str | None = None, debtorName: str | None = None, debtorAccount: ~nordigen_cli.models.model.AccountSchema | None = None, ultimateDebtor: str | None = None, remittanceInformationUnstructured: str | None = None, remittanceInformationUnstructuredArray: list[str] | None = None, remittanceInformationStructured: str | None = None, remittanceInformationStructuredArray: list[str] | None = None, additionalInformation: str | None = None, purposeCode: str | None = None, bankTransactionCode: str | None = None, proprietaryBankTransactionCode: str | None = None, internalTransactionId: str | None = None)

Bases: BaseRootMixin

TransactionSchema.

additionalInformation: str | None

bankTransactionCode: str | None

bookingDate: str | None

bookingDateTime: str | None

checkId: str | None

creditorAccount: AccountSchema | None

creditorId: str | None

creditorName: str | None

currencyExchange: list[CurrencyExchangeSchema] | None

debtorAccount: AccountSchema | None

debtorName: str | None

endToEndId: str | None

entryReference: str | None

internalTransactionId: str | None

mandateId: str | None

model_config: ClassVar[ConfigDict] = {'extra': 'forbid', 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

proprietaryBankTransactionCode: str | None

purposeCode: str | None

remittanceInformationStructured: str | None

remittanceInformationStructuredArray: list[str] | None

remittanceInformationUnstructured: str | None

remittanceInformationUnstructuredArray: list[str] | None

transactionAmount: Annotated[TransactionAmountSchema, FieldInfo(annotation=NoneType, required=True, description='transactionAmount')]

transactionId: str | None

ultimateCreditor: str | None

ultimateDebtor: str | None

valueDate: str | None

valueDateTime: str | None

3.1.1.4.4. nordigen_cli.models.renderable module

class nordigen_cli.models.renderable.ReprAccountTransactions

Bases: ReprAdapter

A representation of a transaction schema that can be rendered in the CLI.

classmethod from_model(model: AccountTransactions) → list[ReprAccountTransactions]

Convert a model to a representation.

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class nordigen_cli.models.renderable.ReprTransactionSchema(*, valueDateTime: str, bookingDateTime: str, transactionId: str, transactionAmount: str, transactionCurrency: str, remittanceInformationUnstructured: str, creditorName: str | None)

Bases: ReprAdapter

A representation of a transaction schema that can be rendered in the CLI.

bookingDateTime: str

creditorName: Annotated[str | None, FieldInfo(annotation=NoneType, required=True, alias='creditorName', alias_priority=2)]

classmethod from_model(model: TransactionSchema) → ReprTransactionSchema

Convert a model to a representation.

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

remittanceInformationUnstructured: str

transactionAmount: str

transactionCurrency: str

transactionId: str

valueDateTime: str

3.1.1.4.5. nordigen_cli.models.token module

class nordigen_cli.models.token.AccessToken(*, token: Annotated[str, AfterValidator(func=validate_jwt_format)], expires_str: int = 86400, expires_at: datetime = None)

Bases: BaseToken

as_nord_dict()

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class nordigen_cli.models.token.BaseToken(*, token: Annotated[str, AfterValidator(func=validate_jwt_format)], expires_str: int = 86400, expires_at: datetime = None)

Bases: BaseModel

classmethod compute_expires_at(values)

Compute expires_at from expires_str.

expires_at: datetime

expires_str: int

classmethod from_dict(data: dict)

classmethod from_json(json_str: str)

classmethod from_jwt_str(jwt_str: str)

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

token: Annotated[str, AfterValidator(func=validate_jwt_format)]

classmethod validate_token(value)

exception nordigen_cli.models.token.JWTValidationError(title, line_errors, input_type='python', hide_input=False)

Bases: ValidationError

class nordigen_cli.models.token.RefreshToken(*, token: Annotated[str, AfterValidator(func=validate_jwt_format)], expires_str: int = 86400, expires_at: datetime = None)

Bases: BaseToken

as_nord_dict()

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

exception nordigen_cli.models.token.TokenLoadingError(original_exception: Exception)

Bases: Exception

original_exception: Exception

nordigen_cli.models.token.validate_jwt_format(value)

3.1.1.4.6. Module contents