ImpexiumClient

Attributes

AddExamScoresInput module-attribute

AddExamScoresInput = List['ExamScoreData']

AddOrUpdateAListOfCustomFieldsPerOrganizationInput module-attribute

AddOrUpdateAListOfCustomFieldsPerOrganizationInput = List['CustomFieldValueData']

AddCategoriesForAnOrganizationInput module-attribute

AddCategoriesForAnOrganizationInput = List['SaveCategoryBasicData']

AddCategoriesForAnIndividualInput module-attribute

AddCategoriesForAnIndividualInput = List['SaveCategoryBasicData']

RegisterAnIndividualForAFreeSessionInput module-attribute

RegisterAnIndividualForAFreeSessionInput = List['SessionRegistrationData']

AddOrUpdateAListOfCustomFieldsPerIndividualInput module-attribute

AddOrUpdateAListOfCustomFieldsPerIndividualInput = List[Dict[str, Any]]

MarkRegistrantAttendedInput module-attribute

MarkRegistrantAttendedInput = List[Dict[str, Any]]

TRIGGER_OPERATIONS module-attribute

TRIGGER_OPERATIONS: Dict[str, Dict[str, Any]] = {'When-Individual-Created': {'operation_id': 'When-Individual-Created', 'path': '/{connectionId}/api/v1/Webhooks/IndividualCreated', 'method': 'post', 'required_parameters': ['body'], 'callback_payload_type': None}, 'When-Individual-Deleted': {'operation_id': 'When-Individual-Deleted', 'path': '/{connectionId}/api/v1/Webhooks/Individual.Deleted', 'method': 'post', 'required_parameters': ['body'], 'callback_payload_type': None}, 'When-Individual-Request-Forgotten': {'operation_id': 'When-Individual-Request-Forgotten', 'path': '/{connectionId}/api/v1/Webhooks/Individual.RequestToBeForgotten', 'method': 'post', 'required_parameters': ['body'], 'callback_payload_type': None}, 'When-product-purchased': {'operation_id': 'When-product-purchased', 'path': '/{connectionId}/api/v1/Webhooks/ProductPurchased', 'method': 'post', 'required_parameters': ['body'], 'callback_payload_type': None}, 'When-Committee-Member-Updated': {'operation_id': 'When-Committee-Member-Updated', 'path': '/{connectionId}/api/v1/Webhooks/CommitteeMemberUpdated', 'method': 'post', 'required_parameters': ['body'], 'callback_payload_type': None}, 'When-purchase-cancelled': {'operation_id': 'When-purchase-cancelled', 'path': '/{connectionId}/api/v1/Webhooks/PurchaseCancelled', 'method': 'post', 'required_parameters': ['body'], 'callback_payload_type': None}, 'When-Request-Updated': {'operation_id': 'When-Request-Updated', 'path': '/{connectionId}/api/v1/Webhooks/RequestUpdated', 'method': 'post', 'required_parameters': ['body'], 'callback_payload_type': None}, 'When-Email-Updated': {'operation_id': 'When-Email-Updated', 'path': '/{connectionId}/api/v1/Webhooks/EmailUpdated', 'method': 'post', 'required_parameters': ['body'], 'callback_payload_type': None}, 'When-Customer-Custom-Field-Value-Updated': {'operation_id': 'When-Customer-Custom-Field-Value-Updated', 'path': '/{connectionId}/api/v1/Webhooks/Customer.CustomFieldValueUpdated', 'method': 'post', 'required_parameters': ['body'], 'callback_payload_type': None}, 'When-Customer-Is-Merged': {'operation_id': 'When-Customer-Is-Merged', 'path': '/{connectionId}/api/v1/Webhooks/Customer.Merged', 'method': 'post', 'required_parameters': ['body'], 'callback_payload_type': None}, 'When-Customer-Relationship-Updated': {'operation_id': 'When-Customer-Relationship-Updated', 'path': '/{connectionId}/api/v1/Webhooks/Customer.RelationshipUpdated', 'method': 'post', 'required_parameters': ['body'], 'callback_payload_type': None}, 'When-Customer-Phone-Updated': {'operation_id': 'When-Customer-Phone-Updated', 'path': '/{connectionId}/api/v1/Webhooks/Customer.PhoneUpdated', 'method': 'post', 'required_parameters': ['body'], 'callback_payload_type': None}, 'When-Customer-Address-Updated': {'operation_id': 'When-Customer-Address-Updated', 'path': '/{connectionId}/api/v1/Webhooks/Customer.AddressUpdated', 'method': 'post', 'required_parameters': ['body'], 'callback_payload_type': None}, 'When-Event-Registration-Substituted': {'operation_id': 'When-Event-Registration-Substituted', 'path': '/{connectionId}/api/v1/Webhooks/Event.Registration.Substituted', 'method': 'post', 'required_parameters': ['body'], 'callback_payload_type': None}, 'When-Purchase-Paid': {'operation_id': 'When-Purchase-Paid', 'path': '/{connectionId}/api/v1/Webhooks/Purchase.Paid', 'method': 'post', 'required_parameters': ['body'], 'callback_payload_type': None}, 'When-Membership-Terminated': {'operation_id': 'When-Membership-Terminated', 'path': '/{connectionId}/api/v1/Webhooks/Membership.Terminated', 'method': 'post', 'required_parameters': ['body'], 'callback_payload_type': None}}

Classes

GetAbandonedCheckoutsResponse dataclass

GetAbandonedCheckoutsResponse(page_number: Optional[int] = None, data_list: Optional[List[AbandonedCheckoutData]] = None)

Response for Get Abandoned Checkouts

Attributes

page_number class-attribute instance-attribute

page_number: Optional[int] = field(default=None, metadata={'wire_name': 'pageNumber'})

Page Number

data_list class-attribute instance-attribute

data_list: Optional[List[AbandonedCheckoutData]] = field(default=None, metadata={'wire_name': 'dataList'})

dataList

ListAllExhibitorsResponse dataclass

ListAllExhibitorsResponse(page_number: Optional[int] = None, data_list: Optional[List[ExhibitorData]] = None)

Response for List All Exhibitors

Attributes

page_number class-attribute instance-attribute

page_number: Optional[int] = field(default=None, metadata={'wire_name': 'pageNumber'})

Page Number

data_list class-attribute instance-attribute

data_list: Optional[List[ExhibitorData]] = field(default=None, metadata={'wire_name': 'dataList'})

dataList

ListOfExamsResponse dataclass

ListOfExamsResponse(page_number: Optional[int] = None, data_list: Optional[List[ExamData]] = None)

Response for List of Exams

Attributes

page_number class-attribute instance-attribute

page_number: Optional[int] = field(default=None, metadata={'wire_name': 'pageNumber'})

Page Number

data_list class-attribute instance-attribute

data_list: Optional[List[ExamData]] = field(default=None, metadata={'wire_name': 'dataList'})

dataList

ListRegistrantsResponse dataclass

ListRegistrantsResponse(page_number: Optional[int] = None, data_list: Optional[List[RegistrantData]] = None)

Response for List Registrants

Attributes

page_number class-attribute instance-attribute

page_number: Optional[int] = field(default=None, metadata={'wire_name': 'pageNumber'})

Page Number.

data_list class-attribute instance-attribute

data_list: Optional[List[RegistrantData]] = field(default=None, metadata={'wire_name': 'dataList'})

dataList

GetCourseAttendeesResponse dataclass

GetCourseAttendeesResponse(page_number: Optional[int] = None, data_list: Optional[List[CourseAttendeeData]] = None)

Response for Get Course Attendees

Attributes

page_number class-attribute instance-attribute

page_number: Optional[int] = field(default=None, metadata={'wire_name': 'pageNumber'})

Page Number.

data_list class-attribute instance-attribute

data_list: Optional[List[CourseAttendeeData]] = field(default=None, metadata={'wire_name': 'dataList'})

dataList

ExamScoreResultData dataclass

ExamScoreResultData(individual_record_number: Optional[str] = None, status: Optional[str] = None, message: Optional[str] = None)

Response for Add Exam Scores

Attributes

individual_record_number class-attribute instance-attribute

individual_record_number: Optional[str] = field(default=None, metadata={'wire_name': 'individualRecordNumber'})

Individual Record Number.

status class-attribute instance-attribute

status: Optional[str] = None

Status.

message class-attribute instance-attribute

message: Optional[str] = None

Message.

FindMembersByNameResponse dataclass

FindMembersByNameResponse(page_number: Optional[int] = None, data_list: Optional[List[ContactData]] = None)

Response for Find Members by Name

Attributes

page_number class-attribute instance-attribute

page_number: Optional[int] = field(default=None, metadata={'wire_name': 'pageNumber'})

Page Number.

data_list class-attribute instance-attribute

data_list: Optional[List[ContactData]] = field(default=None, metadata={'wire_name': 'dataList'})

dataList

GetPurchasesForAnIndividualResponse dataclass

GetPurchasesForAnIndividualResponse(page_number: Optional[int] = None, data_list: Optional[List[PurchasedItemData]] = None)

Response for Get Purchases for an Individual

Attributes

page_number class-attribute instance-attribute

page_number: Optional[int] = field(default=None, metadata={'wire_name': 'pageNumber'})

Page Number.

data_list class-attribute instance-attribute

data_list: Optional[List[PurchasedItemData]] = field(default=None, metadata={'wire_name': 'dataList'})

dataList

CustomFieldResultData dataclass

CustomFieldResultData(status: Optional[str] = None, message: Optional[str] = None, custom_field_name: Optional[str] = None)

Response for Add or Update a List of Custom Fields Per Organization

Attributes

status class-attribute instance-attribute

status: Optional[str] = None

Status.

message class-attribute instance-attribute

message: Optional[str] = None

Message.

custom_field_name class-attribute instance-attribute

custom_field_name: Optional[str] = field(default=None, metadata={'wire_name': 'customFieldName'})

Custom Field Name.

CustomFieldData dataclass

CustomFieldData(name: Optional[str] = None, caption: Optional[str] = None, value: Optional[str] = None)

Response for Get Individual Custom Field Values

Attributes

name class-attribute instance-attribute

name: Optional[str] = None

Name.

caption class-attribute instance-attribute

caption: Optional[str] = None

Caption.

value class-attribute instance-attribute

value: Optional[str] = None

Custom Field Value. For multi-selects, use "|" as delimiter.

ListAllEventCancellationsByEventResponse dataclass

ListAllEventCancellationsByEventResponse(page_number: Optional[int] = None, data_list: Optional[List[RegistrantCancellationData]] = None)

Response for List All Event Cancellations by Event

Attributes

page_number class-attribute instance-attribute

page_number: Optional[int] = field(default=None, metadata={'wire_name': 'pageNumber'})

Page Number.

data_list class-attribute instance-attribute

data_list: Optional[List[RegistrantCancellationData]] = field(default=None, metadata={'wire_name': 'dataList'})

dataList

GetAllOpenOrdersForAnIndividualResponse dataclass

GetAllOpenOrdersForAnIndividualResponse(page_number: Optional[int] = None, data_list: Optional[List[PayableOrderData]] = None)

Response for Get All Open Orders for an Individual

Attributes

page_number class-attribute instance-attribute

page_number: Optional[int] = field(default=None, metadata={'wire_name': 'pageNumber'})

Page Number

data_list class-attribute instance-attribute

data_list: Optional[List[PayableOrderData]] = field(default=None, metadata={'wire_name': 'dataList'})

dataList

ListCompletedUserTasksByUserIdOrEmailResponse dataclass

ListCompletedUserTasksByUserIdOrEmailResponse(page_number: Optional[int] = None, data_list: Optional[List[UserTaskData]] = None)

Response for List Completed User Tasks by User ID or Email

Attributes

page_number class-attribute instance-attribute

page_number: Optional[int] = field(default=None, metadata={'wire_name': 'pageNumber'})

Page Number.

data_list class-attribute instance-attribute

data_list: Optional[List[UserTaskData]] = field(default=None, metadata={'wire_name': 'dataList'})

dataList

ListPendingUserTasksByUserIdOrEmailResponse dataclass

ListPendingUserTasksByUserIdOrEmailResponse(page_number: Optional[int] = None, data_list: Optional[List[UserTaskData]] = None)

Response for List Pending User Tasks by User ID or Email

Attributes

page_number class-attribute instance-attribute

page_number: Optional[int] = field(default=None, metadata={'wire_name': 'pageNumber'})

Page Number.

data_list class-attribute instance-attribute

data_list: Optional[List[UserTaskData]] = field(default=None, metadata={'wire_name': 'dataList'})

dataList

TaskData dataclass

TaskData(task_number: Optional[str] = None, title: Optional[str] = None, category: Optional[str] = None, description: Optional[str] = None, start_date: Optional[str] = None, due_date: Optional[str] = None)

Response for Update Task by Task Number

Attributes

task_number class-attribute instance-attribute

task_number: Optional[str] = field(default=None, metadata={'wire_name': 'taskNumber'})

Task Number.

title class-attribute instance-attribute

title: Optional[str] = None

Title.

category class-attribute instance-attribute

category: Optional[str] = None

Category.

description class-attribute instance-attribute

description: Optional[str] = None

Description.

start_date class-attribute instance-attribute

start_date: Optional[str] = field(default=None, metadata={'wire_name': 'startDate'})

Start Date.

due_date class-attribute instance-attribute

due_date: Optional[str] = field(default=None, metadata={'wire_name': 'dueDate'})

Due Date.

ListAllCountriesResponse dataclass

ListAllCountriesResponse(page_number: Optional[int] = None, data_list: Optional[List[CountryData]] = None)

Response for List All Countries

Attributes

page_number class-attribute instance-attribute

page_number: Optional[int] = field(default=None, metadata={'wire_name': 'pageNumber'})

Page Number

data_list class-attribute instance-attribute

data_list: Optional[List[CountryData]] = field(default=None, metadata={'wire_name': 'dataList'})

dataList

GetAllStatesByCountryResponse dataclass

GetAllStatesByCountryResponse(page_number: Optional[int] = None, data_list: Optional[List[StateProvinceData]] = None)

Response for Get All States by Country

Attributes

page_number class-attribute instance-attribute

page_number: Optional[int] = field(default=None, metadata={'wire_name': 'pageNumber'})

Page Number

data_list class-attribute instance-attribute

data_list: Optional[List[StateProvinceData]] = field(default=None, metadata={'wire_name': 'dataList'})

dataList

ListAllExhibitsResponse dataclass

ListAllExhibitsResponse(page_number: Optional[int] = None, data_list: Optional[List[ExhibitData]] = None)

Response for List All Exhibits

Attributes

page_number class-attribute instance-attribute

page_number: Optional[int] = field(default=None, metadata={'wire_name': 'pageNumber'})

Page Number

data_list class-attribute instance-attribute

data_list: Optional[List[ExhibitData]] = field(default=None, metadata={'wire_name': 'dataList'})

dataList

RequestUpdateData dataclass

RequestUpdateData(request_number: Optional[str] = None, closed_date: Optional[str] = None)

Response for Update Customer Request

Attributes

request_number class-attribute instance-attribute

request_number: Optional[str] = field(default=None, metadata={'wire_name': 'requestNumber'})

Request Number.

closed_date class-attribute instance-attribute

closed_date: Optional[str] = field(default=None, metadata={'wire_name': 'closedDate'})

Closed Date.

ListOfCustomerRelationshipsResponse dataclass

ListOfCustomerRelationshipsResponse(page_number: Optional[int] = None, data_list: Optional[List[RelationshipTypeData]] = None)

Response for List of Customer Relationships

Attributes

page_number class-attribute instance-attribute

page_number: Optional[int] = field(default=None, metadata={'wire_name': 'pageNumber'})

Page Number.

data_list class-attribute instance-attribute

data_list: Optional[List[RelationshipTypeData]] = field(default=None, metadata={'wire_name': 'dataList'})

dataList

ListAllOpenCustomerRequestResponse dataclass

ListAllOpenCustomerRequestResponse(page_number: Optional[int] = None, data_list: Optional[List[RequestData]] = None)

Response for List All Open Customer Request

Attributes

page_number class-attribute instance-attribute

page_number: Optional[int] = field(default=None, metadata={'wire_name': 'pageNumber'})

Page Number.

data_list class-attribute instance-attribute

data_list: Optional[List[RequestData]] = field(default=None, metadata={'wire_name': 'dataList'})

dataList

MembershipData dataclass

MembershipData(membership_type: Optional[str] = None, membership_type_id: Optional[str] = None, code: Optional[str] = None, expire_date: Optional[str] = None, grace_expire_date: Optional[str] = None, inherited_membership_benefits: Optional[bool] = None, renewal_url: Optional[str] = None, join_date: Optional[str] = None, terminate_date: Optional[str] = None, effective_date: Optional[str] = None, membership_unique_id: Optional[str] = None, terms_list: Optional[List[Dict[str, Any]]] = None)

Response for Get Organization Inactive Memberships

Attributes

membership_type class-attribute instance-attribute

membership_type: Optional[str] = field(default=None, metadata={'wire_name': 'membershipType'})

Membership Type.

membership_type_id class-attribute instance-attribute

membership_type_id: Optional[str] = field(default=None, metadata={'wire_name': 'membershipTypeId'})

Membership Type ID.

code class-attribute instance-attribute

code: Optional[str] = None

Code.

expire_date class-attribute instance-attribute

expire_date: Optional[str] = field(default=None, metadata={'wire_name': 'expireDate'})

Expire Date.

grace_expire_date class-attribute instance-attribute

grace_expire_date: Optional[str] = field(default=None, metadata={'wire_name': 'graceExpireDate'})

Grace Expire Date.

inherited_membership_benefits class-attribute instance-attribute

inherited_membership_benefits: Optional[bool] = field(default=None, metadata={'wire_name': 'inheritedMembershipBenefits'})

Inherited Membership Benefits.

renewal_url class-attribute instance-attribute

renewal_url: Optional[str] = field(default=None, metadata={'wire_name': 'renewalUrl'})

Renewal URL.

join_date class-attribute instance-attribute

join_date: Optional[str] = field(default=None, metadata={'wire_name': 'joinDate'})

Join Date.

terminate_date class-attribute instance-attribute

terminate_date: Optional[str] = field(default=None, metadata={'wire_name': 'terminateDate'})

Terminate Date.

effective_date class-attribute instance-attribute

effective_date: Optional[str] = field(default=None, metadata={'wire_name': 'effectiveDate'})

Effective Date.

membership_unique_id class-attribute instance-attribute

membership_unique_id: Optional[str] = field(default=None, metadata={'wire_name': 'membershipUniqueId'})

Membership Unique ID.

terms_list class-attribute instance-attribute

terms_list: Optional[List[Dict[str, Any]]] = field(default=None, metadata={'wire_name': 'termsList'})

Terms List

UserTaskData dataclass

UserTaskData(task_number: Optional[str] = None, title: Optional[str] = None, category: Optional[str] = None, description: Optional[str] = None, assigned_by: Optional[str] = None, start_date: Optional[str] = None, due_date: Optional[str] = None, progress: Optional[str] = None, completed_date: Optional[str] = None)

Response for Update User Task Progress or Mark as Completed

Attributes

task_number class-attribute instance-attribute

task_number: Optional[str] = field(default=None, metadata={'wire_name': 'taskNumber'})

Task Number.

title class-attribute instance-attribute

title: Optional[str] = None

Title.

category class-attribute instance-attribute

category: Optional[str] = None

Category.

description class-attribute instance-attribute

description: Optional[str] = None

Description.

assigned_by class-attribute instance-attribute

assigned_by: Optional[str] = field(default=None, metadata={'wire_name': 'assignedBy'})

Assigned By.

start_date class-attribute instance-attribute

start_date: Optional[str] = field(default=None, metadata={'wire_name': 'startDate'})

Start Date.

due_date class-attribute instance-attribute

due_date: Optional[str] = field(default=None, metadata={'wire_name': 'dueDate'})

Due Date.

progress class-attribute instance-attribute

progress: Optional[str] = None

Progress.

completed_date class-attribute instance-attribute

completed_date: Optional[str] = field(default=None, metadata={'wire_name': 'completedDate'})

Completed Date.

IndividualData dataclass

IndividualData(first_name: Optional[str] = None, last_name: Optional[str] = None, middle_name: Optional[str] = None, preferred_first_name: Optional[str] = None, second_last_name: Optional[str] = None, prefix: Optional[str] = None, suffix: Optional[str] = None, gender: Optional[str] = None, primary_organization: Optional[Dict[str, Any]] = None, committees: Optional[List[Dict[str, Any]]] = None, security_roles: Optional[List[Dict[str, Any]]] = None, user: Optional[Dict[str, Any]] = None, designation_data: Optional[List[Dict[str, Any]]] = None, relationships: Optional[List[Dict[str, Any]]] = None, job_roles: Optional[List[Dict[str, Any]]] = None, tags: Optional[List[str]] = None, id: Optional[str] = None, customer_type: Optional[str] = None, record_number: Optional[str] = None, title: Optional[str] = None, name: Optional[str] = None, addresses: Optional[List[Dict[str, Any]]] = None, email: Optional[str] = None, image_uri: Optional[str] = None, twitter: Optional[str] = None, linked_in: Optional[str] = None, emails: Optional[List[Dict[str, Any]]] = None, phones: Optional[List[Dict[str, Any]]] = None, web_site: Optional[str] = None, memberships: Optional[List[Dict[str, Any]]] = None, category: Optional[str] = None, categories: Optional[List[Dict[str, Any]]] = None, custom_fields: Optional[List[Dict[str, Any]]] = None, show_in_directory: Optional[bool] = None, links: Optional[List[Dict[str, Any]]] = None, old_id: Optional[str] = None, is_deceased: Optional[bool] = None)

