Skip to content

ValidityTerm

Source code in docs_src/capo_marketplace_agreement/types/validity_term.py
class ValidityTerm(TypedDict, closed=True):
    type: NotRequired[
        "capo_marketplace_agreement.types.unversioned_term_type.UnversionedTermType"
    ]
    """<p>Category of the term being updated. </p>"""
    id: NotRequired["capo_marketplace_agreement.types.term_id.TermId"]
    """<p>The unique identifier for the term.</p>"""
    agreement_duration: NotRequired[
        "capo_marketplace_agreement.types.bounded_string.BoundedString"
    ]
    """<p>Defines the duration that the agreement remains active. If <code>AgreementStartDate</code> isn’t provided, the agreement duration is relative to the agreement signature time. The duration is represented in the ISO_8601 format.</p>"""
    agreement_start_date: NotRequired[
        "capo_marketplace_agreement.types.timestamp.Timestamp"
    ]
    """<p>Defines the date when agreement starts. The agreement starts at 00:00:00.000 UTC on the date provided. If <code>AgreementStartDate</code> isn’t provided, the agreement start date is determined based on agreement signature time.</p>"""
    agreement_end_date: NotRequired[
        "capo_marketplace_agreement.types.timestamp.Timestamp"
    ]
    """<p>Defines the date when the agreement ends. The agreement ends at 23:59:59.999 UTC on the date provided. If <code>AgreementEndDate</code> isn’t provided, the agreement end date is determined by the validity of individual terms.</p>"""

agreement_duration instance-attribute

agreement_duration: NotRequired[BoundedString]

Defines the duration that the agreement remains active. If AgreementStartDate isn’t provided, the agreement duration is relative to the agreement signature time. The duration is represented in the ISO_8601 format.

agreement_end_date instance-attribute

agreement_end_date: NotRequired[Timestamp]

Defines the date when the agreement ends. The agreement ends at 23:59:59.999 UTC on the date provided. If AgreementEndDate isn’t provided, the agreement end date is determined by the validity of individual terms.

agreement_start_date instance-attribute

agreement_start_date: NotRequired[Timestamp]

Defines the date when agreement starts. The agreement starts at 00:00:00.000 UTC on the date provided. If AgreementStartDate isn’t provided, the agreement start date is determined based on agreement signature time.

id instance-attribute

id: NotRequired[TermId]

The unique identifier for the term.

type instance-attribute

type: NotRequired[UnversionedTermType]

Category of the term being updated.