@gofynd/fdk-client-javascript 1.4.2-beta.6 → 1.4.3
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.
- package/README.md +1 -1
- package/package.json +5 -3
- package/sdk/application/ApplicationAPIClient.d.ts +1 -1
- package/sdk/application/ApplicationAPIClient.js +0 -1
- package/sdk/application/Cart/CartApplicationClient.d.ts +25 -25
- package/sdk/application/Cart/CartApplicationClient.js +25 -25
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +40 -40
- package/sdk/application/Catalog/CatalogApplicationClient.js +40 -40
- package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
- package/sdk/application/Common/CommonApplicationClient.js +2 -2
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +3 -3
- package/sdk/application/Communication/CommunicationApplicationClient.js +3 -3
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +16 -16
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +16 -16
- package/sdk/application/Content/ContentApplicationClient.d.ts +10 -10
- package/sdk/application/Content/ContentApplicationClient.js +10 -10
- package/sdk/application/Content/ContentApplicationModel.d.ts +18 -18
- package/sdk/application/Content/ContentApplicationModel.js +26 -26
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +2 -2
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +12 -6
- package/sdk/application/Lead/LeadApplicationClient.d.ts +7 -7
- package/sdk/application/Lead/LeadApplicationClient.js +7 -7
- package/sdk/application/Lead/LeadApplicationModel.d.ts +64 -77
- package/sdk/application/Lead/LeadApplicationModel.js +42 -52
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +9 -9
- package/sdk/application/Logistic/LogisticApplicationClient.js +9 -9
- package/sdk/application/Order/OrderApplicationClient.d.ts +13 -13
- package/sdk/application/Order/OrderApplicationClient.js +16 -12
- package/sdk/application/Order/OrderApplicationValidator.d.ts +7 -0
- package/sdk/application/Order/OrderApplicationValidator.js +3 -0
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +47 -47
- package/sdk/application/Payment/PaymentApplicationClient.js +52 -52
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +5 -2
- package/sdk/application/Payment/PaymentApplicationModel.js +4 -2
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +5 -5
- package/sdk/application/Payment/PaymentApplicationValidator.js +3 -3
- package/sdk/application/PosCart/PosCartApplicationClient.d.ts +27 -27
- package/sdk/application/PosCart/PosCartApplicationClient.js +27 -27
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +6 -6
- package/sdk/application/Rewards/RewardsApplicationClient.js +6 -6
- package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
- package/sdk/application/Share/ShareApplicationClient.js +7 -7
- package/sdk/application/Share/ShareApplicationModel.d.ts +2 -0
- package/sdk/application/Share/ShareApplicationModel.js +2 -0
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +4 -4
- package/sdk/application/Theme/ThemeApplicationClient.js +4 -4
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +25 -32
- package/sdk/application/Theme/ThemeApplicationModel.js +30 -40
- package/sdk/application/User/UserApplicationClient.d.ts +28 -28
- package/sdk/application/User/UserApplicationClient.js +28 -28
- package/sdk/application/User/UserApplicationModel.d.ts +44 -13
- package/sdk/application/User/UserApplicationModel.js +17 -13
- package/sdk/common/AxiosHelper.d.ts +1 -1
- package/sdk/common/AxiosHelper.js +38 -17
- package/sdk/common/Clickstream.js +33 -19
- package/sdk/common/curlHelper.js +1 -3
- package/sdk/common/utils.d.ts +15 -0
- package/sdk/common/utils.js +30 -0
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +2 -2
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +2 -2
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +1 -1
- package/sdk/partner/Lead/LeadPartnerClient.js +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +4 -4
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +4 -4
- package/sdk/partner/OAuthClient.d.ts +3 -3
- package/sdk/partner/PartnerAPIClient.d.ts +1 -1
- package/sdk/partner/PartnerAPIClient.js +0 -1
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +19 -19
- package/sdk/partner/Theme/ThemePartnerClient.js +19 -19
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +25 -32
- package/sdk/partner/Theme/ThemePartnerModel.js +30 -40
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +2 -2
- package/sdk/partner/Webhook/WebhookPartnerClient.js +2 -2
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +2 -2
- package/sdk/partner/Webhook/WebhookPartnerModel.js +2 -2
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +4 -4
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +4 -4
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +17 -17
- package/sdk/platform/Billing/BillingPlatformClient.js +17 -17
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +49 -49
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +49 -49
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +60 -60
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +62 -62
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +87 -87
- package/sdk/platform/Catalog/CatalogPlatformClient.js +87 -87
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +65 -28
- package/sdk/platform/Catalog/CatalogPlatformModel.js +68 -36
- package/sdk/platform/Common/CommonPlatformClient.d.ts +2 -2
- package/sdk/platform/Common/CommonPlatformClient.js +2 -2
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +58 -58
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +58 -58
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +1 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +12 -0
- package/sdk/platform/Communication/CommunicationPlatformModel.js +12 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +16 -16
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +16 -16
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +2 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +2 -0
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +32 -32
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +32 -32
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +18 -18
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +57 -57
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +63 -63
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +4 -4
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +4 -4
- package/sdk/platform/Content/ContentPlatformClient.d.ts +3 -3
- package/sdk/platform/Content/ContentPlatformClient.js +9 -9
- package/sdk/platform/Content/ContentPlatformModel.d.ts +18 -18
- package/sdk/platform/Content/ContentPlatformModel.js +26 -26
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +4 -4
- package/sdk/platform/Content/ContentPlatformValidator.js +4 -4
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +11 -11
- package/sdk/platform/Discount/DiscountPlatformClient.js +11 -11
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +9 -9
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +19 -13
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +23 -14
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +12 -1
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +14 -0
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +27 -27
- package/sdk/platform/Finance/FinancePlatformClient.js +27 -27
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +6 -6
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +6 -6
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +11 -11
- package/sdk/platform/Lead/LeadPlatformClient.js +11 -11
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +62 -77
- package/sdk/platform/Lead/LeadPlatformModel.js +40 -52
- package/sdk/platform/OAuthClient.d.ts +3 -3
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +2 -2
- package/sdk/platform/Order/OrderPlatformClient.d.ts +43 -43
- package/sdk/platform/Order/OrderPlatformClient.js +55 -44
- package/sdk/platform/Order/OrderPlatformModel.d.ts +8 -2
- package/sdk/platform/Order/OrderPlatformModel.js +8 -2
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +14 -0
- package/sdk/platform/Order/OrderPlatformValidator.js +6 -0
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +2 -2
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +38 -38
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +38 -38
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +10 -10
- package/sdk/platform/Payment/PaymentPlatformClient.js +10 -10
- package/sdk/platform/PlatformAPIClient.d.ts +1 -1
- package/sdk/platform/PlatformAPIClient.js +0 -1
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +12 -12
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +9 -9
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +9 -9
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +15 -15
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +15 -15
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +2 -2
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +4 -2
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +5 -5
- package/sdk/platform/Share/SharePlatformApplicationClient.js +5 -5
- package/sdk/platform/Share/SharePlatformModel.d.ts +2 -0
- package/sdk/platform/Share/SharePlatformModel.js +2 -0
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +28 -28
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +28 -28
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +3 -3
- package/sdk/platform/Theme/ThemePlatformClient.js +3 -3
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +25 -32
- package/sdk/platform/Theme/ThemePlatformModel.js +30 -40
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +16 -16
- package/sdk/platform/User/UserPlatformApplicationClient.js +16 -16
- package/sdk/platform/User/UserPlatformModel.d.ts +48 -13
- package/sdk/platform/User/UserPlatformModel.js +21 -13
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +16 -16
- package/sdk/platform/Webhook/WebhookPlatformClient.js +16 -16
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +5 -45
- package/sdk/platform/Webhook/WebhookPlatformModel.js +4 -50
- package/sdk/public/Billing/BillingPublicClient.d.ts +1 -1
- package/sdk/public/Billing/BillingPublicClient.js +4 -4
- package/sdk/public/Billing/BillingPublicValidator.d.ts +2 -2
- package/sdk/public/Billing/BillingPublicValidator.js +2 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +1 -1
- package/sdk/public/Configuration/ConfigurationPublicClient.js +1 -1
- package/sdk/public/Content/ContentPublicValidator.d.ts +2 -2
- package/sdk/public/Content/ContentPublicValidator.js +3 -3
- package/sdk/public/Inventory/InventoryPublicModel.d.ts +8 -8
- package/sdk/public/Inventory/InventoryPublicModel.js +8 -8
- package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.js +1 -1
- package/sdk/public/PublicAPIClient.d.ts +1 -1
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +2 -2
- package/sdk/public/Webhook/WebhookPublicClient.js +2 -2
|
@@ -9,7 +9,7 @@ declare class Lead {
|
|
|
9
9
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
10
10
|
* @returns {Promise<LeadPlatformModel.CloseVideoRoomResponse>} - Success response
|
|
11
11
|
* @name closeVideoRoom
|
|
12
|
-
* @summary: Close video room
|
|
12
|
+
* @summary: Close video room
|
|
13
13
|
* @description: Terminate and close an active video room. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/closeVideoRoom/).
|
|
14
14
|
*/
|
|
15
15
|
closeVideoRoom({ uniqueName, requestHeaders }?: LeadPlatformApplicationValidator.CloseVideoRoomParam, { responseHeaders }?: object): Promise<LeadPlatformModel.CloseVideoRoomResponse>;
|
|
@@ -19,7 +19,7 @@ declare class Lead {
|
|
|
19
19
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
20
20
|
* @returns {Promise<LeadPlatformModel.CustomForm>} - Success response
|
|
21
21
|
* @name createCustomForm
|
|
22
|
-
* @summary: Create custom form
|
|
22
|
+
* @summary: Create custom form
|
|
23
23
|
* @description: Create a new custom form for application users to fill - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/createCustomForm/).
|
|
24
24
|
*/
|
|
25
25
|
createCustomForm({ body, requestHeaders }?: LeadPlatformApplicationValidator.CreateCustomFormParam, { responseHeaders }?: object): Promise<LeadPlatformModel.CustomForm>;
|
|
@@ -49,7 +49,7 @@ declare class Lead {
|
|
|
49
49
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
50
50
|
* @returns {Promise<LeadPlatformModel.CustomForm>} - Success response
|
|
51
51
|
* @name editCustomForm
|
|
52
|
-
* @summary: Edit custom form
|
|
52
|
+
* @summary: Edit custom form
|
|
53
53
|
* @description: Modify the content and assosciated settings of a custom form. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/editCustomForm/).
|
|
54
54
|
*/
|
|
55
55
|
editCustomForm({ slug, body, requestHeaders }?: LeadPlatformApplicationValidator.EditCustomFormParam, { responseHeaders }?: object): Promise<LeadPlatformModel.CustomForm>;
|
|
@@ -69,7 +69,7 @@ declare class Lead {
|
|
|
69
69
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
70
70
|
* @returns {Promise<LeadPlatformModel.CustomForm>} - Success response
|
|
71
71
|
* @name getCustomForm
|
|
72
|
-
* @summary: Get custom form
|
|
72
|
+
* @summary: Get custom form
|
|
73
73
|
* @description: Retrieve information about a custom form which includes corresponding field details and any validation regex required against that field or not - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getCustomForm/).
|
|
74
74
|
*/
|
|
75
75
|
getCustomForm({ slug, requestHeaders }?: LeadPlatformApplicationValidator.GetCustomFormParam, { responseHeaders }?: object): Promise<LeadPlatformModel.CustomForm>;
|
|
@@ -79,7 +79,7 @@ declare class Lead {
|
|
|
79
79
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
80
80
|
* @returns {Promise<LeadPlatformModel.CustomFormList>} - Success response
|
|
81
81
|
* @name getCustomForms
|
|
82
|
-
* @summary: Get custom forms
|
|
82
|
+
* @summary: Get custom forms
|
|
83
83
|
* @description: Retrieve a list of available custom forms. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getCustomForms/).
|
|
84
84
|
*/
|
|
85
85
|
getCustomForms({ requestHeaders }?: any, { responseHeaders }?: object): Promise<LeadPlatformModel.CustomFormList>;
|
|
@@ -146,7 +146,7 @@ declare class Lead {
|
|
|
146
146
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
147
147
|
* @returns {Promise<LeadPlatformModel.CreateVideoRoomResponse>} - Success response
|
|
148
148
|
* @name openVideoRoom
|
|
149
|
-
* @summary: Open video room
|
|
149
|
+
* @summary: Open video room
|
|
150
150
|
* @description: Initiate and open a video room. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/openVideoRoom/).
|
|
151
151
|
*/
|
|
152
152
|
openVideoRoom({ body, requestHeaders }?: LeadPlatformApplicationValidator.OpenVideoRoomParam, { responseHeaders }?: object): Promise<LeadPlatformModel.CreateVideoRoomResponse>;
|
|
@@ -21,7 +21,7 @@ class Lead {
|
|
|
21
21
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
22
22
|
* @returns {Promise<LeadPlatformModel.CloseVideoRoomResponse>} - Success response
|
|
23
23
|
* @name closeVideoRoom
|
|
24
|
-
* @summary: Close video room
|
|
24
|
+
* @summary: Close video room
|
|
25
25
|
* @description: Terminate and close an active video room. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/closeVideoRoom/).
|
|
26
26
|
*/
|
|
27
27
|
async closeVideoRoom(
|
|
@@ -100,7 +100,7 @@ class Lead {
|
|
|
100
100
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
101
101
|
* @returns {Promise<LeadPlatformModel.CustomForm>} - Success response
|
|
102
102
|
* @name createCustomForm
|
|
103
|
-
* @summary: Create custom form
|
|
103
|
+
* @summary: Create custom form
|
|
104
104
|
* @description: Create a new custom form for application users to fill - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/createCustomForm/).
|
|
105
105
|
*/
|
|
106
106
|
async createCustomForm(
|
|
@@ -339,7 +339,7 @@ class Lead {
|
|
|
339
339
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
340
340
|
* @returns {Promise<LeadPlatformModel.CustomForm>} - Success response
|
|
341
341
|
* @name editCustomForm
|
|
342
|
-
* @summary: Edit custom form
|
|
342
|
+
* @summary: Edit custom form
|
|
343
343
|
* @description: Modify the content and assosciated settings of a custom form. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/editCustomForm/).
|
|
344
344
|
*/
|
|
345
345
|
async editCustomForm(
|
|
@@ -499,7 +499,7 @@ class Lead {
|
|
|
499
499
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
500
500
|
* @returns {Promise<LeadPlatformModel.CustomForm>} - Success response
|
|
501
501
|
* @name getCustomForm
|
|
502
|
-
* @summary: Get custom form
|
|
502
|
+
* @summary: Get custom form
|
|
503
503
|
* @description: Retrieve information about a custom form which includes corresponding field details and any validation regex required against that field or not - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getCustomForm/).
|
|
504
504
|
*/
|
|
505
505
|
async getCustomForm(
|
|
@@ -576,7 +576,7 @@ class Lead {
|
|
|
576
576
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
577
577
|
* @returns {Promise<LeadPlatformModel.CustomFormList>} - Success response
|
|
578
578
|
* @name getCustomForms
|
|
579
|
-
* @summary: Get custom forms
|
|
579
|
+
* @summary: Get custom forms
|
|
580
580
|
* @description: Retrieve a list of available custom forms. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getCustomForms/).
|
|
581
581
|
*/
|
|
582
582
|
async getCustomForms(
|
|
@@ -1067,7 +1067,7 @@ class Lead {
|
|
|
1067
1067
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1068
1068
|
* @returns {Promise<LeadPlatformModel.CreateVideoRoomResponse>} - Success response
|
|
1069
1069
|
* @name openVideoRoom
|
|
1070
|
-
* @summary: Open video room
|
|
1070
|
+
* @summary: Open video room
|
|
1071
1071
|
* @description: Initiate and open a video room. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/openVideoRoom/).
|
|
1072
1072
|
*/
|
|
1073
1073
|
async openVideoRoom(
|
|
@@ -8,7 +8,7 @@ declare class Lead {
|
|
|
8
8
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
9
9
|
* @returns {Promise<LeadPlatformModel.TicketHistory>} - Success response
|
|
10
10
|
* @name createPlatformTicketHistory
|
|
11
|
-
* @summary: Create platform ticket history
|
|
11
|
+
* @summary: Create platform ticket history
|
|
12
12
|
* @description: Create futher interactions on a company level ticket such as changing it's status, priority or replying to a ticket via a thread. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/createPlatformTicketHistory/).
|
|
13
13
|
*/
|
|
14
14
|
createPlatformTicketHistory({ id, body, requestHeaders }?: LeadPlatformValidator.CreatePlatformTicketHistoryParam, { responseHeaders }?: object): Promise<LeadPlatformModel.TicketHistory>;
|
|
@@ -18,7 +18,7 @@ declare class Lead {
|
|
|
18
18
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
19
19
|
* @returns {Promise<LeadPlatformModel.Ticket>} - Success response
|
|
20
20
|
* @name createTicket
|
|
21
|
-
* @summary: Create ticket
|
|
21
|
+
* @summary: Create ticket
|
|
22
22
|
* @description: Create a new ticket at application level - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/createTicket/).
|
|
23
23
|
*/
|
|
24
24
|
createTicket({ body, requestHeaders }?: LeadPlatformValidator.CreateTicketParam, { responseHeaders }?: object): Promise<LeadPlatformModel.Ticket>;
|
|
@@ -28,7 +28,7 @@ declare class Lead {
|
|
|
28
28
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
29
29
|
* @returns {Promise<LeadPlatformModel.Ticket>} - Success response
|
|
30
30
|
* @name editPlatformTicket
|
|
31
|
-
* @summary: Edit platform ticket
|
|
31
|
+
* @summary: Edit platform ticket
|
|
32
32
|
* @description: Modify the content and settings of a specific company level ticket. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/editPlatformTicket/).
|
|
33
33
|
*/
|
|
34
34
|
editPlatformTicket({ id, body, requestHeaders }?: LeadPlatformValidator.EditPlatformTicketParam, { responseHeaders }?: object): Promise<LeadPlatformModel.Ticket>;
|
|
@@ -38,7 +38,7 @@ declare class Lead {
|
|
|
38
38
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
39
39
|
* @returns {Promise<LeadPlatformModel.TicketFeedbackList>} - Success response
|
|
40
40
|
* @name getFeedbacks
|
|
41
|
-
* @summary: Get feedbacks
|
|
41
|
+
* @summary: Get feedbacks
|
|
42
42
|
* @description: Retrieve feedback information related to a ticket. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getFeedbacks/).
|
|
43
43
|
*/
|
|
44
44
|
getFeedbacks({ id, requestHeaders }?: LeadPlatformValidator.GetFeedbacksParam, { responseHeaders }?: object): Promise<LeadPlatformModel.TicketFeedbackList>;
|
|
@@ -48,7 +48,7 @@ declare class Lead {
|
|
|
48
48
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
49
49
|
* @returns {Promise<LeadPlatformModel.CloseVideoRoomResponse>} - Success response
|
|
50
50
|
* @name getGeneralConfig
|
|
51
|
-
* @summary: Get general configuration
|
|
51
|
+
* @summary: Get general configuration
|
|
52
52
|
* @description: Retrieve general configuration settings related to support system for company tickets - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getGeneralConfig/).
|
|
53
53
|
*/
|
|
54
54
|
getGeneralConfig({ requestHeaders }?: any, { responseHeaders }?: object): Promise<LeadPlatformModel.CloseVideoRoomResponse>;
|
|
@@ -58,7 +58,7 @@ declare class Lead {
|
|
|
58
58
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
59
59
|
* @returns {Promise<LeadPlatformModel.Ticket>} - Success response
|
|
60
60
|
* @name getPlatformTicket
|
|
61
|
-
* @summary: Get platform ticket
|
|
61
|
+
* @summary: Get platform ticket
|
|
62
62
|
* @description: Retrieve detailed information about a specific ticket which is raised at company level - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getPlatformTicket/).
|
|
63
63
|
*/
|
|
64
64
|
getPlatformTicket({ id, requestHeaders }?: LeadPlatformValidator.GetPlatformTicketParam, { responseHeaders }?: object): Promise<LeadPlatformModel.Ticket>;
|
|
@@ -68,7 +68,7 @@ declare class Lead {
|
|
|
68
68
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
69
69
|
* @returns {Promise<LeadPlatformModel.TicketHistoryList>} - Success response
|
|
70
70
|
* @name getPlatformTicketHistory
|
|
71
|
-
* @summary: Get platform ticket history
|
|
71
|
+
* @summary: Get platform ticket history
|
|
72
72
|
* @description: Retrieve a list of history records for a company level ticket. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getPlatformTicketHistory/).
|
|
73
73
|
*/
|
|
74
74
|
getPlatformTicketHistory({ id, requestHeaders }?: LeadPlatformValidator.GetPlatformTicketHistoryParam, { responseHeaders }?: object): Promise<LeadPlatformModel.TicketHistoryList>;
|
|
@@ -78,7 +78,7 @@ declare class Lead {
|
|
|
78
78
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
79
79
|
* @returns {Promise<LeadPlatformModel.TicketList>} - Success response
|
|
80
80
|
* @name getPlatformTickets
|
|
81
|
-
* @summary: Get platform tickets
|
|
81
|
+
* @summary: Get platform tickets
|
|
82
82
|
* @description: Retrieve a list of tickets created within the platform at company level - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getPlatformTickets/).
|
|
83
83
|
*/
|
|
84
84
|
getPlatformTickets({ items, filters, q, status, priority, category, pageNo, pageSize, requestHeaders, }?: LeadPlatformValidator.GetPlatformTicketsParam, { responseHeaders }?: object): Promise<LeadPlatformModel.TicketList>;
|
|
@@ -90,7 +90,7 @@ declare class Lead {
|
|
|
90
90
|
* - Success response
|
|
91
91
|
*
|
|
92
92
|
* @name getPlatformVideoParticipants
|
|
93
|
-
* @summary: Get platform video participants
|
|
93
|
+
* @summary: Get platform video participants
|
|
94
94
|
* @description: Retrieve a list of participants in a platform video room. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getPlatformVideoParticipants/).
|
|
95
95
|
*/
|
|
96
96
|
getPlatformVideoParticipants({ uniqueName, requestHeaders }?: LeadPlatformValidator.GetPlatformVideoParticipantsParam, { responseHeaders }?: object): Promise<LeadPlatformModel.GetParticipantsInsideVideoRoomResponse>;
|
|
@@ -101,7 +101,7 @@ declare class Lead {
|
|
|
101
101
|
* @returns {Promise<LeadPlatformModel.GetTokenForVideoRoomResponse>} -
|
|
102
102
|
* Success response
|
|
103
103
|
* @name getTokenForPlatformVideoRoom
|
|
104
|
-
* @summary: Get token for platform video room
|
|
104
|
+
* @summary: Get token for platform video room
|
|
105
105
|
* @description: Retrieve an access token for a platform video room. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getTokenForPlatformVideoRoom/).
|
|
106
106
|
*/
|
|
107
107
|
getTokenForPlatformVideoRoom({ uniqueName, requestHeaders }?: LeadPlatformValidator.GetTokenForPlatformVideoRoomParam, { responseHeaders }?: object): Promise<LeadPlatformModel.GetTokenForVideoRoomResponse>;
|
|
@@ -111,7 +111,7 @@ declare class Lead {
|
|
|
111
111
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
112
112
|
* @returns {Promise<LeadPlatformModel.TicketFeedback>} - Success response
|
|
113
113
|
* @name submitFeedback
|
|
114
|
-
* @summary: Submit feedback
|
|
114
|
+
* @summary: Submit feedback
|
|
115
115
|
* @description: Provide feedback on a ticket and it's resolution. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/submitFeedback/).
|
|
116
116
|
*/
|
|
117
117
|
submitFeedback({ id, body, requestHeaders }?: LeadPlatformValidator.SubmitFeedbackParam, { responseHeaders }?: object): Promise<LeadPlatformModel.TicketFeedback>;
|
|
@@ -20,7 +20,7 @@ class Lead {
|
|
|
20
20
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
21
21
|
* @returns {Promise<LeadPlatformModel.TicketHistory>} - Success response
|
|
22
22
|
* @name createPlatformTicketHistory
|
|
23
|
-
* @summary: Create platform ticket history
|
|
23
|
+
* @summary: Create platform ticket history
|
|
24
24
|
* @description: Create futher interactions on a company level ticket such as changing it's status, priority or replying to a ticket via a thread. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/createPlatformTicketHistory/).
|
|
25
25
|
*/
|
|
26
26
|
async createPlatformTicketHistory(
|
|
@@ -103,7 +103,7 @@ class Lead {
|
|
|
103
103
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
104
104
|
* @returns {Promise<LeadPlatformModel.Ticket>} - Success response
|
|
105
105
|
* @name createTicket
|
|
106
|
-
* @summary: Create ticket
|
|
106
|
+
* @summary: Create ticket
|
|
107
107
|
* @description: Create a new ticket at application level - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/createTicket/).
|
|
108
108
|
*/
|
|
109
109
|
async createTicket(
|
|
@@ -180,7 +180,7 @@ class Lead {
|
|
|
180
180
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
181
181
|
* @returns {Promise<LeadPlatformModel.Ticket>} - Success response
|
|
182
182
|
* @name editPlatformTicket
|
|
183
|
-
* @summary: Edit platform ticket
|
|
183
|
+
* @summary: Edit platform ticket
|
|
184
184
|
* @description: Modify the content and settings of a specific company level ticket. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/editPlatformTicket/).
|
|
185
185
|
*/
|
|
186
186
|
async editPlatformTicket(
|
|
@@ -261,7 +261,7 @@ class Lead {
|
|
|
261
261
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
262
262
|
* @returns {Promise<LeadPlatformModel.TicketFeedbackList>} - Success response
|
|
263
263
|
* @name getFeedbacks
|
|
264
|
-
* @summary: Get feedbacks
|
|
264
|
+
* @summary: Get feedbacks
|
|
265
265
|
* @description: Retrieve feedback information related to a ticket. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getFeedbacks/).
|
|
266
266
|
*/
|
|
267
267
|
async getFeedbacks(
|
|
@@ -338,7 +338,7 @@ class Lead {
|
|
|
338
338
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
339
339
|
* @returns {Promise<LeadPlatformModel.CloseVideoRoomResponse>} - Success response
|
|
340
340
|
* @name getGeneralConfig
|
|
341
|
-
* @summary: Get general configuration
|
|
341
|
+
* @summary: Get general configuration
|
|
342
342
|
* @description: Retrieve general configuration settings related to support system for company tickets - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getGeneralConfig/).
|
|
343
343
|
*/
|
|
344
344
|
async getGeneralConfig(
|
|
@@ -413,7 +413,7 @@ class Lead {
|
|
|
413
413
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
414
414
|
* @returns {Promise<LeadPlatformModel.Ticket>} - Success response
|
|
415
415
|
* @name getPlatformTicket
|
|
416
|
-
* @summary: Get platform ticket
|
|
416
|
+
* @summary: Get platform ticket
|
|
417
417
|
* @description: Retrieve detailed information about a specific ticket which is raised at company level - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getPlatformTicket/).
|
|
418
418
|
*/
|
|
419
419
|
async getPlatformTicket(
|
|
@@ -492,7 +492,7 @@ class Lead {
|
|
|
492
492
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
493
493
|
* @returns {Promise<LeadPlatformModel.TicketHistoryList>} - Success response
|
|
494
494
|
* @name getPlatformTicketHistory
|
|
495
|
-
* @summary: Get platform ticket history
|
|
495
|
+
* @summary: Get platform ticket history
|
|
496
496
|
* @description: Retrieve a list of history records for a company level ticket. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getPlatformTicketHistory/).
|
|
497
497
|
*/
|
|
498
498
|
async getPlatformTicketHistory(
|
|
@@ -571,7 +571,7 @@ class Lead {
|
|
|
571
571
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
572
572
|
* @returns {Promise<LeadPlatformModel.TicketList>} - Success response
|
|
573
573
|
* @name getPlatformTickets
|
|
574
|
-
* @summary: Get platform tickets
|
|
574
|
+
* @summary: Get platform tickets
|
|
575
575
|
* @description: Retrieve a list of tickets created within the platform at company level - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getPlatformTickets/).
|
|
576
576
|
*/
|
|
577
577
|
async getPlatformTickets(
|
|
@@ -684,7 +684,7 @@ class Lead {
|
|
|
684
684
|
* - Success response
|
|
685
685
|
*
|
|
686
686
|
* @name getPlatformVideoParticipants
|
|
687
|
-
* @summary: Get platform video participants
|
|
687
|
+
* @summary: Get platform video participants
|
|
688
688
|
* @description: Retrieve a list of participants in a platform video room. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getPlatformVideoParticipants/).
|
|
689
689
|
*/
|
|
690
690
|
async getPlatformVideoParticipants(
|
|
@@ -766,7 +766,7 @@ class Lead {
|
|
|
766
766
|
* @returns {Promise<LeadPlatformModel.GetTokenForVideoRoomResponse>} -
|
|
767
767
|
* Success response
|
|
768
768
|
* @name getTokenForPlatformVideoRoom
|
|
769
|
-
* @summary: Get token for platform video room
|
|
769
|
+
* @summary: Get token for platform video room
|
|
770
770
|
* @description: Retrieve an access token for a platform video room. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getTokenForPlatformVideoRoom/).
|
|
771
771
|
*/
|
|
772
772
|
async getTokenForPlatformVideoRoom(
|
|
@@ -847,7 +847,7 @@ class Lead {
|
|
|
847
847
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
848
848
|
* @returns {Promise<LeadPlatformModel.TicketFeedback>} - Success response
|
|
849
849
|
* @name submitFeedback
|
|
850
|
-
* @summary: Submit feedback
|
|
850
|
+
* @summary: Submit feedback
|
|
851
851
|
* @description: Provide feedback on a ticket and it's resolution. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/submitFeedback/).
|
|
852
852
|
*/
|
|
853
853
|
async submitFeedback(
|
|
@@ -131,26 +131,7 @@ export = LeadPlatformModel;
|
|
|
131
131
|
* @property {string} [created_at]
|
|
132
132
|
* @property {string} [updated_at]
|
|
133
133
|
* @property {string} [external_id]
|
|
134
|
-
|
|
135
|
-
/**
|
|
136
|
-
* @typedef PhoneNumber
|
|
137
|
-
* @property {boolean} [active] - Denotes if the phone number is active
|
|
138
|
-
* @property {boolean} [primary] - Denotes it's the primary phone number for the account
|
|
139
|
-
* @property {boolean} [verified] - Denotes it's a verified phone number
|
|
140
|
-
* @property {string} [phone] - Phone number
|
|
141
|
-
* @property {number} [country_code] - Country code
|
|
142
|
-
*/
|
|
143
|
-
/**
|
|
144
|
-
* @typedef Email
|
|
145
|
-
* @property {boolean} [primary] - Denotes it's the primary email for the account
|
|
146
|
-
* @property {boolean} [verified] - Denotes it's a verified email
|
|
147
|
-
* @property {string} [email] - Email Address
|
|
148
|
-
* @property {boolean} [active] - Denotes if the email is active
|
|
149
|
-
*/
|
|
150
|
-
/**
|
|
151
|
-
* @typedef Debug
|
|
152
|
-
* @property {string} [source] - Source of user
|
|
153
|
-
* @property {string} [platform] - Platform of user
|
|
134
|
+
* @property {string} [rr_id]
|
|
154
135
|
*/
|
|
155
136
|
/**
|
|
156
137
|
* @typedef TicketContext
|
|
@@ -305,6 +286,21 @@ export = LeadPlatformModel;
|
|
|
305
286
|
* @typedef ErrorMessage
|
|
306
287
|
* @property {string} [message]
|
|
307
288
|
*/
|
|
289
|
+
/**
|
|
290
|
+
* @typedef PhoneNumber
|
|
291
|
+
* @property {string} [phone] - Phone number
|
|
292
|
+
* @property {number} [country_code] - Country code
|
|
293
|
+
* @property {boolean} [active] - Is the phone number active
|
|
294
|
+
* @property {boolean} [primary] - Is it a primary phone number
|
|
295
|
+
* @property {boolean} [verified] - Is the phone number verified
|
|
296
|
+
*/
|
|
297
|
+
/**
|
|
298
|
+
* @typedef Email
|
|
299
|
+
* @property {string} [email] - Email address
|
|
300
|
+
* @property {boolean} [active] - Is the email active
|
|
301
|
+
* @property {boolean} [primary] - Is it a primary email
|
|
302
|
+
* @property {boolean} [verified] - Is the email verified
|
|
303
|
+
*/
|
|
308
304
|
/** @typedef {"low" | "medium" | "high" | "urgent"} PriorityEnum */
|
|
309
305
|
/** @typedef {"rating" | "log" | "comment" | "thread"} HistoryTypeEnum */
|
|
310
306
|
/**
|
|
@@ -322,7 +318,7 @@ export = LeadPlatformModel;
|
|
|
322
318
|
declare class LeadPlatformModel {
|
|
323
319
|
}
|
|
324
320
|
declare namespace LeadPlatformModel {
|
|
325
|
-
export { TicketList, Page, TicketHistoryList, CustomFormList, CreateCustomFormPayload, EditCustomFormPayload, EditTicketPayload, AgentChangePayload, CreateVideoRoomResponse, CloseVideoRoomResponse, CreateVideoRoomPayload, NotifyUser, Filter, TicketHistoryPayload, GetTokenForVideoRoomResponse, GetParticipantsInsideVideoRoomResponse, Participant, UserSchema,
|
|
321
|
+
export { TicketList, Page, TicketHistoryList, CustomFormList, CreateCustomFormPayload, EditCustomFormPayload, EditTicketPayload, AgentChangePayload, CreateVideoRoomResponse, CloseVideoRoomResponse, CreateVideoRoomPayload, NotifyUser, Filter, TicketHistoryPayload, GetTokenForVideoRoomResponse, GetParticipantsInsideVideoRoomResponse, Participant, UserSchema, TicketContext, CreatedOn, TicketAsset, TicketContent, AddTicketPayload, Priority, Status, TicketFeedbackList, TicketFeedbackPayload, SubmitButton, PollForAssignment, CustomForm, FeedbackForm, TicketCategory, FeedbackResponseItem, TicketFeedback, TicketHistory, Ticket, ErrorMessage, PhoneNumber, Email, PriorityEnum, HistoryTypeEnum, TicketAssetTypeEnum, TicketSourceEnum };
|
|
326
322
|
}
|
|
327
323
|
/** @returns {TicketList} */
|
|
328
324
|
declare function TicketList(): TicketList;
|
|
@@ -588,62 +584,7 @@ type UserSchema = {
|
|
|
588
584
|
created_at?: string;
|
|
589
585
|
updated_at?: string;
|
|
590
586
|
external_id?: string;
|
|
591
|
-
|
|
592
|
-
/** @returns {PhoneNumber} */
|
|
593
|
-
declare function PhoneNumber(): PhoneNumber;
|
|
594
|
-
type PhoneNumber = {
|
|
595
|
-
/**
|
|
596
|
-
* - Denotes if the phone number is active
|
|
597
|
-
*/
|
|
598
|
-
active?: boolean;
|
|
599
|
-
/**
|
|
600
|
-
* - Denotes it's the primary phone number for the account
|
|
601
|
-
*/
|
|
602
|
-
primary?: boolean;
|
|
603
|
-
/**
|
|
604
|
-
* - Denotes it's a verified phone number
|
|
605
|
-
*/
|
|
606
|
-
verified?: boolean;
|
|
607
|
-
/**
|
|
608
|
-
* - Phone number
|
|
609
|
-
*/
|
|
610
|
-
phone?: string;
|
|
611
|
-
/**
|
|
612
|
-
* - Country code
|
|
613
|
-
*/
|
|
614
|
-
country_code?: number;
|
|
615
|
-
};
|
|
616
|
-
/** @returns {Email} */
|
|
617
|
-
declare function Email(): Email;
|
|
618
|
-
type Email = {
|
|
619
|
-
/**
|
|
620
|
-
* - Denotes it's the primary email for the account
|
|
621
|
-
*/
|
|
622
|
-
primary?: boolean;
|
|
623
|
-
/**
|
|
624
|
-
* - Denotes it's a verified email
|
|
625
|
-
*/
|
|
626
|
-
verified?: boolean;
|
|
627
|
-
/**
|
|
628
|
-
* - Email Address
|
|
629
|
-
*/
|
|
630
|
-
email?: string;
|
|
631
|
-
/**
|
|
632
|
-
* - Denotes if the email is active
|
|
633
|
-
*/
|
|
634
|
-
active?: boolean;
|
|
635
|
-
};
|
|
636
|
-
/** @returns {Debug} */
|
|
637
|
-
declare function Debug(): Debug;
|
|
638
|
-
type Debug = {
|
|
639
|
-
/**
|
|
640
|
-
* - Source of user
|
|
641
|
-
*/
|
|
642
|
-
source?: string;
|
|
643
|
-
/**
|
|
644
|
-
* - Platform of user
|
|
645
|
-
*/
|
|
646
|
-
platform?: string;
|
|
587
|
+
rr_id?: string;
|
|
647
588
|
};
|
|
648
589
|
/** @returns {TicketContext} */
|
|
649
590
|
declare function TicketContext(): TicketContext;
|
|
@@ -1027,6 +968,50 @@ declare function ErrorMessage(): ErrorMessage;
|
|
|
1027
968
|
type ErrorMessage = {
|
|
1028
969
|
message?: string;
|
|
1029
970
|
};
|
|
971
|
+
/** @returns {PhoneNumber} */
|
|
972
|
+
declare function PhoneNumber(): PhoneNumber;
|
|
973
|
+
type PhoneNumber = {
|
|
974
|
+
/**
|
|
975
|
+
* - Phone number
|
|
976
|
+
*/
|
|
977
|
+
phone?: string;
|
|
978
|
+
/**
|
|
979
|
+
* - Country code
|
|
980
|
+
*/
|
|
981
|
+
country_code?: number;
|
|
982
|
+
/**
|
|
983
|
+
* - Is the phone number active
|
|
984
|
+
*/
|
|
985
|
+
active?: boolean;
|
|
986
|
+
/**
|
|
987
|
+
* - Is it a primary phone number
|
|
988
|
+
*/
|
|
989
|
+
primary?: boolean;
|
|
990
|
+
/**
|
|
991
|
+
* - Is the phone number verified
|
|
992
|
+
*/
|
|
993
|
+
verified?: boolean;
|
|
994
|
+
};
|
|
995
|
+
/** @returns {Email} */
|
|
996
|
+
declare function Email(): Email;
|
|
997
|
+
type Email = {
|
|
998
|
+
/**
|
|
999
|
+
* - Email address
|
|
1000
|
+
*/
|
|
1001
|
+
email?: string;
|
|
1002
|
+
/**
|
|
1003
|
+
* - Is the email active
|
|
1004
|
+
*/
|
|
1005
|
+
active?: boolean;
|
|
1006
|
+
/**
|
|
1007
|
+
* - Is it a primary email
|
|
1008
|
+
*/
|
|
1009
|
+
primary?: boolean;
|
|
1010
|
+
/**
|
|
1011
|
+
* - Is the email verified
|
|
1012
|
+
*/
|
|
1013
|
+
verified?: boolean;
|
|
1014
|
+
};
|
|
1030
1015
|
/**
|
|
1031
1016
|
* Enum: PriorityEnum Used By: Lead
|
|
1032
1017
|
*
|
|
@@ -149,29 +149,7 @@ const Joi = require("joi");
|
|
|
149
149
|
* @property {string} [created_at]
|
|
150
150
|
* @property {string} [updated_at]
|
|
151
151
|
* @property {string} [external_id]
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
/**
|
|
155
|
-
* @typedef PhoneNumber
|
|
156
|
-
* @property {boolean} [active] - Denotes if the phone number is active
|
|
157
|
-
* @property {boolean} [primary] - Denotes it's the primary phone number for the account
|
|
158
|
-
* @property {boolean} [verified] - Denotes it's a verified phone number
|
|
159
|
-
* @property {string} [phone] - Phone number
|
|
160
|
-
* @property {number} [country_code] - Country code
|
|
161
|
-
*/
|
|
162
|
-
|
|
163
|
-
/**
|
|
164
|
-
* @typedef Email
|
|
165
|
-
* @property {boolean} [primary] - Denotes it's the primary email for the account
|
|
166
|
-
* @property {boolean} [verified] - Denotes it's a verified email
|
|
167
|
-
* @property {string} [email] - Email Address
|
|
168
|
-
* @property {boolean} [active] - Denotes if the email is active
|
|
169
|
-
*/
|
|
170
|
-
|
|
171
|
-
/**
|
|
172
|
-
* @typedef Debug
|
|
173
|
-
* @property {string} [source] - Source of user
|
|
174
|
-
* @property {string} [platform] - Platform of user
|
|
152
|
+
* @property {string} [rr_id]
|
|
175
153
|
*/
|
|
176
154
|
|
|
177
155
|
/**
|
|
@@ -346,6 +324,23 @@ const Joi = require("joi");
|
|
|
346
324
|
* @property {string} [message]
|
|
347
325
|
*/
|
|
348
326
|
|
|
327
|
+
/**
|
|
328
|
+
* @typedef PhoneNumber
|
|
329
|
+
* @property {string} [phone] - Phone number
|
|
330
|
+
* @property {number} [country_code] - Country code
|
|
331
|
+
* @property {boolean} [active] - Is the phone number active
|
|
332
|
+
* @property {boolean} [primary] - Is it a primary phone number
|
|
333
|
+
* @property {boolean} [verified] - Is the phone number verified
|
|
334
|
+
*/
|
|
335
|
+
|
|
336
|
+
/**
|
|
337
|
+
* @typedef Email
|
|
338
|
+
* @property {string} [email] - Email address
|
|
339
|
+
* @property {boolean} [active] - Is the email active
|
|
340
|
+
* @property {boolean} [primary] - Is it a primary email
|
|
341
|
+
* @property {boolean} [verified] - Is the email verified
|
|
342
|
+
*/
|
|
343
|
+
|
|
349
344
|
/** @typedef {"low" | "medium" | "high" | "urgent"} PriorityEnum */
|
|
350
345
|
|
|
351
346
|
/** @typedef {"rating" | "log" | "comment" | "thread"} HistoryTypeEnum */
|
|
@@ -547,35 +542,7 @@ class LeadPlatformModel {
|
|
|
547
542
|
created_at: Joi.string().allow(""),
|
|
548
543
|
updated_at: Joi.string().allow(""),
|
|
549
544
|
external_id: Joi.string().allow(""),
|
|
550
|
-
|
|
551
|
-
}
|
|
552
|
-
|
|
553
|
-
/** @returns {PhoneNumber} */
|
|
554
|
-
static PhoneNumber() {
|
|
555
|
-
return Joi.object({
|
|
556
|
-
active: Joi.boolean(),
|
|
557
|
-
primary: Joi.boolean(),
|
|
558
|
-
verified: Joi.boolean(),
|
|
559
|
-
phone: Joi.string().allow(""),
|
|
560
|
-
country_code: Joi.number(),
|
|
561
|
-
});
|
|
562
|
-
}
|
|
563
|
-
|
|
564
|
-
/** @returns {Email} */
|
|
565
|
-
static Email() {
|
|
566
|
-
return Joi.object({
|
|
567
|
-
primary: Joi.boolean(),
|
|
568
|
-
verified: Joi.boolean(),
|
|
569
|
-
email: Joi.string().allow(""),
|
|
570
|
-
active: Joi.boolean(),
|
|
571
|
-
});
|
|
572
|
-
}
|
|
573
|
-
|
|
574
|
-
/** @returns {Debug} */
|
|
575
|
-
static Debug() {
|
|
576
|
-
return Joi.object({
|
|
577
|
-
source: Joi.string().allow(""),
|
|
578
|
-
platform: Joi.string().allow(""),
|
|
545
|
+
rr_id: Joi.string().allow(""),
|
|
579
546
|
});
|
|
580
547
|
}
|
|
581
548
|
|
|
@@ -785,6 +752,27 @@ class LeadPlatformModel {
|
|
|
785
752
|
});
|
|
786
753
|
}
|
|
787
754
|
|
|
755
|
+
/** @returns {PhoneNumber} */
|
|
756
|
+
static PhoneNumber() {
|
|
757
|
+
return Joi.object({
|
|
758
|
+
phone: Joi.string().allow(""),
|
|
759
|
+
country_code: Joi.number(),
|
|
760
|
+
active: Joi.boolean(),
|
|
761
|
+
primary: Joi.boolean(),
|
|
762
|
+
verified: Joi.boolean(),
|
|
763
|
+
});
|
|
764
|
+
}
|
|
765
|
+
|
|
766
|
+
/** @returns {Email} */
|
|
767
|
+
static Email() {
|
|
768
|
+
return Joi.object({
|
|
769
|
+
email: Joi.string().allow(""),
|
|
770
|
+
active: Joi.boolean(),
|
|
771
|
+
primary: Joi.boolean(),
|
|
772
|
+
verified: Joi.boolean(),
|
|
773
|
+
});
|
|
774
|
+
}
|
|
775
|
+
|
|
788
776
|
/**
|
|
789
777
|
* Enum: PriorityEnum Used By: Lead
|
|
790
778
|
*
|
|
@@ -20,7 +20,7 @@ declare class OAuthClient {
|
|
|
20
20
|
grant_type: any;
|
|
21
21
|
refresh_token: any;
|
|
22
22
|
code: any;
|
|
23
|
-
}): Promise<any
|
|
24
|
-
getOfflineAccessToken(scopes: any, code: any): Promise<any
|
|
25
|
-
getOfflineAccessTokenObj(scopes: any, code: any): Promise<any
|
|
23
|
+
}): Promise<import("axios").AxiosResponse<any, any>>;
|
|
24
|
+
getOfflineAccessToken(scopes: any, code: any): Promise<import("axios").AxiosResponse<any, any>>;
|
|
25
|
+
getOfflineAccessTokenObj(scopes: any, code: any): Promise<import("axios").AxiosResponse<any, any>>;
|
|
26
26
|
}
|
|
@@ -35,7 +35,7 @@ declare class Order {
|
|
|
35
35
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
36
36
|
* @returns {Promise<OrderPlatformModel.ShipmentReasonsResponse>} - Success response
|
|
37
37
|
* @name getPlatformShipmentReasons
|
|
38
|
-
* @summary: Get platform shipment reasons
|
|
38
|
+
* @summary: Get platform shipment reasons
|
|
39
39
|
* @description: Retrieve reasons behind full or partial cancellation of a shipment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getPlatformShipmentReasons/).
|
|
40
40
|
*/
|
|
41
41
|
getPlatformShipmentReasons({ action, requestHeaders }?: OrderPlatformApplicationValidator.GetPlatformShipmentReasonsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentReasonsResponse>;
|
|
@@ -59,7 +59,7 @@ declare class Order {
|
|
|
59
59
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
60
60
|
* @returns {Promise<OrderPlatformModel.PlatformShipmentTrack>} - Success response
|
|
61
61
|
* @name trackShipmentPlatform
|
|
62
|
-
* @summary: Track shipment on the platform
|
|
62
|
+
* @summary: Track shipment on the platform
|
|
63
63
|
* @description: Track shipment by Shipment ID for application based on application Id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/trackShipmentPlatform/).
|
|
64
64
|
*/
|
|
65
65
|
trackShipmentPlatform({ shipmentId, requestHeaders }?: OrderPlatformApplicationValidator.TrackShipmentPlatformParam, { responseHeaders }?: object): Promise<OrderPlatformModel.PlatformShipmentTrack>;
|
|
@@ -258,7 +258,7 @@ class Order {
|
|
|
258
258
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
259
259
|
* @returns {Promise<OrderPlatformModel.ShipmentReasonsResponse>} - Success response
|
|
260
260
|
* @name getPlatformShipmentReasons
|
|
261
|
-
* @summary: Get platform shipment reasons
|
|
261
|
+
* @summary: Get platform shipment reasons
|
|
262
262
|
* @description: Retrieve reasons behind full or partial cancellation of a shipment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getPlatformShipmentReasons/).
|
|
263
263
|
*/
|
|
264
264
|
async getPlatformShipmentReasons(
|
|
@@ -422,7 +422,7 @@ class Order {
|
|
|
422
422
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
423
423
|
* @returns {Promise<OrderPlatformModel.PlatformShipmentTrack>} - Success response
|
|
424
424
|
* @name trackShipmentPlatform
|
|
425
|
-
* @summary: Track shipment on the platform
|
|
425
|
+
* @summary: Track shipment on the platform
|
|
426
426
|
* @description: Track shipment by Shipment ID for application based on application Id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/trackShipmentPlatform/).
|
|
427
427
|
*/
|
|
428
428
|
async trackShipmentPlatform(
|