Response for Find Members (Individuals) by First Name

Attributes

first_name class-attribute instance-attribute

first_name: Optional[str] = field(default=None, metadata={'wire_name': 'firstName'})

First Name.

last_name class-attribute instance-attribute

last_name: Optional[str] = field(default=None, metadata={'wire_name': 'lastName'})

Last Name.

middle_name class-attribute instance-attribute

middle_name: Optional[str] = field(default=None, metadata={'wire_name': 'middleName'})

Middle Name.

preferred_first_name class-attribute instance-attribute

preferred_first_name: Optional[str] = field(default=None, metadata={'wire_name': 'preferredFirstName'})

Preferred First Name.

second_last_name class-attribute instance-attribute

second_last_name: Optional[str] = field(default=None, metadata={'wire_name': 'secondLastName'})

Second Last Name.

prefix class-attribute instance-attribute

prefix: Optional[str] = None

Prefix.

suffix class-attribute instance-attribute

suffix: Optional[str] = None

Suffix.

gender class-attribute instance-attribute

gender: Optional[str] = None

Gender.

committees class-attribute instance-attribute

committees: Optional[List[Dict[str, Any]]] = None

Committees.

security_roles class-attribute instance-attribute

security_roles: Optional[List[Dict[str, Any]]] = field(default=None, metadata={'wire_name': 'securityRoles'})

Security Roles.

designation_data class-attribute instance-attribute

designation_data: Optional[List[Dict[str, Any]]] = field(default=None, metadata={'wire_name': 'designationData'})

Designations.

relationships class-attribute instance-attribute

relationships: Optional[List[Dict[str, Any]]] = None

Relationships.

job_roles class-attribute instance-attribute

job_roles: Optional[List[Dict[str, Any]]] = field(default=None, metadata={'wire_name': 'jobRoles'})

Job Roles.

tags class-attribute instance-attribute

tags: Optional[List[str]] = None

Tags.

id class-attribute instance-attribute

id: Optional[str] = None

Individual Id.

customer_type class-attribute instance-attribute

customer_type: Optional[str] = field(default=None, metadata={'wire_name': 'customerType'})

Customer Type.

record_number class-attribute instance-attribute

record_number: Optional[str] = field(default=None, metadata={'wire_name': 'recordNumber'})

Record Number.

title class-attribute instance-attribute

title: Optional[str] = None

Title.

name class-attribute instance-attribute

name: Optional[str] = None

Name.

addresses class-attribute instance-attribute

addresses: Optional[List[Dict[str, Any]]] = None

Addresses.

email class-attribute instance-attribute

email: Optional[str] = None

Email.

image_uri class-attribute instance-attribute

image_uri: Optional[str] = field(default=None, metadata={'wire_name': 'imageUri'})

Image URI.

twitter class-attribute instance-attribute

twitter: Optional[str] = None

Twitter.

linked_in class-attribute instance-attribute

linked_in: Optional[str] = field(default=None, metadata={'wire_name': 'linkedIn'})

LinkedIn.

emails class-attribute instance-attribute

emails: Optional[List[Dict[str, Any]]] = None

Emails.

phones class-attribute instance-attribute

phones: Optional[List[Dict[str, Any]]] = None

Phones.

web_site class-attribute instance-attribute

web_site: Optional[str] = field(default=None, metadata={'wire_name': 'webSite'})

Website.

memberships class-attribute instance-attribute

memberships: Optional[List[Dict[str, Any]]] = None

Memberships.

category class-attribute instance-attribute

category: Optional[str] = None

Category.

categories class-attribute instance-attribute

categories: Optional[List[Dict[str, Any]]] = None

Categories.

custom_fields class-attribute instance-attribute

custom_fields: Optional[List[Dict[str, Any]]] = field(default=None, metadata={'wire_name': 'customFields'})

Custom Fields.

show_in_directory class-attribute instance-attribute

show_in_directory: Optional[bool] = field(default=None, metadata={'wire_name': 'showInDirectory'})

Show In Directory.

links class-attribute instance-attribute

links: Optional[List[Dict[str, Any]]] = None

Links.

old_id class-attribute instance-attribute

old_id: Optional[str] = field(default=None, metadata={'wire_name': 'oldId'})

Old Id.

is_deceased class-attribute instance-attribute

is_deceased: Optional[bool] = field(default=None, metadata={'wire_name': 'isDeceased'})

Is Deceased.

ListOfAllOrganizationMembersResponse dataclass

ListOfAllOrganizationMembersResponse(page_number: Optional[int] = None, data_list: Optional[List[OrganizationData]] = None)

Response for List of All Organization Members

Attributes

page_number class-attribute instance-attribute

page_number: Optional[int] = field(default=None, metadata={'wire_name': 'pageNumber'})

Page Number.

data_list class-attribute instance-attribute

data_list: Optional[List[OrganizationData]] = field(default=None, metadata={'wire_name': 'dataList'})

dataList

ListOfAllIndividualMembersResponse dataclass

ListOfAllIndividualMembersResponse(page_number: Optional[int] = None, data_list: Optional[List[IndividualData]] = None)

Response for List of All Individual Members

Attributes

page_number class-attribute instance-attribute

page_number: Optional[int] = field(default=None, metadata={'wire_name': 'pageNumber'})

Page Number.

data_list class-attribute instance-attribute

data_list: Optional[List[IndividualData]] = field(default=None, metadata={'wire_name': 'dataList'})

dataList

GetListOfActiveCertificationsForAnOrganizationResponse dataclass

GetListOfActiveCertificationsForAnOrganizationResponse(page_number: Optional[int] = None, data_list: Optional[List[CertificationData]] = None)

Response for Get List of Active Certifications for an Organization

Attributes

page_number class-attribute instance-attribute

page_number: Optional[int] = field(default=None, metadata={'wire_name': 'pageNumber'})

Page Number.

data_list class-attribute instance-attribute

data_list: Optional[List[CertificationData]] = field(default=None, metadata={'wire_name': 'dataList'})

dataList

GetListOfActiveCertificationsForAnIndividualResponse dataclass

GetListOfActiveCertificationsForAnIndividualResponse(page_number: Optional[int] = None, data_list: Optional[List[CertificationData]] = None)

Response for Get List of Active Certifications for an Individual

Attributes

page_number class-attribute instance-attribute

page_number: Optional[int] = field(default=None, metadata={'wire_name': 'pageNumber'})

Page Number.

data_list class-attribute instance-attribute

data_list: Optional[List[CertificationData]] = field(default=None, metadata={'wire_name': 'dataList'})

dataList

GetAListOfLicensesResponse dataclass

GetAListOfLicensesResponse(page_number: Optional[int] = None, data_list: Optional[List[LicenseData]] = None)

Response for Get a List of Licenses

Attributes

page_number class-attribute instance-attribute

page_number: Optional[int] = field(default=None, metadata={'wire_name': 'pageNumber'})

Page Number.

data_list class-attribute instance-attribute

data_list: Optional[List[LicenseData]] = field(default=None, metadata={'wire_name': 'dataList'})

dataList

ListAllAwardsResponse dataclass

ListAllAwardsResponse(page_number: Optional[int] = None, data_list: Optional[List[AwardData]] = None)

Response for List All Awards

Attributes

page_number class-attribute instance-attribute

page_number: Optional[int] = field(default=None, metadata={'wire_name': 'pageNumber'})

Page Number.

data_list class-attribute instance-attribute

data_list: Optional[List[AwardData]] = field(default=None, metadata={'wire_name': 'dataList'})

dataList

FindMembersOrIndividualsByNameResponse dataclass

FindMembersOrIndividualsByNameResponse(page_number: Optional[int] = None, data_list: Optional[List[IndividualData]] = None)

Response for Find Members (Individuals) by Name

Attributes

page_number class-attribute instance-attribute

page_number: Optional[int] = field(default=None, metadata={'wire_name': 'pageNumber'})

Page Number.

data_list class-attribute instance-attribute

data_list: Optional[List[IndividualData]] = field(default=None, metadata={'wire_name': 'dataList'})

dataList

GetAListOfAllServicesOfAnOrganizationResponse dataclass

GetAListOfAllServicesOfAnOrganizationResponse(page_number: Optional[int] = None, data_list: Optional[List[ServiceData]] = None)

Response for Get a List of All Services of an Organization

Attributes

page_number class-attribute instance-attribute

page_number: Optional[int] = field(default=None, metadata={'wire_name': 'pageNumber'})

Page Number.

data_list class-attribute instance-attribute

data_list: Optional[List[ServiceData]] = field(default=None, metadata={'wire_name': 'dataList'})

dataList

ServiceData dataclass

ServiceData(code: Optional[str] = None, name: Optional[str] = None)

Response for Add a Service to an Organization

Attributes

code class-attribute instance-attribute

code: Optional[str] = None

Code.

name class-attribute instance-attribute

name: Optional[str] = None

Name.

PhoneDataSet dataclass

PhoneDataSet(id: Optional[str] = None, primary: Optional[bool] = None, type_: Optional[int] = None, country: Optional[Dict[str, Any]] = None, show_in_directory: Optional[bool] = None, number: Optional[str] = None, extension: Optional[str] = None, type_name: Optional[str] = None)

Response for Update Phone for an Individual

Attributes

id class-attribute instance-attribute

id: Optional[str] = None

ID.

primary class-attribute instance-attribute

primary: Optional[bool] = None

Is Primary.

type_ class-attribute instance-attribute

type_: Optional[int] = field(default=None, metadata={'wire_name': 'type'})

Type.

show_in_directory class-attribute instance-attribute

show_in_directory: Optional[bool] = field(default=None, metadata={'wire_name': 'showInDirectory'})

Show In Directory.

number class-attribute instance-attribute

number: Optional[str] = None

Number.

extension class-attribute instance-attribute

extension: Optional[str] = None

Extension.

type_name class-attribute instance-attribute

type_name: Optional[str] = field(default=None, metadata={'wire_name': 'typeName'})

Type Name.

DeleteAnIndividualWebLinkInput dataclass

DeleteAnIndividualWebLinkInput(type_: Optional[str] = None, url: Optional[str] = None)

Delete an Individual Web Link

Attributes

type_ class-attribute instance-attribute

type_: Optional[str] = field(default=None, metadata={'wire_name': 'type'})

Type.

url class-attribute instance-attribute

url: Optional[str] = None

Url.

AddWebLinkForIndividualInput dataclass

AddWebLinkForIndividualInput(type_: Optional[str] = None, url: Optional[str] = None)

Add Web Link for Individual

Attributes

type_ class-attribute instance-attribute

type_: Optional[str] = field(default=None, metadata={'wire_name': 'type'})

Type.

url class-attribute instance-attribute

url: Optional[str] = None

Url.

GetNomineesByCommitteeResponse dataclass

GetNomineesByCommitteeResponse(page_number: Optional[int] = None, data_list: Optional[List[CommitteeNomineeData]] = None)

Response for Get Nominees by Committee

Attributes

page_number class-attribute instance-attribute

page_number: Optional[int] = field(default=None, metadata={'wire_name': 'pageNumber'})

Page Number.

data_list class-attribute instance-attribute

data_list: Optional[List[CommitteeNomineeData]] = field(default=None, metadata={'wire_name': 'dataList'})

Data List

GetOrganizationsActiveSubscriptionsResponse dataclass

GetOrganizationsActiveSubscriptionsResponse(page_number: Optional[int] = None, data_list: Optional[List[SubscriptionData]] = None)

Response for Get Organization's Active Subscriptions

Attributes

page_number class-attribute instance-attribute

page_number: Optional[int] = field(default=None, metadata={'wire_name': 'pageNumber'})

Page Number.

data_list class-attribute instance-attribute

data_list: Optional[List[SubscriptionData]] = field(default=None, metadata={'wire_name': 'dataList'})

dataList

DeleteAnOrganizationWebLinkInput dataclass

DeleteAnOrganizationWebLinkInput(type_: Optional[str] = None, url: Optional[str] = None)

Delete an Organization Web Link

Attributes

type_ class-attribute instance-attribute

type_: Optional[str] = field(default=None, metadata={'wire_name': 'type'})

Type.

url class-attribute instance-attribute

url: Optional[str] = None

Url.

AddWebLinkForOrganizationInput dataclass

AddWebLinkForOrganizationInput(type_: Optional[str] = None, url: Optional[str] = None)

Add Web Link for Organization

Attributes

type_ class-attribute instance-attribute

type_: Optional[str] = field(default=None, metadata={'wire_name': 'type'})

Type.

url class-attribute instance-attribute

url: Optional[str] = None

Url.

GetOrganizationsRelationshipsResponse dataclass

GetOrganizationsRelationshipsResponse(page_number: Optional[int] = None, data_list: Optional[List[RelationshipData]] = None)

Response for Get Organization's Relationships

Attributes

page_number class-attribute instance-attribute

page_number: Optional[int] = field(default=None, metadata={'wire_name': 'pageNumber'})

Page Number.

data_list class-attribute instance-attribute

data_list: Optional[List[RelationshipData]] = field(default=None, metadata={'wire_name': 'dataList'})

DataList

AddressSaveData dataclass

AddressSaveData(id: Optional[str] = None, primary: Optional[bool] = None, line1: Optional[str] = None, line2: Optional[str] = None, line3: Optional[str] = None, city: Optional[str] = None, state: Optional[str] = None, zipcode: Optional[str] = None, country: Optional[str] = None, type_: Optional[str] = None, show_in_directory: Optional[bool] = None, is_preferred_shipping: Optional[bool] = None, is_preferred_billing: Optional[bool] = None, is_bad_address: Optional[bool] = None)

Response for Add or Update Address to Organization

Attributes

id class-attribute instance-attribute

id: Optional[str] = None

ID.

primary class-attribute instance-attribute

primary: Optional[bool] = None

Primary.

line1 class-attribute instance-attribute

line1: Optional[str] = None

Line 1.

line2 class-attribute instance-attribute

line2: Optional[str] = None

Line 2.

line3 class-attribute instance-attribute

line3: Optional[str] = None

Line 3.

city class-attribute instance-attribute

city: Optional[str] = None

City.

state class-attribute instance-attribute

state: Optional[str] = None

State.

zipcode class-attribute instance-attribute

zipcode: Optional[str] = None

Zipcode.

country class-attribute instance-attribute

country: Optional[str] = None

Country.

type_ class-attribute instance-attribute

type_: Optional[str] = field(default=None, metadata={'wire_name': 'type'})

Type.

show_in_directory class-attribute instance-attribute

show_in_directory: Optional[bool] = field(default=None, metadata={'wire_name': 'showInDirectory'})

Show In Directory.

is_preferred_shipping class-attribute instance-attribute

is_preferred_shipping: Optional[bool] = field(default=None, metadata={'wire_name': 'isPreferredShipping'})

Is Preferred Shipping.

is_preferred_billing class-attribute instance-attribute

is_preferred_billing: Optional[bool] = field(default=None, metadata={'wire_name': 'isPreferredBilling'})

Is Preferred Billing.

is_bad_address class-attribute instance-attribute

is_bad_address: Optional[bool] = field(default=None, metadata={'wire_name': 'isBadAddress'})

Is Bad Address.

GetUpcomingEventsResponse dataclass

GetUpcomingEventsResponse(page_number: Optional[int] = None, data_list: Optional[List[EventData]] = None)

Response for Get Upcoming Events

Attributes

page_number class-attribute instance-attribute

page_number: Optional[int] = field(default=None, metadata={'wire_name': 'pageNumber'})

Page Number.

data_list class-attribute instance-attribute

data_list: Optional[List[EventData]] = field(default=None, metadata={'wire_name': 'dataList'})

DataList

GetCommitteeInformationForAnIndividualResponse dataclass

GetCommitteeInformationForAnIndividualResponse(page_number: Optional[int] = None, data_list: Optional[List[CommitteeMemberData]] = None)

Response for Get Committee Information for an Individual

Attributes

page_number class-attribute instance-attribute

page_number: Optional[int] = field(default=None, metadata={'wire_name': 'pageNumber'})

Page Number

data_list class-attribute instance-attribute

data_list: Optional[List[CommitteeMemberData]] = field(default=None, metadata={'wire_name': 'dataList'})

Data List.

GetAllEventsResponse dataclass

GetAllEventsResponse(page_number: Optional[int] = None, data_list: Optional[List[EventData]] = None)

Response for Get All Events

Attributes

page_number class-attribute instance-attribute

page_number: Optional[int] = field(default=None, metadata={'wire_name': 'pageNumber'})

Page Number.

data_list class-attribute instance-attribute

data_list: Optional[List[EventData]] = field(default=None, metadata={'wire_name': 'dataList'})

DataList

GetAllEventRegistrationsInformationForAnIndividualResponse dataclass

GetAllEventRegistrationsInformationForAnIndividualResponse(page_number: Optional[int] = None, data_list: Optional[List[RegistrationData]] = None)

Response for Get All Event Registrations Information for an Individual

Attributes

page_number class-attribute instance-attribute

page_number: Optional[int] = field(default=None, metadata={'wire_name': 'pageNumber'})

Page Number.

data_list class-attribute instance-attribute

data_list: Optional[List[RegistrationData]] = field(default=None, metadata={'wire_name': 'dataList'})

dataList

GetIndividualsRelationshipsResponse dataclass

GetIndividualsRelationshipsResponse(page_number: Optional[int] = None, data_list: Optional[List[RelationshipData]] = None)

Response for Get Individual's Relationships

Attributes

page_number class-attribute instance-attribute

page_number: Optional[int] = field(default=None, metadata={'wire_name': 'pageNumber'})

Page Number.

data_list class-attribute instance-attribute

data_list: Optional[List[RelationshipData]] = field(default=None, metadata={'wire_name': 'dataList'})

Data List.

UpdateAnIndividualEmailInput dataclass

UpdateAnIndividualEmailInput(primary: Optional[bool] = None, address: Optional[str] = None, type_: Optional[str] = None, show_in_directory: Optional[bool] = None)

Update an Individual Email

Attributes

primary class-attribute instance-attribute

primary: Optional[bool] = None

Primary.

address class-attribute instance-attribute

address: Optional[str] = None

Address.

type_ class-attribute instance-attribute

type_: Optional[str] = field(default=None, metadata={'wire_name': 'type'})

Type.

show_in_directory class-attribute instance-attribute

show_in_directory: Optional[bool] = field(default=None, metadata={'wire_name': 'showInDirectory'})

Show In Directory

SaveRelationshipForOrganizationInput dataclass

SaveRelationshipForOrganizationInput(relationship_name: Optional[str] = None, related_to_customer_record_number: Optional[str] = None, reciprocal_relationship_name: Optional[str] = None, is_primary: Optional[bool] = None, start_date: Optional[str] = None, end_date: Optional[str] = None, is_reciprocal_primary: Optional[bool] = None, title: Optional[str] = None)

Save Relationship for Organization

Attributes

relationship_name class-attribute instance-attribute

relationship_name: Optional[str] = field(default=None, metadata={'wire_name': 'relationshipName'})

Relationship Name.

related_to_customer_record_number class-attribute instance-attribute

related_to_customer_record_number: Optional[str] = field(default=None, metadata={'wire_name': 'relatedToCustomerRecordNumber'})

Related To Customer Record Number.

reciprocal_relationship_name class-attribute instance-attribute

reciprocal_relationship_name: Optional[str] = field(default=None, metadata={'wire_name': 'reciprocalRelationshipName'})

Reciprocal Relationship Name.

is_primary class-attribute instance-attribute

is_primary: Optional[bool] = field(default=None, metadata={'wire_name': 'isPrimary'})

Is Primary.

start_date class-attribute instance-attribute

start_date: Optional[str] = field(default=None, metadata={'wire_name': 'startDate'})

Start Date.

end_date class-attribute instance-attribute

end_date: Optional[str] = field(default=None, metadata={'wire_name': 'endDate'})

End Date.

is_reciprocal_primary class-attribute instance-attribute

is_reciprocal_primary: Optional[bool] = field(default=None, metadata={'wire_name': 'isReciprocalPrimary'})

Is Reciprocal Primary.

title class-attribute instance-attribute

title: Optional[str] = None

Title.

AddIndividualInput dataclass

AddIndividualInput(first_name: Optional[str] = None, last_name: Optional[str] = None, email: Optional[str] = None, record_number: Optional[str] = None)

Add Individual

Attributes

first_name class-attribute instance-attribute

first_name: Optional[str] = field(default=None, metadata={'wire_name': 'firstName'})

First Name.

last_name class-attribute instance-attribute

last_name: Optional[str] = field(default=None, metadata={'wire_name': 'lastName'})

Last Name.

email class-attribute instance-attribute

email: Optional[str] = None

Email Address.

record_number class-attribute instance-attribute

record_number: Optional[str] = field(default=None, metadata={'wire_name': 'recordNumber'})

Record Number.

AddEmailToIndividualInput dataclass

