Skip to content

AmendBenefitApplicationInput

Source code in docs_src/capo_partnercentral_benefits/types/amend_benefit_application_input.py
class AmendBenefitApplicationInput(TypedDict, closed=True):
    catalog: "capo_partnercentral_benefits.types.catalog_name.CatalogName"
    """<p>The catalog identifier that specifies which benefit catalog the application belongs to.</p>"""
    client_token: "str"
    """<p>A unique, case-sensitive identifier to ensure idempotent processing of the amendment request.</p>"""
    revision: "str"
    """<p>The current revision number of the benefit application to ensure optimistic concurrency control.</p>"""
    identifier: "capo_partnercentral_benefits.types.benefit_application_identifier.BenefitApplicationIdentifier"
    """<p>The unique identifier of the benefit application to be amended.</p>"""
    amendment_reason: "str"
    """<p>A descriptive reason explaining why the benefit application is being amended.</p>"""
    amendments: "capo_partnercentral_benefits.types.amendment_list.AmendmentList"
    """<p>A list of specific field amendments to apply to the benefit application.</p>"""

amendment_reason instance-attribute

amendment_reason: str

A descriptive reason explaining why the benefit application is being amended.

amendments instance-attribute

amendments: AmendmentList

A list of specific field amendments to apply to the benefit application.

catalog instance-attribute

catalog: CatalogName

The catalog identifier that specifies which benefit catalog the application belongs to.

client_token instance-attribute

client_token: str

A unique, case-sensitive identifier to ensure idempotent processing of the amendment request.

identifier instance-attribute

The unique identifier of the benefit application to be amended.

revision instance-attribute

revision: str

The current revision number of the benefit application to ensure optimistic concurrency control.