@leadping/sdk 1.0.26 → 1.0.27
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.
|
@@ -5,7 +5,7 @@ import { type BaseRequestBuilder, type RequestConfiguration, type RequestInforma
|
|
|
5
5
|
*/
|
|
6
6
|
export interface NotesRequestBuilder extends BaseRequestBuilder<NotesRequestBuilder> {
|
|
7
7
|
/**
|
|
8
|
-
* Updates the shared 10DLC notes for the current business.
|
|
8
|
+
* Updates the shared 10DLC registration notes for the current business, keeping carrier review context and messaging compliance details current.
|
|
9
9
|
* @param body The request body
|
|
10
10
|
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
|
|
11
11
|
* @returns {Promise<BusinessResponse>}
|
|
@@ -14,7 +14,7 @@ export interface NotesRequestBuilder extends BaseRequestBuilder<NotesRequestBuil
|
|
|
14
14
|
*/
|
|
15
15
|
put(body: TenDlcNotesRequest, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<BusinessResponse | undefined>;
|
|
16
16
|
/**
|
|
17
|
-
* Updates the shared 10DLC notes for the current business.
|
|
17
|
+
* Updates the shared 10DLC registration notes for the current business, keeping carrier review context and messaging compliance details current.
|
|
18
18
|
* @param body The request body
|
|
19
19
|
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
|
|
20
20
|
* @returns {RequestInformation}
|
|
@@ -18,7 +18,7 @@ export interface LeadStatusesRequestBuilder extends BaseRequestBuilder<LeadStatu
|
|
|
18
18
|
*/
|
|
19
19
|
get(requestConfiguration?: RequestConfiguration<object> | undefined): Promise<LeadStatusResponse[] | undefined>;
|
|
20
20
|
/**
|
|
21
|
-
* Creates a reusable lead status for the current business to categorize leads
|
|
21
|
+
* Creates a reusable lead status for the current business to categorize, organize, and track leads consistently throughout its sales and follow-up workflow.
|
|
22
22
|
* @param body The request body
|
|
23
23
|
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
|
|
24
24
|
* @returns {Promise<LeadStatusResponse>}
|
|
@@ -31,7 +31,7 @@ export interface LeadStatusesRequestBuilder extends BaseRequestBuilder<LeadStatu
|
|
|
31
31
|
*/
|
|
32
32
|
toGetRequestInformation(requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
|
|
33
33
|
/**
|
|
34
|
-
* Creates a reusable lead status for the current business to categorize leads
|
|
34
|
+
* Creates a reusable lead status for the current business to categorize, organize, and track leads consistently throughout its sales and follow-up workflow.
|
|
35
35
|
* @param body The request body
|
|
36
36
|
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
|
|
37
37
|
* @returns {RequestInformation}
|
|
@@ -11,7 +11,7 @@ export interface LeadStatusesItemRequestBuilder extends BaseRequestBuilder<LeadS
|
|
|
11
11
|
*/
|
|
12
12
|
delete(requestConfiguration?: RequestConfiguration<object> | undefined): Promise<boolean | undefined>;
|
|
13
13
|
/**
|
|
14
|
-
* Updates the name, color, and display order of a lead status owned by the current business.
|
|
14
|
+
* Updates the name, color, and display order of a lead status owned by the current business so pipeline stages remain clear and consistently organized.
|
|
15
15
|
* @param body The request body
|
|
16
16
|
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
|
|
17
17
|
* @returns {Promise<LeadStatusResponse>}
|
|
@@ -24,7 +24,7 @@ export interface LeadStatusesItemRequestBuilder extends BaseRequestBuilder<LeadS
|
|
|
24
24
|
*/
|
|
25
25
|
toDeleteRequestInformation(requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
|
|
26
26
|
/**
|
|
27
|
-
* Updates the name, color, and display order of a lead status owned by the current business.
|
|
27
|
+
* Updates the name, color, and display order of a lead status owned by the current business so pipeline stages remain clear and consistently organized.
|
|
28
28
|
* @param body The request body
|
|
29
29
|
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
|
|
30
30
|
* @returns {RequestInformation}
|
|
@@ -10,7 +10,7 @@ export interface NotificationsItemRequestBuilder extends BaseRequestBuilder<Noti
|
|
|
10
10
|
*/
|
|
11
11
|
get markRead(): MarkReadRequestBuilder;
|
|
12
12
|
/**
|
|
13
|
-
*
|
|
13
|
+
* Returns one notification for the current user and business, including its content, read state, delivery context, and relevant account activity.
|
|
14
14
|
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
|
|
15
15
|
* @returns {Promise<NotificationResponse>}
|
|
16
16
|
* @throws {ProblemDetails} error when the service returns a 401 status code
|
|
@@ -18,7 +18,7 @@ export interface NotificationsItemRequestBuilder extends BaseRequestBuilder<Noti
|
|
|
18
18
|
*/
|
|
19
19
|
get(requestConfiguration?: RequestConfiguration<object> | undefined): Promise<NotificationResponse | undefined>;
|
|
20
20
|
/**
|
|
21
|
-
*
|
|
21
|
+
* Returns one notification for the current user and business, including its content, read state, delivery context, and relevant account activity.
|
|
22
22
|
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
|
|
23
23
|
* @returns {RequestInformation}
|
|
24
24
|
*/
|
|
@@ -5,21 +5,21 @@ import { type BaseRequestBuilder, type RequestConfiguration, type RequestInforma
|
|
|
5
5
|
*/
|
|
6
6
|
export interface PdfAccessRequestBuilder extends BaseRequestBuilder<PdfAccessRequestBuilder> {
|
|
7
7
|
/**
|
|
8
|
-
* Creates a short-lived URL
|
|
8
|
+
* Creates a short-lived, secure URL that lets the current business view or download a private Stripe invoice PDF without exposing a permanent file link.
|
|
9
9
|
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
|
|
10
10
|
* @returns {Promise<InvoicePdfAccessResponse>}
|
|
11
11
|
* @throws {ProblemDetails} error when the service returns a 404 status code
|
|
12
12
|
*/
|
|
13
13
|
get(requestConfiguration?: RequestConfiguration<PdfAccessRequestBuilderGetQueryParameters> | undefined): Promise<InvoicePdfAccessResponse | undefined>;
|
|
14
14
|
/**
|
|
15
|
-
* Creates a short-lived URL
|
|
15
|
+
* Creates a short-lived, secure URL that lets the current business view or download a private Stripe invoice PDF without exposing a permanent file link.
|
|
16
16
|
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
|
|
17
17
|
* @returns {RequestInformation}
|
|
18
18
|
*/
|
|
19
19
|
toGetRequestInformation(requestConfiguration?: RequestConfiguration<PdfAccessRequestBuilderGetQueryParameters> | undefined): RequestInformation;
|
|
20
20
|
}
|
|
21
21
|
/**
|
|
22
|
-
* Creates a short-lived URL
|
|
22
|
+
* Creates a short-lived, secure URL that lets the current business view or download a private Stripe invoice PDF without exposing a permanent file link.
|
|
23
23
|
*/
|
|
24
24
|
export interface PdfAccessRequestBuilderGetQueryParameters {
|
|
25
25
|
download?: boolean;
|
package/package.json
CHANGED