AddEmailToIndividualInput(primary: Optional[bool] = None, address: Optional[str] = None, type_: Optional[str] = None, show_in_directory: Optional[bool] = None)

Add Email to Individual

Attributes

primary class-attribute instance-attribute

primary: Optional[bool] = None

Primary

address class-attribute instance-attribute

address: Optional[str] = None

Address.

type_ class-attribute instance-attribute

type_: Optional[str] = field(default=None, metadata={'wire_name': 'type'})

Type.

show_in_directory class-attribute instance-attribute

show_in_directory: Optional[bool] = field(default=None, metadata={'wire_name': 'showInDirectory'})

Show In Directory

EmailData dataclass

EmailData(primary: Optional[bool] = None, address: Optional[str] = None, type_: Optional[str] = None, show_in_directory: Optional[bool] = None)

Response for Add Email to Individual

Attributes

primary class-attribute instance-attribute

primary: Optional[bool] = None

Is Primary Email.

address class-attribute instance-attribute

address: Optional[str] = None

Address.

type_ class-attribute instance-attribute

type_: Optional[str] = field(default=None, metadata={'wire_name': 'type'})

Type.

show_in_directory class-attribute instance-attribute

show_in_directory: Optional[bool] = field(default=None, metadata={'wire_name': 'showInDirectory'})

Show In Directory.

FindMembersOrIndividualsByFirstAndLastNameResponse dataclass

FindMembersOrIndividualsByFirstAndLastNameResponse(page_number: Optional[int] = None, data_list: Optional[List[IndividualData]] = None)

Response for Find Members (Individuals) by First Name and Last Name

Attributes

page_number class-attribute instance-attribute

page_number: Optional[int] = field(default=None, metadata={'wire_name': 'pageNumber'})

Page Number.

data_list class-attribute instance-attribute

data_list: Optional[List[IndividualData]] = field(default=None, metadata={'wire_name': 'dataList'})

dataList

AddActivityInput dataclass

AddActivityInput(category: Optional[str] = None, text: Optional[str] = None, url: Optional[str] = None, activity_date: Optional[str] = None)

Add Activity

Attributes

category class-attribute instance-attribute

category: Optional[str] = None

Category.

text class-attribute instance-attribute

text: Optional[str] = None

Text.

url class-attribute instance-attribute

url: Optional[str] = None

URL.

activity_date class-attribute instance-attribute

activity_date: Optional[str] = field(default=None, metadata={'wire_name': 'activityDate'})

Activity Date.

FindIndividualIdOrEmailResponse dataclass

FindIndividualIdOrEmailResponse(page_number: Optional[int] = None, data_list: Optional[List[IndividualData]] = None)

Response for Find Individual by Id or Email or Record Number

Attributes

page_number class-attribute instance-attribute

page_number: Optional[int] = field(default=None, metadata={'wire_name': 'pageNumber'})

Page Number.

data_list class-attribute instance-attribute

data_list: Optional[List[IndividualData]] = field(default=None, metadata={'wire_name': 'dataList'})

Data List.

AddRelationshipToIndividualInput dataclass

AddRelationshipToIndividualInput(relationship_name: Optional[str] = None, related_to_customer_record_number: Optional[str] = None, reciprocal_relationship_name: Optional[str] = None, is_primary: Optional[bool] = None, is_reciprocal_primary: Optional[bool] = None, start_date: Optional[str] = None, end_date: Optional[str] = None)

Add Relationship to Individual

Attributes

relationship_name class-attribute instance-attribute

relationship_name: Optional[str] = field(default=None, metadata={'wire_name': 'relationshipName'})

Relationship Name.

related_to_customer_record_number class-attribute instance-attribute

related_to_customer_record_number: Optional[str] = field(default=None, metadata={'wire_name': 'relatedToCustomerRecordNumber'})

Related To Customer Record Number.

reciprocal_relationship_name class-attribute instance-attribute

reciprocal_relationship_name: Optional[str] = field(default=None, metadata={'wire_name': 'reciprocalRelationshipName'})

Reciprocal Relationship Name.

is_primary class-attribute instance-attribute

is_primary: Optional[bool] = field(default=None, metadata={'wire_name': 'isPrimary'})

Is Primary.

is_reciprocal_primary class-attribute instance-attribute

is_reciprocal_primary: Optional[bool] = field(default=None, metadata={'wire_name': 'isReciprocalPrimary'})

Is Reciprocal Primary.

start_date class-attribute instance-attribute

start_date: Optional[str] = field(default=None, metadata={'wire_name': 'startDate'})

Start Date.

end_date class-attribute instance-attribute

end_date: Optional[str] = field(default=None, metadata={'wire_name': 'endDate'})

End Date.

IndividualsLookupByNameResponse dataclass

IndividualsLookupByNameResponse(page_number: Optional[int] = None, data_list: Optional[List[IndividualLookupBasicData]] = None)

Response for Lookup Individuals

Attributes

page_number class-attribute instance-attribute

page_number: Optional[int] = field(default=None, metadata={'wire_name': 'pageNumber'})

Page Number.

data_list class-attribute instance-attribute

data_list: Optional[List[IndividualLookupBasicData]] = field(default=None, metadata={'wire_name': 'dataList'})

Data List.

AddToCommitteeResponse dataclass

AddToCommitteeResponse(id: Optional[str] = None, first_name: Optional[str] = None, last_name: Optional[str] = None, code: Optional[str] = None, record_number: Optional[str] = None, position: Optional[str] = None, position_code: Optional[str] = None, start_date: Optional[str] = None, end_date: Optional[str] = None, primary_organization: Optional[Dict[str, Any]] = None, organization_representing: Optional[Dict[str, Any]] = None, nominated_by_customer: Optional[Dict[str, Any]] = None, addresses: Optional[List[Dict[str, Any]]] = None, phones: Optional[List[Dict[str, Any]]] = None, emails: Optional[List[Dict[str, Any]]] = None, rank: Optional[int] = None)

Response for Add Individual to Committee

Attributes

id class-attribute instance-attribute

id: Optional[str] = None

Member Id.

first_name class-attribute instance-attribute

first_name: Optional[str] = field(default=None, metadata={'wire_name': 'firstName'})

First Name.

last_name class-attribute instance-attribute

last_name: Optional[str] = field(default=None, metadata={'wire_name': 'lastName'})

Last Name.

code class-attribute instance-attribute

code: Optional[str] = None

Code.

record_number class-attribute instance-attribute

record_number: Optional[str] = field(default=None, metadata={'wire_name': 'recordNumber'})

Record Number.

position class-attribute instance-attribute

position: Optional[str] = None

Position.

position_code class-attribute instance-attribute

position_code: Optional[str] = field(default=None, metadata={'wire_name': 'positionCode'})

Position Code.

start_date class-attribute instance-attribute

start_date: Optional[str] = field(default=None, metadata={'wire_name': 'startDate'})

Start Date.

end_date class-attribute instance-attribute

end_date: Optional[str] = field(default=None, metadata={'wire_name': 'endDate'})

End Date.

rank class-attribute instance-attribute

rank: Optional[int] = None

Rank.

AddOrganizationInput dataclass

AddOrganizationInput(id: Optional[str] = None, name: Optional[str] = None, show_in_directory: Optional[bool] = None, branch_name: Optional[str] = None, website: Optional[str] = None)

Add Organization

Attributes

id class-attribute instance-attribute

id: Optional[str] = None

Id.

name class-attribute instance-attribute

name: Optional[str] = None

Name.

show_in_directory class-attribute instance-attribute

show_in_directory: Optional[bool] = field(default=None, metadata={'wire_name': 'showInDirectory'})

Show In Directory.

branch_name class-attribute instance-attribute

branch_name: Optional[str] = field(default=None, metadata={'wire_name': 'branchName'})

Branch Name.

website class-attribute instance-attribute

website: Optional[str] = None

Website.

OrganizationData dataclass

OrganizationData(contact_ids: Optional[List[str]] = None, parent_company_id: Optional[str] = None, description: Optional[str] = None, branch_name: Optional[str] = None, tags: Optional[List[str]] = None, id: Optional[str] = None, customer_type: Optional[str] = None, record_number: Optional[str] = None, title: Optional[str] = None, name: Optional[str] = None, addresses: Optional[List[Dict[str, Any]]] = None, email: Optional[str] = None, image_uri: Optional[str] = None, twitter: Optional[str] = None, linked_in: Optional[str] = None, emails: Optional[List[Dict[str, Any]]] = None, phones: Optional[List[Dict[str, Any]]] = None, web_site: Optional[str] = None, memberships: Optional[List[Dict[str, Any]]] = None, category: Optional[str] = None, categories: Optional[List[Dict[str, Any]]] = None, custom_fields: Optional[List[Dict[str, Any]]] = None, show_in_directory: Optional[bool] = None, links: Optional[List[Dict[str, Any]]] = None, old_id: Optional[str] = None)

Response for Add Organization

Attributes

contact_ids class-attribute instance-attribute

contact_ids: Optional[List[str]] = field(default=None, metadata={'wire_name': 'contactIds'})

Contact Ids.

parent_company_id class-attribute instance-attribute

parent_company_id: Optional[str] = field(default=None, metadata={'wire_name': 'parentCompanyId'})

Parent Company Id.

description class-attribute instance-attribute

description: Optional[str] = None

Description.

branch_name class-attribute instance-attribute

branch_name: Optional[str] = field(default=None, metadata={'wire_name': 'branchName'})

Branch Name.

tags class-attribute instance-attribute

tags: Optional[List[str]] = None

Tags.

id class-attribute instance-attribute

id: Optional[str] = None

Organization Id.

customer_type class-attribute instance-attribute

customer_type: Optional[str] = field(default=None, metadata={'wire_name': 'customerType'})

Customer Type.

record_number class-attribute instance-attribute

record_number: Optional[str] = field(default=None, metadata={'wire_name': 'recordNumber'})

Record Number.

title class-attribute instance-attribute

title: Optional[str] = None

Title.

name class-attribute instance-attribute

name: Optional[str] = None

Organization Name.

addresses class-attribute instance-attribute

addresses: Optional[List[Dict[str, Any]]] = None

Addresses.

email class-attribute instance-attribute

email: Optional[str] = None

Email.

image_uri class-attribute instance-attribute

image_uri: Optional[str] = field(default=None, metadata={'wire_name': 'imageUri'})

Image URI.

twitter class-attribute instance-attribute

twitter: Optional[str] = None

Twitter.

linked_in class-attribute instance-attribute

linked_in: Optional[str] = field(default=None, metadata={'wire_name': 'linkedIn'})

LinkedIn.

emails class-attribute instance-attribute

emails: Optional[List[Dict[str, Any]]] = None

Emails.

phones class-attribute instance-attribute

phones: Optional[List[Dict[str, Any]]] = None

Phones.

web_site class-attribute instance-attribute

web_site: Optional[str] = field(default=None, metadata={'wire_name': 'webSite'})

Website.

memberships class-attribute instance-attribute

memberships: Optional[List[Dict[str, Any]]] = None

Memberships.

category class-attribute instance-attribute

category: Optional[str] = None

Category.

categories class-attribute instance-attribute

categories: Optional[List[Dict[str, Any]]] = None

Categories.

custom_fields class-attribute instance-attribute

custom_fields: Optional[List[Dict[str, Any]]] = field(default=None, metadata={'wire_name': 'customFields'})

Custom Fields.

show_in_directory class-attribute instance-attribute

show_in_directory: Optional[bool] = field(default=None, metadata={'wire_name': 'showInDirectory'})

Show In Directory.

links class-attribute instance-attribute

links: Optional[List[Dict[str, Any]]] = None

Links.

old_id class-attribute instance-attribute

old_id: Optional[str] = field(default=None, metadata={'wire_name': 'oldId'})

Old Id.

UpdateOrganizationInput dataclass

UpdateOrganizationInput(name: Optional[str] = None, description: Optional[str] = None, show_in_directory: Optional[bool] = None, branch_name: Optional[str] = None, website: Optional[str] = None)

Update Organization

Attributes

name class-attribute instance-attribute

name: Optional[str] = None

Name.

description class-attribute instance-attribute

description: Optional[str] = None

Description.

show_in_directory class-attribute instance-attribute

show_in_directory: Optional[bool] = field(default=None, metadata={'wire_name': 'showInDirectory'})

Show In Directory.

branch_name class-attribute instance-attribute

branch_name: Optional[str] = field(default=None, metadata={'wire_name': 'branchName'})

Branch Name.

website class-attribute instance-attribute

website: Optional[str] = None

Website.

OrganizationLookupByNameResponse dataclass

OrganizationLookupByNameResponse(page_number: Optional[int] = None, data_list: Optional[List[OrganizationLookupBasicData]] = None)

Response for Lookup Organizations

Attributes

page_number class-attribute instance-attribute

page_number: Optional[int] = field(default=None, metadata={'wire_name': 'pageNumber'})

Page Number.

data_list class-attribute instance-attribute

data_list: Optional[List[OrganizationLookupBasicData]] = field(default=None, metadata={'wire_name': 'dataList'})

Data List.

GetAllCommitteesResponse dataclass

GetAllCommitteesResponse(page_number: Optional[int] = None, data_list: Optional[List[CommitteeData]] = None)

Response for Get All Committees

Attributes

page_number class-attribute instance-attribute

page_number: Optional[int] = field(default=None, metadata={'wire_name': 'pageNumber'})

Page Number.

data_list class-attribute instance-attribute

data_list: Optional[List[CommitteeData]] = field(default=None, metadata={'wire_name': 'dataList'})

dataList

GetPositionsByCommitteeResponse dataclass

GetPositionsByCommitteeResponse(page_number: Optional[int] = None, data_list: Optional[List[CommitteePositionData]] = None)

Response for Get Positions by Committee

Attributes

page_number class-attribute instance-attribute

page_number: Optional[int] = field(default=None, metadata={'wire_name': 'pageNumber'})

Page Number.

data_list class-attribute instance-attribute

data_list: Optional[List[CommitteePositionData]] = field(default=None, metadata={'wire_name': 'dataList'})

dataList

GetSubCommitteesResponse dataclass

GetSubCommitteesResponse(page_number: Optional[int] = None, data_list: Optional[List[CommitteeData]] = None)

Response for Get Sub-Committees

Attributes

page_number class-attribute instance-attribute

page_number: Optional[int] = field(default=None, metadata={'wire_name': 'pageNumber'})

pageNumber

data_list class-attribute instance-attribute

data_list: Optional[List[CommitteeData]] = field(default=None, metadata={'wire_name': 'dataList'})

dataList

GetIndividualsActiveSubscriptionsResponse dataclass

GetIndividualsActiveSubscriptionsResponse(page_number: Optional[int] = None, data_list: Optional[List[SubscriptionData]] = None)

Response for Get Individual's Active Subscriptions

Attributes

page_number class-attribute instance-attribute

page_number: Optional[int] = field(default=None, metadata={'wire_name': 'pageNumber'})

Page Number.

data_list class-attribute instance-attribute

data_list: Optional[List[SubscriptionData]] = field(default=None, metadata={'wire_name': 'dataList'})

dataList

ListAllIndividualsResponse dataclass

ListAllIndividualsResponse(page_number: Optional[int] = None, data_list: Optional[List[IndividualData]] = None)

Response for List all Individuals

Attributes

page_number class-attribute instance-attribute

page_number: Optional[int] = field(default=None, metadata={'wire_name': 'pageNumber'})

Page Number.

FindCustomerPhoneResponse dataclass

FindCustomerPhoneResponse(page_number: Optional[int] = None, data_list: Optional[List[Dict[str, Any]]] = None)

Response for Find Customer by Phone Number

Attributes

page_number class-attribute instance-attribute

page_number: Optional[int] = field(default=None, metadata={'wire_name': 'pageNumber'})

Page Number.

AwardsGetIndividualAwardRecipientsResponse dataclass

AwardsGetIndividualAwardRecipientsResponse(page_number: Optional[int] = None, data_list: Optional[List[AwardRecipientIndividualData]] = None)

Response for List Award Individual Recipients

Attributes

page_number class-attribute instance-attribute

page_number: Optional[int] = field(default=None, metadata={'wire_name': 'pageNumber'})

Page Number.

data_list class-attribute instance-attribute

data_list: Optional[List[AwardRecipientIndividualData]] = field(default=None, metadata={'wire_name': 'dataList'})

Data List.

AwardsGetOrganizationAwardRecipientsResponse dataclass

AwardsGetOrganizationAwardRecipientsResponse(page_number: Optional[int] = None, data_list: Optional[List[AwardRecipientOrganizationData]] = None)

Response for List Award Organization Recipients

Attributes

page_number class-attribute instance-attribute

page_number: Optional[int] = field(default=None, metadata={'wire_name': 'pageNumber'})

Page Number.

data_list class-attribute instance-attribute

data_list: Optional[List[AwardRecipientOrganizationData]] = field(default=None, metadata={'wire_name': 'dataList'})

Data List.

WhenIndividualCreatedInput dataclass

WhenIndividualCreatedInput(type_name: Optional[str] = None, secret: Optional[str] = None, call_back_url: Optional[str] = None, description: Optional[str] = None)

When an individual is created

Attributes

type_name class-attribute instance-attribute

type_name: Optional[str] = field(default=None, metadata={'wire_name': 'typeName'})

Type Name.

secret class-attribute instance-attribute

secret: Optional[str] = None

Secret.

call_back_url class-attribute instance-attribute

call_back_url: Optional[str] = field(default=None, metadata={'wire_name': 'callBackUrl'})

Callback URL.

description class-attribute instance-attribute

description: Optional[str] = None

Description.

WhenIndividualDeletedInput dataclass

WhenIndividualDeletedInput(type_name: Optional[str] = None, secret: Optional[str] = None, call_back_url: Optional[str] = None, description: Optional[str] = None)

When an individual is deleted

Attributes

type_name class-attribute instance-attribute

type_name: Optional[str] = field(default=None, metadata={'wire_name': 'typeName'})

Type Name.

secret class-attribute instance-attribute

secret: Optional[str] = None

Secret.

call_back_url class-attribute instance-attribute

call_back_url: Optional[str] = field(default=None, metadata={'wire_name': 'callBackUrl'})

Callback URL.

description class-attribute instance-attribute

description: Optional[str] = None

Description.

WhenIndividualRequestForgottenInput dataclass

WhenIndividualRequestForgottenInput(type_name: Optional[str] = None, secret: Optional[str] = None, call_back_url: Optional[str] = None, description: Optional[str] = None)

When an individual requests to be forgotten

Attributes

type_name class-attribute instance-attribute

type_name: Optional[str] = field(default=None, metadata={'wire_name': 'typeName'})

Type Name.

secret class-attribute instance-attribute

secret: Optional[str] = None

Secret.

call_back_url class-attribute instance-attribute

call_back_url: Optional[str] = field(default=None, metadata={'wire_name': 'callBackUrl'})

Callback URL.

description class-attribute instance-attribute

description: Optional[str] = None

Description.

WhenProductPurchasedInput dataclass

WhenProductPurchasedInput(id: Optional[str] = None, type_name: Optional[str] = None, filters: Optional[List[str]] = None, secret: Optional[str] = None, call_back_url: Optional[str] = None, description: Optional[str] = None)

When a product is purchased

Attributes

id class-attribute instance-attribute

id: Optional[str] = None

Id.

type_name class-attribute instance-attribute

type_name: Optional[str] = field(default=None, metadata={'wire_name': 'typeName'})

Type Name.

filters class-attribute instance-attribute

filters: Optional[List[str]] = None

Filters.

secret class-attribute instance-attribute

secret: Optional[str] = None

Secret.

call_back_url class-attribute instance-attribute

call_back_url: Optional[str] = field(default=None, metadata={'wire_name': 'callBackUrl'})

Callback URL.

description class-attribute instance-attribute

description: Optional[str] = None

Description.

WhenCommitteeMemberUpdatedInput dataclass

WhenCommitteeMemberUpdatedInput(type_name: Optional[str] = None, secret: Optional[str] = None, call_back_url: Optional[str] = None, description: Optional[str] = None)

When a committee member is updated

Attributes

type_name class-attribute instance-attribute

type_name: Optional[str] = field(default=None, metadata={'wire_name': 'typeName'})

Type Name.

secret class-attribute instance-attribute

secret: Optional[str] = None

Secret.

call_back_url class-attribute instance-attribute

call_back_url: Optional[str] = field(default=None, metadata={'wire_name': 'callBackUrl'})

Callback URL.

description class-attribute instance-attribute

description: Optional[str] = None

Description.

WhenPurchaseCancelledInput dataclass

WhenPurchaseCancelledInput(id: Optional[str] = None, type_name: Optional[str] = None, filters: Optional[List[str]] = None, secret: Optional[str] = None, call_back_url: Optional[str] = None, description: Optional[str] = None)

When a purchase is canceled

Attributes

id class-attribute instance-attribute

id: Optional[str] = None

Id.

type_name class-attribute instance-attribute

type_name: Optional[str] = field(default=None, metadata={'wire_name': 'typeName'})

Type Name.

filters class-attribute instance-attribute

filters: Optional[List[str]] = None

Filters.

secret class-attribute instance-attribute

secret: Optional[str] = None

Secret.

call_back_url class-attribute instance-attribute

call_back_url: Optional[str] = field(default=None, metadata={'wire_name': 'callBackUrl'})

Callback URL.

description class-attribute instance-attribute

