@leadping/sdk 1.0.44 → 1.0.45
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -1,19 +1,9 @@
|
|
|
1
1
|
import { type LeadIntakeRequest, type LeadResponse } from '../../models/index.js';
|
|
2
|
-
import { type BaseRequestBuilder, type
|
|
2
|
+
import { type BaseRequestBuilder, type RequestConfiguration, type RequestInformation, type RequestsMetadata } from '@microsoft/kiota-abstractions';
|
|
3
3
|
/**
|
|
4
4
|
* Builds and executes requests for operations under /leads/intake
|
|
5
5
|
*/
|
|
6
6
|
export interface IntakeRequestBuilder extends BaseRequestBuilder<IntakeRequestBuilder> {
|
|
7
|
-
/**
|
|
8
|
-
* Creates a source-authenticated lead from query parameters, supporting simple form posts, tracking metadata, and follow-up automation.
|
|
9
|
-
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
|
|
10
|
-
* @returns {Promise<LeadResponse>}
|
|
11
|
-
* @throws {ProblemDetails} error when the service returns a 400 status code
|
|
12
|
-
* @throws {ProblemDetails} error when the service returns a 401 status code
|
|
13
|
-
* @throws {ProblemDetails} error when the service returns a 403 status code
|
|
14
|
-
* @throws {ProblemDetails} error when the service returns a 429 status code
|
|
15
|
-
*/
|
|
16
|
-
get(requestConfiguration?: RequestConfiguration<IntakeRequestBuilderGetQueryParameters> | undefined): Promise<LeadResponse | undefined>;
|
|
17
7
|
/**
|
|
18
8
|
* Creates a source-authenticated lead from a flat intake payload, capturing contact fields, metadata, and automation-ready lead details.
|
|
19
9
|
* @param body Defines the fields clients can send when working with lead intake.
|
|
@@ -25,12 +15,6 @@ export interface IntakeRequestBuilder extends BaseRequestBuilder<IntakeRequestBu
|
|
|
25
15
|
* @throws {ProblemDetails} error when the service returns a 429 status code
|
|
26
16
|
*/
|
|
27
17
|
post(body: LeadIntakeRequest, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<LeadResponse | undefined>;
|
|
28
|
-
/**
|
|
29
|
-
* Creates a source-authenticated lead from query parameters, supporting simple form posts, tracking metadata, and follow-up automation.
|
|
30
|
-
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
|
|
31
|
-
* @returns {RequestInformation}
|
|
32
|
-
*/
|
|
33
|
-
toGetRequestInformation(requestConfiguration?: RequestConfiguration<IntakeRequestBuilderGetQueryParameters> | undefined): RequestInformation;
|
|
34
18
|
/**
|
|
35
19
|
* Creates a source-authenticated lead from a flat intake payload, capturing contact fields, metadata, and automation-ready lead details.
|
|
36
20
|
* @param body Defines the fields clients can send when working with lead intake.
|
|
@@ -39,147 +23,10 @@ export interface IntakeRequestBuilder extends BaseRequestBuilder<IntakeRequestBu
|
|
|
39
23
|
*/
|
|
40
24
|
toPostRequestInformation(body: LeadIntakeRequest, requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
|
|
41
25
|
}
|
|
42
|
-
/**
|
|
43
|
-
* Creates a source-authenticated lead from query parameters, supporting simple form posts, tracking metadata, and follow-up automation.
|
|
44
|
-
*/
|
|
45
|
-
export interface IntakeRequestBuilderGetQueryParameters {
|
|
46
|
-
/**
|
|
47
|
-
* First street address line submitted by the lead intake source.
|
|
48
|
-
*/
|
|
49
|
-
address1?: string;
|
|
50
|
-
/**
|
|
51
|
-
* Second street address line submitted by the lead intake source.
|
|
52
|
-
*/
|
|
53
|
-
address2?: string;
|
|
54
|
-
/**
|
|
55
|
-
* Lead birth date used for demographic matching and insurance intake workflows.
|
|
56
|
-
*/
|
|
57
|
-
birthDate?: DateOnly;
|
|
58
|
-
/**
|
|
59
|
-
* City for the lead or organization postal address.
|
|
60
|
-
*/
|
|
61
|
-
city?: string;
|
|
62
|
-
/**
|
|
63
|
-
* Lead date of birth supplied by intake sources and normalized into the lead profile.
|
|
64
|
-
*/
|
|
65
|
-
dateOfBirth?: DateOnly;
|
|
66
|
-
/**
|
|
67
|
-
* Direct-post price supplied by the lead source during intake.
|
|
68
|
-
*/
|
|
69
|
-
directPostPrice?: number;
|
|
70
|
-
/**
|
|
71
|
-
* Email address for the person represented by this lead intake request.
|
|
72
|
-
*/
|
|
73
|
-
email?: string;
|
|
74
|
-
/**
|
|
75
|
-
* External system identifier used to reconcile this lead intake request across integrations.
|
|
76
|
-
*/
|
|
77
|
-
externalId?: string;
|
|
78
|
-
/**
|
|
79
|
-
* First name of the lead, user, or contact represented by this lead intake request.
|
|
80
|
-
*/
|
|
81
|
-
firstName?: string;
|
|
82
|
-
/**
|
|
83
|
-
* Lead gender supplied by intake sources and normalized when possible.
|
|
84
|
-
*/
|
|
85
|
-
gender?: string;
|
|
86
|
-
/**
|
|
87
|
-
* Landing page URL where the lead submitted their information.
|
|
88
|
-
*/
|
|
89
|
-
landingPage?: string;
|
|
90
|
-
/**
|
|
91
|
-
* Last name of the lead, user, or contact represented by this lead intake request.
|
|
92
|
-
*/
|
|
93
|
-
lastName?: string;
|
|
94
|
-
/**
|
|
95
|
-
* Phone details for the lead, user, or organization represented by this lead intake request.
|
|
96
|
-
*/
|
|
97
|
-
phone?: string;
|
|
98
|
-
/**
|
|
99
|
-
* Source-provided phone type, such as mobile, landline, or VoIP, used during lead intake normalization.
|
|
100
|
-
*/
|
|
101
|
-
phoneType?: string;
|
|
102
|
-
/**
|
|
103
|
-
* Postal code for the lead or organization address.
|
|
104
|
-
*/
|
|
105
|
-
postalCode?: string;
|
|
106
|
-
/**
|
|
107
|
-
* Lead price or transaction price supplied to the Leadping API.
|
|
108
|
-
*/
|
|
109
|
-
price?: number;
|
|
110
|
-
/**
|
|
111
|
-
* Product or offer associated with the lead or source.
|
|
112
|
-
*/
|
|
113
|
-
product?: string;
|
|
114
|
-
/**
|
|
115
|
-
* Referring page or traffic source that sent the lead into Leadping.
|
|
116
|
-
*/
|
|
117
|
-
referrer?: string;
|
|
118
|
-
/**
|
|
119
|
-
* Seller-provided lead identifier used to deduplicate and reconcile lead delivery.
|
|
120
|
-
*/
|
|
121
|
-
sellerLeadId?: string;
|
|
122
|
-
/**
|
|
123
|
-
* Alternate seller-provided lead identifier used during intake normalization.
|
|
124
|
-
*/
|
|
125
|
-
sellerLeadIdentifier?: string;
|
|
126
|
-
/**
|
|
127
|
-
* Source-provided key-value metadata retained for lead attribution and integration troubleshooting.
|
|
128
|
-
*/
|
|
129
|
-
sourceMetadata?: string;
|
|
130
|
-
/**
|
|
131
|
-
* State, province, or region for the lead or organization postal address.
|
|
132
|
-
*/
|
|
133
|
-
state?: string;
|
|
134
|
-
/**
|
|
135
|
-
* Affiliate or publisher sub ID captured for lead attribution.
|
|
136
|
-
*/
|
|
137
|
-
subId?: string;
|
|
138
|
-
/**
|
|
139
|
-
* Tag IDs assigned to or filtered against this lead.
|
|
140
|
-
*/
|
|
141
|
-
tagIds?: string[];
|
|
142
|
-
/**
|
|
143
|
-
* Tag names assigned to this lead when matching existing tags by name.
|
|
144
|
-
*/
|
|
145
|
-
tagNames?: string[];
|
|
146
|
-
/**
|
|
147
|
-
* TrustedForm certificate URL used as proof of consumer consent.
|
|
148
|
-
*/
|
|
149
|
-
trustedFormUrl?: string;
|
|
150
|
-
/**
|
|
151
|
-
* UTM campaign parameter captured for lead attribution reporting.
|
|
152
|
-
*/
|
|
153
|
-
utmCampaign?: string;
|
|
154
|
-
/**
|
|
155
|
-
* UTM content parameter captured for lead attribution reporting.
|
|
156
|
-
*/
|
|
157
|
-
utmContent?: string;
|
|
158
|
-
/**
|
|
159
|
-
* UTM medium parameter captured for lead attribution reporting.
|
|
160
|
-
*/
|
|
161
|
-
utmMedium?: string;
|
|
162
|
-
/**
|
|
163
|
-
* UTM source parameter captured for lead attribution reporting.
|
|
164
|
-
*/
|
|
165
|
-
utmSource?: string;
|
|
166
|
-
/**
|
|
167
|
-
* UTM term parameter captured for lead attribution reporting.
|
|
168
|
-
*/
|
|
169
|
-
utmTerm?: string;
|
|
170
|
-
/**
|
|
171
|
-
* Industry vertical used for lead routing, compliance review, and reporting.
|
|
172
|
-
*/
|
|
173
|
-
vertical?: string;
|
|
174
|
-
/**
|
|
175
|
-
* ZIP code submitted by the lead intake source.
|
|
176
|
-
*/
|
|
177
|
-
zip?: string;
|
|
178
|
-
}
|
|
179
26
|
/**
|
|
180
27
|
* Uri template for the request builder.
|
|
181
28
|
*/
|
|
182
|
-
export declare const IntakeRequestBuilderUriTemplate = "{+baseurl}/leads/intake
|
|
29
|
+
export declare const IntakeRequestBuilderUriTemplate = "{+baseurl}/leads/intake";
|
|
183
30
|
/**
|
|
184
31
|
* Metadata for all the requests in the request builder.
|
|
185
32
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../leads/intake/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAA2I,KAAK,iBAAiB,EAAE,KAAK,YAAY,EAAuB,MAAM,uBAAuB,CAAC;AAEhP,OAAO,EAAE,KAAK,kBAAkB,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../leads/intake/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAA2I,KAAK,iBAAiB,EAAE,KAAK,YAAY,EAAuB,MAAM,uBAAuB,CAAC;AAEhP,OAAO,EAAE,KAAK,kBAAkB,EAAuC,KAAK,oBAAoB,EAAE,KAAK,kBAAkB,EAAE,KAAK,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AAExL;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,kBAAkB,CAAC,oBAAoB,CAAC;IAClF;;;;;;;;;OASG;IACF,IAAI,CAAC,IAAI,EAAE,iBAAiB,EAAE,oBAAoB,CAAC,EAAE,oBAAoB,CAAC,MAAM,CAAC,GAAG,SAAS,GAAI,OAAO,CAAC,YAAY,GAAG,SAAS,CAAC,CAAC;IACpI;;;;;OAKG;IACF,wBAAwB,CAAC,IAAI,EAAE,iBAAiB,EAAE,oBAAoB,CAAC,EAAE,oBAAoB,CAAC,MAAM,CAAC,GAAG,SAAS,GAAI,kBAAkB,CAAC;CAC5I;AACD;;GAEG;AACH,eAAO,MAAM,+BAA+B,4BAA4B,CAAC;AACzE;;GAEG;AACH,eAAO,MAAM,oCAAoC,EAAE,gBAgBlD,CAAC"}
|
|
@@ -6,62 +6,11 @@ import { createLeadResponseFromDiscriminatorValue, createProblemDetailsFromDiscr
|
|
|
6
6
|
/**
|
|
7
7
|
* Uri template for the request builder.
|
|
8
8
|
*/
|
|
9
|
-
export const IntakeRequestBuilderUriTemplate = "{+baseurl}/leads/intake
|
|
10
|
-
/**
|
|
11
|
-
* Mapper for query parameters from symbol name to serialization name represented as a constant.
|
|
12
|
-
*/
|
|
13
|
-
const IntakeRequestBuilderGetQueryParametersMapper = {
|
|
14
|
-
"address1": "Address1",
|
|
15
|
-
"address2": "Address2",
|
|
16
|
-
"birthDate": "BirthDate",
|
|
17
|
-
"city": "City",
|
|
18
|
-
"dateOfBirth": "DateOfBirth",
|
|
19
|
-
"directPostPrice": "DirectPostPrice",
|
|
20
|
-
"email": "Email",
|
|
21
|
-
"externalId": "ExternalId",
|
|
22
|
-
"firstName": "FirstName",
|
|
23
|
-
"gender": "Gender",
|
|
24
|
-
"landingPage": "LandingPage",
|
|
25
|
-
"lastName": "LastName",
|
|
26
|
-
"phone": "Phone",
|
|
27
|
-
"phoneType": "PhoneType",
|
|
28
|
-
"postalCode": "PostalCode",
|
|
29
|
-
"price": "Price",
|
|
30
|
-
"product": "Product",
|
|
31
|
-
"referrer": "Referrer",
|
|
32
|
-
"sellerLeadId": "SellerLeadId",
|
|
33
|
-
"sellerLeadIdentifier": "SellerLeadIdentifier",
|
|
34
|
-
"sourceMetadata": "SourceMetadata",
|
|
35
|
-
"state": "State",
|
|
36
|
-
"subId": "SubId",
|
|
37
|
-
"tagIds": "TagIds",
|
|
38
|
-
"tagNames": "TagNames",
|
|
39
|
-
"trustedFormUrl": "TrustedFormUrl",
|
|
40
|
-
"utmCampaign": "UtmCampaign",
|
|
41
|
-
"utmContent": "UtmContent",
|
|
42
|
-
"utmMedium": "UtmMedium",
|
|
43
|
-
"utmSource": "UtmSource",
|
|
44
|
-
"utmTerm": "UtmTerm",
|
|
45
|
-
"vertical": "Vertical",
|
|
46
|
-
"zip": "Zip",
|
|
47
|
-
};
|
|
9
|
+
export const IntakeRequestBuilderUriTemplate = "{+baseurl}/leads/intake";
|
|
48
10
|
/**
|
|
49
11
|
* Metadata for all the requests in the request builder.
|
|
50
12
|
*/
|
|
51
13
|
export const IntakeRequestBuilderRequestsMetadata = {
|
|
52
|
-
get: {
|
|
53
|
-
uriTemplate: IntakeRequestBuilderUriTemplate,
|
|
54
|
-
responseBodyContentType: "application/json",
|
|
55
|
-
errorMappings: {
|
|
56
|
-
400: createProblemDetailsFromDiscriminatorValue,
|
|
57
|
-
401: createProblemDetailsFromDiscriminatorValue,
|
|
58
|
-
403: createProblemDetailsFromDiscriminatorValue,
|
|
59
|
-
429: createProblemDetailsFromDiscriminatorValue,
|
|
60
|
-
},
|
|
61
|
-
adapterMethodName: "send",
|
|
62
|
-
responseBodyFactory: createLeadResponseFromDiscriminatorValue,
|
|
63
|
-
queryParametersMapper: IntakeRequestBuilderGetQueryParametersMapper,
|
|
64
|
-
},
|
|
65
14
|
post: {
|
|
66
15
|
uriTemplate: IntakeRequestBuilderUriTemplate,
|
|
67
16
|
responseBodyContentType: "application/json",
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../leads/intake/index.ts"],"names":[],"mappings":"AAAA,oBAAoB;AACpB,oBAAoB;AACpB,+BAA+B;AAC/B,aAAa;AACb,OAAO,EAAE,wCAAwC,EAAE,0CAA0C,EAAE,0BAA0B,EAAyF,MAAM,uBAAuB,CAAC;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../leads/intake/index.ts"],"names":[],"mappings":"AAAA,oBAAoB;AACpB,oBAAoB;AACpB,+BAA+B;AAC/B,aAAa;AACb,OAAO,EAAE,wCAAwC,EAAE,0CAA0C,EAAE,0BAA0B,EAAyF,MAAM,uBAAuB,CAAC;AA2BhP;;GAEG;AACH,MAAM,CAAC,MAAM,+BAA+B,GAAG,yBAAyB,CAAC;AACzE;;GAEG;AACH,MAAM,CAAC,MAAM,oCAAoC,GAAqB;IAClE,IAAI,EAAE;QACF,WAAW,EAAE,+BAA+B;QAC5C,uBAAuB,EAAE,kBAAkB;QAC3C,aAAa,EAAE;YACX,GAAG,EAAE,0CAAuE;YAC5E,GAAG,EAAE,0CAAuE;YAC5E,GAAG,EAAE,0CAAuE;YAC5E,GAAG,EAAE,0CAAuE;SAC/E;QACD,iBAAiB,EAAE,MAAM;QACzB,mBAAmB,EAAG,wCAAwC;QAC9D,sBAAsB,EAAE,kBAAkB;QAC1C,qBAAqB,EAAE,0BAA0B;QACjD,kCAAkC,EAAE,wBAAwB;KAC/D;CACJ,CAAC;AACF,mBAAmB;AACnB,mBAAmB"}
|
package/package.json
CHANGED