@leadping/sdk 1.0.32 → 1.0.33

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 (78) hide show
  1. package/dist/analytics/my/index.d.ts +9 -0
  2. package/dist/analytics/my/index.d.ts.map +1 -1
  3. package/dist/analytics/my/index.js.map +1 -1
  4. package/dist/automations/index.d.ts +2 -2
  5. package/dist/automations/item/index.d.ts +2 -2
  6. package/dist/automations/preview/index.d.ts +2 -2
  7. package/dist/contact/index.d.ts +2 -2
  8. package/dist/conversations/my/index.d.ts +3 -0
  9. package/dist/conversations/my/index.d.ts.map +1 -1
  10. package/dist/conversations/my/index.js.map +1 -1
  11. package/dist/events/all/my/index.d.ts +9 -0
  12. package/dist/events/all/my/index.d.ts.map +1 -1
  13. package/dist/events/all/my/index.js.map +1 -1
  14. package/dist/events/conversations/item/notes/index.d.ts +2 -2
  15. package/dist/events/organizations/item/index.d.ts +6 -0
  16. package/dist/events/organizations/item/index.d.ts.map +1 -1
  17. package/dist/events/organizations/item/index.js.map +1 -1
  18. package/dist/feedback/index.d.ts +2 -2
  19. package/dist/leadStatusChanges/all/my/index.d.ts +2 -2
  20. package/dist/leadStatuses/index.d.ts +1 -1
  21. package/dist/leads/all/my/index.d.ts +12 -0
  22. package/dist/leads/all/my/index.d.ts.map +1 -1
  23. package/dist/leads/all/my/index.js.map +1 -1
  24. package/dist/leads/index.d.ts +2 -2
  25. package/dist/leads/intake/index.d.ts +2 -2
  26. package/dist/leads/item/archive/index.d.ts +3 -3
  27. package/dist/leads/item/index.d.ts +2 -2
  28. package/dist/leads/item/tags/index.d.ts +5 -5
  29. package/dist/models/index.d.ts +456 -369
  30. package/dist/models/index.d.ts.map +1 -1
  31. package/dist/models/index.js +69 -2
  32. package/dist/models/index.js.map +1 -1
  33. package/dist/notifications/push/installations/current/index.d.ts +2 -2
  34. package/dist/notifications/push/installations/index.d.ts +1 -1
  35. package/dist/notifications/push/installations/item/index.d.ts +2 -2
  36. package/dist/organizations/invitations/accept/index.d.ts +2 -2
  37. package/dist/organizations/me/index.d.ts +4 -4
  38. package/dist/organizations/me/invitations/index.d.ts +2 -2
  39. package/dist/organizations/me/members/index.d.ts +2 -2
  40. package/dist/organizations/me/members/item/index.d.ts +2 -2
  41. package/dist/organizations/me/switchEscaped/index.d.ts +2 -2
  42. package/dist/paymentMethods/invoices/index.d.ts +1 -1
  43. package/dist/paymentMethods/invoices/item/pdfAccess/index.d.ts +3 -0
  44. package/dist/paymentMethods/invoices/item/pdfAccess/index.d.ts.map +1 -1
  45. package/dist/paymentMethods/invoices/item/pdfAccess/index.js.map +1 -1
  46. package/dist/phoneCall/initiate/index.d.ts +2 -2
  47. package/dist/phoneNumbers/index.d.ts +2 -2
  48. package/dist/phoneNumbers/isAvailableForPurchase/index.d.ts +2 -2
  49. package/dist/phoneNumbers/item/index.d.ts +2 -2
  50. package/dist/phoneNumbers/outgoing/conversation/item/index.d.ts +2 -2
  51. package/dist/phoneNumbers/outgoing/conversation/item/override/index.d.ts +2 -2
  52. package/dist/phoneNumbers/outgoing/manualOverride/index.d.ts +2 -2
  53. package/dist/phoneNumbers/outgoing/newEscaped/index.d.ts +2 -2
  54. package/dist/phoneNumbers/search/index.d.ts +2 -2
  55. package/dist/reports/exports/index.d.ts +1 -1
  56. package/dist/reports/exports/item/download/index.d.ts +3 -0
  57. package/dist/reports/exports/item/download/index.d.ts.map +1 -1
  58. package/dist/reports/exports/item/download/index.js.map +1 -1
  59. package/dist/sms/media/index.d.ts +2 -2
  60. package/dist/sms/send/index.d.ts +2 -2
  61. package/dist/sources/index.d.ts +2 -2
  62. package/dist/sources/item/index.d.ts +2 -2
  63. package/dist/suppressions/all/my/index.d.ts +2 -2
  64. package/dist/suppressions/check/index.d.ts +2 -2
  65. package/dist/suppressions/index.d.ts +3 -3
  66. package/dist/suppressions/item/index.d.ts +2 -2
  67. package/dist/suppressions/release/index.d.ts +2 -2
  68. package/dist/tags/index.d.ts +6 -3
  69. package/dist/tags/index.d.ts.map +1 -1
  70. package/dist/tags/index.js.map +1 -1
  71. package/dist/tags/item/index.d.ts +2 -2
  72. package/dist/transactions/all/my/index.d.ts +6 -0
  73. package/dist/transactions/all/my/index.d.ts.map +1 -1
  74. package/dist/transactions/all/my/index.js.map +1 -1
  75. package/dist/users/changeBillingPlan/index.d.ts +2 -2
  76. package/dist/users/compliance/index.d.ts +2 -2
  77. package/dist/users/me/index.d.ts +2 -2
  78. package/package.json +1 -1