description: Optional[str] = None

Description.

WhenRequestUpdatedInput dataclass

WhenRequestUpdatedInput(type_name: Optional[str] = None, secret: Optional[str] = None, call_back_url: Optional[str] = None, description: Optional[str] = None)

When a customer request is updated

Attributes

type_name class-attribute instance-attribute

type_name: Optional[str] = field(default=None, metadata={'wire_name': 'typeName'})

Type Name.

secret class-attribute instance-attribute

secret: Optional[str] = None

Secret.

call_back_url class-attribute instance-attribute

call_back_url: Optional[str] = field(default=None, metadata={'wire_name': 'callBackUrl'})

Callback URL.

description class-attribute instance-attribute

description: Optional[str] = None

Description.

WhenEmailUpdatedInput dataclass

WhenEmailUpdatedInput(type_name: Optional[str] = None, secret: Optional[str] = None, call_back_url: Optional[str] = None, description: Optional[str] = None)

When a customer email is updated

Attributes

type_name class-attribute instance-attribute

type_name: Optional[str] = field(default=None, metadata={'wire_name': 'typeName'})

Type Name.

secret class-attribute instance-attribute

secret: Optional[str] = None

Secret.

call_back_url class-attribute instance-attribute

call_back_url: Optional[str] = field(default=None, metadata={'wire_name': 'callBackUrl'})

Callback URL.

description class-attribute instance-attribute

description: Optional[str] = None

Description.

WhenCustomerCustomFieldValueUpdatedInput dataclass

WhenCustomerCustomFieldValueUpdatedInput(type_name: Optional[str] = None, filters: Optional[List[str]] = None, secret: Optional[str] = None, call_back_url: Optional[str] = None, description: Optional[str] = None)

When a customer custom field value is updated

Attributes

type_name class-attribute instance-attribute

type_name: Optional[str] = field(default=None, metadata={'wire_name': 'typeName'})

Type Name.

filters class-attribute instance-attribute

filters: Optional[List[str]] = None

Filters.

secret class-attribute instance-attribute

secret: Optional[str] = None

Secret.

call_back_url class-attribute instance-attribute

call_back_url: Optional[str] = field(default=None, metadata={'wire_name': 'callBackUrl'})

Callback URL.

description class-attribute instance-attribute

description: Optional[str] = None

Description.

WhenCustomerIsMergedInput dataclass

WhenCustomerIsMergedInput(type_name: Optional[str] = None, secret: Optional[str] = None, call_back_url: Optional[str] = None, description: Optional[str] = None)

When a customer is merged

Attributes

type_name class-attribute instance-attribute

type_name: Optional[str] = field(default=None, metadata={'wire_name': 'typeName'})

Type Name.

secret class-attribute instance-attribute

secret: Optional[str] = None

Secret.

call_back_url class-attribute instance-attribute

call_back_url: Optional[str] = field(default=None, metadata={'wire_name': 'callBackUrl'})

Callback URL.

description class-attribute instance-attribute

description: Optional[str] = None

Description.

WhenCustomerRelationshipUpdatedInput dataclass

WhenCustomerRelationshipUpdatedInput(type_name: Optional[str] = None, secret: Optional[str] = None, call_back_url: Optional[str] = None, description: Optional[str] = None)

When a customer relationship is updated

Attributes

type_name class-attribute instance-attribute

type_name: Optional[str] = field(default=None, metadata={'wire_name': 'typeName'})

Type Name.

secret class-attribute instance-attribute

secret: Optional[str] = None

Secret.

call_back_url class-attribute instance-attribute

call_back_url: Optional[str] = field(default=None, metadata={'wire_name': 'callBackUrl'})

Callback URL.

description class-attribute instance-attribute

description: Optional[str] = None

Description.

WhenCustomerPhoneUpdatedInput dataclass

WhenCustomerPhoneUpdatedInput(type_name: Optional[str] = None, secret: Optional[str] = None, call_back_url: Optional[str] = None, description: Optional[str] = None)

When a customer phone is updated

Attributes

type_name class-attribute instance-attribute

type_name: Optional[str] = field(default=None, metadata={'wire_name': 'typeName'})

Type Name.

secret class-attribute instance-attribute

secret: Optional[str] = None

Secret.

call_back_url class-attribute instance-attribute

call_back_url: Optional[str] = field(default=None, metadata={'wire_name': 'callBackUrl'})

Callback URL.

description class-attribute instance-attribute

description: Optional[str] = None

Description.

WhenCustomerAddressUpdatedInput dataclass

WhenCustomerAddressUpdatedInput(type_name: Optional[str] = None, secret: Optional[str] = None, call_back_url: Optional[str] = None, description: Optional[str] = None)

When a customer address is updated

Attributes

type_name class-attribute instance-attribute

type_name: Optional[str] = field(default=None, metadata={'wire_name': 'typeName'})

Type Name.

secret class-attribute instance-attribute

secret: Optional[str] = None

Secret.

call_back_url class-attribute instance-attribute

call_back_url: Optional[str] = field(default=None, metadata={'wire_name': 'callBackUrl'})

Callback URL.

description class-attribute instance-attribute

description: Optional[str] = None

Description.

WhenEventRegistrationSubstitutedInput dataclass

WhenEventRegistrationSubstitutedInput(type_name: Optional[str] = None, filters: Optional[List[str]] = None, secret: Optional[str] = None, call_back_url: Optional[str] = None, description: Optional[str] = None)

When an event registration is substituted

Attributes

type_name class-attribute instance-attribute

type_name: Optional[str] = field(default=None, metadata={'wire_name': 'typeName'})

Type Name.

filters class-attribute instance-attribute

filters: Optional[List[str]] = None

Filters.

secret class-attribute instance-attribute

secret: Optional[str] = None

Secret.

call_back_url class-attribute instance-attribute

call_back_url: Optional[str] = field(default=None, metadata={'wire_name': 'callBackUrl'})

Callback URL.

description class-attribute instance-attribute

description: Optional[str] = None

Description.

WhenPurchasePaidInput dataclass

WhenPurchasePaidInput(type_name: Optional[str] = None, filters: Optional[List[str]] = None, secret: Optional[str] = None, call_back_url: Optional[str] = None, description: Optional[str] = None)

When a purchase is paid

Attributes

type_name class-attribute instance-attribute

type_name: Optional[str] = field(default=None, metadata={'wire_name': 'typeName'})

Type Name.

filters class-attribute instance-attribute

filters: Optional[List[str]] = None

Filters.

secret class-attribute instance-attribute

secret: Optional[str] = None

Secret.

call_back_url class-attribute instance-attribute

call_back_url: Optional[str] = field(default=None, metadata={'wire_name': 'callBackUrl'})

Callback URL.

description class-attribute instance-attribute

description: Optional[str] = None

Description.

WhenMembershipTerminatedInput dataclass

WhenMembershipTerminatedInput(id: Optional[str] = None, type_name: Optional[str] = None, secret: Optional[str] = None, call_back_url: Optional[str] = None, description: Optional[str] = None)

When a membership is terminated

Attributes

id class-attribute instance-attribute

id: Optional[str] = None

Id.

type_name class-attribute instance-attribute

type_name: Optional[str] = field(default=None, metadata={'wire_name': 'typeName'})

Type Name.

secret class-attribute instance-attribute

secret: Optional[str] = None

Secret.

call_back_url class-attribute instance-attribute

call_back_url: Optional[str] = field(default=None, metadata={'wire_name': 'callBackUrl'})

Callback URL.

description class-attribute instance-attribute

description: Optional[str] = None

Description.

AbandonedCheckoutData dataclass

AbandonedCheckoutData(created_on: Optional[str] = None, created_by_email_address: Optional[str] = None, currency: Optional[str] = None, customer: Optional[Dict[str, Any]] = None, line_items: Optional[List[Dict[str, Any]]] = None)

Definition: AbandonedCheckoutData

Attributes

created_on class-attribute instance-attribute

created_on: Optional[str] = field(default=None, metadata={'wire_name': 'createdOn'})

Created On

created_by_email_address class-attribute instance-attribute

created_by_email_address: Optional[str] = field(default=None, metadata={'wire_name': 'createdByEmailAddress'})

Created By Email Address

currency class-attribute instance-attribute

currency: Optional[str] = None

Currency

line_items class-attribute instance-attribute

line_items: Optional[List[Dict[str, Any]]] = field(default=None, metadata={'wire_name': 'lineItems'})

Line Items

ExhibitorData dataclass

ExhibitorData(organization: Optional[Dict[str, Any]] = None, booths: Optional[List[Dict[str, Any]]] = None)

Definition: ExhibitorData

Attributes

organization class-attribute instance-attribute

organization: Optional[Dict[str, Any]] = None

Organization

booths class-attribute instance-attribute

booths: Optional[List[Dict[str, Any]]] = None

Booths

ExamData dataclass

ExamData(exam_start_date: Optional[str] = None, exam_end_date: Optional[str] = None, exam_number: Optional[str] = None, education_credits: Optional[List[Dict[str, Any]]] = None, categories: Optional[List[Dict[str, Any]]] = None, active_prices: Optional[List[Dict[str, Any]]] = None, related_products: Optional[List[Dict[str, Any]]] = None, tags: Optional[List[str]] = None, id: Optional[str] = None, code: Optional[str] = None, name: Optional[str] = None, short_description: Optional[str] = None, long_description: Optional[str] = None, type_: Optional[str] = None, url: Optional[str] = None, image_url: Optional[List[str]] = None, is_public: Optional[bool] = None, available_from: Optional[str] = None, available_until: Optional[str] = None)

Definition: ExamData

Attributes

exam_start_date class-attribute instance-attribute

exam_start_date: Optional[str] = field(default=None, metadata={'wire_name': 'examStartDate'})

Exam Start Date

exam_end_date class-attribute instance-attribute

exam_end_date: Optional[str] = field(default=None, metadata={'wire_name': 'examEndDate'})

Exam End Date

exam_number class-attribute instance-attribute

exam_number: Optional[str] = field(default=None, metadata={'wire_name': 'examNumber'})

Exam Number

education_credits class-attribute instance-attribute

education_credits: Optional[List[Dict[str, Any]]] = field(default=None, metadata={'wire_name': 'educationCredits'})

Education Credits

categories class-attribute instance-attribute

categories: Optional[List[Dict[str, Any]]] = None

categories

active_prices class-attribute instance-attribute

active_prices: Optional[List[Dict[str, Any]]] = field(default=None, metadata={'wire_name': 'activePrices'})

Active Prices

related_products class-attribute instance-attribute

related_products: Optional[List[Dict[str, Any]]] = field(default=None, metadata={'wire_name': 'relatedProducts'})

Related Products

tags class-attribute instance-attribute

tags: Optional[List[str]] = None

Tags.

id class-attribute instance-attribute

id: Optional[str] = None

ID.

code class-attribute instance-attribute

code: Optional[str] = None

Code.

name class-attribute instance-attribute

name: Optional[str] = None

Name.

short_description class-attribute instance-attribute

short_description: Optional[str] = field(default=None, metadata={'wire_name': 'shortDescription'})

Short Description.

long_description class-attribute instance-attribute

long_description: Optional[str] = field(default=None, metadata={'wire_name': 'longDescription'})

Long Description.

type_ class-attribute instance-attribute

type_: Optional[str] = field(default=None, metadata={'wire_name': 'type'})

Type.

url class-attribute instance-attribute

url: Optional[str] = None

Url.

image_url class-attribute instance-attribute

image_url: Optional[List[str]] = field(default=None, metadata={'wire_name': 'imageUrl'})

Image Url.

is_public class-attribute instance-attribute

is_public: Optional[bool] = field(default=None, metadata={'wire_name': 'isPublic'})

Is Public.

available_from class-attribute instance-attribute

available_from: Optional[str] = field(default=None, metadata={'wire_name': 'availableFrom'})

Available From.

available_until class-attribute instance-attribute

available_until: Optional[str] = field(default=None, metadata={'wire_name': 'availableUntil'})

Available Until.

RegistrantData dataclass

RegistrantData(title: Optional[str] = None, badge_name: Optional[str] = None, badge_organization: Optional[str] = None, badge_city: Optional[str] = None, badge_state: Optional[str] = None, attended_date: Optional[str] = None, sessions: Optional[List[Dict[str, Any]]] = None, itemized_custom_fields: Optional[List[Dict[str, Any]]] = None, guest_of_record_number: Optional[str] = None, registrant_type_code: Optional[str] = None, registrant_type_name: Optional[str] = None, registration_number: Optional[str] = None, bought_together_with: Optional[List[Dict[str, Any]]] = None, first_name: Optional[str] = None, last_name: Optional[str] = None, middle_name: Optional[str] = None, preferred_first_name: Optional[str] = None, second_last_name: Optional[str] = None, prefix: Optional[str] = None, suffix: Optional[str] = None, gender: Optional[str] = None, primary_organization: Optional[Dict[str, Any]] = None, id: Optional[str] = None, customer_type: Optional[str] = None, record_number: Optional[str] = None, show_in_directory: Optional[bool] = None, addresses: Optional[List[Dict[str, Any]]] = None, phones: Optional[List[Dict[str, Any]]] = None, emails: Optional[List[Dict[str, Any]]] = None)

Definition: RegistrantData

Attributes

title class-attribute instance-attribute

title: Optional[str] = None

Title.

badge_name class-attribute instance-attribute

badge_name: Optional[str] = field(default=None, metadata={'wire_name': 'badgeName'})

Badge Name

badge_organization class-attribute instance-attribute

badge_organization: Optional[str] = field(default=None, metadata={'wire_name': 'badgeOrganization'})

Badge Organization.

badge_city class-attribute instance-attribute

badge_city: Optional[str] = field(default=None, metadata={'wire_name': 'badgeCity'})

Badge City.

badge_state class-attribute instance-attribute

badge_state: Optional[str] = field(default=None, metadata={'wire_name': 'badgeState'})

Badge State.

attended_date class-attribute instance-attribute

attended_date: Optional[str] = field(default=None, metadata={'wire_name': 'attendedDate'})

Attended Date.

itemized_custom_fields class-attribute instance-attribute

itemized_custom_fields: Optional[List[Dict[str, Any]]] = field(default=None, metadata={'wire_name': 'itemizedCustomFields'})

Itemized Custom Fields

guest_of_record_number class-attribute instance-attribute

guest_of_record_number: Optional[str] = field(default=None, metadata={'wire_name': 'guestOfRecordNumber'})

Guest Of Record Number.

registrant_type_code class-attribute instance-attribute

registrant_type_code: Optional[str] = field(default=None, metadata={'wire_name': 'registrantTypeCode'})

Registrant Type Code.

registrant_type_name class-attribute instance-attribute

registrant_type_name: Optional[str] = field(default=None, metadata={'wire_name': 'registrantTypeName'})

Registrant Type Name.

registration_number class-attribute instance-attribute

registration_number: Optional[str] = field(default=None, metadata={'wire_name': 'registrationNumber'})

Registration Number.

first_name class-attribute instance-attribute

first_name: Optional[str] = field(default=None, metadata={'wire_name': 'firstName'})

First Name.

last_name class-attribute instance-attribute

last_name: Optional[str] = field(default=None, metadata={'wire_name': 'lastName'})

Last Name.

middle_name class-attribute instance-attribute

middle_name: Optional[str] = field(default=None, metadata={'wire_name': 'middleName'})

Middle Name.

preferred_first_name class-attribute instance-attribute

preferred_first_name: Optional[str] = field(default=None, metadata={'wire_name': 'preferredFirstName'})

Preferred First Name.

second_last_name class-attribute instance-attribute

second_last_name: Optional[str] = field(default=None, metadata={'wire_name': 'secondLastName'})

Second Last Name.

prefix class-attribute instance-attribute

prefix: Optional[str] = None

Prefix.

suffix class-attribute instance-attribute

suffix: Optional[str] = None

Suffix.

gender class-attribute instance-attribute

gender: Optional[str] = None

Gender.

id class-attribute instance-attribute

id: Optional[str] = None

ID.

customer_type class-attribute instance-attribute

customer_type: Optional[str] = field(default=None, metadata={'wire_name': 'customerType'})

Customer Type

record_number class-attribute instance-attribute

record_number: Optional[str] = field(default=None, metadata={'wire_name': 'recordNumber'})

Record Number.

show_in_directory class-attribute instance-attribute

show_in_directory: Optional[bool] = field(default=None, metadata={'wire_name': 'showInDirectory'})

Show In Directory.

CourseAttendeeData dataclass

CourseAttendeeData(title: Optional[str] = None, registered_date: Optional[str] = None, attended_date: Optional[str] = None, itemized_custom_fields: Optional[List[Dict[str, Any]]] = None, first_name: Optional[str] = None, last_name: Optional[str] = None, middle_name: Optional[str] = None, preferred_first_name: Optional[str] = None, second_last_name: Optional[str] = None, prefix: Optional[str] = None, suffix: Optional[str] = None, gender: Optional[str] = None, primary_organization: Optional[Dict[str, Any]] = None, id: Optional[str] = None, customer_type: Optional[str] = None, record_number: Optional[str] = None, show_in_directory: Optional[bool] = None, addresses: Optional[List[Dict[str, Any]]] = None, emails: Optional[List[Dict[str, Any]]] = None, phones: Optional[List[Dict[str, Any]]] = None)

Definition: CourseAttendeeData

Attributes

title class-attribute instance-attribute

title: Optional[str] = None

Title.

registered_date class-attribute instance-attribute

registered_date: Optional[str] = field(default=None, metadata={'wire_name': 'registeredDate'})

Registered Date.

attended_date class-attribute instance-attribute

attended_date: Optional[str] = field(default=None, metadata={'wire_name': 'attendedDate'})

Attended Date.

itemized_custom_fields class-attribute instance-attribute

itemized_custom_fields: Optional[List[Dict[str, Any]]] = field(default=None, metadata={'wire_name': 'itemizedCustomFields'})

Itemized Custom Fields

first_name class-attribute instance-attribute

first_name: Optional[str] = field(default=None, metadata={'wire_name': 'firstName'})

First Name.

last_name class-attribute instance-attribute

last_name: Optional[str] = field(default=None, metadata={'wire_name': 'lastName'})

Last Name.

middle_name class-attribute instance-attribute

middle_name: Optional[str] = field(default=None, metadata={'wire_name': 'middleName'})

Middle Name.

preferred_first_name class-attribute instance-attribute

preferred_first_name: Optional[str] = field(default=None, metadata={'wire_name': 'preferredFirstName'})

Preferred First Name.

second_last_name class-attribute instance-attribute

second_last_name: Optional[str] = field(default=None, metadata={'wire_name': 'secondLastName'})

Second Last Name.

prefix class-attribute instance-attribute

prefix: Optional[str] = None

Prefix.

suffix class-attribute instance-attribute

suffix: Optional[str] = None

Suffix

gender class-attribute instance-attribute

gender: Optional[str] = None

Gender.

id class-attribute instance-attribute

id: Optional[str] = None

ID.

customer_type class-attribute instance-attribute

customer_type: Optional[str] = field(default=None, metadata={'wire_name': 'customerType'})

Customer Type.

record_number class-attribute instance-attribute

record_number: Optional[str] = field(default=None, metadata={'wire_name': 'recordNumber'})

Record Number.

show_in_directory class-attribute instance-attribute

show_in_directory: Optional[bool] = field(default=None, metadata={'wire_name': 'showInDirectory'})

Show In Directory.

addresses class-attribute instance-attribute

addresses: Optional[List[Dict[str, Any]]] = None

Addresses.

emails class-attribute instance-attribute

emails: Optional[List[Dict[str, Any]]] = None

Emails.

phones class-attribute instance-attribute

phones: Optional[List[Dict[str, Any]]] = None

Phones.

ExamScoreData dataclass

ExamScoreData(individual_record_number: Optional[str] = None, score: Optional[str] = None)

Definition: ExamScoreData

Attributes

individual_record_number class-attribute instance-attribute

individual_record_number: Optional[str] = field(default=None, metadata={'wire_name': 'individualRecordNumber'})

Individual Record Number.

score class-attribute instance-attribute

score: Optional[str] = None

Score.

ContactData dataclass

ContactData(id: Optional[str] = None, customer_type: Optional[str] = None, record_number: Optional[str] = None, title: Optional[str] = None, name: Optional[str] = None, addresses: Optional[List[Dict[str, Any]]] = None, image_uri: Optional[str] = None, twitter: Optional[str] = None, linked_in: Optional[str] = None, emails: Optional[List[Dict[str, Any]]] = None, phones: Optional[List[Dict[str, Any]]] = None, web_site: Optional[str] = None, memberships: Optional[List[Dict[str, Any]]] = None, category: Optional[str] = None, categories: Optional[List[Dict[str, Any]]] = None, custom_fields: Optional[List[Dict[str, Any]]] = None, show_in_directory: Optional[bool] = None, links: Optional[List[Dict[str, Any]]] = None, old_id: Optional[str] = None)

Definition: ContactData

Attributes

id class-attribute instance-attribute

id: Optional[str] = None

ID.

customer_type class-attribute instance-attribute

customer_type: Optional[str] = field(default=None, metadata={'wire_name': 'customerType'})

Customer Type.

record_number class-attribute instance-attribute

record_number: Optional[str] = field(default=None, metadata={'wire_name': 'recordNumber'})

