@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
|
@@ -46,7 +46,7 @@ class Lead {
|
|
|
46
46
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
47
47
|
* @returns {Promise<LeadApplicationModel.TicketHistory>} - Success response
|
|
48
48
|
* @name createHistory
|
|
49
|
-
* @summary: Logs ticket history
|
|
49
|
+
* @summary: Logs ticket history
|
|
50
50
|
* @description: Adds a history entry for a specific support ticket. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/createHistory/).
|
|
51
51
|
*/
|
|
52
52
|
async createHistory(
|
|
@@ -124,7 +124,7 @@ class Lead {
|
|
|
124
124
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
125
125
|
* @returns {Promise<LeadApplicationModel.Ticket>} - Success response
|
|
126
126
|
* @name createTicket
|
|
127
|
-
* @summary: Creates a new ticket
|
|
127
|
+
* @summary: Creates a new ticket
|
|
128
128
|
* @description: Generates a new customer support ticket for a user query. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/createTicket/).
|
|
129
129
|
*/
|
|
130
130
|
async createTicket(
|
|
@@ -202,7 +202,7 @@ class Lead {
|
|
|
202
202
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
203
203
|
* @returns {Promise<LeadApplicationModel.CustomForm>} - Success response
|
|
204
204
|
* @name getCustomForm
|
|
205
|
-
* @summary: Fetches custom form
|
|
205
|
+
* @summary: Fetches custom form
|
|
206
206
|
* @description: Retrieves a customizable form template for data collection. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/getCustomForm/).
|
|
207
207
|
*/
|
|
208
208
|
async getCustomForm(
|
|
@@ -284,7 +284,7 @@ class Lead {
|
|
|
284
284
|
* - Success response
|
|
285
285
|
*
|
|
286
286
|
* @name getParticipantsInsideVideoRoom
|
|
287
|
-
* @summary: Lists video room participants
|
|
287
|
+
* @summary: Lists video room participants
|
|
288
288
|
* @description: Gets the current participants inside a specific video room. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/getParticipantsInsideVideoRoom/).
|
|
289
289
|
*/
|
|
290
290
|
async getParticipantsInsideVideoRoom(
|
|
@@ -364,7 +364,7 @@ class Lead {
|
|
|
364
364
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
365
365
|
* @returns {Promise<LeadApplicationModel.Ticket>} - Success response
|
|
366
366
|
* @name getTicket
|
|
367
|
-
* @summary: Retrieves a support ticket
|
|
367
|
+
* @summary: Retrieves a support ticket
|
|
368
368
|
* @description: Retrieve details of a specific customer support ticket. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/getTicket/).
|
|
369
369
|
*/
|
|
370
370
|
async getTicket(
|
|
@@ -441,7 +441,7 @@ class Lead {
|
|
|
441
441
|
* @returns {Promise<LeadApplicationModel.GetTokenForVideoRoomResponse>} -
|
|
442
442
|
* Success response
|
|
443
443
|
* @name getTokenForVideoRoom
|
|
444
|
-
* @summary: Retrieves video room token
|
|
444
|
+
* @summary: Retrieves video room token
|
|
445
445
|
* @description: Retrieves a secure token for accessing a video chat room. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/getTokenForVideoRoom/).
|
|
446
446
|
*/
|
|
447
447
|
async getTokenForVideoRoom(
|
|
@@ -520,7 +520,7 @@ class Lead {
|
|
|
520
520
|
* @returns {Promise<LeadApplicationModel.SubmitCustomFormResponse>} -
|
|
521
521
|
* Success response
|
|
522
522
|
* @name submitCustomForm
|
|
523
|
-
* @summary: Submits form data
|
|
523
|
+
* @summary: Submits form data
|
|
524
524
|
* @description: Sends user-entered data from a custom form for processing. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/submitCustomForm/).
|
|
525
525
|
*/
|
|
526
526
|
async submitCustomForm(
|
|
@@ -41,26 +41,8 @@ export = LeadApplicationModel;
|
|
|
41
41
|
* @property {string} [_id]
|
|
42
42
|
* @property {string} [created_at]
|
|
43
43
|
* @property {string} [updated_at]
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
* @typedef PhoneNumber
|
|
47
|
-
* @property {boolean} [active] - Denotes if the phone number is active
|
|
48
|
-
* @property {boolean} [primary] - Denotes it's the primary phone number for the account
|
|
49
|
-
* @property {boolean} [verified] - Denotes it's a verified phone number
|
|
50
|
-
* @property {string} [phone] - Phone number
|
|
51
|
-
* @property {number} [country_code] - Country code
|
|
52
|
-
*/
|
|
53
|
-
/**
|
|
54
|
-
* @typedef Email
|
|
55
|
-
* @property {boolean} [primary] - Denotes it's the primary email for the account
|
|
56
|
-
* @property {boolean} [verified] - Denotes it's a verified email
|
|
57
|
-
* @property {string} [email] - Email Address
|
|
58
|
-
* @property {boolean} [active] - Denotes if the email is active
|
|
59
|
-
*/
|
|
60
|
-
/**
|
|
61
|
-
* @typedef Debug
|
|
62
|
-
* @property {string} [source] - Source of user
|
|
63
|
-
* @property {string} [platform] - Platform of user
|
|
44
|
+
* @property {string} [external_id]
|
|
45
|
+
* @property {string} [rr_id]
|
|
64
46
|
*/
|
|
65
47
|
/**
|
|
66
48
|
* @typedef SubmitCustomFormResponse
|
|
@@ -191,6 +173,21 @@ export = LeadApplicationModel;
|
|
|
191
173
|
* @property {string} [updated_at] - Time when the ticket was last updated
|
|
192
174
|
* @property {string} [created_at] - Time when the ticket was created
|
|
193
175
|
*/
|
|
176
|
+
/**
|
|
177
|
+
* @typedef PhoneNumber
|
|
178
|
+
* @property {string} [phone] - Phone number
|
|
179
|
+
* @property {number} [country_code] - Country code
|
|
180
|
+
* @property {boolean} [active] - Is the phone number active
|
|
181
|
+
* @property {boolean} [primary] - Is it a primary phone number
|
|
182
|
+
* @property {boolean} [verified] - Is the phone number verified
|
|
183
|
+
*/
|
|
184
|
+
/**
|
|
185
|
+
* @typedef Email
|
|
186
|
+
* @property {string} [email] - Email address
|
|
187
|
+
* @property {boolean} [active] - Is the email active
|
|
188
|
+
* @property {boolean} [primary] - Is it a primary email
|
|
189
|
+
* @property {boolean} [verified] - Is the email verified
|
|
190
|
+
*/
|
|
194
191
|
/** @typedef {"low" | "medium" | "high" | "urgent"} PriorityEnum */
|
|
195
192
|
/** @typedef {"rating" | "log" | "comment" | "thread"} HistoryTypeEnum */
|
|
196
193
|
/**
|
|
@@ -208,7 +205,7 @@ export = LeadApplicationModel;
|
|
|
208
205
|
declare class LeadApplicationModel {
|
|
209
206
|
}
|
|
210
207
|
declare namespace LeadApplicationModel {
|
|
211
|
-
export { TicketHistoryPayload, CustomFormSubmissionPayload, GetTokenForVideoRoomResponse, GetParticipantsInsideVideoRoomResponse, Participant, UserSchema,
|
|
208
|
+
export { TicketHistoryPayload, CustomFormSubmissionPayload, GetTokenForVideoRoomResponse, GetParticipantsInsideVideoRoomResponse, Participant, UserSchema, SubmitCustomFormResponse, TicketContext, CreatedOn, TicketAsset, TicketContent, AddTicketPayload, Priority, Status, SubmitButton, PollForAssignment, CustomForm, FeedbackForm, TicketCategory, TicketHistory, Ticket, PhoneNumber, Email, PriorityEnum, HistoryTypeEnum, TicketAssetTypeEnum, TicketSourceEnum };
|
|
212
209
|
}
|
|
213
210
|
/** @returns {TicketHistoryPayload} */
|
|
214
211
|
declare function TicketHistoryPayload(): TicketHistoryPayload;
|
|
@@ -279,62 +276,8 @@ type UserSchema = {
|
|
|
279
276
|
_id?: string;
|
|
280
277
|
created_at?: string;
|
|
281
278
|
updated_at?: string;
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
declare function PhoneNumber(): PhoneNumber;
|
|
285
|
-
type PhoneNumber = {
|
|
286
|
-
/**
|
|
287
|
-
* - Denotes if the phone number is active
|
|
288
|
-
*/
|
|
289
|
-
active?: boolean;
|
|
290
|
-
/**
|
|
291
|
-
* - Denotes it's the primary phone number for the account
|
|
292
|
-
*/
|
|
293
|
-
primary?: boolean;
|
|
294
|
-
/**
|
|
295
|
-
* - Denotes it's a verified phone number
|
|
296
|
-
*/
|
|
297
|
-
verified?: boolean;
|
|
298
|
-
/**
|
|
299
|
-
* - Phone number
|
|
300
|
-
*/
|
|
301
|
-
phone?: string;
|
|
302
|
-
/**
|
|
303
|
-
* - Country code
|
|
304
|
-
*/
|
|
305
|
-
country_code?: number;
|
|
306
|
-
};
|
|
307
|
-
/** @returns {Email} */
|
|
308
|
-
declare function Email(): Email;
|
|
309
|
-
type Email = {
|
|
310
|
-
/**
|
|
311
|
-
* - Denotes it's the primary email for the account
|
|
312
|
-
*/
|
|
313
|
-
primary?: boolean;
|
|
314
|
-
/**
|
|
315
|
-
* - Denotes it's a verified email
|
|
316
|
-
*/
|
|
317
|
-
verified?: boolean;
|
|
318
|
-
/**
|
|
319
|
-
* - Email Address
|
|
320
|
-
*/
|
|
321
|
-
email?: string;
|
|
322
|
-
/**
|
|
323
|
-
* - Denotes if the email is active
|
|
324
|
-
*/
|
|
325
|
-
active?: boolean;
|
|
326
|
-
};
|
|
327
|
-
/** @returns {Debug} */
|
|
328
|
-
declare function Debug(): Debug;
|
|
329
|
-
type Debug = {
|
|
330
|
-
/**
|
|
331
|
-
* - Source of user
|
|
332
|
-
*/
|
|
333
|
-
source?: string;
|
|
334
|
-
/**
|
|
335
|
-
* - Platform of user
|
|
336
|
-
*/
|
|
337
|
-
platform?: string;
|
|
279
|
+
external_id?: string;
|
|
280
|
+
rr_id?: string;
|
|
338
281
|
};
|
|
339
282
|
/** @returns {SubmitCustomFormResponse} */
|
|
340
283
|
declare function SubmitCustomFormResponse(): SubmitCustomFormResponse;
|
|
@@ -657,6 +600,50 @@ type Ticket = {
|
|
|
657
600
|
*/
|
|
658
601
|
created_at?: string;
|
|
659
602
|
};
|
|
603
|
+
/** @returns {PhoneNumber} */
|
|
604
|
+
declare function PhoneNumber(): PhoneNumber;
|
|
605
|
+
type PhoneNumber = {
|
|
606
|
+
/**
|
|
607
|
+
* - Phone number
|
|
608
|
+
*/
|
|
609
|
+
phone?: string;
|
|
610
|
+
/**
|
|
611
|
+
* - Country code
|
|
612
|
+
*/
|
|
613
|
+
country_code?: number;
|
|
614
|
+
/**
|
|
615
|
+
* - Is the phone number active
|
|
616
|
+
*/
|
|
617
|
+
active?: boolean;
|
|
618
|
+
/**
|
|
619
|
+
* - Is it a primary phone number
|
|
620
|
+
*/
|
|
621
|
+
primary?: boolean;
|
|
622
|
+
/**
|
|
623
|
+
* - Is the phone number verified
|
|
624
|
+
*/
|
|
625
|
+
verified?: boolean;
|
|
626
|
+
};
|
|
627
|
+
/** @returns {Email} */
|
|
628
|
+
declare function Email(): Email;
|
|
629
|
+
type Email = {
|
|
630
|
+
/**
|
|
631
|
+
* - Email address
|
|
632
|
+
*/
|
|
633
|
+
email?: string;
|
|
634
|
+
/**
|
|
635
|
+
* - Is the email active
|
|
636
|
+
*/
|
|
637
|
+
active?: boolean;
|
|
638
|
+
/**
|
|
639
|
+
* - Is it a primary email
|
|
640
|
+
*/
|
|
641
|
+
primary?: boolean;
|
|
642
|
+
/**
|
|
643
|
+
* - Is the email verified
|
|
644
|
+
*/
|
|
645
|
+
verified?: boolean;
|
|
646
|
+
};
|
|
660
647
|
/**
|
|
661
648
|
* Enum: PriorityEnum Used By: Lead
|
|
662
649
|
*
|
|
@@ -47,29 +47,8 @@ const Joi = require("joi");
|
|
|
47
47
|
* @property {string} [_id]
|
|
48
48
|
* @property {string} [created_at]
|
|
49
49
|
* @property {string} [updated_at]
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
/**
|
|
53
|
-
* @typedef PhoneNumber
|
|
54
|
-
* @property {boolean} [active] - Denotes if the phone number is active
|
|
55
|
-
* @property {boolean} [primary] - Denotes it's the primary phone number for the account
|
|
56
|
-
* @property {boolean} [verified] - Denotes it's a verified phone number
|
|
57
|
-
* @property {string} [phone] - Phone number
|
|
58
|
-
* @property {number} [country_code] - Country code
|
|
59
|
-
*/
|
|
60
|
-
|
|
61
|
-
/**
|
|
62
|
-
* @typedef Email
|
|
63
|
-
* @property {boolean} [primary] - Denotes it's the primary email for the account
|
|
64
|
-
* @property {boolean} [verified] - Denotes it's a verified email
|
|
65
|
-
* @property {string} [email] - Email Address
|
|
66
|
-
* @property {boolean} [active] - Denotes if the email is active
|
|
67
|
-
*/
|
|
68
|
-
|
|
69
|
-
/**
|
|
70
|
-
* @typedef Debug
|
|
71
|
-
* @property {string} [source] - Source of user
|
|
72
|
-
* @property {string} [platform] - Platform of user
|
|
50
|
+
* @property {string} [external_id]
|
|
51
|
+
* @property {string} [rr_id]
|
|
73
52
|
*/
|
|
74
53
|
|
|
75
54
|
/**
|
|
@@ -216,6 +195,23 @@ const Joi = require("joi");
|
|
|
216
195
|
* @property {string} [created_at] - Time when the ticket was created
|
|
217
196
|
*/
|
|
218
197
|
|
|
198
|
+
/**
|
|
199
|
+
* @typedef PhoneNumber
|
|
200
|
+
* @property {string} [phone] - Phone number
|
|
201
|
+
* @property {number} [country_code] - Country code
|
|
202
|
+
* @property {boolean} [active] - Is the phone number active
|
|
203
|
+
* @property {boolean} [primary] - Is it a primary phone number
|
|
204
|
+
* @property {boolean} [verified] - Is the phone number verified
|
|
205
|
+
*/
|
|
206
|
+
|
|
207
|
+
/**
|
|
208
|
+
* @typedef Email
|
|
209
|
+
* @property {string} [email] - Email address
|
|
210
|
+
* @property {boolean} [active] - Is the email active
|
|
211
|
+
* @property {boolean} [primary] - Is it a primary email
|
|
212
|
+
* @property {boolean} [verified] - Is the email verified
|
|
213
|
+
*/
|
|
214
|
+
|
|
219
215
|
/** @typedef {"low" | "medium" | "high" | "urgent"} PriorityEnum */
|
|
220
216
|
|
|
221
217
|
/** @typedef {"rating" | "log" | "comment" | "thread"} HistoryTypeEnum */
|
|
@@ -295,35 +291,8 @@ class LeadApplicationModel {
|
|
|
295
291
|
_id: Joi.string().allow(""),
|
|
296
292
|
created_at: Joi.string().allow(""),
|
|
297
293
|
updated_at: Joi.string().allow(""),
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
/** @returns {PhoneNumber} */
|
|
302
|
-
static PhoneNumber() {
|
|
303
|
-
return Joi.object({
|
|
304
|
-
active: Joi.boolean(),
|
|
305
|
-
primary: Joi.boolean(),
|
|
306
|
-
verified: Joi.boolean(),
|
|
307
|
-
phone: Joi.string().allow(""),
|
|
308
|
-
country_code: Joi.number(),
|
|
309
|
-
});
|
|
310
|
-
}
|
|
311
|
-
|
|
312
|
-
/** @returns {Email} */
|
|
313
|
-
static Email() {
|
|
314
|
-
return Joi.object({
|
|
315
|
-
primary: Joi.boolean(),
|
|
316
|
-
verified: Joi.boolean(),
|
|
317
|
-
email: Joi.string().allow(""),
|
|
318
|
-
active: Joi.boolean(),
|
|
319
|
-
});
|
|
320
|
-
}
|
|
321
|
-
|
|
322
|
-
/** @returns {Debug} */
|
|
323
|
-
static Debug() {
|
|
324
|
-
return Joi.object({
|
|
325
|
-
source: Joi.string().allow(""),
|
|
326
|
-
platform: Joi.string().allow(""),
|
|
294
|
+
external_id: Joi.string().allow(""),
|
|
295
|
+
rr_id: Joi.string().allow(""),
|
|
327
296
|
});
|
|
328
297
|
}
|
|
329
298
|
|
|
@@ -496,6 +465,27 @@ class LeadApplicationModel {
|
|
|
496
465
|
});
|
|
497
466
|
}
|
|
498
467
|
|
|
468
|
+
/** @returns {PhoneNumber} */
|
|
469
|
+
static PhoneNumber() {
|
|
470
|
+
return Joi.object({
|
|
471
|
+
phone: Joi.string().allow(""),
|
|
472
|
+
country_code: Joi.number(),
|
|
473
|
+
active: Joi.boolean(),
|
|
474
|
+
primary: Joi.boolean(),
|
|
475
|
+
verified: Joi.boolean(),
|
|
476
|
+
});
|
|
477
|
+
}
|
|
478
|
+
|
|
479
|
+
/** @returns {Email} */
|
|
480
|
+
static Email() {
|
|
481
|
+
return Joi.object({
|
|
482
|
+
email: Joi.string().allow(""),
|
|
483
|
+
active: Joi.boolean(),
|
|
484
|
+
primary: Joi.boolean(),
|
|
485
|
+
verified: Joi.boolean(),
|
|
486
|
+
});
|
|
487
|
+
}
|
|
488
|
+
|
|
499
489
|
/**
|
|
500
490
|
* Enum: PriorityEnum Used By: Lead
|
|
501
491
|
*
|
|
@@ -23,7 +23,7 @@ declare class Logistic {
|
|
|
23
23
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
24
24
|
* @returns {Promise<LogisticApplicationModel.CountryListResponse>} - Success response
|
|
25
25
|
* @name getAllCountries
|
|
26
|
-
* @summary: Lists all countries
|
|
26
|
+
* @summary: Lists all countries
|
|
27
27
|
* @description: Retrieve a list of all countries supported by the system. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getAllCountries/).
|
|
28
28
|
*/
|
|
29
29
|
getAllCountries({ requestHeaders }?: any, { responseHeaders }?: object): Promise<LogisticApplicationModel.CountryListResponse>;
|
|
@@ -33,7 +33,7 @@ declare class Logistic {
|
|
|
33
33
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
34
34
|
* @returns {Promise<LogisticApplicationModel.GetCountries>} - Success response
|
|
35
35
|
* @name getCountries
|
|
36
|
-
* @summary: Get all countries and associated data
|
|
36
|
+
* @summary: Get all countries and associated data
|
|
37
37
|
* @description: Retrieve of all countries. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getCountries/).
|
|
38
38
|
*/
|
|
39
39
|
getCountries({ onboarding, pageNo, pageSize, q, requestHeaders }?: LogisticApplicationValidator.GetCountriesParam, { responseHeaders }?: object): Promise<LogisticApplicationModel.GetCountries>;
|
|
@@ -43,7 +43,7 @@ declare class Logistic {
|
|
|
43
43
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
44
44
|
* @returns {Promise<LogisticApplicationModel.GetCountry>} - Success response
|
|
45
45
|
* @name getCountry
|
|
46
|
-
* @summary: Get single country and associated data
|
|
46
|
+
* @summary: Get single country and associated data
|
|
47
47
|
* @description: Retrieve data for a single country and address format. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getCountry/).
|
|
48
48
|
*/
|
|
49
49
|
getCountry({ countryIsoCode, requestHeaders }?: LogisticApplicationValidator.GetCountryParam, { responseHeaders }?: object): Promise<LogisticApplicationModel.GetCountry>;
|
|
@@ -53,7 +53,7 @@ declare class Logistic {
|
|
|
53
53
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
54
54
|
* @returns {Promise<LogisticApplicationModel.GetLocalities>} - Success response
|
|
55
55
|
* @name getLocalities
|
|
56
|
-
* @summary: Get Localities
|
|
56
|
+
* @summary: Get Localities
|
|
57
57
|
* @description: Get Localities data. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getLocalities/).
|
|
58
58
|
*/
|
|
59
59
|
getLocalities({ localityType, country, state, city, pageNo, pageSize, q, requestHeaders, }?: LogisticApplicationValidator.GetLocalitiesParam, { responseHeaders }?: object): Promise<LogisticApplicationModel.GetLocalities>;
|
|
@@ -73,7 +73,7 @@ declare class Logistic {
|
|
|
73
73
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
74
74
|
* @returns {Promise<LogisticApplicationModel.GetStoreResponse>} - Success response
|
|
75
75
|
* @name getLocations
|
|
76
|
-
* @summary: Fetches available locations
|
|
76
|
+
* @summary: Fetches available locations
|
|
77
77
|
* @description: Retrieves a list of all locations of countries, states, cities. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getLocations/).
|
|
78
78
|
*/
|
|
79
79
|
getLocations({ xApplicationId, xApplicationData, country, state, city, pincode, sector, pageNo, pageSize, requestHeaders, }?: LogisticApplicationValidator.GetLocationsParam, { responseHeaders }?: object): Promise<LogisticApplicationModel.GetStoreResponse>;
|
|
@@ -84,7 +84,7 @@ declare class Logistic {
|
|
|
84
84
|
* @returns {Promise<LogisticApplicationModel.ReAssignStoreResponse>} -
|
|
85
85
|
* Success response
|
|
86
86
|
* @name getOptimalLocations
|
|
87
|
-
* @summary: Finds optimal locations
|
|
87
|
+
* @summary: Finds optimal locations
|
|
88
88
|
* @description: Retrieve the most efficient locations for logistics purposes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getOptimalLocations/).
|
|
89
89
|
*/
|
|
90
90
|
getOptimalLocations({ body, requestHeaders }?: LogisticApplicationValidator.GetOptimalLocationsParam, { responseHeaders }?: object): Promise<LogisticApplicationModel.ReAssignStoreResponse>;
|
|
@@ -94,7 +94,7 @@ declare class Logistic {
|
|
|
94
94
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
95
95
|
* @returns {Promise<LogisticApplicationModel.PincodeApiResponse>} - Success response
|
|
96
96
|
* @name getPincodeCity
|
|
97
|
-
* @summary: Fetches city by pincode
|
|
97
|
+
* @summary: Fetches city by pincode
|
|
98
98
|
* @description: Retrieve the name of the city associated with a given pincode. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getPincodeCity/).
|
|
99
99
|
*/
|
|
100
100
|
getPincodeCity({ pincode, requestHeaders }?: LogisticApplicationValidator.GetPincodeCityParam, { responseHeaders }?: object): Promise<LogisticApplicationModel.PincodeApiResponse>;
|
|
@@ -106,7 +106,7 @@ declare class Logistic {
|
|
|
106
106
|
* - Success response
|
|
107
107
|
*
|
|
108
108
|
* @name getPincodeZones
|
|
109
|
-
* @summary: Fetches zones by pincode
|
|
109
|
+
* @summary: Fetches zones by pincode
|
|
110
110
|
* @description: Retreive the logistical zones corresponding to a given pincode. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getPincodeZones/).
|
|
111
111
|
*/
|
|
112
112
|
getPincodeZones({ body, requestHeaders }?: LogisticApplicationValidator.GetPincodeZonesParam, { responseHeaders }?: object): Promise<LogisticApplicationModel.GetZoneFromPincodeViewResponse>;
|
|
@@ -116,7 +116,7 @@ declare class Logistic {
|
|
|
116
116
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
117
117
|
* @returns {Promise<LogisticApplicationModel.TATViewResponse>} - Success response
|
|
118
118
|
* @name getTatProduct
|
|
119
|
-
* @summary: Retrieves product turnaround time
|
|
119
|
+
* @summary: Retrieves product turnaround time
|
|
120
120
|
* @description: Retrieve the estimated delivery time for a specific product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getTatProduct/).
|
|
121
121
|
*/
|
|
122
122
|
getTatProduct({ body, requestHeaders }?: LogisticApplicationValidator.GetTatProductParam, { responseHeaders }?: object): Promise<LogisticApplicationModel.TATViewResponse>;
|
|
@@ -53,7 +53,7 @@ class Logistic {
|
|
|
53
53
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
54
54
|
* @returns {Promise<LogisticApplicationModel.CountryListResponse>} - Success response
|
|
55
55
|
* @name getAllCountries
|
|
56
|
-
* @summary: Lists all countries
|
|
56
|
+
* @summary: Lists all countries
|
|
57
57
|
* @description: Retrieve a list of all countries supported by the system. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getAllCountries/).
|
|
58
58
|
*/
|
|
59
59
|
async getAllCountries(
|
|
@@ -131,7 +131,7 @@ class Logistic {
|
|
|
131
131
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
132
132
|
* @returns {Promise<LogisticApplicationModel.GetCountries>} - Success response
|
|
133
133
|
* @name getCountries
|
|
134
|
-
* @summary: Get all countries and associated data
|
|
134
|
+
* @summary: Get all countries and associated data
|
|
135
135
|
* @description: Retrieve of all countries. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getCountries/).
|
|
136
136
|
*/
|
|
137
137
|
async getCountries(
|
|
@@ -215,7 +215,7 @@ class Logistic {
|
|
|
215
215
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
216
216
|
* @returns {Promise<LogisticApplicationModel.GetCountry>} - Success response
|
|
217
217
|
* @name getCountry
|
|
218
|
-
* @summary: Get single country and associated data
|
|
218
|
+
* @summary: Get single country and associated data
|
|
219
219
|
* @description: Retrieve data for a single country and address format. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getCountry/).
|
|
220
220
|
*/
|
|
221
221
|
async getCountry(
|
|
@@ -293,7 +293,7 @@ class Logistic {
|
|
|
293
293
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
294
294
|
* @returns {Promise<LogisticApplicationModel.GetLocalities>} - Success response
|
|
295
295
|
* @name getLocalities
|
|
296
|
-
* @summary: Get Localities
|
|
296
|
+
* @summary: Get Localities
|
|
297
297
|
* @description: Get Localities data. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getLocalities/).
|
|
298
298
|
*/
|
|
299
299
|
async getLocalities(
|
|
@@ -469,7 +469,7 @@ class Logistic {
|
|
|
469
469
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
470
470
|
* @returns {Promise<LogisticApplicationModel.GetStoreResponse>} - Success response
|
|
471
471
|
* @name getLocations
|
|
472
|
-
* @summary: Fetches available locations
|
|
472
|
+
* @summary: Fetches available locations
|
|
473
473
|
* @description: Retrieves a list of all locations of countries, states, cities. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getLocations/).
|
|
474
474
|
*/
|
|
475
475
|
async getLocations(
|
|
@@ -588,7 +588,7 @@ class Logistic {
|
|
|
588
588
|
* @returns {Promise<LogisticApplicationModel.ReAssignStoreResponse>} -
|
|
589
589
|
* Success response
|
|
590
590
|
* @name getOptimalLocations
|
|
591
|
-
* @summary: Finds optimal locations
|
|
591
|
+
* @summary: Finds optimal locations
|
|
592
592
|
* @description: Retrieve the most efficient locations for logistics purposes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getOptimalLocations/).
|
|
593
593
|
*/
|
|
594
594
|
async getOptimalLocations(
|
|
@@ -668,7 +668,7 @@ class Logistic {
|
|
|
668
668
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
669
669
|
* @returns {Promise<LogisticApplicationModel.PincodeApiResponse>} - Success response
|
|
670
670
|
* @name getPincodeCity
|
|
671
|
-
* @summary: Fetches city by pincode
|
|
671
|
+
* @summary: Fetches city by pincode
|
|
672
672
|
* @description: Retrieve the name of the city associated with a given pincode. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getPincodeCity/).
|
|
673
673
|
*/
|
|
674
674
|
async getPincodeCity(
|
|
@@ -748,7 +748,7 @@ class Logistic {
|
|
|
748
748
|
* - Success response
|
|
749
749
|
*
|
|
750
750
|
* @name getPincodeZones
|
|
751
|
-
* @summary: Fetches zones by pincode
|
|
751
|
+
* @summary: Fetches zones by pincode
|
|
752
752
|
* @description: Retreive the logistical zones corresponding to a given pincode. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getPincodeZones/).
|
|
753
753
|
*/
|
|
754
754
|
async getPincodeZones(
|
|
@@ -826,7 +826,7 @@ class Logistic {
|
|
|
826
826
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
827
827
|
* @returns {Promise<LogisticApplicationModel.TATViewResponse>} - Success response
|
|
828
828
|
* @name getTatProduct
|
|
829
|
-
* @summary: Retrieves product turnaround time
|
|
829
|
+
* @summary: Retrieves product turnaround time
|
|
830
830
|
* @description: Retrieve the estimated delivery time for a specific product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getTatProduct/).
|
|
831
831
|
*/
|
|
832
832
|
async getTatProduct(
|
|
@@ -27,7 +27,7 @@ declare class Order {
|
|
|
27
27
|
* @returns {Promise<OrderApplicationModel.CustomerDetailsResponse>} -
|
|
28
28
|
* Success response
|
|
29
29
|
* @name getCustomerDetailsByShipmentId
|
|
30
|
-
* @summary: Retrieves shipment customer
|
|
30
|
+
* @summary: Retrieves shipment customer
|
|
31
31
|
* @description: Retrieve customer details such as mobile number using Shipment ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getCustomerDetailsByShipmentId/).
|
|
32
32
|
*/
|
|
33
33
|
getCustomerDetailsByShipmentId({ orderId, shipmentId, requestHeaders }?: OrderApplicationValidator.GetCustomerDetailsByShipmentIdParam, { responseHeaders }?: object): Promise<OrderApplicationModel.CustomerDetailsResponse>;
|
|
@@ -38,7 +38,7 @@ declare class Order {
|
|
|
38
38
|
* @returns {Promise<OrderApplicationModel.ResponseGetInvoiceShipment>} -
|
|
39
39
|
* Success response
|
|
40
40
|
* @name getInvoiceByShipmentId
|
|
41
|
-
* @summary: Retrieves invoice for shipment
|
|
41
|
+
* @summary: Retrieves invoice for shipment
|
|
42
42
|
* @description: Retrieve the invoice corresponding to a specific shipment ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getInvoiceByShipmentId/).
|
|
43
43
|
*/
|
|
44
44
|
getInvoiceByShipmentId({ shipmentId, requestHeaders }?: OrderApplicationValidator.GetInvoiceByShipmentIdParam, { responseHeaders }?: object): Promise<OrderApplicationModel.ResponseGetInvoiceShipment>;
|
|
@@ -48,7 +48,7 @@ declare class Order {
|
|
|
48
48
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
49
49
|
* @returns {Promise<OrderApplicationModel.OrderById>} - Success response
|
|
50
50
|
* @name getOrderById
|
|
51
|
-
* @summary: Fetches order by ID
|
|
51
|
+
* @summary: Fetches order by ID
|
|
52
52
|
* @description: Retrieve order details such as tracking details, shipment, store information using Fynd Order ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getOrderById/).
|
|
53
53
|
*/
|
|
54
54
|
getOrderById({ orderId, allowInactive, requestHeaders }?: OrderApplicationValidator.GetOrderByIdParam, { responseHeaders }?: object): Promise<OrderApplicationModel.OrderById>;
|
|
@@ -58,17 +58,17 @@ declare class Order {
|
|
|
58
58
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
59
59
|
* @returns {Promise<OrderApplicationModel.OrderList>} - Success response
|
|
60
60
|
* @name getOrders
|
|
61
|
-
* @summary: Lists customer orders
|
|
61
|
+
* @summary: Lists customer orders
|
|
62
62
|
* @description: Retrieves all orders associated with a customer account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getOrders/).
|
|
63
63
|
*/
|
|
64
|
-
getOrders({ status, pageNo, pageSize, fromDate, toDate, startDate, endDate, customMeta, requestHeaders, }?: OrderApplicationValidator.GetOrdersParam, { responseHeaders }?: object): Promise<OrderApplicationModel.OrderList>;
|
|
64
|
+
getOrders({ status, pageNo, pageSize, fromDate, toDate, startDate, endDate, customMeta, allowInactive, requestHeaders, }?: OrderApplicationValidator.GetOrdersParam, { responseHeaders }?: object): Promise<OrderApplicationModel.OrderList>;
|
|
65
65
|
/**
|
|
66
66
|
* @param {OrderApplicationValidator.GetPosOrderByIdParam} arg - Arg object.
|
|
67
67
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
68
68
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
69
69
|
* @returns {Promise<OrderApplicationModel.OrderById>} - Success response
|
|
70
70
|
* @name getPosOrderById
|
|
71
|
-
* @summary: Retrieves POS order details
|
|
71
|
+
* @summary: Retrieves POS order details
|
|
72
72
|
* @description: Retrieve a POS order and all its details such as tracking details, shipment, store information using Fynd Order ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getPosOrderById/).
|
|
73
73
|
*/
|
|
74
74
|
getPosOrderById({ orderId, requestHeaders }?: OrderApplicationValidator.GetPosOrderByIdParam, { responseHeaders }?: object): Promise<OrderApplicationModel.OrderById>;
|
|
@@ -78,7 +78,7 @@ declare class Order {
|
|
|
78
78
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
79
79
|
* @returns {Promise<OrderApplicationModel.ShipmentBagReasons>} - Success response
|
|
80
80
|
* @name getShipmentBagReasons
|
|
81
|
-
* @summary: Lists bag reasons
|
|
81
|
+
* @summary: Lists bag reasons
|
|
82
82
|
* @description: Retrieves reasons that led to the cancellation for the status of shipment bags. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getShipmentBagReasons/).
|
|
83
83
|
*/
|
|
84
84
|
getShipmentBagReasons({ shipmentId, bagId, requestHeaders }?: OrderApplicationValidator.GetShipmentBagReasonsParam, { responseHeaders }?: object): Promise<OrderApplicationModel.ShipmentBagReasons>;
|
|
@@ -88,7 +88,7 @@ declare class Order {
|
|
|
88
88
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
89
89
|
* @returns {Promise<OrderApplicationModel.ShipmentById>} - Success response
|
|
90
90
|
* @name getShipmentById
|
|
91
|
-
* @summary: Fetches shipment by ID
|
|
91
|
+
* @summary: Fetches shipment by ID
|
|
92
92
|
* @description: Retrieve shipment details such as price breakup, tracking details, store information, etc. using Shipment ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getShipmentById/).
|
|
93
93
|
*/
|
|
94
94
|
getShipmentById({ shipmentId, allowInactive, requestHeaders }?: OrderApplicationValidator.GetShipmentByIdParam, { responseHeaders }?: object): Promise<OrderApplicationModel.ShipmentById>;
|
|
@@ -98,7 +98,7 @@ declare class Order {
|
|
|
98
98
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
99
99
|
* @returns {Promise<OrderApplicationModel.ShipmentReasons>} - Success response
|
|
100
100
|
* @name getShipmentReasons
|
|
101
|
-
* @summary: Lists shipment reasons
|
|
101
|
+
* @summary: Lists shipment reasons
|
|
102
102
|
* @description: Retrieve reasons explaining various shipment statuses. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getShipmentReasons/).
|
|
103
103
|
*/
|
|
104
104
|
getShipmentReasons({ shipmentId, requestHeaders }?: OrderApplicationValidator.GetShipmentReasonsParam, { responseHeaders }?: object): Promise<OrderApplicationModel.ShipmentReasons>;
|
|
@@ -109,7 +109,7 @@ declare class Order {
|
|
|
109
109
|
* @returns {Promise<OrderApplicationModel.SendOtpToCustomerResponse>} -
|
|
110
110
|
* Success response
|
|
111
111
|
* @name sendOtpToShipmentCustomer
|
|
112
|
-
* @summary: Sends OTP to customer
|
|
112
|
+
* @summary: Sends OTP to customer
|
|
113
113
|
* @description: Sends a one-time password (OTP) to the customer for shipment verification. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/sendOtpToShipmentCustomer/).
|
|
114
114
|
*/
|
|
115
115
|
sendOtpToShipmentCustomer({ orderId, shipmentId, requestHeaders }?: OrderApplicationValidator.SendOtpToShipmentCustomerParam, { responseHeaders }?: object): Promise<OrderApplicationModel.SendOtpToCustomerResponse>;
|
|
@@ -119,7 +119,7 @@ declare class Order {
|
|
|
119
119
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
120
120
|
* @returns {Promise<OrderApplicationModel.ShipmentTrack>} - Success response
|
|
121
121
|
* @name trackShipment
|
|
122
|
-
* @summary: Tracks shipment status
|
|
122
|
+
* @summary: Tracks shipment status
|
|
123
123
|
* @description: Track Shipment by shipment id, for application based on application Id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/trackShipment/).
|
|
124
124
|
*/
|
|
125
125
|
trackShipment({ shipmentId, requestHeaders }?: OrderApplicationValidator.TrackShipmentParam, { responseHeaders }?: object): Promise<OrderApplicationModel.ShipmentTrack>;
|
|
@@ -131,7 +131,7 @@ declare class Order {
|
|
|
131
131
|
* - Success response
|
|
132
132
|
*
|
|
133
133
|
* @name updateShipmentStatus
|
|
134
|
-
* @summary: Updates shipment status
|
|
134
|
+
* @summary: Updates shipment status
|
|
135
135
|
* @description: Modifies the current status of a specific shipment using its shipment ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/updateShipmentStatus/).
|
|
136
136
|
*/
|
|
137
137
|
updateShipmentStatus({ shipmentId, body, requestHeaders }?: OrderApplicationValidator.UpdateShipmentStatusParam, { responseHeaders }?: object): Promise<OrderApplicationModel.ShipmentApplicationStatusResponse>;
|
|
@@ -141,7 +141,7 @@ declare class Order {
|
|
|
141
141
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
142
142
|
* @returns {Promise<OrderApplicationModel.VerifyOtpResponse>} - Success response
|
|
143
143
|
* @name verifyOtpShipmentCustomer
|
|
144
|
-
* @summary: Verifies OTP
|
|
144
|
+
* @summary: Verifies OTP
|
|
145
145
|
* @description: Confirms the OTP sent to the shipment customer for verification. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/verifyOtpShipmentCustomer/).
|
|
146
146
|
*/
|
|
147
147
|
verifyOtpShipmentCustomer({ orderId, shipmentId, body, requestHeaders }?: OrderApplicationValidator.VerifyOtpShipmentCustomerParam, { responseHeaders }?: object): Promise<OrderApplicationModel.VerifyOtpResponse>;
|