@leadping/sdk 1.0.7 → 1.0.9

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.
Files changed (38) hide show
  1. package/README.md +6 -1
  2. package/dist/automations/index.d.ts +2 -2
  3. package/dist/automations/item/index.d.ts +2 -2
  4. package/dist/automations/preview/index.d.ts +2 -2
  5. package/dist/businesses/me/index.d.ts +2 -2
  6. package/dist/businesses/me/switchEscaped/index.d.ts +2 -2
  7. package/dist/businesses/me/users/index.d.ts +2 -2
  8. package/dist/businesses/me/users/item/index.d.ts +2 -2
  9. package/dist/contact/index.d.ts +2 -2
  10. package/dist/feedback/admin/index.d.ts +27 -0
  11. package/dist/feedback/admin/index.d.ts.map +1 -1
  12. package/dist/feedback/admin/index.js.map +1 -1
  13. package/dist/feedback/admin/item/index.d.ts +2 -2
  14. package/dist/feedback/index.d.ts +2 -2
  15. package/dist/leads/index.d.ts +2 -2
  16. package/dist/leads/intake/index.d.ts +35 -35
  17. package/dist/leads/item/archive/index.d.ts +3 -3
  18. package/dist/leads/item/index.d.ts +2 -2
  19. package/dist/leads/item/tags/index.d.ts +4 -4
  20. package/dist/models/index.d.ts +1109 -1020
  21. package/dist/models/index.d.ts.map +1 -1
  22. package/dist/models/index.js +48 -0
  23. package/dist/models/index.js.map +1 -1
  24. package/dist/phoneNumbers/index.d.ts +2 -2
  25. package/dist/phoneNumbers/isAvailableForPurchase/index.d.ts +2 -2
  26. package/dist/phoneNumbers/item/index.d.ts +2 -2
  27. package/dist/phoneNumbers/outgoing/conversation/item/index.d.ts +2 -2
  28. package/dist/phoneNumbers/outgoing/conversation/item/override/index.d.ts +2 -2
  29. package/dist/phoneNumbers/outgoing/manualOverride/index.d.ts +2 -2
  30. package/dist/phoneNumbers/outgoing/newEscaped/index.d.ts +2 -2
  31. package/dist/phoneNumbers/search/index.d.ts +2 -2
  32. package/dist/sms/send/index.d.ts +2 -2
  33. package/dist/sources/index.d.ts +2 -2
  34. package/dist/sources/item/index.d.ts +2 -2
  35. package/dist/tags/index.d.ts +2 -2
  36. package/dist/tags/item/index.d.ts +2 -2
  37. package/dist/users/me/index.d.ts +2 -2
  38. package/package.json +1 -1