Record Number.

title class-attribute instance-attribute

title: Optional[str] = None

Title.

name class-attribute instance-attribute

name: Optional[str] = None

Name.

image_uri class-attribute instance-attribute

image_uri: Optional[str] = field(default=None, metadata={'wire_name': 'imageUri'})

Image Uri.

twitter class-attribute instance-attribute

twitter: Optional[str] = None

Twitter.

linked_in class-attribute instance-attribute

linked_in: Optional[str] = field(default=None, metadata={'wire_name': 'linkedIn'})

LinkedIn.

emails class-attribute instance-attribute

emails: Optional[List[Dict[str, Any]]] = None

emails

web_site class-attribute instance-attribute

web_site: Optional[str] = field(default=None, metadata={'wire_name': 'webSite'})

Website.

memberships class-attribute instance-attribute

memberships: Optional[List[Dict[str, Any]]] = None

Memberships.

category class-attribute instance-attribute

category: Optional[str] = None

Category.

categories class-attribute instance-attribute

categories: Optional[List[Dict[str, Any]]] = None

Categories

custom_fields class-attribute instance-attribute

custom_fields: Optional[List[Dict[str, Any]]] = field(default=None, metadata={'wire_name': 'customFields'})

Custom Fields

show_in_directory class-attribute instance-attribute

show_in_directory: Optional[bool] = field(default=None, metadata={'wire_name': 'showInDirectory'})

Show In Directory.

links class-attribute instance-attribute

links: Optional[List[Dict[str, Any]]] = None

Links

old_id class-attribute instance-attribute

old_id: Optional[str] = field(default=None, metadata={'wire_name': 'oldId'})

Old ID.

PurchasedItemData dataclass

PurchasedItemData(order_number: Optional[str] = None, product_code: Optional[str] = None, product_name: Optional[str] = None, product_type: Optional[str] = None, purchase_date: Optional[str] = None, additional_info: Optional[str] = None, quantity: Optional[int] = None, itemized_custom_fields: Optional[List[Dict[str, Any]]] = None, product_categories: Optional[List[Dict[str, Any]]] = None)

Definition: PurchasedItemData

Attributes

order_number class-attribute instance-attribute

order_number: Optional[str] = field(default=None, metadata={'wire_name': 'orderNumber'})

Order Number.

product_code class-attribute instance-attribute

product_code: Optional[str] = field(default=None, metadata={'wire_name': 'productCode'})

Product Code.

product_name class-attribute instance-attribute

product_name: Optional[str] = field(default=None, metadata={'wire_name': 'productName'})

Product Name.

product_type class-attribute instance-attribute

product_type: Optional[str] = field(default=None, metadata={'wire_name': 'productType'})

Product Type.

purchase_date class-attribute instance-attribute

purchase_date: Optional[str] = field(default=None, metadata={'wire_name': 'purchaseDate'})

Purchase Date.

additional_info class-attribute instance-attribute

additional_info: Optional[str] = field(default=None, metadata={'wire_name': 'additionalInfo'})

Additional Info.

quantity class-attribute instance-attribute

quantity: Optional[int] = None

Quantity.

itemized_custom_fields class-attribute instance-attribute

itemized_custom_fields: Optional[List[Dict[str, Any]]] = field(default=None, metadata={'wire_name': 'itemizedCustomFields'})

Itemized Custom Fields

product_categories class-attribute instance-attribute

product_categories: Optional[List[Dict[str, Any]]] = field(default=None, metadata={'wire_name': 'productCategories'})

Product Categories

CustomFieldValueData dataclass

CustomFieldValueData(name: Optional[str] = None, value: Optional[str] = None)

Definition: CustomFieldValueData

Attributes

name class-attribute instance-attribute

name: Optional[str] = None

Name.

value class-attribute instance-attribute

value: Optional[str] = None

Value.

CommitteeNomineeSaveData dataclass

CommitteeNomineeSaveData(nominee_record_number: Optional[str] = None, code: Optional[str] = None, position_code: Optional[str] = None, status: Optional[str] = None, representing_organization_record_number: Optional[str] = None, representing_organization_relationship_name: Optional[str] = None, nominated_by_customer_record_number: Optional[str] = None, committee_term: Optional[int] = None, rank: Optional[int] = None)

Definition: CommitteeNomineeSaveData

Attributes

nominee_record_number class-attribute instance-attribute

nominee_record_number: Optional[str] = field(default=None, metadata={'wire_name': 'nomineeRecordNumber'})

Nominee Record Number.

code class-attribute instance-attribute

code: Optional[str] = None

Code.

position_code class-attribute instance-attribute

position_code: Optional[str] = field(default=None, metadata={'wire_name': 'positionCode'})

Position Code.

status class-attribute instance-attribute

status: Optional[str] = None

Status.

representing_organization_record_number class-attribute instance-attribute

representing_organization_record_number: Optional[str] = field(default=None, metadata={'wire_name': 'representingOrganizationRecordNumber'})

Representing Organization Record Number.

representing_organization_relationship_name class-attribute instance-attribute

representing_organization_relationship_name: Optional[str] = field(default=None, metadata={'wire_name': 'representingOrganizationRelationshipName'})

Representing Organization Relationship Name.

nominated_by_customer_record_number class-attribute instance-attribute

nominated_by_customer_record_number: Optional[str] = field(default=None, metadata={'wire_name': 'nominatedByCustomerRecordNumber'})

Nominated By Customer Record Number.

committee_term class-attribute instance-attribute

committee_term: Optional[int] = field(default=None, metadata={'wire_name': 'committeeTerm'})

Committee Term.

rank class-attribute instance-attribute

rank: Optional[int] = None

Rank.

RegistrantCancellationData dataclass

RegistrantCancellationData(title: Optional[str] = None, registration_number: Optional[str] = None, event_cancellation_date: Optional[str] = None, guest_of_record_number: Optional[str] = None, cancelled_sessions: Optional[List[Dict[str, Any]]] = None, first_name: Optional[str] = None, last_name: Optional[str] = None, middle_name: Optional[str] = None, preferred_first_name: Optional[str] = None, second_last_name: Optional[str] = None, prefix: Optional[str] = None, suffix: Optional[str] = None, gender: Optional[str] = None, primary_organization: Optional[Dict[str, Any]] = None, id: Optional[str] = None, customer_type: Optional[str] = None, record_number: Optional[str] = None, show_in_directory: Optional[bool] = None, addresses: Optional[List[Dict[str, Any]]] = None, emails: Optional[List[Dict[str, Any]]] = None, phones: Optional[List[Dict[str, Any]]] = None)

Definition: RegistrantCancellationData

Attributes

title class-attribute instance-attribute

title: Optional[str] = None

Title.

registration_number class-attribute instance-attribute

registration_number: Optional[str] = field(default=None, metadata={'wire_name': 'registrationNumber'})

Registration Number.

event_cancellation_date class-attribute instance-attribute

event_cancellation_date: Optional[str] = field(default=None, metadata={'wire_name': 'eventCancellationDate'})

Event Cancellation Date.

guest_of_record_number class-attribute instance-attribute

guest_of_record_number: Optional[str] = field(default=None, metadata={'wire_name': 'guestOfRecordNumber'})

Guest Of Record Number.

cancelled_sessions class-attribute instance-attribute

cancelled_sessions: Optional[List[Dict[str, Any]]] = field(default=None, metadata={'wire_name': 'cancelledSessions'})

Cancelled Sessions.

first_name class-attribute instance-attribute

first_name: Optional[str] = field(default=None, metadata={'wire_name': 'firstName'})

First Name.

last_name class-attribute instance-attribute

last_name: Optional[str] = field(default=None, metadata={'wire_name': 'lastName'})

Last Name.

middle_name class-attribute instance-attribute

middle_name: Optional[str] = field(default=None, metadata={'wire_name': 'middleName'})

Middle Name.

preferred_first_name class-attribute instance-attribute

preferred_first_name: Optional[str] = field(default=None, metadata={'wire_name': 'preferredFirstName'})

Preferred First Name.

second_last_name class-attribute instance-attribute

second_last_name: Optional[str] = field(default=None, metadata={'wire_name': 'secondLastName'})

Second Last Name.

prefix class-attribute instance-attribute

prefix: Optional[str] = None

Prefix.

suffix class-attribute instance-attribute

suffix: Optional[str] = None

Suffix.

gender class-attribute instance-attribute

gender: Optional[str] = None

Gender.

primary_organization class-attribute instance-attribute

primary_organization: Optional[Dict[str, Any]] = field(default=None, metadata={'wire_name': 'primaryOrganization'})

primaryOrganization

id class-attribute instance-attribute

id: Optional[str] = None

ID.

customer_type class-attribute instance-attribute

customer_type: Optional[str] = field(default=None, metadata={'wire_name': 'customerType'})

Customer Type.

record_number class-attribute instance-attribute

record_number: Optional[str] = field(default=None, metadata={'wire_name': 'recordNumber'})

Record Number.

show_in_directory class-attribute instance-attribute

show_in_directory: Optional[bool] = field(default=None, metadata={'wire_name': 'showInDirectory'})

Show In Directory.

addresses class-attribute instance-attribute

addresses: Optional[List[Dict[str, Any]]] = None

Addresses.

emails class-attribute instance-attribute

emails: Optional[List[Dict[str, Any]]] = None

Emails

phones class-attribute instance-attribute

phones: Optional[List[Dict[str, Any]]] = None

Phones.

PayableOrderData dataclass

PayableOrderData(number: Optional[str] = None, date: Optional[str] = None, balance: Optional[float] = None, line_items: Optional[List[Dict[str, Any]]] = None, type_: Optional[str] = None, id: Optional[str] = None, customer_id: Optional[str] = None, total_amount: Optional[float] = None, title: Optional[str] = None)

Definition: PayableOrderData

Attributes

number class-attribute instance-attribute

number: Optional[str] = None

Number.

date class-attribute instance-attribute

date: Optional[str] = None

Date.

balance class-attribute instance-attribute

balance: Optional[float] = None

Balance.

line_items class-attribute instance-attribute

line_items: Optional[List[Dict[str, Any]]] = field(default=None, metadata={'wire_name': 'lineItems'})

lineItems

type_ class-attribute instance-attribute

type_: Optional[str] = field(default=None, metadata={'wire_name': 'type'})

Type.

id class-attribute instance-attribute

id: Optional[str] = None

ID.

customer_id class-attribute instance-attribute

customer_id: Optional[str] = field(default=None, metadata={'wire_name': 'customerId'})

Customer Id.

total_amount class-attribute instance-attribute

total_amount: Optional[float] = field(default=None, metadata={'wire_name': 'totalAmount'})

Total Amount.

title class-attribute instance-attribute

title: Optional[str] = None

Title.

BaseNoteData dataclass

BaseNoteData(content: Optional[str] = None, category: Optional[str] = None, is_internal: Optional[bool] = None)

Definition: BaseNoteData

Attributes

content class-attribute instance-attribute

content: Optional[str] = field(default=None, metadata={'wire_name': 'Content'})

Content.

category class-attribute instance-attribute

category: Optional[str] = field(default=None, metadata={'wire_name': 'Category'})

Category.

is_internal class-attribute instance-attribute

is_internal: Optional[bool] = field(default=None, metadata={'wire_name': 'isInternal'})

Is Internal.

TaskSaveData dataclass

TaskSaveData(title: Optional[str] = None, category: Optional[str] = None, description: Optional[str] = None, start_date: Optional[str] = None, due_date: Optional[str] = None)

Definition: TaskSaveData

Attributes

title class-attribute instance-attribute

title: Optional[str] = None

Title.

category class-attribute instance-attribute

category: Optional[str] = None

Category.

description class-attribute instance-attribute

description: Optional[str] = None

Description.

start_date class-attribute instance-attribute

start_date: Optional[str] = field(default=None, metadata={'wire_name': 'startDate'})

Start Date.

due_date class-attribute instance-attribute

due_date: Optional[str] = field(default=None, metadata={'wire_name': 'dueDate'})

Due Date.

CountryData dataclass

CountryData(id: Optional[str] = None, name: Optional[str] = None, two_letter_iso_code: Optional[str] = None, three_letter_iso_code: Optional[str] = None, code: Optional[int] = None)

Definition: CountryData

Attributes

id class-attribute instance-attribute

id: Optional[str] = None

ID.

name class-attribute instance-attribute

name: Optional[str] = None

Name.

two_letter_iso_code class-attribute instance-attribute

two_letter_iso_code: Optional[str] = field(default=None, metadata={'wire_name': 'twoLetterIsoCode'})

Two Letter Iso Code.

three_letter_iso_code class-attribute instance-attribute

three_letter_iso_code: Optional[str] = field(default=None, metadata={'wire_name': 'threeLetterIsoCode'})

Three Letter Iso Code.

code class-attribute instance-attribute

code: Optional[int] = None

Code.

StateProvinceData dataclass

StateProvinceData(id: Optional[str] = None, name: Optional[str] = None, abbreviation: Optional[str] = None, iso_code: Optional[str] = None)

Definition: StateProvinceData

Attributes

id class-attribute instance-attribute

id: Optional[str] = None

ID.

name class-attribute instance-attribute

name: Optional[str] = None

Name.

abbreviation class-attribute instance-attribute

abbreviation: Optional[str] = None

Abbreviation.

iso_code class-attribute instance-attribute

iso_code: Optional[str] = field(default=None, metadata={'wire_name': 'isoCode'})

Iso Code.

ExhibitData dataclass

ExhibitData(code: Optional[str] = None, name: Optional[str] = None, start_date: Optional[str] = None, start_time: Optional[str] = None, end_date: Optional[str] = None, end_time: Optional[str] = None, categories: Optional[List[Dict[str, Any]]] = None, short_description: Optional[str] = None, long_description: Optional[str] = None, featured_listing: Optional[Dict[str, Any]] = None)

Definition: ExhibitData

Attributes

code class-attribute instance-attribute

code: Optional[str] = None

Code.

name class-attribute instance-attribute

name: Optional[str] = None

Name.

start_date class-attribute instance-attribute

start_date: Optional[str] = field(default=None, metadata={'wire_name': 'startDate'})

Start Date.

start_time class-attribute instance-attribute

start_time: Optional[str] = field(default=None, metadata={'wire_name': 'startTime'})

Start Time.

end_date class-attribute instance-attribute

end_date: Optional[str] = field(default=None, metadata={'wire_name': 'endDate'})

End Date.

end_time class-attribute instance-attribute

end_time: Optional[str] = field(default=None, metadata={'wire_name': 'endTime'})

End Time.

categories class-attribute instance-attribute

categories: Optional[List[Dict[str, Any]]] = None

Categories

short_description class-attribute instance-attribute

short_description: Optional[str] = field(default=None, metadata={'wire_name': 'shortDescription'})

Short Description.

long_description class-attribute instance-attribute

long_description: Optional[str] = field(default=None, metadata={'wire_name': 'longDescription'})

Long Description.

RequestSaveData dataclass

RequestSaveData(requested_by_customer_record_number: Optional[str] = None, request_type: Optional[str] = None, description: Optional[str] = None, source: Optional[str] = None)

Definition: RequestSaveData

Attributes

requested_by_customer_record_number class-attribute instance-attribute

requested_by_customer_record_number: Optional[str] = field(default=None, metadata={'wire_name': 'requestedByCustomerRecordNumber'})

Requested By Customer Record Number.

request_type class-attribute instance-attribute

request_type: Optional[str] = field(default=None, metadata={'wire_name': 'requestType'})

Request Type.

description class-attribute instance-attribute

description: Optional[str] = None

Description.

source class-attribute instance-attribute

source: Optional[str] = None

Source.

RelationshipTypeData dataclass

RelationshipTypeData(name: Optional[str] = None, reciprocal_relationship_name: Optional[str] = None, relationship_type: Optional[str] = None, allow_primary: Optional[bool] = None, can_purchase_for_organization: Optional[bool] = None, can_manage_p_a_c: Optional[bool] = None, can_manage_organization: Optional[bool] = None)

Definition: RelationshipTypeData

Attributes

name class-attribute instance-attribute

name: Optional[str] = None

Name.

reciprocal_relationship_name class-attribute instance-attribute

reciprocal_relationship_name: Optional[str] = field(default=None, metadata={'wire_name': 'reciprocalRelationshipName'})

Reciprocal Relationship Name.

relationship_type class-attribute instance-attribute

relationship_type: Optional[str] = field(default=None, metadata={'wire_name': 'relationshipType'})

Relationship Type.

allow_primary class-attribute instance-attribute

allow_primary: Optional[bool] = field(default=None, metadata={'wire_name': 'allowPrimary'})

Allow Primary.

can_purchase_for_organization class-attribute instance-attribute

can_purchase_for_organization: Optional[bool] = field(default=None, metadata={'wire_name': 'canPurchaseForOrganization'})

Can Purchase For Organization.

can_manage_p_a_c class-attribute instance-attribute

can_manage_p_a_c: Optional[bool] = field(default=None, metadata={'wire_name': 'canManagePAC'})

Can Manage PAC.

can_manage_organization class-attribute instance-attribute

can_manage_organization: Optional[bool] = field(default=None, metadata={'wire_name': 'canManageOrganization'})

Can Manage Organization.

RequestData dataclass

RequestData(request_number: Optional[str] = None, request_date: Optional[str] = None, requested_by_customer_record_number: Optional[str] = None, request_type: Optional[str] = None, description: Optional[str] = None, source: Optional[str] = None, closed_date: Optional[str] = None)

Definition: RequestData

Attributes

request_number class-attribute instance-attribute

request_number: Optional[str] = field(default=None, metadata={'wire_name': 'requestNumber'})

Request Number.

request_date class-attribute instance-attribute

request_date: Optional[str] = field(default=None, metadata={'wire_name': 'requestDate'})

Request Date.

requested_by_customer_record_number class-attribute instance-attribute

requested_by_customer_record_number: Optional[str] = field(default=None, metadata={'wire_name': 'requestedByCustomerRecordNumber'})

Requested By Customer Record Number.

request_type class-attribute instance-attribute

request_type: Optional[str] = field(default=None, metadata={'wire_name': 'requestType'})

Request Type.

description class-attribute instance-attribute

description: Optional[str] = None

Description.

source class-attribute instance-attribute

source: Optional[str] = None

Source.

closed_date class-attribute instance-attribute

closed_date: Optional[str] = field(default=None, metadata={'wire_name': 'closedDate'})

Closed Date.

NotificationData dataclass

NotificationData(title: Optional[str] = None, message: Optional[str] = None, url: Optional[str] = None, date: Optional[str] = None, is_read: Optional[bool] = None)

Definition: NotificationData

Attributes

title class-attribute instance-attribute

title: Optional[str] = None

Title.

message class-attribute instance-attribute

message: Optional[str] = None

Message.

url class-attribute instance-attribute

url: Optional[str] = None

Url.

date class-attribute instance-attribute

date: Optional[str] = None

Date.

is_read class-attribute instance-attribute

is_read: Optional[bool] = field(default=None, metadata={'wire_name': 'isRead'})

Is Read.

SaveCategoryBasicData dataclass

SaveCategoryBasicData(code: Optional[str] = None, is_primary: Optional[bool] = None)

Definition: SaveCategoryBasicData

Attributes

code class-attribute instance-attribute

code: Optional[str] = None

Code.

is_primary class-attribute instance-attribute

is_primary: Optional[bool] = field(default=None, metadata={'wire_name': 'isPrimary'})

Is Primary.

CertificationData dataclass

CertificationData(code: Optional[str] = None, name: Optional[str] = None, expire_date: Optional[str] = None)

Definition: CertificationData

Attributes

code class-attribute instance-attribute

code: Optional[str] = None

Code.

name class-attribute instance-attribute

name: Optional[str] = None

Name.

expire_date class-attribute instance-attribute

expire_date: Optional[str] = field(default=None, metadata={'wire_name': 'expireDate'})

Expire Date.

ActivityData dataclass

ActivityData(category: Optional[str] = None, text: Optional[str] = None, url: Optional[str] = None, activity_date: Optional[str] = None)

Definition: ActivityData

Attributes

category class-attribute instance-attribute

category: Optional[str] = None

Category.

text class-attribute instance-attribute

text: Optional[str] = None

Text.

url class-attribute instance-attribute

url: Optional[str] = None

Url.

activity_date class-attribute instance-attribute

activity_date: Optional[str] = field(default=None, metadata={'wire_name': 'activityDate'})

Activity Date.

SessionRegistrationData dataclass

SessionRegistrationData(session_code: Optional[str] = None)

Definition: SessionRegistrationData

Attributes

session_code class-attribute instance-attribute

session_code: Optional[str] = field(default=None, metadata={'wire_name': 'sessionCode'})

Session Code.

AwardData dataclass

AwardData(id: Optional[str] = None, name: Optional[str] = None, description: Optional[str] = None, year: Optional[int] = None, customer_type: Optional[str] = None, allow_public_nomination: Optional[bool] = None, nomination_start_date: Optional[str] = None, nomination_end_date: Optional[str] = None)

Definition: AwardData

Attributes

id class-attribute instance-attribute

id: Optional[str] = None

ID.

name class-attribute instance-attribute

name: Optional[str] = None

Name.

description class-attribute instance-attribute

description: Optional[str] = None

Description.

year class-attribute instance-attribute

year: Optional[int] = None

