@randock/nameshift-api-client 0.0.460 → 0.0.462

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@randock/nameshift-api-client",
-  "version": "0.0.460",
+  "version": "0.0.462",
   "description": "OpenAPI client for @randock/nameshift-api-client",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/apis/LeadsApi.ts

@@ -20,6 +20,7 @@ import type {
   CreateLeadMessageInput,
   CreateManualLeadInput,
   IntersectionLeadDtoWithLeadDetailsDtoWithManualLeadBuyerDetailsDto,
+  LeadEnrichmentDto,
   LeadLeaseToOwnAndRentConfigurationPresetsDto,
   LeadOfferExpirationConfigurationInput,
   List200Response,
@@ -43,6 +44,8 @@ import {
     CreateManualLeadInputToJSON,
     IntersectionLeadDtoWithLeadDetailsDtoWithManualLeadBuyerDetailsDtoFromJSON,
     IntersectionLeadDtoWithLeadDetailsDtoWithManualLeadBuyerDetailsDtoToJSON,
+    LeadEnrichmentDtoFromJSON,
+    LeadEnrichmentDtoToJSON,
     LeadLeaseToOwnAndRentConfigurationPresetsDtoFromJSON,
     LeadLeaseToOwnAndRentConfigurationPresetsDtoToJSON,
     LeadOfferExpirationConfigurationInputFromJSON,
@@ -97,6 +100,10 @@ export interface LeadsApiGetLeadRequest {
     leadId: string;
 }
 
+export interface LeadsApiGetLeadEnrichmentRequest {
+    leadId: string;
+}
+
 export interface LeadsApiGetManualLeadRequest {
     leadId: string;
 }
@@ -508,6 +515,53 @@ export class LeadsApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Returns buyer background enrichment for a lead: web footprint, the company behind the email domain, email classification, and IP intelligence. Sections are empty while enrichment is pending. Requires account ownership.  **API key scope required:** `LEADS_READ`. Requests authenticated with a seller session do not need any scope.
+     * Get lead buyer enrichment
+     */
+    async getLeadEnrichmentRaw(requestParameters: LeadsApiGetLeadEnrichmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<LeadEnrichmentDto>> {
+        if (requestParameters['leadId'] == null) {
+            throw new runtime.RequiredError(
+                'leadId',
+                'Required parameter "leadId" was null or undefined when calling getLeadEnrichment().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["apikey"] = await this.configuration.apiKey("apikey"); // api_key authentication
+        }
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearer", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await this.request({
+            path: `/private/leads/{leadId}/enrichment`.replace(`{${"leadId"}}`, encodeURIComponent(String(requestParameters['leadId']))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => LeadEnrichmentDtoFromJSON(jsonValue));
+    }
+
+    /**
+     * Returns buyer background enrichment for a lead: web footprint, the company behind the email domain, email classification, and IP intelligence. Sections are empty while enrichment is pending. Requires account ownership.  **API key scope required:** `LEADS_READ`. Requests authenticated with a seller session do not need any scope.
+     * Get lead buyer enrichment
+     */
+    async getLeadEnrichment(requestParameters: LeadsApiGetLeadEnrichmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<LeadEnrichmentDto> {
+        const response = await this.getLeadEnrichmentRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Returns configuration presets for lead offers.  **API key scope required:** `LEADS_READ`. Requests authenticated with a seller session do not need any scope.
      * Get lease-to-own configuration presets

package/src/models/BuyerAcceptanceEnum.ts

@@ -0,0 +1,55 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Nameshift
+ * Nameshift domain marketplace and management API.  ## Authentication - **Bearer JWT** — Seller and buyer sessions obtained via login endpoints. - **API key** — Pass the `apikey` header for programmatic seller access.  ## Audiences - **(public)** tags — Unauthenticated or buyer-facing endpoints. - **Accounts / Domains / Leads / Buyers** — Seller or buyer resources. - **Partner** — Partner integrations.
+ *
+ * The version of the OpenAPI document: 1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+/**
+ * Share of the leads the buyer started that ever reached an accepted deal: accepts_nothing (below 25%), normal (25-75%), accepts_anything (75% and up), or unknown when the buyer has a single lead and no accepted deal yet.
+ * @export
+ */
+export const BuyerAcceptanceEnum = {
+    UNKNOWN: 'unknown',
+    ACCEPTS_NOTHING: 'accepts_nothing',
+    NORMAL: 'normal',
+    ACCEPTS_ANYTHING: 'accepts_anything'
+} as const;
+export type BuyerAcceptanceEnum = typeof BuyerAcceptanceEnum[keyof typeof BuyerAcceptanceEnum];
+
+
+export function instanceOfBuyerAcceptanceEnum(value: any): boolean {
+    for (const key in BuyerAcceptanceEnum) {
+        if (Object.prototype.hasOwnProperty.call(BuyerAcceptanceEnum, key)) {
+            if (BuyerAcceptanceEnum[key as keyof typeof BuyerAcceptanceEnum] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function BuyerAcceptanceEnumFromJSON(json: any): BuyerAcceptanceEnum {
+    return BuyerAcceptanceEnumFromJSONTyped(json, false);
+}
+
+export function BuyerAcceptanceEnumFromJSONTyped(json: any, ignoreDiscriminator: boolean): BuyerAcceptanceEnum {
+    return json as BuyerAcceptanceEnum;
+}
+
+export function BuyerAcceptanceEnumToJSON(value?: BuyerAcceptanceEnum | null): any {
+    return value as any;
+}
+
+export function BuyerAcceptanceEnumToJSONTyped(value: any, ignoreDiscriminator: boolean): BuyerAcceptanceEnum {
+    return value as BuyerAcceptanceEnum;
+}
+

package/src/models/BuyerDto.ts

@@ -13,6 +13,28 @@
  */
 
 import { mapValues } from '../runtime';
+import type { BuyerPaymentEnum } from './BuyerPaymentEnum';
+import {
+    BuyerPaymentEnumFromJSON,
+    BuyerPaymentEnumFromJSONTyped,
+    BuyerPaymentEnumToJSON,
+    BuyerPaymentEnumToJSONTyped,
+} from './BuyerPaymentEnum';
+import type { BuyerAcceptanceEnum } from './BuyerAcceptanceEnum';
+import {
+    BuyerAcceptanceEnumFromJSON,
+    BuyerAcceptanceEnumFromJSONTyped,
+    BuyerAcceptanceEnumToJSON,
+    BuyerAcceptanceEnumToJSONTyped,
+} from './BuyerAcceptanceEnum';
+import type { BuyerExperienceEnum } from './BuyerExperienceEnum';
+import {
+    BuyerExperienceEnumFromJSON,
+    BuyerExperienceEnumFromJSONTyped,
+    BuyerExperienceEnumToJSON,
+    BuyerExperienceEnumToJSONTyped,
+} from './BuyerExperienceEnum';
+
 /**
  * 
  * @export
@@ -61,8 +83,34 @@ export interface BuyerDto {
      * @memberof BuyerDto
      */
     phoneNumber: string | null;
+    /**
+     * 
+     * @type {BuyerExperienceEnum}
+     * @memberof BuyerDto
+     */
+    experience: BuyerExperienceEnum;
+    /**
+     * 
+     * @type {BuyerAcceptanceEnum}
+     * @memberof BuyerDto
+     */
+    accepted: BuyerAcceptanceEnum;
+    /**
+     * 
+     * @type {BuyerPaymentEnum}
+     * @memberof BuyerDto
+     */
+    payment: BuyerPaymentEnum;
+    /**
+     * Warning that the buyer started fewer than 4 leads, so the buyer classifications are based on little data.
+     * @type {boolean}
+     * @memberof BuyerDto
+     */
+    limitedData: boolean;
 }
 
+
+
 /**
  * Check if a given object implements the BuyerDto interface.
  */
@@ -74,6 +122,10 @@ export function instanceOfBuyerDto(value: object): value is BuyerDto {
     if (!('buyerName' in value) || value['buyerName'] === undefined) return false;
     if (!('emailDomain' in value) || value['emailDomain'] === undefined) return false;
     if (!('phoneNumber' in value) || value['phoneNumber'] === undefined) return false;
+    if (!('experience' in value) || value['experience'] === undefined) return false;
+    if (!('accepted' in value) || value['accepted'] === undefined) return false;
+    if (!('payment' in value) || value['payment'] === undefined) return false;
+    if (!('limitedData' in value) || value['limitedData'] === undefined) return false;
     return true;
 }
 
@@ -94,6 +146,10 @@ export function BuyerDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean):
         'buyerName': json['buyerName'],
         'emailDomain': json['emailDomain'],
         'phoneNumber': json['phoneNumber'],
+        'experience': BuyerExperienceEnumFromJSON(json['experience']),
+        'accepted': BuyerAcceptanceEnumFromJSON(json['accepted']),
+        'payment': BuyerPaymentEnumFromJSON(json['payment']),
+        'limitedData': json['limitedData'],
     };
 }
 
@@ -115,6 +171,10 @@ export function BuyerDtoToJSONTyped(value?: BuyerDto | null, ignoreDiscriminator
         'buyerName': value['buyerName'],
         'emailDomain': value['emailDomain'],
         'phoneNumber': value['phoneNumber'],
+        'experience': BuyerExperienceEnumToJSON(value['experience']),
+        'accepted': BuyerAcceptanceEnumToJSON(value['accepted']),
+        'payment': BuyerPaymentEnumToJSON(value['payment']),
+        'limitedData': value['limitedData'],
     };
 }
 

package/src/models/BuyerExperienceEnum.ts

@@ -0,0 +1,54 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Nameshift
+ * Nameshift domain marketplace and management API.  ## Authentication - **Bearer JWT** — Seller and buyer sessions obtained via login endpoints. - **API key** — Pass the `apikey` header for programmatic seller access.  ## Audiences - **(public)** tags — Unauthenticated or buyer-facing endpoints. - **Accounts / Domains / Leads / Buyers** — Seller or buyer resources. - **Partner** — Partner integrations.
+ *
+ * The version of the OpenAPI document: 1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+/**
+ * Experience level based on the number of domains the buyer bought: none (0), active (1-3), expert (4+).
+ * @export
+ */
+export const BuyerExperienceEnum = {
+    NONE: 'none',
+    ACTIVE: 'active',
+    EXPERT: 'expert'
+} as const;
+export type BuyerExperienceEnum = typeof BuyerExperienceEnum[keyof typeof BuyerExperienceEnum];
+
+
+export function instanceOfBuyerExperienceEnum(value: any): boolean {
+    for (const key in BuyerExperienceEnum) {
+        if (Object.prototype.hasOwnProperty.call(BuyerExperienceEnum, key)) {
+            if (BuyerExperienceEnum[key as keyof typeof BuyerExperienceEnum] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function BuyerExperienceEnumFromJSON(json: any): BuyerExperienceEnum {
+    return BuyerExperienceEnumFromJSONTyped(json, false);
+}
+
+export function BuyerExperienceEnumFromJSONTyped(json: any, ignoreDiscriminator: boolean): BuyerExperienceEnum {
+    return json as BuyerExperienceEnum;
+}
+
+export function BuyerExperienceEnumToJSON(value?: BuyerExperienceEnum | null): any {
+    return value as any;
+}
+
+export function BuyerExperienceEnumToJSONTyped(value: any, ignoreDiscriminator: boolean): BuyerExperienceEnum {
+    return value as BuyerExperienceEnum;
+}
+

package/src/models/BuyerPaymentEnum.ts

@@ -0,0 +1,55 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Nameshift
+ * Nameshift domain marketplace and management API.  ## Authentication - **Bearer JWT** — Seller and buyer sessions obtained via login endpoints. - **API key** — Pass the `apikey` header for programmatic seller access.  ## Audiences - **(public)** tags — Unauthenticated or buyer-facing endpoints. - **Accounts / Domains / Leads / Buyers** — Seller or buyer resources. - **Partner** — Partner integrations.
+ *
+ * The version of the OpenAPI document: 1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+/**
+ * Share of the leads the buyer started that were actually paid: pays_nothing (below 25%), normal (25-75%), pays_everything (75% and up), or unknown when the buyer has a single lead and no purchase yet.
+ * @export
+ */
+export const BuyerPaymentEnum = {
+    UNKNOWN: 'unknown',
+    PAYS_NOTHING: 'pays_nothing',
+    NORMAL: 'normal',
+    PAYS_EVERYTHING: 'pays_everything'
+} as const;
+export type BuyerPaymentEnum = typeof BuyerPaymentEnum[keyof typeof BuyerPaymentEnum];
+
+
+export function instanceOfBuyerPaymentEnum(value: any): boolean {
+    for (const key in BuyerPaymentEnum) {
+        if (Object.prototype.hasOwnProperty.call(BuyerPaymentEnum, key)) {
+            if (BuyerPaymentEnum[key as keyof typeof BuyerPaymentEnum] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function BuyerPaymentEnumFromJSON(json: any): BuyerPaymentEnum {
+    return BuyerPaymentEnumFromJSONTyped(json, false);
+}
+
+export function BuyerPaymentEnumFromJSONTyped(json: any, ignoreDiscriminator: boolean): BuyerPaymentEnum {
+    return json as BuyerPaymentEnum;
+}
+
+export function BuyerPaymentEnumToJSON(value?: BuyerPaymentEnum | null): any {
+    return value as any;
+}
+
+export function BuyerPaymentEnumToJSONTyped(value: any, ignoreDiscriminator: boolean): BuyerPaymentEnum {
+    return value as BuyerPaymentEnum;
+}
+

package/src/models/FeatureFlagListItemDto.ts

@@ -95,7 +95,8 @@ export const FeatureFlagListItemDtoNameEnum = {
     USE_MAILER_FALLBACK_FOR_MANUAL_OTP_REQUEST: 'USE_MAILER_FALLBACK_FOR_MANUAL_OTP_REQUEST',
     AIRWALLEX_BANK_TRANSFER_PAYMENT_METHOD: 'AIRWALLEX_BANK_TRANSFER_PAYMENT_METHOD',
     MARKETPLACE_ROUTING: 'MARKETPLACE_ROUTING',
-    AI_DOMAIN_EDIT: 'AI_DOMAIN_EDIT'
+    AI_DOMAIN_EDIT: 'AI_DOMAIN_EDIT',
+    LEAD_ENRICHMENT: 'LEAD_ENRICHMENT'
 } as const;
 export type FeatureFlagListItemDtoNameEnum = typeof FeatureFlagListItemDtoNameEnum[keyof typeof FeatureFlagListItemDtoNameEnum];
 

package/src/models/IntersectionAccountDtoWithSettingsDtoWithNotificationsDtoWithFeatureFlagsDto.ts

@@ -181,7 +181,8 @@ export const IntersectionAccountDtoWithSettingsDtoWithNotificationsDtoWithFeatur
     USE_MAILER_FALLBACK_FOR_MANUAL_OTP_REQUEST: 'USE_MAILER_FALLBACK_FOR_MANUAL_OTP_REQUEST',
     AIRWALLEX_BANK_TRANSFER_PAYMENT_METHOD: 'AIRWALLEX_BANK_TRANSFER_PAYMENT_METHOD',
     MARKETPLACE_ROUTING: 'MARKETPLACE_ROUTING',
-    AI_DOMAIN_EDIT: 'AI_DOMAIN_EDIT'
+    AI_DOMAIN_EDIT: 'AI_DOMAIN_EDIT',
+    LEAD_ENRICHMENT: 'LEAD_ENRICHMENT'
 } as const;
 export type IntersectionAccountDtoWithSettingsDtoWithNotificationsDtoWithFeatureFlagsDtoEnabledFeaturesEnum = typeof IntersectionAccountDtoWithSettingsDtoWithNotificationsDtoWithFeatureFlagsDtoEnabledFeaturesEnum[keyof typeof IntersectionAccountDtoWithSettingsDtoWithNotificationsDtoWithFeatureFlagsDtoEnabledFeaturesEnum];
 

package/src/models/LeadEnrichmentCompanyDto.ts

@@ -0,0 +1,120 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Nameshift
+ * Nameshift domain marketplace and management API.  ## Authentication - **Bearer JWT** — Seller and buyer sessions obtained via login endpoints. - **API key** — Pass the `apikey` header for programmatic seller access.  ## Audiences - **(public)** tags — Unauthenticated or buyer-facing endpoints. - **Accounts / Domains / Leads / Buyers** — Seller or buyer resources. - **Partner** — Partner integrations.
+ *
+ * The version of the OpenAPI document: 1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface LeadEnrichmentCompanyDto
+ */
+export interface LeadEnrichmentCompanyDto {
+    /**
+     * 
+     * @type {string}
+     * @memberof LeadEnrichmentCompanyDto
+     */
+    status: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof LeadEnrichmentCompanyDto
+     */
+    legalName: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof LeadEnrichmentCompanyDto
+     */
+    tradeName: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof LeadEnrichmentCompanyDto
+     */
+    countryCode: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof LeadEnrichmentCompanyDto
+     */
+    vatId: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof LeadEnrichmentCompanyDto
+     */
+    registryId: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof LeadEnrichmentCompanyDto
+     */
+    domainRegisteredAt: string | null;
+}
+
+/**
+ * Check if a given object implements the LeadEnrichmentCompanyDto interface.
+ */
+export function instanceOfLeadEnrichmentCompanyDto(value: object): value is LeadEnrichmentCompanyDto {
+    if (!('status' in value) || value['status'] === undefined) return false;
+    if (!('legalName' in value) || value['legalName'] === undefined) return false;
+    if (!('tradeName' in value) || value['tradeName'] === undefined) return false;
+    if (!('countryCode' in value) || value['countryCode'] === undefined) return false;
+    if (!('vatId' in value) || value['vatId'] === undefined) return false;
+    if (!('registryId' in value) || value['registryId'] === undefined) return false;
+    if (!('domainRegisteredAt' in value) || value['domainRegisteredAt'] === undefined) return false;
+    return true;
+}
+
+export function LeadEnrichmentCompanyDtoFromJSON(json: any): LeadEnrichmentCompanyDto {
+    return LeadEnrichmentCompanyDtoFromJSONTyped(json, false);
+}
+
+export function LeadEnrichmentCompanyDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): LeadEnrichmentCompanyDto {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'status': json['status'],
+        'legalName': json['legalName'],
+        'tradeName': json['tradeName'],
+        'countryCode': json['countryCode'],
+        'vatId': json['vatId'],
+        'registryId': json['registryId'],
+        'domainRegisteredAt': json['domainRegisteredAt'],
+    };
+}
+
+export function LeadEnrichmentCompanyDtoToJSON(json: any): LeadEnrichmentCompanyDto {
+    return LeadEnrichmentCompanyDtoToJSONTyped(json, false);
+}
+
+export function LeadEnrichmentCompanyDtoToJSONTyped(value?: LeadEnrichmentCompanyDto | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'status': value['status'],
+        'legalName': value['legalName'],
+        'tradeName': value['tradeName'],
+        'countryCode': value['countryCode'],
+        'vatId': value['vatId'],
+        'registryId': value['registryId'],
+        'domainRegisteredAt': value['domainRegisteredAt'],
+    };
+}
+

package/src/models/LeadEnrichmentDto.ts

@@ -0,0 +1,149 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Nameshift
+ * Nameshift domain marketplace and management API.  ## Authentication - **Bearer JWT** — Seller and buyer sessions obtained via login endpoints. - **API key** — Pass the `apikey` header for programmatic seller access.  ## Audiences - **(public)** tags — Unauthenticated or buyer-facing endpoints. - **Accounts / Domains / Leads / Buyers** — Seller or buyer resources. - **Partner** — Partner integrations.
+ *
+ * The version of the OpenAPI document: 1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+import type { LeadEnrichmentIpDto } from './LeadEnrichmentIpDto';
+import {
+    LeadEnrichmentIpDtoFromJSON,
+    LeadEnrichmentIpDtoFromJSONTyped,
+    LeadEnrichmentIpDtoToJSON,
+    LeadEnrichmentIpDtoToJSONTyped,
+} from './LeadEnrichmentIpDto';
+import type { LeadEnrichmentEmailDto } from './LeadEnrichmentEmailDto';
+import {
+    LeadEnrichmentEmailDtoFromJSON,
+    LeadEnrichmentEmailDtoFromJSONTyped,
+    LeadEnrichmentEmailDtoToJSON,
+    LeadEnrichmentEmailDtoToJSONTyped,
+} from './LeadEnrichmentEmailDto';
+import type { LeadEnrichmentWebResultDto } from './LeadEnrichmentWebResultDto';
+import {
+    LeadEnrichmentWebResultDtoFromJSON,
+    LeadEnrichmentWebResultDtoFromJSONTyped,
+    LeadEnrichmentWebResultDtoToJSON,
+    LeadEnrichmentWebResultDtoToJSONTyped,
+} from './LeadEnrichmentWebResultDto';
+import type { LeadEnrichmentCompanyDto } from './LeadEnrichmentCompanyDto';
+import {
+    LeadEnrichmentCompanyDtoFromJSON,
+    LeadEnrichmentCompanyDtoFromJSONTyped,
+    LeadEnrichmentCompanyDtoToJSON,
+    LeadEnrichmentCompanyDtoToJSONTyped,
+} from './LeadEnrichmentCompanyDto';
+
+/**
+ * 
+ * @export
+ * @interface LeadEnrichmentDto
+ */
+export interface LeadEnrichmentDto {
+    /**
+     * Whether any enrichment is held for this lead yet.
+     * @type {boolean}
+     * @memberof LeadEnrichmentDto
+     */
+    available: boolean;
+    /**
+     * Enrichment lifecycle status of the lead record.
+     * @type {string}
+     * @memberof LeadEnrichmentDto
+     */
+    status: string | null;
+    /**
+     * Summary of the buyer's public web footprint.
+     * @type {string}
+     * @memberof LeadEnrichmentDto
+     */
+    webSummary: string | null;
+    /**
+     * 
+     * @type {Array<LeadEnrichmentWebResultDto>}
+     * @memberof LeadEnrichmentDto
+     */
+    webResults: Array<LeadEnrichmentWebResultDto>;
+    /**
+     * 
+     * @type {LeadEnrichmentEmailDto}
+     * @memberof LeadEnrichmentDto
+     */
+    email: LeadEnrichmentEmailDto | null;
+    /**
+     * 
+     * @type {LeadEnrichmentCompanyDto}
+     * @memberof LeadEnrichmentDto
+     */
+    company: LeadEnrichmentCompanyDto | null;
+    /**
+     * 
+     * @type {LeadEnrichmentIpDto}
+     * @memberof LeadEnrichmentDto
+     */
+    ip: LeadEnrichmentIpDto | null;
+}
+
+/**
+ * Check if a given object implements the LeadEnrichmentDto interface.
+ */
+export function instanceOfLeadEnrichmentDto(value: object): value is LeadEnrichmentDto {
+    if (!('available' in value) || value['available'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    if (!('webSummary' in value) || value['webSummary'] === undefined) return false;
+    if (!('webResults' in value) || value['webResults'] === undefined) return false;
+    if (!('email' in value) || value['email'] === undefined) return false;
+    if (!('company' in value) || value['company'] === undefined) return false;
+    if (!('ip' in value) || value['ip'] === undefined) return false;
+    return true;
+}
+
+export function LeadEnrichmentDtoFromJSON(json: any): LeadEnrichmentDto {
+    return LeadEnrichmentDtoFromJSONTyped(json, false);
+}
+
+export function LeadEnrichmentDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): LeadEnrichmentDto {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'available': json['available'],
+        'status': json['status'],
+        'webSummary': json['webSummary'],
+        'webResults': ((json['webResults'] as Array<any>).map(LeadEnrichmentWebResultDtoFromJSON)),
+        'email': LeadEnrichmentEmailDtoFromJSON(json['email']),
+        'company': LeadEnrichmentCompanyDtoFromJSON(json['company']),
+        'ip': LeadEnrichmentIpDtoFromJSON(json['ip']),
+    };
+}
+
+export function LeadEnrichmentDtoToJSON(json: any): LeadEnrichmentDto {
+    return LeadEnrichmentDtoToJSONTyped(json, false);
+}
+
+export function LeadEnrichmentDtoToJSONTyped(value?: LeadEnrichmentDto | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'available': value['available'],
+        'status': value['status'],
+        'webSummary': value['webSummary'],
+        'webResults': ((value['webResults'] as Array<any>).map(LeadEnrichmentWebResultDtoToJSON)),
+        'email': LeadEnrichmentEmailDtoToJSON(value['email']),
+        'company': LeadEnrichmentCompanyDtoToJSON(value['company']),
+        'ip': LeadEnrichmentIpDtoToJSON(value['ip']),
+    };
+}
+