package/README.md CHANGED
@@ -1,4 +1,9 @@
1
- # Leadping TypeScript SDK
1
+ [![](https://img.shields.io/npm/v/@leadping/sdk.svg?style=for-the-badge)](https://www.npmjs.com/package/@leadping/sdk)
2
+ [![](https://img.shields.io/github/actions/workflow/status/leadpingai/leadping-typescript/publish.yml?style=for-the-badge)](https://github.com/leadpingai/leadping-typescript/actions/workflows/publish.yml)
3
+ [![](https://img.shields.io/npm/dt/@leadping/sdk.svg?style=for-the-badge)](https://www.npmjs.com/package/@leadping/sdk)
4
+ [![](https://img.shields.io/github/actions/workflow/status/leadpingai/leadping-typescript/codeql.yml?label=CodeQL&style=for-the-badge)](https://github.com/leadpingai/leadping-typescript/actions/workflows/codeql.yml)
5
+
6
+ # ![Leadping](https://leadping.ai/favicon.ico) Leadping TypeScript SDK
2
7
 
3
8
  Type-safe TypeScript client for the Leadping API.
4
9
 
@@ -23,7 +23,7 @@ export interface AutomationsRequestBuilder extends BaseRequestBuilder<Automation
23
23
  byId(id: string): AutomationsItemRequestBuilder;
24
24
  /**
25
25
  * Creates an automation for current-business leads, configuring triggers, message steps, and follow-up behavior.
26
- * @param body Request payload for automation.
26
+ * @param body Request schema for the Leadping API automation configuration request, including the fields clients can send.
27
27
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
28
28
  * @returns {Promise<AutomationResponse>}
29
29
  * @throws {ProblemDetails} error when the service returns a 400 status code
@@ -31,7 +31,7 @@ export interface AutomationsRequestBuilder extends BaseRequestBuilder<Automation
31
31
  post(body: AutomationRequest, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<AutomationResponse | undefined>;
32
32
  /**
33
33
  * Creates an automation for current-business leads, configuring triggers, message steps, and follow-up behavior.
34
- * @param body Request payload for automation.
34
+ * @param body Request schema for the Leadping API automation configuration request, including the fields clients can send.
35
35
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
36
36
  * @returns {RequestInformation}
37
37
  */
@@ -20,7 +20,7 @@ export interface AutomationsItemRequestBuilder extends BaseRequestBuilder<Automa
20
20
  get(requestConfiguration?: RequestConfiguration<object> | undefined): Promise<AutomationResponse | undefined>;
21
21
  /**
22
22
  * Updates an automation for current-business leads, changing triggers, message steps, routing, or active follow-up settings.
23
- * @param body Request payload for automation.
23
+ * @param body Request schema for the Leadping API automation configuration request, including the fields clients can send.
24
24
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
25
25
  * @returns {Promise<AutomationResponse>}
26
26
  * @throws {ProblemDetails} error when the service returns a 400 status code
@@ -41,7 +41,7 @@ export interface AutomationsItemRequestBuilder extends BaseRequestBuilder<Automa
41
41
  toGetRequestInformation(requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
42
42
  /**
43
43
  * Updates an automation for current-business leads, changing triggers, message steps, routing, or active follow-up settings.
44
- * @param body Request payload for automation.
44
+ * @param body Request schema for the Leadping API automation configuration request, including the fields clients can send.
45
45
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
46
46
  * @returns {RequestInformation}
47
47
  */
@@ -6,7 +6,7 @@ import { type BaseRequestBuilder, type RequestConfiguration, type RequestInforma
6
6
  export interface PreviewRequestBuilder extends BaseRequestBuilder<PreviewRequestBuilder> {
7
7
  /**
8
8
  * Previews automation execution for a sample lead, showing matched steps and messages without creating follow-up events.
9
- * @param body API DTO containing automation preview data used by Leadping API contracts.
9
+ * @param body Request schema for the Leadping API automation preview request, including the fields clients can send.
10
10
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
11
11
  * @returns {Promise<AutomationPreviewResponse>}
12
12
  * @throws {ProblemDetails} error when the service returns a 400 status code
@@ -14,7 +14,7 @@ export interface PreviewRequestBuilder extends BaseRequestBuilder<PreviewRequest
14
14
  post(body: AutomationPreviewRequest, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<AutomationPreviewResponse | undefined>;
15
15
  /**
16
16
  * Previews automation execution for a sample lead, showing matched steps and messages without creating follow-up events.
17
- * @param body API DTO containing automation preview data used by Leadping API contracts.
17
+ * @param body Request schema for the Leadping API automation preview request, including the fields clients can send.
18
18
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
19
19
  * @returns {RequestInformation}
20
20
  */
@@ -33,7 +33,7 @@ export interface MeRequestBuilder extends BaseRequestBuilder<MeRequestBuilder> {
33
33
  get(requestConfiguration?: RequestConfiguration<object> | undefined): Promise<BusinessResponse | undefined>;
34
34
  /**
35
35
  * Updates the authenticated user's current business profile, including contact, settings, and communication configuration.
36
- * @param body Request payload for business.
36
+ * @param body Request schema for the Leadping API business profile request, including the fields clients can send.
37
37
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
38
38
  * @returns {Promise<BusinessResponse>}
39
39
  * @throws {ProblemDetails} error when the service returns a 400 status code
@@ -47,7 +47,7 @@ export interface MeRequestBuilder extends BaseRequestBuilder<MeRequestBuilder> {
47
47
  toGetRequestInformation(requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
48
48
  /**
49
49
  * Updates the authenticated user's current business profile, including contact, settings, and communication configuration.
50
- * @param body Request payload for business.
50
+ * @param body Request schema for the Leadping API business profile request, including the fields clients can send.
51
51
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
52
52
  * @returns {RequestInformation}
53
53
  */
@@ -6,7 +6,7 @@ import { type BaseRequestBuilder, type RequestConfiguration, type RequestInforma
6
6
  export interface SwitchRequestBuilder extends BaseRequestBuilder<SwitchRequestBuilder> {
7
7
  /**
8
8
  * Switches the authenticated user's active business context so subsequent lead, billing, and communication requests target that business.
9
- * @param body Request payload for business switch.
9
+ * @param body Request schema for the Leadping API business switch request, including the fields clients can send.
10
10
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
11
11
  * @returns {Promise<BusinessResponse>}
12
12
  * @throws {ProblemDetails} error when the service returns a 403 status code
@@ -14,7 +14,7 @@ export interface SwitchRequestBuilder extends BaseRequestBuilder<SwitchRequestBu
14
14
  post(body: BusinessSwitchRequest, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<BusinessResponse | undefined>;
15
15
  /**
16
16
  * Switches the authenticated user's active business context so subsequent lead, billing, and communication requests target that business.
17
- * @param body Request payload for business switch.
17
+ * @param body Request schema for the Leadping API business switch request, including the fields clients can send.
18
18
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
19
19
  * @returns {RequestInformation}
20
20
  */
@@ -19,7 +19,7 @@ export interface UsersRequestBuilder extends BaseRequestBuilder<UsersRequestBuil
19
19
  get(requestConfiguration?: RequestConfiguration<object> | undefined): Promise<BusinessUserTableRow[] | undefined>;
20
20
  /**
21
21
  * Adds an existing user to the current business with the requested role for shared lead communication and account access.
22
- * @param body Request payload for business user.
22
+ * @param body Request schema for the Leadping API business user request, including the fields clients can send.
23
23
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
24
24
  * @returns {Promise<BusinessUserResponse>}
25
25
  * @throws {ProblemDetails} error when the service returns a 400 status code
@@ -34,7 +34,7 @@ export interface UsersRequestBuilder extends BaseRequestBuilder<UsersRequestBuil
34
34
  toGetRequestInformation(requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
35
35
  /**
36
36
  * Adds an existing user to the current business with the requested role for shared lead communication and account access.
37
- * @param body Request payload for business user.
37
+ * @param body Request schema for the Leadping API business user request, including the fields clients can send.
38
38
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
39
39
  * @returns {RequestInformation}
40
40
  */
@@ -13,7 +13,7 @@ export interface WithUserItemRequestBuilder extends BaseRequestBuilder<WithUserI
13
13
  delete(requestConfiguration?: RequestConfiguration<object> | undefined): Promise<void>;
14
14
  /**
15
15
  * Changes a user's role in the current business, updating access to lead, automation, billing, and admin workflows.
16
- * @param body Request payload for business user.
16
+ * @param body Request schema for the Leadping API business user request, including the fields clients can send.
17
17
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
18
18
  * @returns {Promise<BusinessUserResponse>}
19
19
  * @throws {ProblemDetails} error when the service returns a 400 status code
@@ -28,7 +28,7 @@ export interface WithUserItemRequestBuilder extends BaseRequestBuilder<WithUserI
28
28
  toDeleteRequestInformation(requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
29
29
  /**
30
30
  * Changes a user's role in the current business, updating access to lead, automation, billing, and admin workflows.
31
- * @param body Request payload for business user.
31
+ * @param body Request schema for the Leadping API business user request, including the fields clients can send.
32
32
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
33
33
  * @returns {RequestInformation}
34
34
  */
@@ -6,7 +6,7 @@ import { type BaseRequestBuilder, type RequestConfiguration, type RequestInforma
6
6
  export interface ContactRequestBuilder extends BaseRequestBuilder<ContactRequestBuilder> {
7
7
  /**
8
8
  * Submits a public contact request to Leadping support, capturing sender details and message content without requiring authentication.
9
- * @param body Request model for submitting a contact form.
9
+ * @param body Request schema for the Leadping API contact form request, including the fields clients can send.
10
10
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
11
11
  * @returns {Promise<ContactResponse>}
12
12
  * @throws {ProblemDetails} error when the service returns a 400 status code
@@ -14,7 +14,7 @@ export interface ContactRequestBuilder extends BaseRequestBuilder<ContactRequest
14
14
  post(body: ContactRequest, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<ContactResponse | undefined>;
15
15
  /**
16
16
  * Submits a public contact request to Leadping support, capturing sender details and message content without requiring authentication.
17
- * @param body Request model for submitting a contact form.
17
+ * @param body Request schema for the Leadping API contact form request, including the fields clients can send.
18
18
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
19
19
  * @returns {RequestInformation}
20
20
  */
@@ -28,14 +28,41 @@ export interface AdminRequestBuilder extends BaseRequestBuilder<AdminRequestBuil
28
28
  * Lists submitted feedback for admin triage with query filters, paging, status, and category review fields.
29
29
  */
30
30
  export interface AdminRequestBuilderGetQueryParameters {
31
+ /**
32
+ * Product area or app section connected to this feedback admin query request.
33
+ */
31
34
  area?: string;
35
+ /**
36
+ * Business ID used to filter feedback items for admin review.
37
+ */
32
38
  businessId?: string;
39
+ /**
40
+ * Pagination token used to request the next page of Leadping API results.
41
+ */
33
42
  continuationToken?: string;
43
+ /**
44
+ * End of the created-at date range filter for Leadping API results.
45
+ */
34
46
  createdEnd?: Date;
47
+ /**
48
+ * Start of the created-at date range filter for Leadping API results.
49
+ */
35
50
  createdStart?: Date;
51
+ /**
52
+ * Maximum number of results requested for this Leadping API page.
53
+ */
36
54
  pageSize?: number;
55
+ /**
56
+ * Search text used to filter Leadping API results.
57
+ */
37
58
  search?: string;
59
+ /**
60
+ * Current lifecycle status for this feedback admin query request in the Leadping API.
61
+ */
38
62
  status?: string;
63
+ /**
64
+ * Type classification used to route and interpret this feedback admin query request in the Leadping API.
65
+ */
39
66
  type?: string;
40
67
  }
41
68
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../feedback/admin/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAA6D,KAAK,6BAA6B,EAAE,MAAM,uBAAuB,CAAC;AAEtI,OAAO,EAA2C,KAAK,uBAAuB,EAAE,MAAM,iBAAiB,CAAC;AAExG,OAAO,EAAE,KAAK,kBAAkB,EAAE,KAAK,kCAAkC,EAAE,KAAK,kBAAkB,EAAuC,KAAK,oBAAoB,EAAE,KAAK,kBAAkB,EAAE,KAAK,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AAE1P;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,kBAAkB,CAAC,mBAAmB,CAAC;IAChF;;;;OAIG;IACF,IAAI,CAAC,EAAE,EAAE,MAAM,GAAI,uBAAuB,CAAC;IAC5C;;;;OAIG;IACF,GAAG,CAAC,oBAAoB,CAAC,EAAE,oBAAoB,CAAC,qCAAqC,CAAC,GAAG,SAAS,GAAI,OAAO,CAAC,6BAA6B,GAAG,SAAS,CAAC,CAAC;IAC1J;;;;OAIG;IACF,uBAAuB,CAAC,oBAAoB,CAAC,EAAE,oBAAoB,CAAC,qCAAqC,CAAC,GAAG,SAAS,GAAI,kBAAkB,CAAC;CACjJ;AACD;;GAEG;AACH,MAAM,WAAW,qCAAqC;IAClD,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,UAAU,CAAC,EAAE,IAAI,CAAC;IAClB,YAAY,CAAC,EAAE,IAAI,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;CACjB;AACD;;GAEG;AACH,eAAO,MAAM,8BAA8B,+HAA+H,CAAC;AAe3K;;GAEG;AACH,eAAO,MAAM,qCAAqC,EAAE,MAAM,CAAC,OAAO,CAAC,MAAM,mBAAmB,EAAE,kCAAkC,CAAC,EAAE,kBAAkB,CAKpJ,CAAC;AACF;;GAEG;AACH,eAAO,MAAM,mCAAmC,EAAE,gBAQjD,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../feedback/admin/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAA6D,KAAK,6BAA6B,EAAE,MAAM,uBAAuB,CAAC;AAEtI,OAAO,EAA2C,KAAK,uBAAuB,EAAE,MAAM,iBAAiB,CAAC;AAExG,OAAO,EAAE,KAAK,kBAAkB,EAAE,KAAK,kCAAkC,EAAE,KAAK,kBAAkB,EAAuC,KAAK,oBAAoB,EAAE,KAAK,kBAAkB,EAAE,KAAK,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AAE1P;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,kBAAkB,CAAC,mBAAmB,CAAC;IAChF;;;;OAIG;IACF,IAAI,CAAC,EAAE,EAAE,MAAM,GAAI,uBAAuB,CAAC;IAC5C;;;;OAIG;IACF,GAAG,CAAC,oBAAoB,CAAC,EAAE,oBAAoB,CAAC,qCAAqC,CAAC,GAAG,SAAS,GAAI,OAAO,CAAC,6BAA6B,GAAG,SAAS,CAAC,CAAC;IAC1J;;;;OAIG;IACF,uBAAuB,CAAC,oBAAoB,CAAC,EAAE,oBAAoB,CAAC,qCAAqC,CAAC,GAAG,SAAS,GAAI,kBAAkB,CAAC;CACjJ;AACD;;GAEG;AACH,MAAM,WAAW,qCAAqC;IAClD;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B;;OAEG;IACH,UAAU,CAAC,EAAE,IAAI,CAAC;IAClB;;OAEG;IACH,YAAY,CAAC,EAAE,IAAI,CAAC;IACpB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACjB;AACD;;GAEG;AACH,eAAO,MAAM,8BAA8B,+HAA+H,CAAC;AAe3K;;GAEG;AACH,eAAO,MAAM,qCAAqC,EAAE,MAAM,CAAC,OAAO,CAAC,MAAM,mBAAmB,EAAE,kCAAkC,CAAC,EAAE,kBAAkB,CAKpJ,CAAC;AACF;;GAEG;AACH,eAAO,MAAM,mCAAmC,EAAE,gBAQjD,CAAC"}
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../feedback/admin/index.ts"],"names":[],"mappings":"AAAA,oBAAoB;AACpB,oBAAoB;AACpB,+BAA+B;AAC/B,aAAa;AACb,OAAO,EAAE,yDAAyD,EAAsC,MAAM,uBAAuB,CAAC;AACtI,aAAa;AACb,OAAO,EAAE,uCAAuC,EAAgC,MAAM,iBAAiB,CAAC;AAyCxG;;GAEG;AACH,MAAM,CAAC,MAAM,8BAA8B,GAAG,4HAA4H,CAAC;AAC3K;;GAEG;AACH,MAAM,2CAA2C,GAA2B;IACxE,MAAM,EAAE,MAAM;IACd,YAAY,EAAE,YAAY;IAC1B,mBAAmB,EAAE,mBAAmB;IACxC,YAAY,EAAE,YAAY;IAC1B,cAAc,EAAE,cAAc;IAC9B,UAAU,EAAE,UAAU;IACtB,QAAQ,EAAE,QAAQ;IAClB,QAAQ,EAAE,QAAQ;IAClB,MAAM,EAAE,MAAM;CACjB,CAAC;AACF;;GAEG;AACH,MAAM,CAAC,MAAM,qCAAqC,GAAuG;IACrJ,IAAI,EAAE;QACF,gBAAgB,EAAE,uCAAuC;QACzD,sBAAsB,EAAE,CAAC,IAAI,CAAC;KACjC;CACJ,CAAC;AACF;;GAEG;AACH,MAAM,CAAC,MAAM,mCAAmC,GAAqB;IACjE,GAAG,EAAE;QACD,WAAW,EAAE,8BAA8B;QAC3C,uBAAuB,EAAE,kBAAkB;QAC3C,iBAAiB,EAAE,MAAM;QACzB,mBAAmB,EAAG,yDAAyD;QAC/E,qBAAqB,EAAE,2CAA2C;KACrE;CACJ,CAAC;AACF,mBAAmB;AACnB,mBAAmB"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../feedback/admin/index.ts"],"names":[],"mappings":"AAAA,oBAAoB;AACpB,oBAAoB;AACpB,+BAA+B;AAC/B,aAAa;AACb,OAAO,EAAE,yDAAyD,EAAsC,MAAM,uBAAuB,CAAC;AACtI,aAAa;AACb,OAAO,EAAE,uCAAuC,EAAgC,MAAM,iBAAiB,CAAC;AAoExG;;GAEG;AACH,MAAM,CAAC,MAAM,8BAA8B,GAAG,4HAA4H,CAAC;AAC3K;;GAEG;AACH,MAAM,2CAA2C,GAA2B;IACxE,MAAM,EAAE,MAAM;IACd,YAAY,EAAE,YAAY;IAC1B,mBAAmB,EAAE,mBAAmB;IACxC,YAAY,EAAE,YAAY;IAC1B,cAAc,EAAE,cAAc;IAC9B,UAAU,EAAE,UAAU;IACtB,QAAQ,EAAE,QAAQ;IAClB,QAAQ,EAAE,QAAQ;IAClB,MAAM,EAAE,MAAM;CACjB,CAAC;AACF;;GAEG;AACH,MAAM,CAAC,MAAM,qCAAqC,GAAuG;IACrJ,IAAI,EAAE;QACF,gBAAgB,EAAE,uCAAuC;QACzD,sBAAsB,EAAE,CAAC,IAAI,CAAC;KACjC;CACJ,CAAC;AACF;;GAEG;AACH,MAAM,CAAC,MAAM,mCAAmC,GAAqB;IACjE,GAAG,EAAE;QACD,WAAW,EAAE,8BAA8B;QAC3C,uBAAuB,EAAE,kBAAkB;QAC3C,iBAAiB,EAAE,MAAM;QACzB,mBAAmB,EAAG,yDAAyD;QAC/E,qBAAqB,EAAE,2CAA2C;KACrE;CACJ,CAAC;AACF,mBAAmB;AACnB,mBAAmB"}
@@ -13,7 +13,7 @@ export interface AdminItemRequestBuilder extends BaseRequestBuilder<AdminItemReq
13
13
  get(requestConfiguration?: RequestConfiguration<object> | undefined): Promise<FeedbackResponse | undefined>;
14
14
  /**
15
15
  * Updates admin triage fields on a feedback item, such as status, priority, notes, or reviewed metadata.
16
- * @param body Admin triage update request for product feedback.
16
+ * @param body Request schema for the Leadping API feedback admin update request, including the fields clients can send.
17
17
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
18
18
  * @returns {Promise<FeedbackResponse>}
19
19
  * @throws {ProblemDetails} error when the service returns a 400 status code
@@ -28,7 +28,7 @@ export interface AdminItemRequestBuilder extends BaseRequestBuilder<AdminItemReq
28
28
  toGetRequestInformation(requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
29
29
  /**
30
30
  * Updates admin triage fields on a feedback item, such as status, priority, notes, or reviewed metadata.
31
- * @param body Admin triage update request for product feedback.
31
+ * @param body Request schema for the Leadping API feedback admin update request, including the fields clients can send.
32
32
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
33
33
  * @returns {RequestInformation}
34
34
  */
@@ -11,7 +11,7 @@ export interface FeedbackRequestBuilder extends BaseRequestBuilder<FeedbackReque
11
11
  get admin(): AdminRequestBuilder;
12
12
  /**
13
13
  * Creates product feedback for the current business, capturing category, message, and context for operator review.
14
- * @param body User-facing request for product feedback capture.
14
+ * @param body Request schema for the Leadping API feedback creation request, including the fields clients can send.
15
15
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
16
16
  * @returns {Promise<FeedbackResponse>}
17
17
  * @throws {ProblemDetails} error when the service returns a 400 status code
@@ -19,7 +19,7 @@ export interface FeedbackRequestBuilder extends BaseRequestBuilder<FeedbackReque
19
19
  post(body: FeedbackCreateRequest, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<FeedbackResponse | undefined>;
20
20
  /**
21
21
  * Creates product feedback for the current business, capturing category, message, and context for operator review.
22
- * @param body User-facing request for product feedback capture.
22
+ * @param body Request schema for the Leadping API feedback creation request, including the fields clients can send.
23
23
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
24
24
  * @returns {RequestInformation}
25
25
  */
@@ -23,7 +23,7 @@ export interface LeadsRequestBuilder extends BaseRequestBuilder<LeadsRequestBuil
23
23
  byId(id: string): LeadsItemRequestBuilder;
24
24
  /**
25
25
  * Creates a source-authenticated lead captured outside Leadping, starting follow-up, routing, and automation from structured lead data.
26
- * @param body Request payload for lead.
26
+ * @param body Request schema for the Leadping API lead request, including the fields clients can send.
27
27
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
28
28
  * @returns {Promise<LeadResponse>}
29
29
  * @throws {ProblemDetails} error when the service returns a 400 status code
@@ -34,7 +34,7 @@ export interface LeadsRequestBuilder extends BaseRequestBuilder<LeadsRequestBuil
34
34
  post(body: LeadRequest, requestConfiguration?: RequestConfiguration<LeadsRequestBuilderPostQueryParameters> | undefined): Promise<LeadResponse | undefined>;
35
35
  /**
36
36
  * Creates a source-authenticated lead captured outside Leadping, starting follow-up, routing, and automation from structured lead data.
37
- * @param body Request payload for lead.
37
+ * @param body Request schema for the Leadping API lead request, including the fields clients can send.
38
38
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
39
39
  * @returns {RequestInformation}
40
40
  */
@@ -15,7 +15,7 @@ export interface IntakeRequestBuilder extends BaseRequestBuilder<IntakeRequestBu
15
15
  get(requestConfiguration?: RequestConfiguration<IntakeRequestBuilderGetQueryParameters> | undefined): Promise<LeadResponse | undefined>;
16
16
  /**
17
17
  * Creates a source-authenticated lead from a flat intake payload, capturing contact fields, metadata, and automation-ready lead details.
18
- * @param body Request payload for lead intake.
18
+ * @param body Request schema for the Leadping API lead intake request, including the fields clients can send.
19
19
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
20
20
  * @returns {Promise<LeadResponse>}
21
21
  * @throws {ProblemDetails} error when the service returns a 400 status code
@@ -31,7 +31,7 @@ export interface IntakeRequestBuilder extends BaseRequestBuilder<IntakeRequestBu
31
31
  toGetRequestInformation(requestConfiguration?: RequestConfiguration<IntakeRequestBuilderGetQueryParameters> | undefined): RequestInformation;
32
32
  /**
33
33
  * Creates a source-authenticated lead from a flat intake payload, capturing contact fields, metadata, and automation-ready lead details.
34
- * @param body Request payload for lead intake.
34
+ * @param body Request schema for the Leadping API lead intake request, including the fields clients can send.
35
35
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
36
36
  * @returns {RequestInformation}
37
37
  */
@@ -42,83 +42,83 @@ export interface IntakeRequestBuilder extends BaseRequestBuilder<IntakeRequestBu
42
42
  */
43
43
  export interface IntakeRequestBuilderGetQueryParameters {
44
44
  /**
45
- * The address1 value for this lead intake.
45
+ * First street address line submitted by the lead intake source.
46
46
  */
47
47
  address1?: string;
48
48
  /**
49
- * The address2 value for this lead intake.
49
+ * Second street address line submitted by the lead intake source.
50
50
  */
51
51
  address2?: string;
52
52
  /**
53
- * The date and time for the birth date value on this lead intake.
53
+ * Lead birth date used for demographic matching and insurance intake workflows.
54
54
  */
55
55
  birthDate?: DateOnly;
56
56
  /**
57
- * The city value for this lead intake.
57
+ * City for the lead or business postal address.
58
58
  */
59
59
  city?: string;
60
60
  /**
61
- * The date and time for the date of birth value on this lead intake.
61
+ * Lead date of birth supplied by intake sources and normalized into the lead profile.
62
62
  */
63
63
  dateOfBirth?: DateOnly;
64
64
  /**
65
- * The direct post price value for this lead intake.
65
+ * Direct-post price supplied by the lead source during intake.
66
66
  */
67
67
  directPostPrice?: number;
68
68
  /**
69
- * The email address associated with this lead intake.
69
+ * Email address for the person represented by this lead intake request.
70
70
  */
71
71
  email?: string;
72
72
  /**
73
- * The external ID associated with this lead intake.
73
+ * External system identifier used to reconcile this lead intake request across integrations.
74
74
  */
75
75
  externalId?: string;
76
76
  /**
77
- * The first name value for this lead intake.
77
+ * First name of the lead, user, or contact represented by this lead intake request.
78
78
  */
79
79
  firstName?: string;
80
80
  /**
81
- * The gender value for this lead intake.
81
+ * Lead gender supplied by intake sources and normalized when possible.
82
82
  */
83
83
  gender?: string;
84
84
  /**
85
- * The landing page value for this lead intake.
85
+ * Landing page URL where the lead submitted their information.
86
86
  */
87
87
  landingPage?: string;
88
88
  /**
89
- * The date and time for the last name value on this lead intake.
89
+ * Last name of the lead, user, or contact represented by this lead intake request.
90
90
  */
91
91
  lastName?: string;
92
92
  /**
93
- * The phone number associated with this lead intake.
93
+ * Phone details for the lead, user, or business represented by this lead intake request.
94
94
  */
95
95
  phone?: string;
96
96
  /**
97
- * The phone type classification for this lead intake.
97
+ * Source-provided phone type, such as mobile, landline, or VoIP, used during lead intake normalization.
98
98
  */
99
99
  phoneType?: string;
100
100
  /**
101
- * The postal code value for this lead intake.
101
+ * Postal code for the lead or business address.
102
102
  */
103
103
  postalCode?: string;
104
104
  /**
105
- * The monetary price for this lead intake.
105
+ * Lead price or transaction price supplied to the Leadping API.
106
106
  */
107
107
  price?: number;
108
108
  /**
109
- * The product value for this lead intake.
109
+ * Product or offer associated with the lead or source.
110
110
  */
111
111
  product?: string;
112
112
  /**
113
- * The referrer value for this lead intake.
113
+ * Referring page or traffic source that sent the lead into Leadping.
114
114
  */
115
115
  referrer?: string;
116
116
  /**
117
- * The seller lead ID associated with this lead intake.
117
+ * Seller-provided lead identifier used to deduplicate and reconcile lead delivery.
118
118
  */
119
119
  sellerLeadId?: string;
120
120
  /**
121
- * The seller lead identifier value for this lead intake.
121
+ * Alternate seller-provided lead identifier used during intake normalization.
122
122
  */
123
123
  sellerLeadIdentifier?: string;
124
124
  /**
@@ -126,55 +126,55 @@ export interface IntakeRequestBuilderGetQueryParameters {
126
126
  */
127
127
  sourceKey?: string;
128
128
  /**
129
- * The source metadata key-value data carried with this lead intake; values must be safe to expose in API responses.
129
+ * Source-provided key-value metadata retained for lead attribution and integration troubleshooting.
130
130
  */
131
131
  sourceMetadata?: string;
132
132
  /**
133
- * The current state for this lead intake.
133
+ * State, province, or region for the lead or business postal address.
134
134
  */
135
135
  state?: string;
136
136
  /**
137
- * The sub ID associated with this lead intake.
137
+ * Affiliate or publisher sub ID captured for lead attribution.
138
138
  */
139
139
  subId?: string;
140
140
  /**
141
- * Existing business tag ids to assign as part of intake.
141
+ * Tag IDs assigned to or filtered against this lead.
142
142
  */
143
143
  tagIds?: string[];
144
144
  /**
145
- * Business tag names to assign as part of intake.
145
+ * Tag names assigned to this lead when matching existing tags by name.
146
146
  */
147
147
  tagNames?: string[];
148
148
  /**
149
- * The URL associated with this lead intake.
149
+ * TrustedForm certificate URL used as proof of consumer consent.
150
150
  */
151
151
  trustedFormUrl?: string;
152
152
  /**
153
- * The utm campaign value for this lead intake.
153
+ * UTM campaign parameter captured for lead attribution reporting.
154
154
  */
155
155
  utmCampaign?: string;
156
156
  /**
157
- * The utm content value for this lead intake.
157
+ * UTM content parameter captured for lead attribution reporting.
158
158
  */
159
159
  utmContent?: string;
160
160
  /**
161
- * The utm medium value for this lead intake.
161
+ * UTM medium parameter captured for lead attribution reporting.
162
162
  */
163
163
  utmMedium?: string;
164
164
  /**
165
- * The utm source value for this lead intake.
165
+ * UTM source parameter captured for lead attribution reporting.
166
166
  */
167
167
  utmSource?: string;
168
168
  /**
169
- * The utm term value for this lead intake.
169
+ * UTM term parameter captured for lead attribution reporting.
170
170
  */
171
171
  utmTerm?: string;
172
172
  /**
173
- * The vertical value for this lead intake.
173
+ * Industry vertical used for lead routing, compliance review, and reporting.
174
174
  */
175
175
  vertical?: string;
176
176
  /**
177
- * The zip value for this lead intake.
177
+ * ZIP code submitted by the lead intake source.
178
178
  */
179
179
  zip?: string;
180
180
  }
@@ -1,7 +1,7 @@
1
1
  import { type LeadArchiveRequest, type LeadResponse } from '../../../models/index.js';
2
2
  import { type BaseRequestBuilder, type Parsable, type ParseNode, type RequestConfiguration, type RequestInformation, type RequestsMetadata, type SerializationWriter } from '@microsoft/kiota-abstractions';
3
3
  /**
4
- * Request payload for archiving a lead without deleting its history.
4
+ * Request schema for the Leadping API lead archive request, including the fields clients can send.
5
5
  */
6
6
  export interface ArchivePostRequestBody extends LeadArchiveRequest, Parsable {
7
7
  }
@@ -11,7 +11,7 @@ export interface ArchivePostRequestBody extends LeadArchiveRequest, Parsable {
11
11
  export interface ArchiveRequestBuilder extends BaseRequestBuilder<ArchiveRequestBuilder> {
12
12
  /**
13
13
  * Archives a lead without deleting history, removing it from active pipeline views while preserving communication and event records.
14
- * @param body Request payload for archiving a lead without deleting its history.
14
+ * @param body Request schema for the Leadping API lead archive request, including the fields clients can send.
15
15
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
16
16
  * @returns {Promise<LeadResponse>}
17
17
  * @throws {ProblemDetails} error when the service returns a 400 status code
@@ -20,7 +20,7 @@ export interface ArchiveRequestBuilder extends BaseRequestBuilder<ArchiveRequest
20
20
  post(body: ArchivePostRequestBody, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<LeadResponse | undefined>;
21
21
  /**
22
22
  * Archives a lead without deleting history, removing it from active pipeline views while preserving communication and event records.
23
- * @param body Request payload for archiving a lead without deleting its history.
23
+ * @param body Request schema for the Leadping API lead archive request, including the fields clients can send.
24
24
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
25
25
  * @returns {RequestInformation}
26
26
  */
@@ -40,7 +40,7 @@ export interface LeadsItemRequestBuilder extends BaseRequestBuilder<LeadsItemReq
40
40
  get(requestConfiguration?: RequestConfiguration<object> | undefined): Promise<LeadResponse | undefined>;
41
41
  /**
42
42
  * Updates lead details for the current business, keeping contact data, status, source, and follow-up context current.
43
- * @param body Request payload for lead.
43
+ * @param body Request schema for the Leadping API lead request, including the fields clients can send.
44
44
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
45
45
  * @returns {Promise<LeadResponse>}
46
46
  * @throws {ProblemDetails} error when the service returns a 400 status code
@@ -61,7 +61,7 @@ export interface LeadsItemRequestBuilder extends BaseRequestBuilder<LeadsItemReq
61
61
  toGetRequestInformation(requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
62
62
  /**
63
63
  * Updates lead details for the current business, keeping contact data, status, source, and follow-up context current.
64
- * @param body Request payload for lead.
64
+ * @param body Request schema for the Leadping API lead request, including the fields clients can send.
65
65
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
66
66
  * @returns {RequestInformation}
67
67
  */
@@ -13,7 +13,7 @@ export interface TagsRequestBuilder extends BaseRequestBuilder<TagsRequestBuilde
13
13
  byTagId(tagId: string): WithTagItemRequestBuilder;
14
14
  /**
15
15
  * Adds one or more current-business tags to a lead so users can segment, filter, route, and review follow-up work.
16
- * @param body Request payload for adding or replacing tags on a lead.
16
+ * @param body Request schema for the Leadping API lead tag update request, including the fields clients can send.
17
17
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
18
18
  * @returns {Promise<LeadResponse>}
19
19
  * @throws {ProblemDetails} error when the service returns a 400 status code
@@ -22,7 +22,7 @@ export interface TagsRequestBuilder extends BaseRequestBuilder<TagsRequestBuilde
22
22
  post(body: LeadTagsRequest, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<LeadResponse | undefined>;
23
23
  /**
24
24
  * Replaces all tags on a lead with the supplied current-business tags, keeping segmentation and routing labels in sync.
25
- * @param body Request payload for adding or replacing tags on a lead.
25
+ * @param body Request schema for the Leadping API lead tag update request, including the fields clients can send.
26
26
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
27
27
  * @returns {Promise<LeadResponse>}
28
28
  * @throws {ProblemDetails} error when the service returns a 400 status code
@@ -31,14 +31,14 @@ export interface TagsRequestBuilder extends BaseRequestBuilder<TagsRequestBuilde
31
31
  put(body: LeadTagsRequest, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<LeadResponse | undefined>;
32
32
  /**
33
33
  * Adds one or more current-business tags to a lead so users can segment, filter, route, and review follow-up work.
34
- * @param body Request payload for adding or replacing tags on a lead.
34
+ * @param body Request schema for the Leadping API lead tag update request, including the fields clients can send.
35
35
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
36
36
  * @returns {RequestInformation}
37
37
  */
38
38
  toPostRequestInformation(body: LeadTagsRequest, requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
39
39
  /**
40
40
  * Replaces all tags on a lead with the supplied current-business tags, keeping segmentation and routing labels in sync.
41
- * @param body Request payload for adding or replacing tags on a lead.
41
+ * @param body Request schema for the Leadping API lead tag update request, including the fields clients can send.
42
42
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
43
43
  * @returns {RequestInformation}
44
44
  */