Year.

customer_type class-attribute instance-attribute

customer_type: Optional[str] = field(default=None, metadata={'wire_name': 'customerType'})

Customer Type.

allow_public_nomination class-attribute instance-attribute

allow_public_nomination: Optional[bool] = field(default=None, metadata={'wire_name': 'allowPublicNomination'})

Allow Public Nomination.

nomination_start_date class-attribute instance-attribute

nomination_start_date: Optional[str] = field(default=None, metadata={'wire_name': 'nominationStartDate'})

Nomination Start Date.

nomination_end_date class-attribute instance-attribute

nomination_end_date: Optional[str] = field(default=None, metadata={'wire_name': 'nominationEndDate'})

Nomination End Date.

LicenseData dataclass

LicenseData(id: Optional[str] = None, license_type: Optional[str] = None, number: Optional[str] = None, state: Optional[str] = None, status: Optional[str] = None, start_date: Optional[str] = None, expiration_date: Optional[str] = None)

Definition: LicenseData

Attributes

id class-attribute instance-attribute

id: Optional[str] = None

ID.

license_type class-attribute instance-attribute

license_type: Optional[str] = field(default=None, metadata={'wire_name': 'licenseType'})

License Type.

number class-attribute instance-attribute

number: Optional[str] = None

Number.

state class-attribute instance-attribute

state: Optional[str] = None

State.

status class-attribute instance-attribute

status: Optional[str] = None

Status.

start_date class-attribute instance-attribute

start_date: Optional[str] = field(default=None, metadata={'wire_name': 'startDate'})

Start Date.

expiration_date class-attribute instance-attribute

expiration_date: Optional[str] = field(default=None, metadata={'wire_name': 'expirationDate'})

Experation Date.

CommitteeNomineeData dataclass

CommitteeNomineeData(id: Optional[str] = None, first_name: Optional[str] = None, last_name: Optional[str] = None, code: Optional[str] = None, position: Optional[str] = None, position_code: Optional[str] = None, start_date: Optional[str] = None, end_date: Optional[str] = None, primary_organization: Optional[Dict[str, Any]] = None, organization_representing: Optional[Dict[str, Any]] = None, nominated_by_customer: Optional[Dict[str, Any]] = None, addresses: Optional[List[Dict[str, Any]]] = None, phones: Optional[List[Dict[str, Any]]] = None, emails: Optional[List[Dict[str, Any]]] = None, rank: Optional[int] = None)

Definition: CommitteeNomineeData

Attributes

id class-attribute instance-attribute

id: Optional[str] = None

ID.

first_name class-attribute instance-attribute

first_name: Optional[str] = field(default=None, metadata={'wire_name': 'firstName'})

First Name.

last_name class-attribute instance-attribute

last_name: Optional[str] = field(default=None, metadata={'wire_name': 'lastName'})

Last Name.

code class-attribute instance-attribute

code: Optional[str] = None

Code.

position class-attribute instance-attribute

position: Optional[str] = None

Position.

position_code class-attribute instance-attribute

position_code: Optional[str] = field(default=None, metadata={'wire_name': 'positionCode'})

Position Code.

start_date class-attribute instance-attribute

start_date: Optional[str] = field(default=None, metadata={'wire_name': 'startDate'})

Start Date.

end_date class-attribute instance-attribute

end_date: Optional[str] = field(default=None, metadata={'wire_name': 'endDate'})

End Date.

rank class-attribute instance-attribute

rank: Optional[int] = None

Rank.

RelationshipData dataclass

RelationshipData(relationship_name: Optional[str] = None, related_to_customer: Optional[Dict[str, Any]] = None, reciprocal_relationship_name: Optional[str] = None, is_primary: Optional[bool] = None, start_date: Optional[str] = None, end_date: Optional[str] = None)

Definition: RelationshipData

Attributes

relationship_name class-attribute instance-attribute

relationship_name: Optional[str] = field(default=None, metadata={'wire_name': 'relationshipName'})

Relationship Name.

related_to_customer class-attribute instance-attribute

related_to_customer: Optional[Dict[str, Any]] = field(default=None, metadata={'wire_name': 'relatedToCustomer'})

Related To Customer.

reciprocal_relationship_name class-attribute instance-attribute

reciprocal_relationship_name: Optional[str] = field(default=None, metadata={'wire_name': 'reciprocalRelationshipName'})

Reciprocal Relationship Name.

is_primary class-attribute instance-attribute

is_primary: Optional[bool] = field(default=None, metadata={'wire_name': 'isPrimary'})

Is Primary.

start_date class-attribute instance-attribute

start_date: Optional[str] = field(default=None, metadata={'wire_name': 'startDate'})

Start Date.

end_date class-attribute instance-attribute

end_date: Optional[str] = field(default=None, metadata={'wire_name': 'endDate'})

End Date.

RegistrationData dataclass

RegistrationData(individual_id: Optional[str] = None, event: Optional[Dict[str, Any]] = None, sessions: Optional[List[Dict[str, Any]]] = None, badge_name: Optional[str] = None, badge_organization: Optional[str] = None, badge_city: Optional[str] = None, badge_state: Optional[str] = None, bought_together_with: Optional[List[Dict[str, Any]]] = None, registrant_type_code: Optional[str] = None, registrant_type_name: Optional[str] = None, registration_number: Optional[str] = None)

Definition: RegistrationData

Attributes

individual_id class-attribute instance-attribute

individual_id: Optional[str] = field(default=None, metadata={'wire_name': 'individualId'})

Individual ID.

event class-attribute instance-attribute

event: Optional[Dict[str, Any]] = None

Event.

sessions class-attribute instance-attribute

sessions: Optional[List[Dict[str, Any]]] = None

Sessions.

badge_name class-attribute instance-attribute

badge_name: Optional[str] = field(default=None, metadata={'wire_name': 'badgeName'})

Badge Name.

badge_organization class-attribute instance-attribute

badge_organization: Optional[str] = field(default=None, metadata={'wire_name': 'badgeOrganization'})

Badge Organization.

badge_city class-attribute instance-attribute

badge_city: Optional[str] = field(default=None, metadata={'wire_name': 'badgeCity'})

Badge City.

badge_state class-attribute instance-attribute

badge_state: Optional[str] = field(default=None, metadata={'wire_name': 'badgeState'})

Badge State.

registrant_type_code class-attribute instance-attribute

registrant_type_code: Optional[str] = field(default=None, metadata={'wire_name': 'registrantTypeCode'})

Registrant Type Code.

registrant_type_name class-attribute instance-attribute

registrant_type_name: Optional[str] = field(default=None, metadata={'wire_name': 'registrantTypeName'})

Registrant Type Name.

registration_number class-attribute instance-attribute

registration_number: Optional[str] = field(default=None, metadata={'wire_name': 'registrationNumber'})

Registration Number.

CommitteeMemberData dataclass

CommitteeMemberData(committee: Optional[Dict[str, Any]] = None, position: Optional[str] = None, position_code: Optional[str] = None, code: Optional[str] = None, start_date: Optional[str] = None, end_date: Optional[str] = None)

Definition: CommitteeMemberData

Attributes

position class-attribute instance-attribute

position: Optional[str] = None

Position.

position_code class-attribute instance-attribute

position_code: Optional[str] = field(default=None, metadata={'wire_name': 'positionCode'})

Position Code.

code class-attribute instance-attribute

code: Optional[str] = None

Code.

start_date class-attribute instance-attribute

start_date: Optional[str] = field(default=None, metadata={'wire_name': 'startDate'})

Start Date.

end_date class-attribute instance-attribute

end_date: Optional[str] = field(default=None, metadata={'wire_name': 'endDate'})

End Date.

EventData dataclass

EventData(event_id: Optional[str] = None, event_code: Optional[str] = None, event_name: Optional[str] = None, event_start_date: Optional[str] = None, event_start_time: Optional[str] = None, event_end_date: Optional[str] = None, event_end_time: Optional[str] = None, event_timezone: Optional[str] = None, event_description: Optional[str] = None, short_description: Optional[str] = None, public_event: Optional[bool] = None, image_url: Optional[List[str]] = None, external_url: Optional[str] = None, external_code: Optional[str] = None, event_locations: Optional[List[Dict[str, Any]]] = None, categories: Optional[List[Dict[str, Any]]] = None, education_credits: Optional[List[Dict[str, Any]]] = None, uploads_data: Optional[List[Dict[str, Any]]] = None, related_products: Optional[List[Dict[str, Any]]] = None, tags: Optional[List[str]] = None)

Definition: EventData

Attributes

event_id class-attribute instance-attribute

event_id: Optional[str] = field(default=None, metadata={'wire_name': 'eventId'})

Event ID.

event_code class-attribute instance-attribute

event_code: Optional[str] = field(default=None, metadata={'wire_name': 'eventCode'})

Event Code.

event_name class-attribute instance-attribute

event_name: Optional[str] = field(default=None, metadata={'wire_name': 'eventName'})

Event Name.

event_start_date class-attribute instance-attribute

event_start_date: Optional[str] = field(default=None, metadata={'wire_name': 'eventStartDate'})

Event Start Date.

event_start_time class-attribute instance-attribute

event_start_time: Optional[str] = field(default=None, metadata={'wire_name': 'eventStartTime'})

Event Start Time.

event_end_date class-attribute instance-attribute

event_end_date: Optional[str] = field(default=None, metadata={'wire_name': 'eventEndDate'})

Event End Date.

event_end_time class-attribute instance-attribute

event_end_time: Optional[str] = field(default=None, metadata={'wire_name': 'eventEndTime'})

Event End Time.

event_timezone class-attribute instance-attribute

event_timezone: Optional[str] = field(default=None, metadata={'wire_name': 'eventTimezone'})

Event Time Zone.

event_description class-attribute instance-attribute

event_description: Optional[str] = field(default=None, metadata={'wire_name': 'eventDescription'})

Event Description.

short_description class-attribute instance-attribute

short_description: Optional[str] = field(default=None, metadata={'wire_name': 'shortDescription'})

Short Description.

public_event class-attribute instance-attribute

public_event: Optional[bool] = field(default=None, metadata={'wire_name': 'publicEvent'})

Public Event.

image_url class-attribute instance-attribute

image_url: Optional[List[str]] = field(default=None, metadata={'wire_name': 'imageUrl'})

Image Url.

external_url class-attribute instance-attribute

external_url: Optional[str] = field(default=None, metadata={'wire_name': 'externalUrl'})

External Url.

external_code class-attribute instance-attribute

external_code: Optional[str] = field(default=None, metadata={'wire_name': 'externalCode'})

External Code.

event_locations class-attribute instance-attribute

event_locations: Optional[List[Dict[str, Any]]] = field(default=None, metadata={'wire_name': 'eventLocations'})

Event Locations.

categories class-attribute instance-attribute

categories: Optional[List[Dict[str, Any]]] = None

Event Locations - Categories.

education_credits class-attribute instance-attribute

education_credits: Optional[List[Dict[str, Any]]] = field(default=None, metadata={'wire_name': 'educationCredits'})

Event Locations - Education Credits.

uploads_data class-attribute instance-attribute

uploads_data: Optional[List[Dict[str, Any]]] = field(default=None, metadata={'wire_name': 'uploadsData'})

Event Locations - Uploads Data

related_products class-attribute instance-attribute

related_products: Optional[List[Dict[str, Any]]] = field(default=None, metadata={'wire_name': 'relatedProducts'})

Event Locations - Related Products.

tags class-attribute instance-attribute

tags: Optional[List[str]] = None

Event Locations - Tags

PhoneSaveData dataclass

PhoneSaveData(country_name: Optional[str] = None, primary: Optional[bool] = None, show_in_directory: Optional[bool] = None, number: Optional[str] = None, extension: Optional[str] = None, type_name: Optional[str] = None)

Definition: PhoneSaveData

Attributes

country_name class-attribute instance-attribute

country_name: Optional[str] = field(default=None, metadata={'wire_name': 'countryName'})

Country Name.

primary class-attribute instance-attribute

primary: Optional[bool] = None

Primary.

show_in_directory class-attribute instance-attribute

show_in_directory: Optional[bool] = field(default=None, metadata={'wire_name': 'showInDirectory'})

Show in Directory.

number class-attribute instance-attribute

number: Optional[str] = None

Number.

extension class-attribute instance-attribute

extension: Optional[str] = None

Extension.

type_name class-attribute instance-attribute

type_name: Optional[str] = field(default=None, metadata={'wire_name': 'typeName'})

Type Name.

IndividualPayload dataclass

IndividualPayload(webhook_id: Optional[str] = None, properties: Optional[Dict[str, Any]] = None, notifications: Optional[List[Dict[str, Any]]] = None)

Definition: IndividualPayload

Attributes

webhook_id class-attribute instance-attribute

webhook_id: Optional[str] = field(default=None, metadata={'wire_name': 'WebhookId'})

Webhook Id.

properties class-attribute instance-attribute

properties: Optional[Dict[str, Any]] = field(default=None, metadata={'wire_name': 'Properties'})

Properties.

notifications class-attribute instance-attribute

notifications: Optional[List[Dict[str, Any]]] = field(default=None, metadata={'wire_name': 'Notifications'})

Notifications.

CommitteeMemberPayload dataclass

CommitteeMemberPayload(webhook_id: Optional[str] = None, properties: Optional[Dict[str, Any]] = None, notifications: Optional[List[Dict[str, Any]]] = None)

Definition: CommitteeMemberPayload

Attributes

webhook_id class-attribute instance-attribute

webhook_id: Optional[str] = field(default=None, metadata={'wire_name': 'WebhookId'})

Webhook Id.

properties class-attribute instance-attribute

properties: Optional[Dict[str, Any]] = field(default=None, metadata={'wire_name': 'Properties'})

Properties.

notifications class-attribute instance-attribute

notifications: Optional[List[Dict[str, Any]]] = field(default=None, metadata={'wire_name': 'Notifications'})

Notifications.

PurchaseCancelledPayload dataclass

PurchaseCancelledPayload(webhook_id: Optional[str] = None, properties: Optional[Dict[str, Any]] = None, notifications: Optional[List[Dict[str, Any]]] = None)

Definition: PurchaseCancelledPayload

Attributes

webhook_id class-attribute instance-attribute

webhook_id: Optional[str] = field(default=None, metadata={'wire_name': 'WebhookId'})

Webhook Id.

properties class-attribute instance-attribute

properties: Optional[Dict[str, Any]] = field(default=None, metadata={'wire_name': 'Properties'})

Properties.

notifications class-attribute instance-attribute

notifications: Optional[List[Dict[str, Any]]] = field(default=None, metadata={'wire_name': 'Notifications'})

Notifications.

CustomerRequestPayload dataclass

CustomerRequestPayload(webhook_id: Optional[str] = None, properties: Optional[Dict[str, Any]] = None, notifications: Optional[List[Dict[str, Any]]] = None)

Definition: CustomerRequestPayload

Attributes

webhook_id class-attribute instance-attribute

webhook_id: Optional[str] = field(default=None, metadata={'wire_name': 'WebhookId'})

Webhook Id,.

properties class-attribute instance-attribute

properties: Optional[Dict[str, Any]] = field(default=None, metadata={'wire_name': 'Properties'})

Properties.

notifications class-attribute instance-attribute

notifications: Optional[List[Dict[str, Any]]] = field(default=None, metadata={'wire_name': 'Notifications'})

Notifications.

EmailPayload dataclass

EmailPayload(webhook_id: Optional[str] = None, properties: Optional[Dict[str, Any]] = None, notifications: Optional[List[Dict[str, Any]]] = None)

Definition: EmailPayload

Attributes

webhook_id class-attribute instance-attribute

webhook_id: Optional[str] = field(default=None, metadata={'wire_name': 'WebhookId'})

Webhook Id.

properties class-attribute instance-attribute

properties: Optional[Dict[str, Any]] = field(default=None, metadata={'wire_name': 'Properties'})

Properties.

notifications class-attribute instance-attribute

notifications: Optional[List[Dict[str, Any]]] = field(default=None, metadata={'wire_name': 'Notifications'})

Notifications.

CommitteeMemberCreateData dataclass

CommitteeMemberCreateData(record_number: Optional[str] = None, code: Optional[str] = None, position_code: Optional[str] = None, start_date: Optional[str] = None, end_date: Optional[str] = None, representing_organization_record_number: Optional[str] = None, representing_organization_relationship_name: Optional[str] = None, nominated_by_customer_record_number: Optional[str] = None, committee_term: Optional[int] = None, rank: Optional[int] = None)

Definition: CommitteeMemberCreateData

Attributes

record_number class-attribute instance-attribute

record_number: Optional[str] = field(default=None, metadata={'wire_name': 'recordNumber'})

Record Number.

code class-attribute instance-attribute

code: Optional[str] = None

Member Code.

position_code class-attribute instance-attribute

position_code: Optional[str] = field(default=None, metadata={'wire_name': 'positionCode'})

Position Code.

start_date class-attribute instance-attribute

start_date: Optional[str] = field(default=None, metadata={'wire_name': 'startDate'})

Start Date.

end_date class-attribute instance-attribute

end_date: Optional[str] = field(default=None, metadata={'wire_name': 'endDate'})

End Date.

representing_organization_record_number class-attribute instance-attribute

representing_organization_record_number: Optional[str] = field(default=None, metadata={'wire_name': 'representingOrganizationRecordNumber'})

Representing Organization - Record Number.

representing_organization_relationship_name class-attribute instance-attribute

representing_organization_relationship_name: Optional[str] = field(default=None, metadata={'wire_name': 'representingOrganizationRelationshipName'})

Representing Organization - Relationship Name.

nominated_by_customer_record_number class-attribute instance-attribute

nominated_by_customer_record_number: Optional[str] = field(default=None, metadata={'wire_name': 'nominatedByCustomerRecordNumber'})

Nominated By - Record Number

committee_term class-attribute instance-attribute

committee_term: Optional[int] = field(default=None, metadata={'wire_name': 'committeeTerm'})

Committee Term.

rank class-attribute instance-attribute

rank: Optional[int] = None

Rank.

SubscriptionData dataclass

SubscriptionData(code: Optional[str] = None, name: Optional[str] = None, expire_date: Optional[str] = None, quantity: Optional[int] = None)

Definition: SubscriptionData

Attributes

code class-attribute instance-attribute

code: Optional[str] = None

Code.

name class-attribute instance-attribute

name: Optional[str] = None

Name.

expire_date class-attribute instance-attribute

expire_date: Optional[str] = field(default=None, metadata={'wire_name': 'expireDate'})

Expire Date.

quantity class-attribute instance-attribute

quantity: Optional[int] = None

Quantity.

CommitteePositionData dataclass

CommitteePositionData(code: Optional[str] = None, name: Optional[str] = None, term: Optional[int] = None, description: Optional[str] = None, is_admin: Optional[bool] = None)

Definition: CommitteePositionData

Attributes

code class-attribute instance-attribute

code: Optional[str] = None

Code.

name class-attribute instance-attribute

name: Optional[str] = None

Name.

term class-attribute instance-attribute

term: Optional[int] = None

Term.

description class-attribute instance-attribute

description: Optional[str] = None

Description.

is_admin class-attribute instance-attribute

is_admin: Optional[bool] = field(default=None, metadata={'wire_name': 'isAdmin'})

Is Admin.

CommitteeData dataclass

CommitteeData(name: Optional[str] = None, code: Optional[str] = None, website: Optional[str] = None, id: Optional[str] = None, parent_committee_id: Optional[str] = None, category_name: Optional[str] = None, category_code: Optional[str] = None, description: Optional[str] = None, start_date: Optional[str] = None, end_date: Optional[str] = None, show_in_directory: Optional[bool] = None, term: Optional[Dict[str, Any]] = None, tags: Optional[List[str]] = None)

Definition: CommitteeData

Attributes

name class-attribute instance-attribute

name: Optional[str] = None

Name.

code class-attribute instance-attribute

code: Optional[str] = None

Code.

website class-attribute instance-attribute

website: Optional[str] = None

Website.

id class-attribute instance-attribute

id: Optional[str] = None

Id.

parent_committee_id class-attribute instance-attribute

parent_committee_id: Optional[str] = field(default=None, metadata={'wire_name': 'parentCommitteeId'})

Parent Committee Id.

category_name class-attribute instance-attribute

category_name: Optional[str] = field(default=None, metadata={'wire_name': 'categoryName'})

Category Name.

category_code class-attribute instance-attribute

category_code: Optional[str] = field(default=None, metadata={'wire_name': 'categoryCode'})

Category Code.

description class-attribute instance-attribute

description: Optional[str] = None

Description.

start_date class-attribute instance-attribute

start_date: Optional[str] = field(default=None, metadata={'wire_name': 'startDate'})

Start Date.

end_date class-attribute instance-attribute

end_date: Optional[str] = field(default=None, metadata={'wire_name': 'endDate'})

End Date.

show_in_directory class-attribute instance-attribute

show_in_directory: Optional[bool] = field(default=None, metadata={'wire_name': 'showInDirectory'})

Show In Directory.

term class-attribute instance-attribute

term: Optional[Dict[str, Any]] = None

Term.

tags class-attribute instance-attribute

tags: Optional[List[str]] = None

Tags.

CommitteeMemberUpdateData dataclass

