Skip to content

CreatePartnershipRequest

Source code in docs_src/capo_b2bi/types/create_partnership_request.py
class CreatePartnershipRequest(TypedDict, closed=True):
    profile_id: "capo_b2bi.types.profile_id.ProfileId"
    """<p>Specifies the unique, system-generated identifier for the profile connected to this partnership.</p>"""
    name: "capo_b2bi.types.partner_name.PartnerName"
    """<p>Specifies a descriptive name for the partnership.</p>"""
    email: "capo_b2bi.types.email.Email"
    """<p>Specifies the email address associated with this trading partner.</p>"""
    phone: NotRequired["capo_b2bi.types.phone.Phone"]
    """<p>Specifies the phone number associated with the partnership.</p>"""
    capabilities: "capo_b2bi.types.partnership_capabilities.PartnershipCapabilities"
    """<p>Specifies a list of the capabilities associated with this partnership.</p>"""
    capability_options: NotRequired[
        "capo_b2bi.types.capability_options.CapabilityOptions"
    ]
    """<p>Specify the structure that contains the details for the associated capabilities.</p>"""
    client_token: NotRequired["str"]
    """<p>Reserved for future use.</p>"""
    tags: NotRequired["capo_b2bi.types.tag_list.TagList"]
    """<p>Specifies the key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to resources (capabilities, partnerships, and so on) for any purpose.</p>"""

capabilities instance-attribute

Specifies a list of the capabilities associated with this partnership.

capability_options instance-attribute

capability_options: NotRequired[CapabilityOptions]

Specify the structure that contains the details for the associated capabilities.

client_token instance-attribute

client_token: NotRequired[str]

Reserved for future use.

email instance-attribute

email: Email

Specifies the email address associated with this trading partner.

name instance-attribute

Specifies a descriptive name for the partnership.

phone instance-attribute

phone: NotRequired[Phone]

Specifies the phone number associated with the partnership.

profile_id instance-attribute

profile_id: ProfileId

Specifies the unique, system-generated identifier for the profile connected to this partnership.

tags instance-attribute

tags: NotRequired[TagList]

Specifies the key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to resources (capabilities, partnerships, and so on) for any purpose.