Skip to content

UpdateBenefitApplicationInput

Source code in docs_src/capo_partnercentral_benefits/types/update_benefit_application_input.py
class UpdateBenefitApplicationInput(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 update request.</p>"""
    name: NotRequired[
        "capo_partnercentral_benefits.types.benefit_application_name.BenefitApplicationName"
    ]
    """<p>The updated human-readable name for the benefit application.</p>"""
    description: NotRequired[
        "capo_partnercentral_benefits.types.benefit_application_description.BenefitApplicationDescription"
    ]
    """<p>The updated detailed description of the benefit application.</p>"""
    identifier: "capo_partnercentral_benefits.types.benefit_application_identifier.BenefitApplicationIdentifier"
    """<p>The unique identifier of the benefit application to update.</p>"""
    revision: "str"
    """<p>The current revision number of the benefit application to ensure optimistic concurrency control.</p>"""
    benefit_application_details: NotRequired["object"]
    """<p>Updated detailed information and requirements specific to the benefit being requested.</p>"""
    partner_contacts: NotRequired[
        "capo_partnercentral_benefits.types.contacts.Contacts"
    ]
    """<p>Updated contact information for partner representatives responsible for this benefit application.</p>"""
    file_details: NotRequired[
        "capo_partnercentral_benefits.types.file_input_details.FileInputDetails"
    ]
    """<p>Updated supporting documents and files attached to the benefit application.</p>"""

benefit_application_details instance-attribute

benefit_application_details: NotRequired[object]

Updated detailed information and requirements specific to the benefit being requested.

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 update request.

description instance-attribute

description: NotRequired[BenefitApplicationDescription]

The updated detailed description of the benefit application.

file_details instance-attribute

file_details: NotRequired[FileInputDetails]

Updated supporting documents and files attached to the benefit application.

identifier instance-attribute

The unique identifier of the benefit application to update.

name instance-attribute

name: NotRequired[BenefitApplicationName]

The updated human-readable name for the benefit application.

partner_contacts instance-attribute

partner_contacts: NotRequired[Contacts]

Updated contact information for partner representatives responsible for this benefit application.

revision instance-attribute

revision: str

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