CommitteeMemberUpdateData(record_number: Optional[str] = None, code: Optional[str] = None, position_code: Optional[str] = None, start_date: Optional[str] = None, end_date: Optional[str] = None, representing_organization_record_number: Optional[str] = None, representing_organization_relationship_name: Optional[str] = None, nominated_by_customer_record_number: Optional[str] = None, committee_term: Optional[int] = None, rank: Optional[int] = None)

Definition: CommitteeMemberUpdateData

Attributes

record_number class-attribute instance-attribute

record_number: Optional[str] = field(default=None, metadata={'wire_name': 'recordNumber'})

Record Number.

code class-attribute instance-attribute

code: Optional[str] = None

Member Code.

position_code class-attribute instance-attribute

position_code: Optional[str] = field(default=None, metadata={'wire_name': 'positionCode'})

New Position Code.

start_date class-attribute instance-attribute

start_date: Optional[str] = field(default=None, metadata={'wire_name': 'startDate'})

Start Date.

end_date class-attribute instance-attribute

end_date: Optional[str] = field(default=None, metadata={'wire_name': 'endDate'})

End Date.

representing_organization_record_number class-attribute instance-attribute

representing_organization_record_number: Optional[str] = field(default=None, metadata={'wire_name': 'representingOrganizationRecordNumber'})

Representing Organization - Record Number.

representing_organization_relationship_name class-attribute instance-attribute

representing_organization_relationship_name: Optional[str] = field(default=None, metadata={'wire_name': 'representingOrganizationRelationshipName'})

Representing Organization - Relationship Name.

nominated_by_customer_record_number class-attribute instance-attribute

nominated_by_customer_record_number: Optional[str] = field(default=None, metadata={'wire_name': 'nominatedByCustomerRecordNumber'})

Nominated By - Record Number

committee_term class-attribute instance-attribute

committee_term: Optional[int] = field(default=None, metadata={'wire_name': 'committeeTerm'})

Committee Term.

rank class-attribute instance-attribute

rank: Optional[int] = None

Rank.

EducationCreditData dataclass

EducationCreditData(type_: Optional[str] = None, description: Optional[str] = None, number_of_credits: Optional[float] = None, date_earned: Optional[str] = None, provider_name: Optional[str] = None, state_name: Optional[str] = None, reference: Optional[str] = None, is_self_reported: Optional[bool] = None)

Definition: EducationCreditData

Attributes

type_ class-attribute instance-attribute

type_: Optional[str] = field(default=None, metadata={'wire_name': 'type'})

Education Credit Type.

description class-attribute instance-attribute

description: Optional[str] = None

Description.

number_of_credits class-attribute instance-attribute

number_of_credits: Optional[float] = field(default=None, metadata={'wire_name': 'numberOfCredits'})

Number of Credits Earned.

date_earned class-attribute instance-attribute

date_earned: Optional[str] = field(default=None, metadata={'wire_name': 'dateEarned'})

Earned Date.

provider_name class-attribute instance-attribute

provider_name: Optional[str] = field(default=None, metadata={'wire_name': 'providerName'})

Provider Name.

state_name class-attribute instance-attribute

state_name: Optional[str] = field(default=None, metadata={'wire_name': 'stateName'})

State or Province Name.

reference class-attribute instance-attribute

reference: Optional[str] = None

Reference.

is_self_reported class-attribute instance-attribute

is_self_reported: Optional[bool] = field(default=None, metadata={'wire_name': 'isSelfReported'})

Is Self Reported.

NoteData dataclass

NoteData(is_alert: Optional[bool] = None, title: Optional[str] = None, follow_up_date: Optional[str] = None, content: Optional[str] = None, category: Optional[str] = None, is_internal: Optional[bool] = None)

Definition: NoteData

Attributes

is_alert class-attribute instance-attribute

is_alert: Optional[bool] = field(default=None, metadata={'wire_name': 'isAlert'})

Is Alert.

title class-attribute instance-attribute

title: Optional[str] = None

Title.

follow_up_date class-attribute instance-attribute

follow_up_date: Optional[str] = field(default=None, metadata={'wire_name': 'followUpDate'})

Follow Up Date.

content class-attribute instance-attribute

content: Optional[str] = None

Content.

category class-attribute instance-attribute

category: Optional[str] = None

Category.

is_internal class-attribute instance-attribute

is_internal: Optional[bool] = field(default=None, metadata={'wire_name': 'isInternal'})

Is Internal.

AwardNominationData dataclass

AwardNominationData(nominee_record_number: Optional[str] = None, nominated_by_customer_record_number: Optional[str] = None, nomination_date: Optional[str] = None, awarded_date: Optional[str] = None, status: Optional[str] = None, description: Optional[str] = None)

Definition: AwardNominationData

Attributes

nominee_record_number class-attribute instance-attribute

nominee_record_number: Optional[str] = field(default=None, metadata={'wire_name': 'nomineeRecordNumber'})

Nominee Record Number.

nominated_by_customer_record_number class-attribute instance-attribute

nominated_by_customer_record_number: Optional[str] = field(default=None, metadata={'wire_name': 'nominatedByCustomerRecordNumber'})

Nominated By Record Number.

nomination_date class-attribute instance-attribute

nomination_date: Optional[str] = field(default=None, metadata={'wire_name': 'nominationDate'})

Nomination Date.

awarded_date class-attribute instance-attribute

awarded_date: Optional[str] = field(default=None, metadata={'wire_name': 'awardedDate'})

Awarded Date.

status class-attribute instance-attribute

status: Optional[str] = None

Status.

description class-attribute instance-attribute

description: Optional[str] = None

An explanation why the nominee should be considered for the award.

UpdateAwardNominationData dataclass

UpdateAwardNominationData(nominee_record_number: Optional[str] = None, nominated_by_customer_record_number: Optional[str] = None, nomination_date: Optional[str] = None, awarded_date: Optional[str] = None, status: Optional[str] = None, description: Optional[str] = None)

Definition: UpdateAwardNominationData

Attributes

nominee_record_number class-attribute instance-attribute

nominee_record_number: Optional[str] = field(default=None, metadata={'wire_name': 'nomineeRecordNumber'})

Nominee Record Number.

nominated_by_customer_record_number class-attribute instance-attribute

nominated_by_customer_record_number: Optional[str] = field(default=None, metadata={'wire_name': 'nominatedByCustomerRecordNumber'})

Nominated By Record Number.

nomination_date class-attribute instance-attribute

nomination_date: Optional[str] = field(default=None, metadata={'wire_name': 'nominationDate'})

Nomination Date.

awarded_date class-attribute instance-attribute

awarded_date: Optional[str] = field(default=None, metadata={'wire_name': 'awardedDate'})

Awarded Date.

status class-attribute instance-attribute

status: Optional[str] = None

Status.

description class-attribute instance-attribute

description: Optional[str] = None

An explanation why the nominee should be considered for the award.

AwardRecipientIndividualData dataclass

AwardRecipientIndividualData(awarded_date: Optional[str] = None, first_name: Optional[str] = None, last_name: Optional[str] = None, middle_name: Optional[str] = None, preferred_first_name: Optional[str] = None, second_last_name: Optional[str] = None, prefix: Optional[str] = None, suffix: Optional[str] = None, gender: Optional[str] = None, primary_organization: Optional[Dict[str, Any]] = None, id: Optional[str] = None, customer_type: Optional[str] = None, record_number: Optional[str] = None, title: Optional[str] = None, addresses: Optional[List[Dict[str, Any]]] = None, emails: Optional[List[Dict[str, Any]]] = None, phones: Optional[List[Dict[str, Any]]] = None, show_in_directory: Optional[bool] = None)

Definition: AwardRecipientIndividualData

Attributes

awarded_date class-attribute instance-attribute

awarded_date: Optional[str] = field(default=None, metadata={'wire_name': 'awardedDate'})

Awarded Date.

first_name class-attribute instance-attribute

first_name: Optional[str] = field(default=None, metadata={'wire_name': 'firstName'})

First Name.

last_name class-attribute instance-attribute

last_name: Optional[str] = field(default=None, metadata={'wire_name': 'lastName'})

Last Name.

middle_name class-attribute instance-attribute

middle_name: Optional[str] = field(default=None, metadata={'wire_name': 'middleName'})

Middle Name.

preferred_first_name class-attribute instance-attribute

preferred_first_name: Optional[str] = field(default=None, metadata={'wire_name': 'preferredFirstName'})

Preferred First Name.

second_last_name class-attribute instance-attribute

second_last_name: Optional[str] = field(default=None, metadata={'wire_name': 'secondLastName'})

Second Last Name.

prefix class-attribute instance-attribute

prefix: Optional[str] = None

Prefix.

suffix class-attribute instance-attribute

suffix: Optional[str] = None

Suffix.

gender class-attribute instance-attribute

gender: Optional[str] = None

Gender.

id class-attribute instance-attribute

id: Optional[str] = None

Individual Id.

customer_type class-attribute instance-attribute

customer_type: Optional[str] = field(default=None, metadata={'wire_name': 'customerType'})

Customer Type.

record_number class-attribute instance-attribute

record_number: Optional[str] = field(default=None, metadata={'wire_name': 'recordNumber'})

Record Number.

title class-attribute instance-attribute

title: Optional[str] = None

Title.

addresses class-attribute instance-attribute

addresses: Optional[List[Dict[str, Any]]] = None

Addresses.

emails class-attribute instance-attribute

emails: Optional[List[Dict[str, Any]]] = None

Emails.

phones class-attribute instance-attribute

phones: Optional[List[Dict[str, Any]]] = None

Phones.

show_in_directory class-attribute instance-attribute

show_in_directory: Optional[bool] = field(default=None, metadata={'wire_name': 'showInDirectory'})

Show In Directory.

AwardRecipientOrganizationData dataclass

AwardRecipientOrganizationData(awarded_date: Optional[str] = None, name: Optional[str] = None, acronym: Optional[str] = None, branch_name: Optional[str] = None, annual_sales: Optional[float] = None, employee_range_id: Optional[str] = None, id: Optional[str] = None, customer_type: Optional[str] = None, record_number: Optional[str] = None, show_in_directory: Optional[bool] = None, addresses: Optional[List[Dict[str, Any]]] = None, emails: Optional[List[Dict[str, Any]]] = None, phones: Optional[List[Dict[str, Any]]] = None)

Definition: AwardRecipientOrganizationData

Attributes

awarded_date class-attribute instance-attribute

awarded_date: Optional[str] = field(default=None, metadata={'wire_name': 'awardedDate'})

Awarded Date.

name class-attribute instance-attribute

name: Optional[str] = None

Organization Name.

acronym class-attribute instance-attribute

acronym: Optional[str] = None

Acronym.

branch_name class-attribute instance-attribute

branch_name: Optional[str] = field(default=None, metadata={'wire_name': 'branchName'})

Branch Name.

annual_sales class-attribute instance-attribute

annual_sales: Optional[float] = field(default=None, metadata={'wire_name': 'annualSales'})

Annual Sales.

employee_range_id class-attribute instance-attribute

employee_range_id: Optional[str] = field(default=None, metadata={'wire_name': 'employeeRangeId'})

Employee Range Id.

id class-attribute instance-attribute

id: Optional[str] = None

Organization Id.

customer_type class-attribute instance-attribute

customer_type: Optional[str] = field(default=None, metadata={'wire_name': 'customerType'})

Customer Type.

record_number class-attribute instance-attribute

record_number: Optional[str] = field(default=None, metadata={'wire_name': 'recordNumber'})

Record Number.

show_in_directory class-attribute instance-attribute

show_in_directory: Optional[bool] = field(default=None, metadata={'wire_name': 'showInDirectory'})

Show In Directory.

addresses class-attribute instance-attribute

addresses: Optional[List[Dict[str, Any]]] = None

Addresses.

emails class-attribute instance-attribute

emails: Optional[List[Dict[str, Any]]] = None

Emails.

phones class-attribute instance-attribute

phones: Optional[List[Dict[str, Any]]] = None

Phones.

OrganizationLookupBasicData dataclass

OrganizationLookupBasicData(name: Optional[str] = None, acronym: Optional[str] = None, branch_name: Optional[str] = None, employee_range_id: Optional[str] = None, id: Optional[str] = None, record_number: Optional[str] = None, addresses: Optional[List[Dict[str, Any]]] = None)

Definition: OrganizationLookupBasicData

Attributes

name class-attribute instance-attribute

name: Optional[str] = None

Organization Name.

acronym class-attribute instance-attribute

acronym: Optional[str] = None

Acronym.

branch_name class-attribute instance-attribute

branch_name: Optional[str] = field(default=None, metadata={'wire_name': 'branchName'})

Branch Name.

employee_range_id class-attribute instance-attribute

employee_range_id: Optional[str] = field(default=None, metadata={'wire_name': 'employeeRangeId'})

Employee Range Id.

id class-attribute instance-attribute

id: Optional[str] = None

Organization Id.

record_number class-attribute instance-attribute

record_number: Optional[str] = field(default=None, metadata={'wire_name': 'recordNumber'})

Record Number.

addresses class-attribute instance-attribute

addresses: Optional[List[Dict[str, Any]]] = None

Addresses.

IndividualLookupBasicData dataclass

IndividualLookupBasicData(first_name: Optional[str] = None, last_name: Optional[str] = None, middle_name: Optional[str] = None, preferred_first_name: Optional[str] = None, second_last_name: Optional[str] = None, prefix: Optional[str] = None, suffix: Optional[str] = None, gender: Optional[str] = None, title: Optional[str] = None, primary_organization: Optional[Dict[str, Any]] = None, id: Optional[str] = None, record_number: Optional[str] = None)

Definition: IndividualLookupBasicData

Attributes

first_name class-attribute instance-attribute

first_name: Optional[str] = field(default=None, metadata={'wire_name': 'firstName'})

First Name.

last_name class-attribute instance-attribute

last_name: Optional[str] = field(default=None, metadata={'wire_name': 'lastName'})

Last Name.

middle_name class-attribute instance-attribute

middle_name: Optional[str] = field(default=None, metadata={'wire_name': 'middleName'})

Middle Name.

preferred_first_name class-attribute instance-attribute

preferred_first_name: Optional[str] = field(default=None, metadata={'wire_name': 'preferredFirstName'})

Preferred First Name.

second_last_name class-attribute instance-attribute

second_last_name: Optional[str] = field(default=None, metadata={'wire_name': 'secondLastName'})

Second Last Name.

prefix class-attribute instance-attribute

prefix: Optional[str] = None

Prefix.

suffix class-attribute instance-attribute

suffix: Optional[str] = None

Suffix.

gender class-attribute instance-attribute

gender: Optional[str] = None

Gender.

title class-attribute instance-attribute

title: Optional[str] = None

Title.

id class-attribute instance-attribute

id: Optional[str] = None

Individual Id.

record_number class-attribute instance-attribute

record_number: Optional[str] = field(default=None, metadata={'wire_name': 'recordNumber'})

Record Number.

CustomerCustomFieldValuePayload dataclass

CustomerCustomFieldValuePayload(webhook_id: Optional[str] = None, properties: Optional[Dict[str, Any]] = None, notifications: Optional[List[Dict[str, Any]]] = None)

Definition: CustomerCustomFieldValuePayload

Attributes

webhook_id class-attribute instance-attribute

webhook_id: Optional[str] = field(default=None, metadata={'wire_name': 'WebhookId'})

Webhook Id.

properties class-attribute instance-attribute

properties: Optional[Dict[str, Any]] = field(default=None, metadata={'wire_name': 'Properties'})

Properties.

CustomerMergedPayload dataclass

CustomerMergedPayload(webhook_id: Optional[str] = None, properties: Optional[Dict[str, Any]] = None, notifications: Optional[List[Dict[str, Any]]] = None)

Definition: CustomerMergedPayload

Attributes

webhook_id class-attribute instance-attribute

webhook_id: Optional[str] = field(default=None, metadata={'wire_name': 'WebhookId'})

Webhook Id.

properties class-attribute instance-attribute

properties: Optional[Dict[str, Any]] = field(default=None, metadata={'wire_name': 'Properties'})

Properties.

CustomerRelationshipUpdatedPayload dataclass

CustomerRelationshipUpdatedPayload(webhook_id: Optional[str] = None, properties: Optional[Dict[str, Any]] = None, notifications: Optional[List[Dict[str, Any]]] = None)

Definition: CustomerRelationshipUpdatedPayload

Attributes

webhook_id class-attribute instance-attribute

webhook_id: Optional[str] = field(default=None, metadata={'wire_name': 'WebhookId'})

Webhook Id.

properties class-attribute instance-attribute

properties: Optional[Dict[str, Any]] = field(default=None, metadata={'wire_name': 'Properties'})

Properties.

CustomerPhoneUpdatedPayload dataclass

CustomerPhoneUpdatedPayload(webhook_id: Optional[str] = None, properties: Optional[Dict[str, Any]] = None, notifications: Optional[List[Dict[str, Any]]] = None)

Definition: CustomerPhoneUpdatedPayload

Attributes

webhook_id class-attribute instance-attribute

webhook_id: Optional[str] = field(default=None, metadata={'wire_name': 'WebhookId'})

Webhook Id.

properties class-attribute instance-attribute

properties: Optional[Dict[str, Any]] = field(default=None, metadata={'wire_name': 'Properties'})

Properties.

CustomerAddressUpdatedPayload dataclass

CustomerAddressUpdatedPayload(webhook_id: Optional[str] = None, properties: Optional[Dict[str, Any]] = None, notifications: Optional[List[Dict[str, Any]]] = None)

Definition: CustomerAddressUpdatedPayload

Attributes

webhook_id class-attribute instance-attribute

webhook_id: Optional[str] = field(default=None, metadata={'wire_name': 'WebhookId'})

Webhook Id.

properties class-attribute instance-attribute

properties: Optional[Dict[str, Any]] = field(default=None, metadata={'wire_name': 'Properties'})

Properties.

EventRegistrationSubstitutedPayload dataclass

EventRegistrationSubstitutedPayload(webhook_id: Optional[str] = None, properties: Optional[Dict[str, Any]] = None, notifications: Optional[List[Dict[str, Any]]] = None)

Definition: EventRegistrationSubstitutedPayload

Attributes

webhook_id class-attribute instance-attribute

webhook_id: Optional[str] = field(default=None, metadata={'wire_name': 'WebhookId'})

Webhook Id.

properties class-attribute instance-attribute

properties: Optional[Dict[str, Any]] = field(default=None, metadata={'wire_name': 'Properties'})

Properties.

IndividualRequestToBeForgottenPayload dataclass

IndividualRequestToBeForgottenPayload(webhook_id: Optional[str] = None, properties: Optional[Dict[str, Any]] = None, notifications: Optional[List[Dict[str, Any]]] = None)

Definition: IndividualRequestToBeForgottenPayload

Attributes

webhook_id class-attribute instance-attribute

webhook_id: Optional[str] = field(default=None, metadata={'wire_name': 'WebhookId'})

Webhook Id.

properties class-attribute instance-attribute

properties: Optional[Dict[str, Any]] = field(default=None, metadata={'wire_name': 'Properties'})

Properties.

ProductPurchasePayload dataclass

ProductPurchasePayload(webhook_id: Optional[str] = None, properties: Optional[Dict[str, Any]] = None, notifications: Optional[List[Dict[str, Any]]] = None)

Definition: ProductPurchasePayload

Attributes

webhook_id class-attribute instance-attribute

webhook_id: Optional[str] = field(default=None, metadata={'wire_name': 'WebhookId'})

Webhook Id.

properties class-attribute instance-attribute

properties: Optional[Dict[str, Any]] = field(default=None, metadata={'wire_name': 'Properties'})

Properties.

MembershipTypeTerminatedPayload dataclass

MembershipTypeTerminatedPayload(webhook_id: Optional[str] = None, properties: Optional[Dict[str, Any]] = None, notifications: Optional[List[Dict[str, Any]]] = None)

Definition: MembershipTypeTerminatedPayload

Attributes

webhook_id class-attribute instance-attribute

webhook_id: Optional[str] = field(default=None, metadata={'wire_name': 'WebhookId'})

Webhook Id.

properties class-attribute instance-attribute

properties: Optional[Dict[str, Any]] = field(default=None, metadata={'wire_name': 'Properties'})

Properties.

ImpexiumClient

ImpexiumClient(connection_runtime_url: str, token_provider: Optional[TokenProvider] = None, options: Optional[ConnectorClientOptions] = None)

Bases: ConnectorClientBase

Typed client for impexium connector.

Initialize a ImpexiumClient.

Parameters:

Name	Type	Description	Default
connection_runtime_url	str	The connection runtime URL from Azure Portal.	required
token_provider	Optional[TokenProvider]	Optional token provider. Defaults to ManagedIdentityTokenProvider.	None
options	Optional[ConnectorClientOptions]	Optional connector client options.	None

Methods:

get_abandoned_checkouts_async async

get_abandoned_checkouts_async(page_number: int, abandoned_from: str, product_code: Optional[str] = None, customer_record_number: Optional[str] = None) -> dict[str, Any] | None

Get Abandoned Checkouts

Get Abandoned Checkouts

list_all_exhibitors_async async

list_all_exhibitors_async(exhibit_code: str, page_number: int) -> dict[str, Any] | None

List All Exhibitors

List All Exhibitors

list_of_exams_async async

