Web2Lead Models

Web2Lead models for the ABC API.

class ab.api.models.web2lead.Web2LeadGetParams(*, AccessKey=None, FirstName=None, LastName=None, Address1=None, Address2=None, City=None, StateProvince=None, ZipPostalCode=None, ReferrerPage=None, EntryUrl=None, SubmissionPage=None, HowHeard=None, Email=None, Phone=None, ShipDate=None, ShipFrom=None, ShipTo=None, BusinessLead=None, ReferredBy=None, ReferredName=None, CustomerComments=None, IPAddress=None, SearchTerm=None, FranchiseeId=None, CompanyName=None, Paid=None, Commodity=None, Industry=None, FullName=None)[source]

Bases: RequestModel

Query parameters for GET /Web2Lead/get — 29 params, all optional strings.

Parameters:

  • AccessKey (str | None)

  • FirstName (str | None)

  • LastName (str | None)

  • Address1 (str | None)

  • Address2 (str | None)

  • City (str | None)

  • StateProvince (str | None)

  • ZipPostalCode (str | None)

  • ReferrerPage (str | None)

  • EntryUrl (str | None)

  • SubmissionPage (str | None)

  • HowHeard (str | None)

  • Email (str | None)

  • Phone (str | None)

  • ShipDate (str | None)

  • ShipFrom (str | None)

  • ShipTo (str | None)

  • BusinessLead (str | None)

  • ReferredBy (str | None)

  • ReferredName (str | None)

  • CustomerComments (str | None)

  • IPAddress (str | None)

  • SearchTerm (str | None)

  • FranchiseeId (str | None)

  • CompanyName (str | None)

  • Paid (str | None)

  • Commodity (str | None)

  • Industry (str | None)

  • FullName (str | None)

access_key: str | None
first_name: str | None
last_name: str | None
address1: str | None
address2: str | None
city: str | None
state_province: str | None
zip_postal_code: str | None
referrer_page: str | None
entry_url: str | None
submission_page: str | None
how_heard: str | None
email: str | None
phone: str | None
ship_date: str | None
ship_from: str | None
ship_to: str | None
business_lead: str | None
referred_by: str | None
referred_name: str | None
customer_comments: str | None
ip_address: str | None
search_term: str | None
franchisee_id: str | None
company_name: str | None
paid: str | None
commodity: str | None
industry: str | None
full_name: str | None
model_config = {'alias_generator': <function _to_camel>, 'extra': 'forbid', 'populate_by_name': True, 'str_strip_whitespace': True, 'use_enum_values': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class ab.api.models.web2lead.Web2LeadGETResult(*, NC_Import_Failed=None, NC_Import_ErrorMessage=None, NC_JobId=None, NC_ContactId=None, **extra_data)[source]

Bases: ResponseModel

Inner result object from GET /Web2Lead/get.

Parameters:

  • NC_Import_Failed (bool | None)

  • NC_Import_ErrorMessage (str | None)

  • NC_JobId (str | None)

  • NC_ContactId (str | None)

  • extra_data (Any)

nc_import_failed: bool | None
nc_import_error_message: str | None
nc_job_id: str | None
nc_contact_id: str | None
model_config = {'alias_generator': <function _to_camel>, 'extra': 'allow', 'populate_by_name': True, 'str_strip_whitespace': True, 'use_enum_values': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class ab.api.models.web2lead.Web2LeadResponse(*, SubmitNewLeadGETResult=None, **extra_data)[source]

Bases: ResponseModel

Response from GET /Web2Lead/get.

Live API wraps the result under SubmitNewLeadGETResult.

Parameters:
result: Web2LeadGETResult | None
model_config = {'alias_generator': <function _to_camel>, 'extra': 'allow', 'populate_by_name': True, 'str_strip_whitespace': True, 'use_enum_values': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class ab.api.models.web2lead.Web2LeadRequest(*, name=None, email=None, phone=None, company=None, message=None)[source]

Bases: RequestModel

Body for POST /Web2Lead/post.

Parameters:

  • name (str | None)

  • email (str | None)

  • phone (str | None)

  • company (str | None)

  • message (str | None)

name: str | None
email: str | None
phone: str | None
company: str | None
message: str | None
model_config = {'alias_generator': <function _to_camel>, 'extra': 'forbid', 'populate_by_name': True, 'str_strip_whitespace': True, 'use_enum_values': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].