@@ -5,7 +5,7 @@ import { type BaseRequestBuilder, type RequestConfiguration, type RequestInforma
5
5
  */
6
6
  export interface CurrentRequestBuilder extends BaseRequestBuilder<CurrentRequestBuilder> {
7
7
  /**
8
- * Register or refresh the current user's mobile push installation.
8
+ * Registers or refreshes the authenticated user's mobile push installation so Leadping can deliver account and workflow notifications to the device.
9
9
  * @param body Describes a mobile push installation. Identity and Azure tags are derived by the API.
10
10
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
11
11
  * @returns {Promise<boolean>}
@@ -14,7 +14,7 @@ export interface CurrentRequestBuilder extends BaseRequestBuilder<CurrentRequest
14
14
  */
15
15
  put(body: PushInstallationRequest, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<boolean | undefined>;
16
16
  /**
17
- * Register or refresh the current user's mobile push installation.
17
+ * Registers or refreshes the authenticated user's mobile push installation so Leadping can deliver account and workflow notifications to the device.
18
18
  * @param body Describes a mobile push installation. Identity and Azure tags are derived by the API.
19
19
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
20
20
  * @returns {RequestInformation}
@@ -11,7 +11,7 @@ export interface InstallationsRequestBuilder extends BaseRequestBuilder<Installa
11
11
  get current(): CurrentRequestBuilder;
12
12
  /**
13
13
  * Gets an item from the leadping.notifications.push.installations.item collection
14
- * @param installationId Unique identifier of the item
14
+ * @param installationId The stable mobile installation identifier to unregister.
15
15
  * @returns {WithInstallationItemRequestBuilder}
16
16
  */
17
17
  byInstallationId(installationId: string): WithInstallationItemRequestBuilder;
@@ -4,14 +4,14 @@ import { type BaseRequestBuilder, type RequestConfiguration, type RequestInforma
4
4
  */
5
5
  export interface WithInstallationItemRequestBuilder extends BaseRequestBuilder<WithInstallationItemRequestBuilder> {
6
6
  /**
7
- * Unregister the current user's mobile push installation.
7
+ * Removes a mobile push installation from the authenticated user's account so Leadping no longer sends notifications to that device.
8
8
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
9
9
  * @returns {Promise<boolean>}
10
10
  * @throws {ProblemDetails} error when the service returns a 401 status code
11
11
  */
12
12
  delete(requestConfiguration?: RequestConfiguration<object> | undefined): Promise<boolean | undefined>;
13
13
  /**
14
- * Unregister the current user's mobile push installation.
14
+ * Removes a mobile push installation from the authenticated user's account so Leadping no longer sends notifications to that device.
15
15
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
16
16
  * @returns {RequestInformation}
17
17
  */
@@ -6,7 +6,7 @@ import { type BaseRequestBuilder, type RequestConfiguration, type RequestInforma
6
6
  export interface AcceptRequestBuilder extends BaseRequestBuilder<AcceptRequestBuilder> {
7
7
  /**
8
8
  * Accepts an organization invitation for the signed-in user, creating membership and setting organization access context.
9
- * @param body Request payload for accept organization invitation.
9
+ * @param body Defines the input used for accept organization invitation.
10
10
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
11
11
  * @returns {Promise<OrganizationInvitationResponse>}
12
12
  * @throws {ProblemDetails} error when the service returns a 400 status code
@@ -14,7 +14,7 @@ export interface AcceptRequestBuilder extends BaseRequestBuilder<AcceptRequestBu
14
14
  post(body: AcceptOrganizationInvitationRequest, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<OrganizationInvitationResponse | undefined>;
15
15
  /**
16
16
  * Accepts an organization invitation for the signed-in user, creating membership and setting organization access context.
17
- * @param body Request payload for accept organization invitation.
17
+ * @param body Defines the input used for accept organization invitation.
18
18
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
19
19
  * @returns {RequestInformation}
20
20
  */
@@ -39,7 +39,7 @@ export interface MeRequestBuilder extends BaseRequestBuilder<MeRequestBuilder> {
39
39
  get(requestConfiguration?: RequestConfiguration<object> | undefined): Promise<OrganizationResponse | undefined>;
40
40
  /**
41
41
  * Creates an organization account for the authenticated user, assigns them as its owner, and makes it their active organization context.
42
- * @param body Request schema for the Leadping API organization profile request, including the fields clients can send.
42
+ * @param body Defines the fields clients can send when working with organization profile.
43
43
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
44
44
  * @returns {Promise<OrganizationResponse>}
45
45
  * @throws {ProblemDetails} error when the service returns a 400 status code
@@ -48,7 +48,7 @@ export interface MeRequestBuilder extends BaseRequestBuilder<MeRequestBuilder> {
48
48
  post(body: OrganizationRequest, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<OrganizationResponse | undefined>;
49
49
  /**
50
50
  * Updates the authenticated user's current organization profile, including contact, settings, and communication configuration.
51
- * @param body Request schema for the Leadping API organization profile request, including the fields clients can send.
51
+ * @param body Defines the fields clients can send when working with organization profile.
52
52
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
53
53
  * @returns {Promise<OrganizationResponse>}
54
54
  * @throws {ProblemDetails} error when the service returns a 400 status code
@@ -63,14 +63,14 @@ export interface MeRequestBuilder extends BaseRequestBuilder<MeRequestBuilder> {
63
63
  toGetRequestInformation(requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
64
64
  /**
65
65
  * Creates an organization account for the authenticated user, assigns them as its owner, and makes it their active organization context.
66
- * @param body Request schema for the Leadping API organization profile request, including the fields clients can send.
66
+ * @param body Defines the fields clients can send when working with organization profile.
67
67
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
68
68
  * @returns {RequestInformation}
69
69
  */
70
70
  toPostRequestInformation(body: OrganizationRequest, requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
71
71
  /**
72
72
  * Updates the authenticated user's current organization profile, including contact, settings, and communication configuration.
73
- * @param body Request schema for the Leadping API organization profile request, including the fields clients can send.
73
+ * @param body Defines the fields clients can send when working with organization profile.
74
74
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
75
75
  * @returns {RequestInformation}
76
76
  */
@@ -20,7 +20,7 @@ export interface InvitationsRequestBuilder extends BaseRequestBuilder<Invitation
20
20
  get(requestConfiguration?: RequestConfiguration<object> | undefined): Promise<OrganizationInvitationTableRow[] | undefined>;
21
21
  /**
22
22
  * Creates an invitation for the current organization so another user can join with the requested role and account access.
23
- * @param body Request payload for organization invitation.
23
+ * @param body Defines the input used for organization invitation.
24
24
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
25
25
  * @returns {Promise<OrganizationInvitationResponse>}
26
26
  * @throws {ProblemDetails} error when the service returns a 400 status code
@@ -35,7 +35,7 @@ export interface InvitationsRequestBuilder extends BaseRequestBuilder<Invitation
35
35
  toGetRequestInformation(requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
36
36
  /**
37
37
  * Creates an invitation for the current organization so another user can join with the requested role and account access.
38
- * @param body Request payload for organization invitation.
38
+ * @param body Defines the input used for organization invitation.
39
39
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
40
40
  * @returns {RequestInformation}
41
41
  */
@@ -20,7 +20,7 @@ export interface MembersRequestBuilder extends BaseRequestBuilder<MembersRequest
20
20
  get(requestConfiguration?: RequestConfiguration<object> | undefined): Promise<OrganizationMemberTableRow[] | undefined>;
21
21
  /**
22
22
  * Adds an existing user to the current organization with the requested role for shared lead communication and account access.
23
- * @param body Request schema for the Leadping API organization user request, including the fields clients can send.
23
+ * @param body Defines the fields clients can send when working with organization user.
24
24
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
25
25
  * @returns {Promise<OrganizationMemberResponse>}
26
26
  * @throws {ProblemDetails} error when the service returns a 400 status code
@@ -36,7 +36,7 @@ export interface MembersRequestBuilder extends BaseRequestBuilder<MembersRequest
36
36
  toGetRequestInformation(requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
37
37
  /**
38
38
  * Adds an existing user to the current organization with the requested role for shared lead communication and account access.
39
- * @param body Request schema for the Leadping API organization user request, including the fields clients can send.
39
+ * @param body Defines the fields clients can send when working with organization user.
40
40
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
41
41
  * @returns {RequestInformation}
42
42
  */
@@ -14,7 +14,7 @@ export interface WithUserItemRequestBuilder extends BaseRequestBuilder<WithUserI
14
14
  delete(requestConfiguration?: RequestConfiguration<object> | undefined): Promise<void>;
15
15
  /**
16
16
  * Changes a user's role in the current organization, updating access to lead, automation, billing, and admin workflows.
17
- * @param body Request schema for the Leadping API organization user request, including the fields clients can send.
17
+ * @param body Defines the fields clients can send when working with organization user.
18
18
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
19
19
  * @returns {Promise<OrganizationMemberResponse>}
20
20
  * @throws {ProblemDetails} error when the service returns a 400 status code
@@ -30,7 +30,7 @@ export interface WithUserItemRequestBuilder extends BaseRequestBuilder<WithUserI
30
30
  toDeleteRequestInformation(requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
31
31
  /**
32
32
  * Changes a user's role in the current organization, updating access to lead, automation, billing, and admin workflows.
33
- * @param body Request schema for the Leadping API organization user request, including the fields clients can send.
33
+ * @param body Defines the fields clients can send when working with organization user.
34
34
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
35
35
  * @returns {RequestInformation}
36
36
  */
@@ -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 organization context so subsequent lead, billing, and communication requests target that organization.
9
- * @param body Request schema for the Leadping API organization switch request, including the fields clients can send.
9
+ * @param body Defines the fields clients can send when working with organization switch.
10
10
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
11
11
  * @returns {Promise<OrganizationResponse>}
12
12
  * @throws {ProblemDetails} error when the service returns a 401 status code
@@ -15,7 +15,7 @@ export interface SwitchRequestBuilder extends BaseRequestBuilder<SwitchRequestBu
15
15
  post(body: OrganizationSwitchRequest, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<OrganizationResponse | undefined>;
16
16
  /**
17
17
  * Switches the authenticated user's active organization context so subsequent lead, billing, and communication requests target that organization.
18
- * @param body Request schema for the Leadping API organization switch request, including the fields clients can send.
18
+ * @param body Defines the fields clients can send when working with organization switch.
19
19
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
20
20
  * @returns {RequestInformation}
21
21
  */
@@ -7,7 +7,7 @@ import { type BaseRequestBuilder, type KeysToExcludeForNavigationMetadata, type
7
7
  export interface InvoicesRequestBuilder extends BaseRequestBuilder<InvoicesRequestBuilder> {
8
8
  /**
9
9
  * Gets an item from the leadping.paymentMethods.invoices.item collection
10
- * @param invoiceId Unique identifier of the item
10
+ * @param invoiceId The Stripe invoice identifier whose PDF should be accessed.
11
11
  * @returns {WithInvoiceItemRequestBuilder}
12
12
  */
13
13
  byInvoiceId(invoiceId: string): WithInvoiceItemRequestBuilder;
@@ -22,6 +22,9 @@ export interface PdfAccessRequestBuilder extends BaseRequestBuilder<PdfAccessReq
22
22
  * Creates a short-lived, secure URL that lets the current organization view or download a private Stripe invoice PDF without exposing a permanent file link.
23
23
  */
24
24
  export interface PdfAccessRequestBuilderGetQueryParameters {
25
+ /**
26
+ * Whether the secure URL should download the PDF instead of displaying it inline.
27
+ */
25
28
  download?: boolean;
26
29
  }
27
30
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../paymentMethods/invoices/item/pdfAccess/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAAoG,KAAK,wBAAwB,EAAuB,MAAM,6BAA6B,CAAC;AAEnM,OAAO,EAAE,KAAK,kBAAkB,EAAuC,KAAK,oBAAoB,EAAE,KAAK,kBAAkB,EAAE,KAAK,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AAExL;;GAEG;AACH,MAAM,WAAW,uBAAwB,SAAQ,kBAAkB,CAAC,uBAAuB,CAAC;IACxF;;;;;OAKG;IACF,GAAG,CAAC,oBAAoB,CAAC,EAAE,oBAAoB,CAAC,yCAAyC,CAAC,GAAG,SAAS,GAAI,OAAO,CAAC,wBAAwB,GAAG,SAAS,CAAC,CAAC;IACzJ;;;;OAIG;IACF,uBAAuB,CAAC,oBAAoB,CAAC,EAAE,oBAAoB,CAAC,yCAAyC,CAAC,GAAG,SAAS,GAAI,kBAAkB,CAAC;CACrJ;AACD;;GAEG;AACH,MAAM,WAAW,yCAAyC;IACtD,QAAQ,CAAC,EAAE,OAAO,CAAC;CACtB;AACD;;GAEG;AACH,eAAO,MAAM,kCAAkC,2EAA2E,CAAC;AAC3H;;GAEG;AACH,eAAO,MAAM,uCAAuC,EAAE,gBAUrD,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../paymentMethods/invoices/item/pdfAccess/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAAoG,KAAK,wBAAwB,EAAuB,MAAM,6BAA6B,CAAC;AAEnM,OAAO,EAAE,KAAK,kBAAkB,EAAuC,KAAK,oBAAoB,EAAE,KAAK,kBAAkB,EAAE,KAAK,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AAExL;;GAEG;AACH,MAAM,WAAW,uBAAwB,SAAQ,kBAAkB,CAAC,uBAAuB,CAAC;IACxF;;;;;OAKG;IACF,GAAG,CAAC,oBAAoB,CAAC,EAAE,oBAAoB,CAAC,yCAAyC,CAAC,GAAG,SAAS,GAAI,OAAO,CAAC,wBAAwB,GAAG,SAAS,CAAC,CAAC;IACzJ;;;;OAIG;IACF,uBAAuB,CAAC,oBAAoB,CAAC,EAAE,oBAAoB,CAAC,yCAAyC,CAAC,GAAG,SAAS,GAAI,kBAAkB,CAAC;CACrJ;AACD;;GAEG;AACH,MAAM,WAAW,yCAAyC;IACtD;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;CACtB;AACD;;GAEG;AACH,eAAO,MAAM,kCAAkC,2EAA2E,CAAC;AAC3H;;GAEG;AACH,eAAO,MAAM,uCAAuC,EAAE,gBAUrD,CAAC"}
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../paymentMethods/invoices/item/pdfAccess/index.ts"],"names":[],"mappings":"AAAA,oBAAoB;AACpB,oBAAoB;AACpB,+BAA+B;AAC/B,aAAa;AACb,OAAO,EAAE,oDAAoD,EAAE,0CAA0C,EAAsD,MAAM,6BAA6B,CAAC;AA4BnM;;GAEG;AACH,MAAM,CAAC,MAAM,kCAAkC,GAAG,wEAAwE,CAAC;AAC3H;;GAEG;AACH,MAAM,CAAC,MAAM,uCAAuC,GAAqB;IACrE,GAAG,EAAE;QACD,WAAW,EAAE,kCAAkC;QAC/C,uBAAuB,EAAE,kBAAkB;QAC3C,aAAa,EAAE;YACX,GAAG,EAAE,0CAAuE;SAC/E;QACD,iBAAiB,EAAE,MAAM;QACzB,mBAAmB,EAAG,oDAAoD;KAC7E;CACJ,CAAC;AACF,mBAAmB;AACnB,mBAAmB"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../paymentMethods/invoices/item/pdfAccess/index.ts"],"names":[],"mappings":"AAAA,oBAAoB;AACpB,oBAAoB;AACpB,+BAA+B;AAC/B,aAAa;AACb,OAAO,EAAE,oDAAoD,EAAE,0CAA0C,EAAsD,MAAM,6BAA6B,CAAC;AA+BnM;;GAEG;AACH,MAAM,CAAC,MAAM,kCAAkC,GAAG,wEAAwE,CAAC;AAC3H;;GAEG;AACH,MAAM,CAAC,MAAM,uCAAuC,GAAqB;IACrE,GAAG,EAAE;QACD,WAAW,EAAE,kCAAkC;QAC/C,uBAAuB,EAAE,kBAAkB;QAC3C,aAAa,EAAE;YACX,GAAG,EAAE,0CAAuE;SAC/E;QACD,iBAAiB,EAAE,MAAM;QACzB,mBAAmB,EAAG,oDAAoD;KAC7E;CACJ,CAAC;AACF,mBAAmB;AACnB,mBAAmB"}
@@ -6,7 +6,7 @@ import { type BaseRequestBuilder, type RequestConfiguration, type RequestInforma
6
6
  export interface InitiateRequestBuilder extends BaseRequestBuilder<InitiateRequestBuilder> {
7
7
  /**
8
8
  * Starts an outbound Leadping phone call for an authenticated user and returns the provider call identifiers, status, and routing details.
9
- * @param body Request schema for the Leadping API phone call initiation request, including the fields clients can send.
9
+ * @param body Defines the fields clients can send when working with phone call initiation.
10
10
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
11
11
  * @returns {Promise<PhoneCallResponse>}
12
12
  * @throws {ProblemDetails} error when the service returns a 400 status code
@@ -15,7 +15,7 @@ export interface InitiateRequestBuilder extends BaseRequestBuilder<InitiateReque
15
15
  post(body: InitiateCallRequest, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<PhoneCallResponse | undefined>;
16
16
  /**
17
17
  * Starts an outbound Leadping phone call for an authenticated user and returns the provider call identifiers, status, and routing details.
18
- * @param body Request schema for the Leadping API phone call initiation request, including the fields clients can send.
18
+ * @param body Defines the fields clients can send when working with phone call initiation.
19
19
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
20
20
  * @returns {RequestInformation}
21
21
  */
@@ -33,7 +33,7 @@ export interface PhoneNumbersRequestBuilder extends BaseRequestBuilder<PhoneNumb
33
33
  byPhoneNumberId(phoneNumberId: string): PhoneNumberItemRequestBuilder;
34
34
  /**
35
35
  * Purchases or creates a phone number for the current organization so it can be assigned to messaging, calls, and lead follow-up.
36
- * @param body Request schema for the Leadping API phone number update request, including the fields clients can send.
36
+ * @param body Defines the fields clients can send when working with phone number update.
37
37
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
38
38
  * @returns {Promise<PhoneNumberResponse>}
39
39
  * @throws {ProblemDetails} error when the service returns a 400 status code
@@ -43,7 +43,7 @@ export interface PhoneNumbersRequestBuilder extends BaseRequestBuilder<PhoneNumb
43
43
  post(body: PhoneNumberRequest, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<PhoneNumberResponse | undefined>;
44
44
  /**
45
45
  * Purchases or creates a phone number for the current organization so it can be assigned to messaging, calls, and lead follow-up.
46
- * @param body Request schema for the Leadping API phone number update request, including the fields clients can send.
46
+ * @param body Defines the fields clients can send when working with phone number update.
47
47
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
48
48
  * @returns {RequestInformation}
49
49
  */
@@ -6,7 +6,7 @@ import { type BaseRequestBuilder, type RequestConfiguration, type RequestInforma
6
6
  export interface IsAvailableForPurchaseRequestBuilder extends BaseRequestBuilder<IsAvailableForPurchaseRequestBuilder> {
7
7
  /**
8
8
  * Checks whether a phone number can be purchased for the current organization before creating or assigning it.
9
- * @param body Request schema for checking phone number availability before purchase or assignment.
9
+ * @param body Defines the phone number and capability requirements Leadping should verify before purchase or assignment.
10
10
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
11
11
  * @returns {Promise<PhoneNumberAvailabilityResponse>}
12
12
  * @throws {ProblemDetails} error when the service returns a 400 status code
@@ -16,7 +16,7 @@ export interface IsAvailableForPurchaseRequestBuilder extends BaseRequestBuilder
16
16
  post(body: PhoneNumberAvailabilityRequest, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<PhoneNumberAvailabilityResponse | undefined>;
17
17
  /**
18
18
  * Checks whether a phone number can be purchased for the current organization before creating or assigning it.
19
- * @param body Request schema for checking phone number availability before purchase or assignment.
19
+ * @param body Defines the phone number and capability requirements Leadping should verify before purchase or assignment.
20
20
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
21
21
  * @returns {RequestInformation}
22
22
  */
@@ -33,7 +33,7 @@ export interface PhoneNumberItemRequestBuilder extends BaseRequestBuilder<PhoneN
33
33
  get(requestConfiguration?: RequestConfiguration<object> | undefined): Promise<PhoneNumberResponse | undefined>;
34
34
  /**
35
35
  * Updates phone number settings such as its optional label, assignment, messaging options, or warmup configuration.
36
- * @param body Request schema for the Leadping API phone number update request, including the fields clients can send.
36
+ * @param body Defines the fields clients can send when working with phone number update.
37
37
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
38
38
  * @returns {Promise<PhoneNumberResponse>}
39
39
  * @throws {ProblemDetails} error when the service returns a 400 status code
@@ -56,7 +56,7 @@ export interface PhoneNumberItemRequestBuilder extends BaseRequestBuilder<PhoneN
56
56
  toGetRequestInformation(requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
57
57
  /**
58
58
  * Updates phone number settings such as its optional label, assignment, messaging options, or warmup configuration.
59
- * @param body Request schema for the Leadping API phone number update request, including the fields clients can send.
59
+ * @param body Defines the fields clients can send when working with phone number update.
60
60
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
61
61
  * @returns {RequestInformation}
62
62
  */
@@ -11,7 +11,7 @@ export interface WithConversationItemRequestBuilder extends BaseRequestBuilder<W
11
11
  get override(): OverrideRequestBuilder;
12
12
  /**
13
13
  * Selects the outgoing phone number for an existing conversation, considering assignments, overrides, and delivery eligibility.
14
- * @param body Request schema for the Leadping API outgoing number selection request, including the fields clients can send.
14
+ * @param body Defines the fields clients can send when working with outgoing number selection.
15
15
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
16
16
  * @returns {Promise<OutgoingNumberSelectionResponse>}
17
17
  * @throws {ProblemDetails} error when the service returns a 400 status code
@@ -20,7 +20,7 @@ export interface WithConversationItemRequestBuilder extends BaseRequestBuilder<W
20
20
  post(body: OutgoingNumberSelectionRequest, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<OutgoingNumberSelectionResponse | undefined>;
21
21
  /**
22
22
  * Selects the outgoing phone number for an existing conversation, considering assignments, overrides, and delivery eligibility.
23
- * @param body Request schema for the Leadping API outgoing number selection request, including the fields clients can send.
23
+ * @param body Defines the fields clients can send when working with outgoing number selection.
24
24
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
25
25
  * @returns {RequestInformation}
26
26
  */
@@ -14,7 +14,7 @@ export interface OverrideRequestBuilder extends BaseRequestBuilder<OverrideReque
14
14
  delete(requestConfiguration?: RequestConfiguration<object> | undefined): Promise<OutgoingNumberSelectionResponse | undefined>;
15
15
  /**
16
16
  * Sets the outgoing phone number override for a conversation so future lead messages use the selected eligible number.
17
- * @param body Request schema for the Leadping API outgoing number manual override request, including the fields clients can send.
17
+ * @param body Defines the fields clients can send when working with outgoing number manual override.
18
18
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
19
19
  * @returns {Promise<OutgoingNumberSelectionResponse>}
20
20
  * @throws {ProblemDetails} error when the service returns a 400 status code
@@ -29,7 +29,7 @@ export interface OverrideRequestBuilder extends BaseRequestBuilder<OverrideReque
29
29
  toDeleteRequestInformation(requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
30
30
  /**
31
31
  * Sets the outgoing phone number override for a conversation so future lead messages use the selected eligible number.
32
- * @param body Request schema for the Leadping API outgoing number manual override request, including the fields clients can send.
32
+ * @param body Defines the fields clients can send when working with outgoing number manual override.
33
33
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
34
34
  * @returns {RequestInformation}
35
35
  */
@@ -6,7 +6,7 @@ import { type BaseRequestBuilder, type RequestConfiguration, type RequestInforma
6
6
  export interface ManualOverrideRequestBuilder extends BaseRequestBuilder<ManualOverrideRequestBuilder> {
7
7
  /**
8
8
  * Validates a manual outgoing-number override before use, checking ownership, destination, and delivery eligibility.
9
- * @param body Request schema for the Leadping API outgoing number manual override request, including the fields clients can send.
9
+ * @param body Defines the fields clients can send when working with outgoing number manual override.
10
10
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
11
11
  * @returns {Promise<OutgoingNumberSelectionResponse>}
12
12
  * @throws {ProblemDetails} error when the service returns a 400 status code
@@ -15,7 +15,7 @@ export interface ManualOverrideRequestBuilder extends BaseRequestBuilder<ManualO
15
15
  post(body: OutgoingNumberManualOverrideRequest, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<OutgoingNumberSelectionResponse | undefined>;
16
16
  /**
17
17
  * Validates a manual outgoing-number override before use, checking ownership, destination, and delivery eligibility.
18
- * @param body Request schema for the Leadping API outgoing number manual override request, including the fields clients can send.
18
+ * @param body Defines the fields clients can send when working with outgoing number manual override.
19
19
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
20
20
  * @returns {RequestInformation}
21
21
  */
@@ -6,7 +6,7 @@ import { type BaseRequestBuilder, type RequestConfiguration, type RequestInforma
6
6
  export interface NewRequestBuilder extends BaseRequestBuilder<NewRequestBuilder> {
7
7
  /**
8
8
  * Selects an outgoing phone number for a new outbound lead message using destination, source, and delivery eligibility rules.
9
- * @param body Request schema for the Leadping API outgoing number selection request, including the fields clients can send.
9
+ * @param body Defines the fields clients can send when working with outgoing number selection.
10
10
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
11
11
  * @returns {Promise<OutgoingNumberSelectionResponse>}
12
12
  * @throws {ProblemDetails} error when the service returns a 400 status code
@@ -15,7 +15,7 @@ export interface NewRequestBuilder extends BaseRequestBuilder<NewRequestBuilder>
15
15
  post(body: OutgoingNumberSelectionRequest, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<OutgoingNumberSelectionResponse | undefined>;
16
16
  /**
17
17
  * Selects an outgoing phone number for a new outbound lead message using destination, source, and delivery eligibility rules.
18
- * @param body Request schema for the Leadping API outgoing number selection request, including the fields clients can send.
18
+ * @param body Defines the fields clients can send when working with outgoing number selection.
19
19
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
20
20
  * @returns {RequestInformation}
21
21
  */
@@ -6,7 +6,7 @@ import { type BaseRequestBuilder, type RequestConfiguration, type RequestInforma
6
6
  export interface SearchRequestBuilder extends BaseRequestBuilder<SearchRequestBuilder> {
7
7
  /**
8
8
  * Searches available phone numbers for purchase, applying country, area, and capability filters for lead communication setup.
9
- * @param body Request schema for the Leadping API phone number search request, including the fields clients can send.
9
+ * @param body Defines the fields clients can send when working with phone number search.
10
10
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
11
11
  * @returns {Promise<PhoneNumberSearchResponse>}
12
12
  * @throws {ProblemDetails} error when the service returns a 400 status code
@@ -16,7 +16,7 @@ export interface SearchRequestBuilder extends BaseRequestBuilder<SearchRequestBu
16
16
  post(body: PhoneNumberSearchRequest, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<PhoneNumberSearchResponse | undefined>;
17
17
  /**
18
18
  * Searches available phone numbers for purchase, applying country, area, and capability filters for lead communication setup.
19
- * @param body Request schema for the Leadping API phone number search request, including the fields clients can send.
19
+ * @param body Defines the fields clients can send when working with phone number search.
20
20
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
21
21
  * @returns {RequestInformation}
22
22
  */
@@ -11,7 +11,7 @@ export interface ExportsRequestBuilder extends BaseRequestBuilder<ExportsRequest
11
11
  get my(): MyRequestBuilder;
12
12
  /**
13
13
  * Gets an item from the leadping.reports.exports.item collection
14
- * @param exportId Unique identifier of the item
14
+ * @param exportId The unique identifier of the current user's data export.
15
15
  * @returns {WithExportItemRequestBuilder}
16
16
  */
17
17
  byExportId(exportId: string): WithExportItemRequestBuilder;
@@ -22,6 +22,9 @@ export interface DownloadRequestBuilder extends BaseRequestBuilder<DownloadReque
22
22
  * Validates an export download token and redirects to the generated file when the current-user report is ready.
23
23
  */
24
24
  export interface DownloadRequestBuilderGetQueryParameters {
25
+ /**
26
+ * The short-lived download token issued for this export.
27
+ */
25
28
  token?: string;
26
29
  }
27
30
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../reports/exports/item/download/index.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,KAAK,kBAAkB,EAAuC,KAAK,oBAAoB,EAAE,KAAK,kBAAkB,EAAE,KAAK,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AAExL;;GAEG;AACH,MAAM,WAAW,sBAAuB,SAAQ,kBAAkB,CAAC,sBAAsB,CAAC;IACtF;;;;;;OAMG;IACF,GAAG,CAAC,oBAAoB,CAAC,EAAE,oBAAoB,CAAC,wCAAwC,CAAC,GAAG,SAAS,GAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACxH;;;;OAIG;IACF,uBAAuB,CAAC,oBAAoB,CAAC,EAAE,oBAAoB,CAAC,wCAAwC,CAAC,GAAG,SAAS,GAAI,kBAAkB,CAAC;CACpJ;AACD;;GAEG;AACH,MAAM,WAAW,wCAAwC;IACrD,KAAK,CAAC,EAAE,MAAM,CAAC;CAClB;AACD;;GAEG;AACH,eAAO,MAAM,iCAAiC,4DAA4D,CAAC;AAC3G;;GAEG;AACH,eAAO,MAAM,sCAAsC,EAAE,gBAWpD,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../reports/exports/item/download/index.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,KAAK,kBAAkB,EAAuC,KAAK,oBAAoB,EAAE,KAAK,kBAAkB,EAAE,KAAK,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AAExL;;GAEG;AACH,MAAM,WAAW,sBAAuB,SAAQ,kBAAkB,CAAC,sBAAsB,CAAC;IACtF;;;;;;OAMG;IACF,GAAG,CAAC,oBAAoB,CAAC,EAAE,oBAAoB,CAAC,wCAAwC,CAAC,GAAG,SAAS,GAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACxH;;;;OAIG;IACF,uBAAuB,CAAC,oBAAoB,CAAC,EAAE,oBAAoB,CAAC,wCAAwC,CAAC,GAAG,SAAS,GAAI,kBAAkB,CAAC;CACpJ;AACD;;GAEG;AACH,MAAM,WAAW,wCAAwC;IACrD;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAClB;AACD;;GAEG;AACH,eAAO,MAAM,iCAAiC,4DAA4D,CAAC;AAC3G;;GAEG;AACH,eAAO,MAAM,sCAAsC,EAAE,gBAWpD,CAAC"}
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../reports/exports/item/download/index.ts"],"names":[],"mappings":"AAAA,oBAAoB;AACpB,oBAAoB;AACpB,+BAA+B;AAC/B,aAAa;AACb,OAAO,EAAE,0CAA0C,EAAuB,MAAM,6BAA6B,CAAC;AA6B9G;;GAEG;AACH,MAAM,CAAC,MAAM,iCAAiC,GAAG,yDAAyD,CAAC;AAC3G;;GAEG;AACH,MAAM,CAAC,MAAM,sCAAsC,GAAqB;IACpE,GAAG,EAAE;QACD,WAAW,EAAE,iCAAiC;QAC9C,uBAAuB,EAAE,oCAAoC;QAC7D,aAAa,EAAE;YACX,GAAG,EAAE,0CAAuE;YAC5E,GAAG,EAAE,0CAAuE;YAC5E,GAAG,EAAE,0CAAuE;SAC/E;QACD,iBAAiB,EAAE,uBAAuB;KAC7C;CACJ,CAAC;AACF,mBAAmB;AACnB,mBAAmB"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../reports/exports/item/download/index.ts"],"names":[],"mappings":"AAAA,oBAAoB;AACpB,oBAAoB;AACpB,+BAA+B;AAC/B,aAAa;AACb,OAAO,EAAE,0CAA0C,EAAuB,MAAM,6BAA6B,CAAC;AAgC9G;;GAEG;AACH,MAAM,CAAC,MAAM,iCAAiC,GAAG,yDAAyD,CAAC;AAC3G;;GAEG;AACH,MAAM,CAAC,MAAM,sCAAsC,GAAqB;IACpE,GAAG,EAAE;QACD,WAAW,EAAE,iCAAiC;QAC9C,uBAAuB,EAAE,oCAAoC;QAC7D,aAAa,EAAE;YACX,GAAG,EAAE,0CAAuE;YAC5E,GAAG,EAAE,0CAAuE;YAC5E,GAAG,EAAE,0CAAuE;SAC/E;QACD,iBAAiB,EAAE,uBAAuB;KAC7C;CACJ,CAAC;AACF,mBAAmB;AACnB,mBAAmB"}
@@ -57,7 +57,7 @@ export interface MediaPostRequestBody_Headers extends AdditionalDataHolder, Pars
57
57
  */
58
58
  export interface MediaRequestBuilder extends BaseRequestBuilder<MediaRequestBuilder> {
59
59
  /**
60
- * Uploads media for a subsequent MMS send.
60
+ * Uploads and validates one media attachment, returning the metadata needed to include the asset in a subsequent Leadping MMS send.
61
61
  * @param body The request body
62
62
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
63
63
  * @returns {Promise<MessageMediaAttachment>}
@@ -65,7 +65,7 @@ export interface MediaRequestBuilder extends BaseRequestBuilder<MediaRequestBuil
65
65
  */
66
66
  post(body: MediaPostRequestBody, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<MessageMediaAttachment | undefined>;
67
67
  /**
68
- * Uploads media for a subsequent MMS send.
68
+ * Uploads and validates one media attachment, returning the metadata needed to include the asset in a subsequent Leadping MMS send.
69
69
  * @param body The request body
70
70
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
71
71
  * @returns {RequestInformation}
@@ -6,7 +6,7 @@ import { type BaseRequestBuilder, type RequestConfiguration, type RequestInforma
6
6
  export interface SendRequestBuilder extends BaseRequestBuilder<SendRequestBuilder> {
7
7
  /**
8
8
  * Sends an SMS message to a lead or phone number, applying current-organization sender selection, scheduling, and delivery rules.
9
- * @param body Request schema for the Leadping API SMS send request, including the fields clients can send.
9
+ * @param body Defines the fields clients can send when working with SMS send.
10
10
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
11
11
  * @returns {Promise<SmsResponse>}
12
12
  * @throws {ProblemDetails} error when the service returns a 400 status code
@@ -16,7 +16,7 @@ export interface SendRequestBuilder extends BaseRequestBuilder<SendRequestBuilde
16
16
  post(body: SendSmsRequest, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<SmsResponse | undefined>;
17
17
  /**
18
18
  * Sends an SMS message to a lead or phone number, applying current-organization sender selection, scheduling, and delivery rules.
19
- * @param body Request schema for the Leadping API SMS send request, including the fields clients can send.
19
+ * @param body Defines the fields clients can send when working with SMS send.
20
20
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
21
21
  * @returns {RequestInformation}
22
22
  */
@@ -18,7 +18,7 @@ export interface SourcesRequestBuilder extends BaseRequestBuilder<SourcesRequest
18
18
  byId(id: string): SourcesItemRequestBuilder;
19
19
  /**
20
20
  * Creates a lead source for the current organization, storing intake credentials and routing context for captured external leads.
21
- * @param body Request schema for the Leadping API lead source request, including the fields clients can send.
21
+ * @param body Defines the fields clients can send when working with lead source.
22
22
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
23
23
  * @returns {Promise<SourceResponse>}
24
24
  * @throws {ProblemDetails} error when the service returns a 400 status code
@@ -27,7 +27,7 @@ export interface SourcesRequestBuilder extends BaseRequestBuilder<SourcesRequest
27
27
  post(body: SourceRequest, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<SourceResponse | undefined>;
28
28
  /**
29
29
  * Creates a lead source for the current organization, storing intake credentials and routing context for captured external leads.
30
- * @param body Request schema for the Leadping API lead source request, including the fields clients can send.
30
+ * @param body Defines the fields clients can send when working with lead source.
31
31
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
32
32
  * @returns {RequestInformation}
33
33
  */
@@ -26,7 +26,7 @@ export interface SourcesItemRequestBuilder extends BaseRequestBuilder<SourcesIte
26
26
  get(requestConfiguration?: RequestConfiguration<object> | undefined): Promise<SourceResponse | undefined>;
27
27
  /**
28
28
  * Updates a lead source for the current organization, changing intake settings, credentials, routing context, or active status.
29
- * @param body Request schema for the Leadping API lead source request, including the fields clients can send.
29
+ * @param body Defines the fields clients can send when working with lead source.
30
30
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
31
31
  * @returns {Promise<SourceResponse>}
32
32
  * @throws {ProblemDetails} error when the service returns a 401 status code
@@ -47,7 +47,7 @@ export interface SourcesItemRequestBuilder extends BaseRequestBuilder<SourcesIte
47
47
  toGetRequestInformation(requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
48
48
  /**
49
49
  * Updates a lead source for the current organization, changing intake settings, credentials, routing context, or active status.
50
- * @param body Request schema for the Leadping API lead source request, including the fields clients can send.
50
+ * @param body Defines the fields clients can send when working with lead source.
51
51
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
52
52
  * @returns {RequestInformation}
53
53
  */
@@ -5,7 +5,7 @@ import { type BaseRequestBuilder, type RequestConfiguration, type RequestInforma
5
5
  */
6
6
  export interface MyRequestBuilder extends BaseRequestBuilder<MyRequestBuilder> {
7
7
  /**
8
- * Get all for current organization
8
+ * Returns a filtered, paginated list of recipients the current organization has blocked from phone, SMS, or email outreach.
9
9
  * @param body Options for flexible, efficient, and explicit querying in Cosmos DB or similar repositories.
10
10
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
11
11
  * @returns {Promise<PagedResultOfSuppressionEntryResponse>}
@@ -13,7 +13,7 @@ export interface MyRequestBuilder extends BaseRequestBuilder<MyRequestBuilder> {
13
13
  */
14
14
  post(body: RequestDataOptions, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<PagedResultOfSuppressionEntryResponse | undefined>;
15
15
  /**
16
- * Get all for current organization
16
+ * Returns a filtered, paginated list of recipients the current organization has blocked from phone, SMS, or email outreach.
17
17
  * @param body Options for flexible, efficient, and explicit querying in Cosmos DB or similar repositories.
18
18
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
19
19
  * @returns {RequestInformation}
@@ -6,7 +6,7 @@ import { type BaseRequestBuilder, type RequestConfiguration, type RequestInforma
6
6
  export interface CheckRequestBuilder extends BaseRequestBuilder<CheckRequestBuilder> {
7
7
  /**
8
8
  * Checks whether a recipient is blocked by an active Leadping suppression entry before sending messages or placing calls through the selected channel.
9
- * @param body Request payload for suppression entry.
9
+ * @param body Defines a recipient and communication channel to suppress, release, or check before Leadping sends outreach.
10
10
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
11
11
  * @returns {Promise<SuppressionCheckResult>}
12
12
  * @throws {ProblemDetails} error when the service returns a 400 status code
@@ -15,7 +15,7 @@ export interface CheckRequestBuilder extends BaseRequestBuilder<CheckRequestBuil
15
15
  post(body: SuppressionEntryRequest, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<SuppressionCheckResult | undefined>;
16
16
  /**
17
17
  * Checks whether a recipient is blocked by an active Leadping suppression entry before sending messages or placing calls through the selected channel.
18
- * @param body Request payload for suppression entry.
18
+ * @param body Defines a recipient and communication channel to suppress, release, or check before Leadping sends outreach.
19
19
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
20
20
  * @returns {RequestInformation}
21
21
  */
@@ -22,13 +22,13 @@ export interface SuppressionsRequestBuilder extends BaseRequestBuilder<Suppressi
22
22
  get release(): ReleaseRequestBuilder;
23
23
  /**
24
24
  * Gets an item from the leadping.suppressions.item collection
25
- * @param id Unique identifier of the item
25
+ * @param id The unique identifier of the suppression entry to retrieve.
26
26
  * @returns {SuppressionsItemRequestBuilder}
27
27
  */
28
28
  byId(id: string): SuppressionsItemRequestBuilder;
29
29
  /**
30
30
  * Creates or reactivates a Leadping suppression entry that blocks future outreach to a recipient across the selected communication channel.
31
- * @param body Request payload for suppression entry.
31
+ * @param body Defines a recipient and communication channel to suppress, release, or check before Leadping sends outreach.
32
32
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
33
33
  * @returns {Promise<SuppressionEntryResponse>}
34
34
  * @throws {ProblemDetails} error when the service returns a 400 status code
@@ -37,7 +37,7 @@ export interface SuppressionsRequestBuilder extends BaseRequestBuilder<Suppressi
37
37
  post(body: SuppressionEntryRequest, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<SuppressionEntryResponse | undefined>;
38
38
  /**
39
39
  * Creates or reactivates a Leadping suppression entry that blocks future outreach to a recipient across the selected communication channel.
40
- * @param body Request payload for suppression entry.
40
+ * @param body Defines a recipient and communication channel to suppress, release, or check before Leadping sends outreach.
41
41
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
42
42
  * @returns {RequestInformation}
43
43
  */
@@ -5,7 +5,7 @@ import { type BaseRequestBuilder, type RequestConfiguration, type RequestInforma
5
5
  */
6
6
  export interface SuppressionsItemRequestBuilder extends BaseRequestBuilder<SuppressionsItemRequestBuilder> {
7
7
  /**
8
- * Get
8
+ * Returns one suppression entry for the current organization, including its recipient, channel, reason, status, and audit timestamps.
9
9
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
10
10
  * @returns {Promise<SuppressionEntryResponse>}
11
11
  * @throws {ProblemDetails} error when the service returns a 401 status code
@@ -13,7 +13,7 @@ export interface SuppressionsItemRequestBuilder extends BaseRequestBuilder<Suppr
13
13
  */
14
14
  get(requestConfiguration?: RequestConfiguration<object> | undefined): Promise<SuppressionEntryResponse | undefined>;
15
15
  /**
16
- * Get
16
+ * Returns one suppression entry for the current organization, including its recipient, channel, reason, status, and audit timestamps.
17
17
  * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
18
18
  * @returns {RequestInformation}
19
19
  */