list_of_exams_async(page_number: int, code: Optional[str] = None, category_name: Optional[str] = None, is_public: Optional[bool] = None, changed_since: Optional[str] = None, tag: Optional[str] = None, include_prices: Optional[bool] = None) -> dict[str, Any] | None

List of Exams

List of Exams

list_registrants_async async

list_registrants_async(event_code: str, page_number: int, session_code: Optional[str] = None, include_details: Optional[bool] = None, registered_since: Optional[str] = None) -> dict[str, Any] | None

List Registrants

List Registrants

get_course_attendees_async async

get_course_attendees_async(code: str, page_number: int) -> dict[str, Any] | None

Get Course Attendees

Get Course Attendees

add_exam_scores_async async

add_exam_scores_async(input: AddExamScoresInput, exam_code: str) -> dict[str, Any] | None

Add Exam Scores

Add Exam Scores

find_members_by_name_async async

find_members_by_name_async(name: str, page_number: int) -> dict[str, Any] | None

Find Members by Name

Find Members by Name

get_purchases_for_an_individual_async async

get_purchases_for_an_individual_async(id_or_record_number: str, page_number: int, product_code: Optional[str] = None, purchased_since: Optional[str] = None, product_category_code: Optional[str] = None) -> dict[str, Any] | None

Get Purchases for an Individual

Get Purchases for an Individual

add_or_update_a_list_of_custom_fields_per_organization_async async

add_or_update_a_list_of_custom_fields_per_organization_async(input: AddOrUpdateAListOfCustomFieldsPerOrganizationInput, id_or_record_number: str) -> dict[str, Any] | None

Add or Update a List of Custom Fields Per Organization

Add or Update a List of Custom Fields Per Organization

add_nominee_async async

add_nominee_async(input: CommitteeNomineeSaveData, code: str) -> None

Add Nominee

Add Nominee

get_individual_custom_field_values_async async

get_individual_custom_field_values_async(id: str) -> dict[str, Any] | None

Get Individual Custom Field Values

Get Individual Custom Field Values

update_custom_field_value_async async

update_custom_field_value_async(input: CustomFieldData, id: str) -> None

Update Individual Custom Field Values

Update Individual Custom Field Values.

list_all_event_cancellations_by_event_async async

list_all_event_cancellations_by_event_async(event_code: str, page_number: int, include_details: Optional[bool] = None, cancelled_since: Optional[str] = None) -> dict[str, Any] | None

List All Event Cancellations by Event

List All Event Cancellations by Event

get_all_open_orders_for_an_individual_async async

get_all_open_orders_for_an_individual_async(id_or_record_number: str, page_number: int, include_line_items: Optional[bool] = None, from_date: Optional[str] = None, to_date: Optional[str] = None) -> dict[str, Any] | None

Get All Open Orders for an Individual

Get All Open Orders for an Individual

list_completed_user_tasks_by_user_id_or_email_async async

list_completed_user_tasks_by_user_id_or_email_async(user_id_or_email: str, page_number: int) -> dict[str, Any] | None

List Completed User Tasks by User ID or Email

List Completed User Tasks by User ID or Email

list_pending_user_tasks_by_user_id_or_email_async async

list_pending_user_tasks_by_user_id_or_email_async(user_id_or_email: str, page_number: int) -> dict[str, Any] | None

List Pending User Tasks by User ID or Email

List Pending User Tasks by User ID or Email

add_note_to_sales_opportunity_async async

add_note_to_sales_opportunity_async(input: BaseNoteData, id: str) -> None

Add Note to Sales Opportunity

Add Note to Sales Opportunity

add_activity_to_sales_opportunity_async async

add_activity_to_sales_opportunity_async(input: ActivityData, id: str) -> None

Add Activity to Sales Opportunity

Add Activity to Sales Opportunity

update_task_by_task_number_async async

update_task_by_task_number_async(input: TaskSaveData, task_number: str) -> dict[str, Any] | None

Update Task by Task Number

Update Task by Task Number

list_all_countries_async async

list_all_countries_async(page_number: int) -> dict[str, Any] | None

List All Countries

List All Countries

get_all_states_by_country_async async

get_all_states_by_country_async(country_id: str, page_number: int) -> dict[str, Any] | None

Get All States by Country

Get All States by Country

list_all_exhibits_async async

list_all_exhibits_async(page_number: int) -> dict[str, Any] | None

List All Exhibits

List All Exhibits

delete_a_category_for_an_organization_async async

delete_a_category_for_an_organization_async(record_number: str, category_code: str) -> None

Delete a Category for an Organization

Delete a Category for an Organization

add_customer_request_async async

add_customer_request_async(input: RequestSaveData) -> None

Add Customer Request

Add Customer Request

update_customer_request_async async

update_customer_request_async(input: RequestUpdateData) -> dict[str, Any] | None

Update Customer Request

Update Customer Request

add_categories_for_an_organization_async async

add_categories_for_an_organization_async(input: AddCategoriesForAnOrganizationInput, record_number: str) -> None

Add Categories for an Organization

Add Categories for an Organization

list_of_customer_relationships_async async

list_of_customer_relationships_async(page_number: int) -> dict[str, Any] | None

List of Customer Relationships

List of Customer Relationships

list_all_open_customer_request_async async

list_all_open_customer_request_async(page_number: int) -> dict[str, Any] | None

List All Open Customer Request

List All Open Customer Request

get_organization_inactive_memberships_async async

get_organization_inactive_memberships_async(id: str) -> dict[str, Any] | None

Get Organization Inactive Memberships

Get Organization Inactive Memberships

delete_record_from_custom_data_table_async async

delete_record_from_custom_data_table_async(table_name: str, id: str) -> None

Delete Record From Custom Data Table

Delete Record From Custom Data Table

update_user_task_progress_or_mark_as_completed_async async

update_user_task_progress_or_mark_as_completed_async(input: UserTaskData, user_id_or_email: str) -> dict[str, Any] | None

Update User Task Progress or Mark as Completed

Update User Task Progress or Mark as Completed

find_members_or_individuals_by_first_name_async async

find_members_or_individuals_by_first_name_async(first_name: str, page_number: int, include_email: Optional[bool] = None) -> dict[str, Any] | None

Find Members (Individuals) by First Name

Find Members (Individuals) by First Name

find_members_or_individuals_by_last_name_async async

find_members_or_individuals_by_last_name_async(last_name: str, page_number: int, include_email: Optional[bool] = None) -> dict[str, Any] | None

Find Members (Individuals) by Last Name

Find Members (Individuals) by Last Name

assign_task_to_a_user_async async

assign_task_to_a_user_async(input: UserTaskData, user_id_or_email: str) -> None

Create a new task or Assign Task to a User

Create a new task or Assign Task to a User

delete_a_category_for_an_individual_async async

delete_a_category_for_an_individual_async(record_number: str, category_code: str) -> None

Delete a Category for an Individual

Delete a Category for an Individual

add_notification_to_individual_async async

add_notification_to_individual_async(input: NotificationData, id: str) -> None

Add Notification to Individual

Add Notification to Individual

add_categories_for_an_individual_async async

add_categories_for_an_individual_async(input: AddCategoriesForAnIndividualInput, record_number: str) -> None

Add Categories for an Individual

Add Categories for an Individual

add_a_new_task_async async

add_a_new_task_async(input: TaskSaveData) -> dict[str, Any] | None

Add a New Task

Add a New Task

list_of_all_organization_members_async async

list_of_all_organization_members_async(page_number: int, zip_code: Optional[str] = None, radius: Optional[float] = None, state_abbreviation: Optional[str] = None, congressional_district: Optional[float] = None, membership_type_code: Optional[str] = None, membership_type_category: Optional[str] = None, city: Optional[str] = None, name: Optional[str] = None, tag: Optional[str] = None, latitude: Optional[float] = None, longitude: Optional[float] = None, domain: Optional[str] = None, include_membership: Optional[bool] = None, include_address: Optional[bool] = None, include_phone: Optional[bool] = None, include_email: Optional[bool] = None, include_custom_fields: Optional[bool] = None, expiring_from: Optional[str] = None, expiring_to: Optional[str] = None) -> dict[str, Any] | None

List of All Organization Members

List of All Organization Members

list_of_all_individual_members_async async

list_of_all_individual_members_async(page_number: int, zip_code: Optional[str] = None, radius: Optional[float] = None, membership_type_code: Optional[str] = None, membership_type_category: Optional[str] = None, tag: Optional[str] = None, include_membership: Optional[bool] = None, include_address: Optional[bool] = None, include_phone: Optional[bool] = None, include_email: Optional[bool] = None, include_link: Optional[bool] = None, include_custom_fields: Optional[bool] = None, include_categories: Optional[bool] = None, include_membership_renewal_url: Optional[bool] = None, expiring_from: Optional[str] = None, expiring_to: Optional[str] = None) -> dict[str, Any] | None

List of All Individual Members

List of All Individual Members

get_list_of_active_certifications_for_an_organization_async async

get_list_of_active_certifications_for_an_organization_async(id_or_record_number: str, page_number: int) -> dict[str, Any] | None

Get List of Active Certifications for an Organization

Get List of Active Certifications for an Organization

get_list_of_active_certifications_for_an_individual_async async

get_list_of_active_certifications_for_an_individual_async(id_or_record_number: str, page_number: int) -> dict[str, Any] | None

Get List of Active Certifications for an Individual

Get List of Active Certifications for an Individual

get_individual_inactive_memberships_async async

get_individual_inactive_memberships_async(id: str) -> dict[str, Any] | None

Get Individual Inactive Memberships

Get Individual Inactive Memberships

add_activity_to_organization_async async

add_activity_to_organization_async(input: ActivityData, id: str) -> None

Add Activity to Organization

Add Activity to Organization

register_an_individual_for_a_free_session_async async

register_an_individual_for_a_free_session_async(input: RegisterAnIndividualForAFreeSessionInput, event_code: str, customer_id_or_record_number: str, registration_number: Optional[str] = None) -> None

Register an Individual for a Free Session

Register an Individual for a Free Session

get_a_list_of_licenses_async async

get_a_list_of_licenses_async(id: str, page_number: int) -> dict[str, Any] | None

Get a List of Licenses

Get a List of Licenses

list_all_awards_async async

list_all_awards_async(page_number: int, year: Optional[int] = None) -> dict[str, Any] | None

List All Awards

List All Awards

find_members_or_individuals_by_name_async async

find_members_or_individuals_by_name_async(name: str, page_number: int, include_email: Optional[bool] = None) -> dict[str, Any] | None

Find Members (Individuals) by Name

Find Members (Individuals) by Name

get_a_list_of_all_services_of_an_organization_async async

get_a_list_of_all_services_of_an_organization_async(id: str) -> dict[str, Any] | None

Get a List of All Services of an Organization

Get a List of All Services of an Organization

add_a_service_to_an_organization_async async

add_a_service_to_an_organization_async(input: ServiceData, id: str) -> dict[str, Any] | None

Add a Service to an Organization

Add a Service to an Organization

update_phone_for_an_individual_async async

update_phone_for_an_individual_async(input: PhoneSaveData, id_or_record_number: str, id: str) -> dict[str, Any] | None

Update Phone for an Individual

Update Phone for an Individual

update_phone_for_an_organization_async async

update_phone_for_an_organization_async(input: PhoneSaveData, id_or_record_number: str, id: str) -> dict[str, Any] | None

Update Phone for an Organization

Update Phone for an Organization

delete_an_individual_web_link_async async

delete_an_individual_web_link_async(input: DeleteAnIndividualWebLinkInput, id_or_record_number: str) -> None

Delete an Individual Web Link

Delete an Individual Web Link

add_web_link_for_individual_async async

add_web_link_for_individual_async(input: AddWebLinkForIndividualInput, id_or_record_number: str) -> None

Add Web Link for Individual

Add Web Link for Individual

add_phone_to_organization_async async

add_phone_to_organization_async(input: PhoneSaveData, id_or_record_number: str) -> dict[str, Any] | None

Add Phone to Organization

Add Phone to Organization

get_nominees_by_committee_async async

get_nominees_by_committee_async(code: str, page_number: int, term: Optional[str] = None) -> dict[str, Any] | None

Get Nominees by Committee

Get Nominees by Committee

get_organizations_active_subscriptions_async async

get_organizations_active_subscriptions_async(id: str, page_number: int) -> dict[str, Any] | None

Get Organization's Active Subscriptions

Get Organization's Active Subscriptions

delete_an_organization_web_link_async async

delete_an_organization_web_link_async(input: DeleteAnOrganizationWebLinkInput, id_or_record_number: str) -> None

Delete an Organization Web Link

Delete an Organization Web Link

add_web_link_for_organization_async async

add_web_link_for_organization_async(input: AddWebLinkForOrganizationInput, id_or_record_number: str) -> None

Add Web Link for Organization

Add Web Link for Organization

add_email_to_organization_async async

add_email_to_organization_async(input: EmailData, id: str) -> None

Add Email to Organization

Add Email to Organization

get_organizations_relationships_async async

get_organizations_relationships_async(id: str, page_number: int, relationship_name: Optional[str] = None, includes_details: Optional[bool] = None) -> dict[str, Any] | None

Get Organization's Relationships

Get Organization's Relationships

add_or_update_address_to_organization_async async

add_or_update_address_to_organization_async(input: AddressSaveData, id_or_record_number: str) -> dict[str, Any] | None

Add or Update Address to Organization

Add or Update Address to Organization

add_or_update_a_list_of_custom_fields_per_individual_async async

add_or_update_a_list_of_custom_fields_per_individual_async(input: AddOrUpdateAListOfCustomFieldsPerIndividualInput, id_or_record_number: str) -> dict[str, Any] | None

Add or Update a List of Custom Fields Per Individual

Add or Update a List of Custom Fields Per Individual

get_upcoming_events_async async

get_upcoming_events_async(page_number: int) -> dict[str, Any] | None

Get Upcoming Events

Get Upcoming Events

add_phone_to_individual_async async

add_phone_to_individual_async(input: PhoneSaveData, id_or_record_number: str) -> dict[str, Any] | None

Add Phone to Individual

Add Phone to Individual

get_committee_information_for_an_individual_async async

get_committee_information_for_an_individual_async(id: str, page_number: int, include_inactive: Optional[bool] = None) -> dict[str, Any] | None

Get Committee Information for an Individual

Get Committee Information for an Individual

get_organization_custom_field_values_async async

get_organization_custom_field_values_async(id: str) -> dict[str, Any] | None

Get Organization Custom Field Values

Get Organization Custom Field Values

get_organization_active_memberships_async async

get_organization_active_memberships_async(id: str) -> dict[str, Any] | None

Get Organization Active Memberships

Get Organization Active Memberships

get_all_events_async async

get_all_events_async(page_number: int, code: Optional[str] = None, name: Optional[str] = None, tag: Optional[str] = None) -> dict[str, Any] | None

Get All Events

Get All Events

get_individual_active_memberships_async async

get_individual_active_memberships_async(id: str) -> dict[str, Any] | None

Get Individual Active Memberships

Get Individual Active Memberships

get_all_event_registrations_information_for_an_individual_async async

get_all_event_registrations_information_for_an_individual_async(id_or_record_number: str, page_number: int, event_code: Optional[str] = None) -> dict[str, Any] | None

Get All Event Registrations Information for an Individual

Get All Event Registrations Information for an Individual

get_individuals_relationships_async async

get_individuals_relationships_async(id: str, page_number: int, relationship_name: Optional[str] = None, include_details: Optional[bool] = None) -> dict[str, Any] | None

Get Individual's Relationships

Get Individual's Relationships

update_an_individual_email_async async

update_an_individual_email_async(input: UpdateAnIndividualEmailInput, id_or_record_number: str, current_email_address: str) -> None

Update an Individual Email

Update an Individual Email

save_relationship_for_organization_async async

save_relationship_for_organization_async(input: SaveRelationshipForOrganizationInput, id: str) -> None

Save Relationship for Organization

Save Relationship for Organization

add_individual_async async

add_individual_async(input: AddIndividualInput, create_user: Optional[bool] = None) -> dict[str, Any] | None

Add Individual

Adds an Individual.

add_email_to_individual_async async

add_email_to_individual_async(input: AddEmailToIndividualInput, id_or_record_number: str) -> dict[str, Any] | None

Add Email to Individual

Add Email to Individual

add_or_update_address_to_individual_async async

add_or_update_address_to_individual_async(input: AddressSaveData, id_or_record_number: str) -> dict[str, Any] | None

Add or Update Address to Individual

Add or Update Address to Individual

find_members_or_individuals_by_first_and_last_name_async async

find_members_or_individuals_by_first_and_last_name_async(first_name: str, last_name: str, page_number: int, include_email: Optional[bool] = None) -> dict[str, Any] | None

Find Members (Individuals) by First Name and Last Name

Find Members (Individuals) by First Name and Last Name

get_committee_members_by_committee_id_or_code_async async

get_committee_members_by_committee_id_or_code_async(id_or_code: str, page_number: int, term: Optional[int] = None, position_codes: Optional[str] = None) -> None

Get Committee Members by committee ID or code

Get Committee Members by Committee ID or Code

add_activity_async async

add_activity_async(input: AddActivityInput, id: str) -> None

Add Activity

Add Activity.

find_individual_id_or_email_async async

find_individual_id_or_email_async(id_or_record_number_or_email: str, page_number: int) -> dict[str, Any] | None

Find Individual by Id or Email or Record Number

Find Individual by Id or Email.

add_relationship_to_individual_async async

add_relationship_to_individual_async(input: AddRelationshipToIndividualInput, id: str) -> None

Add Relationship to Individual

Add Relationship to Individual.

individual_add_education_credit_async async

individual_add_education_credit_async(input: EducationCreditData, id_or_record_number: str) -> None

Add Education Credits to Individual

Add a new Education Credit to an Individual.

individual_add_note_async async

individual_add_note_async(input: NoteData, id: str) -> None

Add Note to Individual

Add a Note to an Individual.

individuals_lookup_by_name_async async

individuals_lookup_by_name_async(page_number: int, name: str) -> dict[str, Any] | None

Lookup Individuals

Lookup Individuals by Name

add_to_committee_async async

add_to_committee_async(input: CommitteeMemberCreateData, code: str) -> dict[str, Any] | None

Add Individual to Committee

Add Individual to Committee.

update_committee_member_async async

update_committee_member_async(input: CommitteeMemberUpdateData, code: str, member_record_number: str, current_position_code: str) -> None

Update Committee Member

Update Committee Member.

add_organization_async async

add_organization_async(input: AddOrganizationInput) -> dict[str, Any] | None

Add Organization

Add Organization.

update_organization_async async

update_organization_async(input: UpdateOrganizationInput, id: str) -> dict[str, Any] | None

Update Organization

Update Organization.

organization_get_profile_async async

organization_get_profile_async(id_or_recordnumber: str, page_number: int) -> dict[str, Any] | None

Find Organization by Id or Record Number

Get organization's profile information by ID or Record Number

organization_add_note_async async

organization_add_note_async(input: NoteData, id: str) -> None

Add Note to Organization

Add a Note to an Organization.

organization_lookup_by_name_async async

organization_lookup_by_name_async(page_number: int, name: str) -> dict[str, Any] | None

Lookup Organizations

Lookup Organizations by Name or Acronym

get_all_committees_async async

get_all_committees_async(page_number: int, code: Optional[str] = None, name: Optional[str] = None, term: Optional[int] = None, active_only: Optional[bool] = None) -> dict[str, Any] | None

Get All Committees

Get All Committees

get_positions_by_committee_async async

get_positions_by_committee_async(code: str) -> dict[str, Any] | None

Get Positions by Committee

Get Positions by Committee

get_sub_committees_async async

get_sub_committees_async(code: str, page_number: int) -> dict[str, Any] | None

Get Sub-Committees

Get Sub-Committees

get_individuals_active_subscriptions_async async

get_individuals_active_subscriptions_async(id: str, page_number: int) -> dict[str, Any] | None

Get Individual's Active Subscriptions

Get Individual's Active Subscriptions

list_all_individuals_async async

list_all_individuals_async(page_number: int, name: Optional[str] = None, include_details: Optional[bool] = None, old_id: Optional[str] = None) -> dict[str, Any] | None

List all Individuals

List all Individuals

find_customer_phone_async async

find_customer_phone_async(page_number: str, phone_number: str) -> dict[str, Any] | None

Find Customer by Phone Number

Find Customer by Phone Number.

mark_registrant_attended_async async

mark_registrant_attended_async(input: MarkRegistrantAttendedInput, record_number: str) -> None

Mark Registrant as Attended

Mark the Registrant as Attended for the specified Events.

awards_add_award_nomination_async async

awards_add_award_nomination_async(input: AwardNominationData, id: str) -> None

Add Award Nomination

Add a new Award Nomination.

awards_update_award_nomination_async async

awards_update_award_nomination_async(input: UpdateAwardNominationData, id: str, nominee_record_number: str) -> None

Update Award Nomination

Update an existing Award Nomination.

awards_get_individual_award_recipients_async async

awards_get_individual_award_recipients_async(page_number: int, id: str) -> dict[str, Any] | None

List Award Individual Recipients

List all Individuals that are Award Recipients.

awards_get_organization_award_recipients_async async

awards_get_organization_award_recipients_async(page_number: int, id: str) -> dict[str, Any] | None

List Award Organization Recipients

List all Organizations that are Award Recipients.