@gofynd/fdk-client-javascript 1.4.15-beta.2 → 1.4.15-beta.4
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 +2 -2
- package/application.d.ts +1 -2
- package/application.js +2 -3
- package/index.d.ts +1 -2
- package/index.js +7 -1
- package/package.json +2 -3
- package/sdk/application/ApplicationClient.js +0 -18
- package/sdk/application/Cart/CartApplicationClient.d.ts +55 -90
- package/sdk/application/Cart/CartApplicationClient.js +27 -1203
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +80 -142
- package/sdk/application/Catalog/CatalogApplicationClient.js +40 -1344
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -8
- package/sdk/application/Common/CommonApplicationClient.js +2 -92
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +6 -19
- package/sdk/application/Communication/CommunicationApplicationClient.js +3 -148
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +32 -73
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +16 -727
- package/sdk/application/Content/ContentApplicationClient.d.ts +46 -78
- package/sdk/application/Content/ContentApplicationClient.js +23 -941
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +6 -11
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +4 -134
- package/sdk/application/Lead/LeadApplicationClient.d.ts +10 -18
- package/sdk/application/Lead/LeadApplicationClient.js +5 -217
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +22 -39
- package/sdk/application/Logistic/LogisticApplicationClient.js +11 -496
- package/sdk/application/Order/OrderApplicationClient.d.ts +22 -42
- package/sdk/application/Order/OrderApplicationClient.js +11 -505
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +92 -212
- package/sdk/application/Payment/PaymentApplicationClient.js +46 -2106
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +14 -28
- package/sdk/application/Rewards/RewardsApplicationClient.js +7 -311
- package/sdk/application/Share/ShareApplicationClient.d.ts +14 -24
- package/sdk/application/Share/ShareApplicationClient.js +7 -309
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -14
- package/sdk/application/Theme/ThemeApplicationClient.js +4 -174
- package/sdk/application/User/UserApplicationClient.d.ts +85 -136
- package/sdk/application/User/UserApplicationClient.js +42 -1818
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +2 -5
- package/sdk/application/Webhook/WebhookApplicationClient.js +1 -50
- package/sdk/application/index.d.ts +0 -18
- package/sdk/application/index.js +0 -33
- package/sdk/partner/OAuthClient.js +1 -0
- package/sdk/platform/Cart/CartPlatformModel.d.ts +7 -0
- package/sdk/platform/Cart/CartPlatformModel.js +3 -0
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +0 -7
- package/sdk/platform/Catalog/CatalogPlatformModel.js +0 -3
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +7 -0
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +3 -0
- package/sdk/public/Configuration/ConfigurationPublicClient.js +4 -2
- package/sdk/public/Content/ContentPublicClient.js +4 -2
- package/sdk/public/Partner/PartnerPublicClient.js +4 -2
- package/sdk/public/Webhook/WebhookPublicClient.js +4 -2
- package/sdk/application/Cart/CartApplicationModel.d.ts +0 -3994
- package/sdk/application/Cart/CartApplicationModel.js +0 -2497
- package/sdk/application/Cart/CartApplicationValidator.d.ts +0 -769
- package/sdk/application/Cart/CartApplicationValidator.js +0 -530
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +0 -3857
- package/sdk/application/Catalog/CatalogApplicationModel.js +0 -2629
- package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +0 -791
- package/sdk/application/Catalog/CatalogApplicationValidator.js +0 -551
- package/sdk/application/Common/CommonApplicationModel.d.ts +0 -449
- package/sdk/application/Common/CommonApplicationModel.js +0 -308
- package/sdk/application/Common/CommonApplicationValidator.d.ts +0 -46
- package/sdk/application/Common/CommonApplicationValidator.js +0 -38
- package/sdk/application/Communication/CommunicationApplicationModel.d.ts +0 -293
- package/sdk/application/Communication/CommunicationApplicationModel.js +0 -201
- package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +0 -29
- package/sdk/application/Communication/CommunicationApplicationValidator.js +0 -38
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +0 -2556
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +0 -1887
- package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +0 -179
- package/sdk/application/Configuration/ConfigurationApplicationValidator.js +0 -176
- package/sdk/application/Content/ContentApplicationModel.d.ts +0 -2133
- package/sdk/application/Content/ContentApplicationModel.js +0 -1589
- package/sdk/application/Content/ContentApplicationValidator.d.ts +0 -284
- package/sdk/application/Content/ContentApplicationValidator.js +0 -264
- package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +0 -272
- package/sdk/application/FileStorage/FileStorageApplicationModel.js +0 -190
- package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +0 -56
- package/sdk/application/FileStorage/FileStorageApplicationValidator.js +0 -53
- package/sdk/application/Lead/LeadApplicationModel.d.ts +0 -590
- package/sdk/application/Lead/LeadApplicationModel.js +0 -480
- package/sdk/application/Lead/LeadApplicationValidator.d.ts +0 -68
- package/sdk/application/Lead/LeadApplicationValidator.js +0 -71
- package/sdk/application/Logistic/LogisticApplicationModel.d.ts +0 -1675
- package/sdk/application/Logistic/LogisticApplicationModel.js +0 -1121
- package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +0 -254
- package/sdk/application/Logistic/LogisticApplicationValidator.js +0 -190
- package/sdk/application/Order/OrderApplicationModel.d.ts +0 -2296
- package/sdk/application/Order/OrderApplicationModel.js +0 -1471
- package/sdk/application/Order/OrderApplicationValidator.d.ts +0 -265
- package/sdk/application/Order/OrderApplicationValidator.js +0 -197
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +0 -4058
- package/sdk/application/Payment/PaymentApplicationModel.js +0 -2630
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +0 -576
- package/sdk/application/Payment/PaymentApplicationValidator.js +0 -594
- package/sdk/application/Rewards/RewardsApplicationModel.d.ts +0 -365
- package/sdk/application/Rewards/RewardsApplicationModel.js +0 -396
- package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +0 -73
- package/sdk/application/Rewards/RewardsApplicationValidator.js +0 -84
- package/sdk/application/Share/ShareApplicationModel.d.ts +0 -339
- package/sdk/application/Share/ShareApplicationModel.js +0 -234
- package/sdk/application/Share/ShareApplicationValidator.d.ts +0 -90
- package/sdk/application/Share/ShareApplicationValidator.js +0 -91
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +0 -1713
- package/sdk/application/Theme/ThemeApplicationModel.js +0 -1426
- package/sdk/application/Theme/ThemeApplicationValidator.d.ts +0 -66
- package/sdk/application/Theme/ThemeApplicationValidator.js +0 -58
- package/sdk/application/User/UserApplicationModel.d.ts +0 -1943
- package/sdk/application/User/UserApplicationModel.js +0 -1382
- package/sdk/application/User/UserApplicationValidator.d.ts +0 -560
- package/sdk/application/User/UserApplicationValidator.js +0 -573
- package/sdk/application/Webhook/WebhookApplicationModel.d.ts +0 -52
- package/sdk/application/Webhook/WebhookApplicationModel.js +0 -46
- package/sdk/application/Webhook/WebhookApplicationValidator.d.ts +0 -16
- package/sdk/application/Webhook/WebhookApplicationValidator.js +0 -19
- package/sdk/common/Clickstream.d.ts +0 -1
- package/sdk/common/Clickstream.js +0 -464
|
@@ -1,1887 +0,0 @@
|
|
|
1
|
-
const Joi = require("joi");
|
|
2
|
-
|
|
3
|
-
/**
|
|
4
|
-
* @typedef ApplicationAboutResponse
|
|
5
|
-
* @property {ApplicationInfo} [application_info]
|
|
6
|
-
*/
|
|
7
|
-
|
|
8
|
-
/**
|
|
9
|
-
* @typedef ApplicationInfo
|
|
10
|
-
* @property {CompanyInfo} [company_info]
|
|
11
|
-
* @property {OwnerInfo} [owner_info]
|
|
12
|
-
* @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
|
|
13
|
-
* of application information.
|
|
14
|
-
* @property {Domain} [domain]
|
|
15
|
-
* @property {ApplicationWebsite} [website]
|
|
16
|
-
* @property {ApplicationCors} [cors]
|
|
17
|
-
* @property {string} [description] - It contains details information about the
|
|
18
|
-
* sales channel.
|
|
19
|
-
* @property {string} [name] - Name of the sales channel, e.g. Zenz Fashion.
|
|
20
|
-
* @property {ApplicationMeta[]} [meta] - Metadata related to the application.
|
|
21
|
-
* @property {string} [token] - Random generated fix length string for sales
|
|
22
|
-
* channel. It is required and auto-generated.
|
|
23
|
-
* @property {string} [secret] - Random generated fix length string for sales
|
|
24
|
-
* channel. It is required and auto-generated.
|
|
25
|
-
* @property {string} [created_at] - ISO 8601 timestamp of sales channel
|
|
26
|
-
* information creation.
|
|
27
|
-
* @property {SecureUrl} [banner]
|
|
28
|
-
* @property {SecureUrl} [logo]
|
|
29
|
-
* @property {boolean} [is_active] - Indicates whether sales channel is active
|
|
30
|
-
* or not active.
|
|
31
|
-
* @property {string} [mode] - Mode of the application.
|
|
32
|
-
* @property {TokenSchema[]} [tokens] - List of tokens associated with the application.
|
|
33
|
-
* @property {Domain[]} [domains] - List of domains associated with the application.
|
|
34
|
-
* @property {SecureUrl} [favicon]
|
|
35
|
-
* @property {SecureUrl} [mobile_logo]
|
|
36
|
-
* @property {string} [slug] - Slug identifier for the application.
|
|
37
|
-
*/
|
|
38
|
-
|
|
39
|
-
/**
|
|
40
|
-
* @typedef CompanyInfo
|
|
41
|
-
* @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
|
|
42
|
-
* of company information.
|
|
43
|
-
* @property {number} [uid] - Unique identifier for the company.
|
|
44
|
-
* @property {string} [created_on] - ISO 8601 timestamp of company information creation.
|
|
45
|
-
* @property {boolean} [is_active] - Indicates company is active or not active.
|
|
46
|
-
* @property {string} [name] - Name of the company, Reliance Retail Limited.
|
|
47
|
-
* @property {CompanyAboutAddress[]} [addresses] - List of addresses associated
|
|
48
|
-
* with the company.
|
|
49
|
-
* @property {string[]} [notification_emails] - List of emails to notify.
|
|
50
|
-
*/
|
|
51
|
-
|
|
52
|
-
/**
|
|
53
|
-
* @typedef OwnerInfo
|
|
54
|
-
* @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
|
|
55
|
-
* of owner info.
|
|
56
|
-
* @property {UserEmail[]} [emails] - List of email addresses of the owner.
|
|
57
|
-
* @property {UserPhoneNumber[]} [phone_numbers] - List of phone numbers of the owner.
|
|
58
|
-
* @property {string} [first_name] - First name of the owner.
|
|
59
|
-
* @property {string} [last_name] - Last name of the owner.
|
|
60
|
-
* @property {string} [profile_pic] - Hosted URL of profile pic.
|
|
61
|
-
*/
|
|
62
|
-
|
|
63
|
-
/**
|
|
64
|
-
* @typedef SupportedLanguage
|
|
65
|
-
* @property {string} [name] - Name of the supported language, e.g. हिन्दी.
|
|
66
|
-
* @property {string} [code] - Unique code of supported language, e.g. hi-IN.
|
|
67
|
-
*/
|
|
68
|
-
|
|
69
|
-
/**
|
|
70
|
-
* @typedef LanguageResponse
|
|
71
|
-
* @property {SupportedLanguage[]} [items] - List of supported languages.
|
|
72
|
-
*/
|
|
73
|
-
|
|
74
|
-
/**
|
|
75
|
-
* @typedef AppStaffResponse
|
|
76
|
-
* @property {AppStaff[]} [staff_users] - List of staff users.
|
|
77
|
-
*/
|
|
78
|
-
|
|
79
|
-
/**
|
|
80
|
-
* @typedef AppStaffListResponse
|
|
81
|
-
* @property {Page} [page]
|
|
82
|
-
* @property {AppStaff[]} [items] - List of staff users.
|
|
83
|
-
*/
|
|
84
|
-
|
|
85
|
-
/**
|
|
86
|
-
* @typedef OrderingStoreSelectRequest
|
|
87
|
-
* @property {OrderingStoreSelect} ordering_store
|
|
88
|
-
*/
|
|
89
|
-
|
|
90
|
-
/**
|
|
91
|
-
* @typedef OrderingStoreSelect
|
|
92
|
-
* @property {number} uid - Ordering store unique uid. It is required.
|
|
93
|
-
*/
|
|
94
|
-
|
|
95
|
-
/**
|
|
96
|
-
* @typedef AppStaff
|
|
97
|
-
* @property {string} [_id] - The unique identifier for the sales channel staff member.
|
|
98
|
-
* @property {boolean} [order_incent] - This is a boolean value. `true` to
|
|
99
|
-
* retrieve the staff members eligible for getting incentives on orders.
|
|
100
|
-
* @property {number[]} [stores] - List of IDs of the ordering stores where the
|
|
101
|
-
* staff member works.
|
|
102
|
-
* @property {string} [application] - The unique identifier (24-digit Mongo
|
|
103
|
-
* Object ID) of the current sales channel.
|
|
104
|
-
* @property {string} [title] - Title for the staff member like owner, staff.
|
|
105
|
-
* @property {string} [user] - Mongo ID of the staff. Helps in retrieving the
|
|
106
|
-
* details of a particular staff member.
|
|
107
|
-
* @property {string} [employee_code] - Employee code of sales channel staff
|
|
108
|
-
* member. It has unique value.
|
|
109
|
-
* @property {string} [first_name] - First name the staff member.
|
|
110
|
-
* @property {string} [last_name] - Last name the staff member.
|
|
111
|
-
* @property {string} [profile_pic_url] - Profile image hosted url of the staff member.
|
|
112
|
-
*/
|
|
113
|
-
|
|
114
|
-
/**
|
|
115
|
-
* @typedef AppTokenResponse
|
|
116
|
-
* @property {Tokens} [tokens]
|
|
117
|
-
* @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
|
|
118
|
-
* of the token.
|
|
119
|
-
* @property {string} [application] - Alphanumeric ID allotted to the current
|
|
120
|
-
* application created within the current business account.
|
|
121
|
-
* @property {string} [created_at] - ISO 8601 timestamp of token creation.
|
|
122
|
-
* @property {string} [modified_at] - ISO 8601 timestamp of token updation.
|
|
123
|
-
* @property {number} [__v] - Version key for tracking revisions. Default value is zero.
|
|
124
|
-
*/
|
|
125
|
-
|
|
126
|
-
/**
|
|
127
|
-
* @typedef Tokens
|
|
128
|
-
* @property {Firebase} [firebase]
|
|
129
|
-
* @property {Moengage} [moengage]
|
|
130
|
-
* @property {Segment} [segment]
|
|
131
|
-
* @property {Gtm} [gtm]
|
|
132
|
-
* @property {Freshchat} [freshchat]
|
|
133
|
-
* @property {Safetynet} [safetynet]
|
|
134
|
-
* @property {FyndRewards} [fynd_rewards]
|
|
135
|
-
* @property {GoogleMap} [google_map]
|
|
136
|
-
*/
|
|
137
|
-
|
|
138
|
-
/**
|
|
139
|
-
* @typedef Firebase
|
|
140
|
-
* @property {Credentials} [credentials]
|
|
141
|
-
* @property {boolean} [enabled] - Shows whether Firebase integration is enabled
|
|
142
|
-
* or disabled for the sales channel.
|
|
143
|
-
*/
|
|
144
|
-
|
|
145
|
-
/**
|
|
146
|
-
* @typedef Credentials
|
|
147
|
-
* @property {Ios} [ios]
|
|
148
|
-
* @property {Android} [android]
|
|
149
|
-
* @property {string} [project_id] - Project ID for Firebase integration.
|
|
150
|
-
* Project ID is a unique identifier for a project and is used only within the console.
|
|
151
|
-
* @property {string} [gcm_sender_id] - Google Cloud Manager's Sender ID for
|
|
152
|
-
* Firebase. It is a unique numerical value which is created when you
|
|
153
|
-
* configure your project in the Google Developers Console/Google Cloud Console.
|
|
154
|
-
* @property {string} [application_id] - Alphanumeric ID allotted to the current
|
|
155
|
-
* application created within the current business account.
|
|
156
|
-
* @property {string} [api_key] - An API key is a unique string that's used to
|
|
157
|
-
* route requests to your Firebase project when interacting with Firebase.
|
|
158
|
-
*/
|
|
159
|
-
|
|
160
|
-
/**
|
|
161
|
-
* @typedef Ios
|
|
162
|
-
* @property {string} [application_id] - Alphanumeric ID allotted to a sales
|
|
163
|
-
* channel application created within a business account.
|
|
164
|
-
* @property {string} [api_key] - Firebase secret credential API key for IOS.
|
|
165
|
-
*/
|
|
166
|
-
|
|
167
|
-
/**
|
|
168
|
-
* @typedef Android
|
|
169
|
-
* @property {string} [application_id] - Alphanumeric ID allotted to a sales
|
|
170
|
-
* channel application created within a business account.
|
|
171
|
-
* @property {string} [api_key] - Firebase secret credential API key for Android.
|
|
172
|
-
*/
|
|
173
|
-
|
|
174
|
-
/**
|
|
175
|
-
* @typedef Moengage
|
|
176
|
-
* @property {MoengageCredentials} [credentials]
|
|
177
|
-
* @property {boolean} [enabled] - Shows whether MoEngage integration is enabled
|
|
178
|
-
* or disabled for the sales channel.
|
|
179
|
-
*/
|
|
180
|
-
|
|
181
|
-
/**
|
|
182
|
-
* @typedef MoengageCredentials
|
|
183
|
-
* @property {string} [app_id] - APP ID provided by MoEngage to identify a
|
|
184
|
-
* specific app. The app_id for your MoEngage account is available on the
|
|
185
|
-
* MoEngage Dashboard.
|
|
186
|
-
*/
|
|
187
|
-
|
|
188
|
-
/**
|
|
189
|
-
* @typedef Segment
|
|
190
|
-
* @property {SegmentCredentials} [credentials]
|
|
191
|
-
* @property {boolean} [enabled] - Shows whether Segment integration is enabled
|
|
192
|
-
* or disabled for the sales channel.
|
|
193
|
-
*/
|
|
194
|
-
|
|
195
|
-
/**
|
|
196
|
-
* @typedef SegmentCredentials
|
|
197
|
-
* @property {string} [write_key] - The unique identifier for a source that
|
|
198
|
-
* tells Segment from which source data is coming from, to which workspace the
|
|
199
|
-
* data belongs, and which destinations should receive the data.
|
|
200
|
-
*/
|
|
201
|
-
|
|
202
|
-
/**
|
|
203
|
-
* @typedef Gtm
|
|
204
|
-
* @property {GtmCredentials} [credentials]
|
|
205
|
-
* @property {boolean} [enabled] - Shows whether GTM integration is enabled or
|
|
206
|
-
* disabled for the sales channel.
|
|
207
|
-
*/
|
|
208
|
-
|
|
209
|
-
/**
|
|
210
|
-
* @typedef GtmCredentials
|
|
211
|
-
* @property {string} [api_key] - Secret credential API key for GTM.
|
|
212
|
-
*/
|
|
213
|
-
|
|
214
|
-
/**
|
|
215
|
-
* @typedef Freshchat
|
|
216
|
-
* @property {FreshchatCredentials} [credentials]
|
|
217
|
-
* @property {boolean} [enabled] - Shows whether Freshchat integration is
|
|
218
|
-
* enabled or disabled for the sales channel.
|
|
219
|
-
*/
|
|
220
|
-
|
|
221
|
-
/**
|
|
222
|
-
* @typedef FreshchatCredentials
|
|
223
|
-
* @property {string} [app_id] - The unique app_id of your Freshchat account for
|
|
224
|
-
* integrating Freshchat with your sales channel.
|
|
225
|
-
* @property {string} [app_key] - The unique app_key of your Freshchat account
|
|
226
|
-
* for integrating Freshchat with your sales channel.
|
|
227
|
-
* @property {string} [web_token] - Web token used for accessing the Freshchat APIs.
|
|
228
|
-
*/
|
|
229
|
-
|
|
230
|
-
/**
|
|
231
|
-
* @typedef Safetynet
|
|
232
|
-
* @property {SafetynetCredentials} [credentials]
|
|
233
|
-
* @property {boolean} [enabled] - Shows whether Safetynet integration is
|
|
234
|
-
* enabled or disabled for the sales channel.
|
|
235
|
-
*/
|
|
236
|
-
|
|
237
|
-
/**
|
|
238
|
-
* @typedef SafetynetCredentials
|
|
239
|
-
* @property {string} [api_key] - Secret credential API key for Safetynet. This
|
|
240
|
-
* API key is used for calling the methods of Safetynet APIs.
|
|
241
|
-
*/
|
|
242
|
-
|
|
243
|
-
/**
|
|
244
|
-
* @typedef FyndRewards
|
|
245
|
-
* @property {FyndRewardsCredentials} [credentials]
|
|
246
|
-
*/
|
|
247
|
-
|
|
248
|
-
/**
|
|
249
|
-
* @typedef FyndRewardsCredentials
|
|
250
|
-
* @property {string} [public_key] - Public key for integrating with Fynd rewards.
|
|
251
|
-
*/
|
|
252
|
-
|
|
253
|
-
/**
|
|
254
|
-
* @typedef GoogleMap
|
|
255
|
-
* @property {boolean} [enabled] - Shows whether Google map integration is enabled or not.
|
|
256
|
-
* @property {GoogleMapCredentials} [credentials]
|
|
257
|
-
*/
|
|
258
|
-
|
|
259
|
-
/**
|
|
260
|
-
* @typedef GoogleMapCredentials
|
|
261
|
-
* @property {string} [api_key] - Secret API key for Google Maps. A unique
|
|
262
|
-
* identifier that authenticates requests made to Google Maps API.
|
|
263
|
-
*/
|
|
264
|
-
|
|
265
|
-
/**
|
|
266
|
-
* @typedef RewardPointsConfig
|
|
267
|
-
* @property {Credit} [credit]
|
|
268
|
-
* @property {Debit} [debit]
|
|
269
|
-
*/
|
|
270
|
-
|
|
271
|
-
/**
|
|
272
|
-
* @typedef Credit
|
|
273
|
-
* @property {boolean} [enabled] - Shows whether reward points should be credited.
|
|
274
|
-
*/
|
|
275
|
-
|
|
276
|
-
/**
|
|
277
|
-
* @typedef Debit
|
|
278
|
-
* @property {boolean} [enabled] - Shows whether reward points are available for debit.
|
|
279
|
-
* @property {boolean} [auto_apply] - Allow automatic debit of reward points.
|
|
280
|
-
* @property {string} [strategy_channel] - Strategy channel for debiting reward points.
|
|
281
|
-
*/
|
|
282
|
-
|
|
283
|
-
/**
|
|
284
|
-
* @typedef ProductDetailFeature
|
|
285
|
-
* @property {string[]} [similar] - Configuration to show similar products,
|
|
286
|
-
* other products from same seller, other products in same category, other
|
|
287
|
-
* products in same price range, etc.
|
|
288
|
-
* @property {boolean} [seller_selection] - Shows whether the customers can
|
|
289
|
-
* choose the seller on PDP.
|
|
290
|
-
* @property {boolean} [update_product_meta] - Allow user to update product
|
|
291
|
-
* meta. Default value is true.
|
|
292
|
-
* @property {boolean} [request_product] - Indicates whether customers can
|
|
293
|
-
* request for a product. Default value is false.
|
|
294
|
-
*/
|
|
295
|
-
|
|
296
|
-
/**
|
|
297
|
-
* @typedef LaunchPage
|
|
298
|
-
* @property {string} [page_type] - Type of the launch page.
|
|
299
|
-
* @property {Object} [params] - Launch page params. It can be nullable.
|
|
300
|
-
* @property {Object} [query] - Query related to launch page. It can be nullable.
|
|
301
|
-
*/
|
|
302
|
-
|
|
303
|
-
/**
|
|
304
|
-
* @typedef LandingPageFeature
|
|
305
|
-
* @property {LaunchPage} [launch_page]
|
|
306
|
-
* @property {boolean} [continue_as_guest] - Shows whether a guest can checkout
|
|
307
|
-
* from cart without logging in.
|
|
308
|
-
* @property {string} [login_btn_text] - Shows the text displayed over the login button.
|
|
309
|
-
* @property {boolean} [show_domain_textbox] - Shows whether a textbox for
|
|
310
|
-
* entering domain is available.
|
|
311
|
-
* @property {boolean} [show_register_btn] - Shows whether register button is
|
|
312
|
-
* available in the login/landing page.
|
|
313
|
-
*/
|
|
314
|
-
|
|
315
|
-
/**
|
|
316
|
-
* @typedef RegistrationPageFeature
|
|
317
|
-
* @property {boolean} [ask_store_address] - Shows whether a form to collect the
|
|
318
|
-
* address of the store, should be displayed upon visiting the website.
|
|
319
|
-
*/
|
|
320
|
-
|
|
321
|
-
/**
|
|
322
|
-
* @typedef AppFeature
|
|
323
|
-
* @property {ProductDetailFeature} [product_detail]
|
|
324
|
-
* @property {LandingPageFeature} [landing_page]
|
|
325
|
-
* @property {RegistrationPageFeature} [registration_page]
|
|
326
|
-
* @property {HomePageFeature} [home_page]
|
|
327
|
-
* @property {CommonFeature} [common]
|
|
328
|
-
* @property {CartFeature} [cart]
|
|
329
|
-
* @property {QrFeature} [qr]
|
|
330
|
-
* @property {PcrFeature} [pcr]
|
|
331
|
-
* @property {OrderFeature} [order]
|
|
332
|
-
* @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
|
|
333
|
-
* for the sales channel features.
|
|
334
|
-
* @property {string} [app] - Application ID of the sales channel.
|
|
335
|
-
* @property {string} [created_at] - ISO 8601 timestamp showing the date when
|
|
336
|
-
* the features were configured.
|
|
337
|
-
* @property {string} [modified_at] - ISO 8601 timestamp of last known
|
|
338
|
-
* modifications to the sales channel feature configuration.
|
|
339
|
-
* @property {number} [__v] - Version key for tracking revisions. Default value is zero.
|
|
340
|
-
*/
|
|
341
|
-
|
|
342
|
-
/**
|
|
343
|
-
* @typedef HomePageFeature
|
|
344
|
-
* @property {boolean} [order_processing] - Shows whether order processing is
|
|
345
|
-
* enabled or not enabled.
|
|
346
|
-
*/
|
|
347
|
-
|
|
348
|
-
/**
|
|
349
|
-
* @typedef CommonFeature
|
|
350
|
-
* @property {CommunicationOptinDialogFeature} [communication_optin_dialog]
|
|
351
|
-
* @property {DeploymentStoreSelectionFeature} [deployment_store_selection]
|
|
352
|
-
* @property {ListingPriceFeature} [listing_price]
|
|
353
|
-
* @property {CurrencyFeature} [currency]
|
|
354
|
-
* @property {RevenueEngineFeature} [revenue_engine]
|
|
355
|
-
* @property {FeedbackFeature} [feedback]
|
|
356
|
-
* @property {CompareProductsFeature} [compare_products]
|
|
357
|
-
* @property {RewardPointsConfig} [reward_points]
|
|
358
|
-
* @property {ListingPageFeature} [listing_page]
|
|
359
|
-
* @property {InternationalShipping} [international_shipping]
|
|
360
|
-
*/
|
|
361
|
-
|
|
362
|
-
/**
|
|
363
|
-
* @typedef InternationalShipping
|
|
364
|
-
* @property {boolean} [enabled] - International shipping is enabled or not.
|
|
365
|
-
*/
|
|
366
|
-
|
|
367
|
-
/**
|
|
368
|
-
* @typedef CommunicationOptinDialogFeature
|
|
369
|
-
* @property {boolean} [visibility] - Shows whether WhatsApp communication is enabled.
|
|
370
|
-
*/
|
|
371
|
-
|
|
372
|
-
/**
|
|
373
|
-
* @typedef DeploymentStoreSelectionFeature
|
|
374
|
-
* @property {boolean} [enabled] - Shows whether selection of store (for
|
|
375
|
-
* deploying the application) is permitted.
|
|
376
|
-
* @property {string} [type] - Permitted values are 'hard' and 'soft'. For hard
|
|
377
|
-
* type delivery, store selection is compulsory. For soft type, delivery store
|
|
378
|
-
* selection is optional.
|
|
379
|
-
*/
|
|
380
|
-
|
|
381
|
-
/**
|
|
382
|
-
* @typedef ListingPriceFeature
|
|
383
|
-
* @property {string} [value] - Shows which price to display on PLP if one
|
|
384
|
-
* product has multiple prices (for each size), valid values are 'min', 'max',
|
|
385
|
-
* 'range'. Default value is range.
|
|
386
|
-
* @property {string} [sort] - Sorting of listing price with min or max value.
|
|
387
|
-
* Default value is min.
|
|
388
|
-
*/
|
|
389
|
-
|
|
390
|
-
/**
|
|
391
|
-
* @typedef ListingPageFeature
|
|
392
|
-
* @property {string} [sort_on] - Determines the sorting criteria for product
|
|
393
|
-
* listings on the page.
|
|
394
|
-
*/
|
|
395
|
-
|
|
396
|
-
/**
|
|
397
|
-
* @typedef CurrencyFeature
|
|
398
|
-
* @property {string[]} [value] - 3-letter currency code.
|
|
399
|
-
* @property {string} [type] - If 'explicit', currency formatting shows currency
|
|
400
|
-
* code with price. For explicit or all currency selection.
|
|
401
|
-
* @property {string} [default_currency] - 3-letter code of the default currency
|
|
402
|
-
* used in the application. Default value is 'INR'.
|
|
403
|
-
*/
|
|
404
|
-
|
|
405
|
-
/**
|
|
406
|
-
* @typedef RevenueEngineFeature
|
|
407
|
-
* @property {boolean} [enabled] - Enable revenue engine. Default value is false.
|
|
408
|
-
*/
|
|
409
|
-
|
|
410
|
-
/**
|
|
411
|
-
* @typedef FeedbackFeature
|
|
412
|
-
* @property {boolean} [enabled] - Whether customer feedback is enabled on PDP.
|
|
413
|
-
* Default value is false.
|
|
414
|
-
*/
|
|
415
|
-
|
|
416
|
-
/**
|
|
417
|
-
* @typedef CompareProductsFeature
|
|
418
|
-
* @property {boolean} [enabled] - Whether product comparison feature is enabled on PDP.
|
|
419
|
-
*/
|
|
420
|
-
|
|
421
|
-
/**
|
|
422
|
-
* @typedef CartFeature
|
|
423
|
-
* @property {boolean} [gst_input] - Whether customer is allowed to enter GST on
|
|
424
|
-
* the cart page for claiming input credits.
|
|
425
|
-
* @property {boolean} [staff_selection] - Whether staff selection is enabled on
|
|
426
|
-
* cart page.
|
|
427
|
-
* @property {boolean} [placing_for_customer] - Whether the staff is placing
|
|
428
|
-
* order on behalf of customer. Default value is true.
|
|
429
|
-
* @property {boolean} [google_map] - Allow adding of Google Maps. Default value is true.
|
|
430
|
-
* @property {boolean} [revenue_engine_coupon] - Allow coupon apply and credits,
|
|
431
|
-
* together. Default value is false.
|
|
432
|
-
*/
|
|
433
|
-
|
|
434
|
-
/**
|
|
435
|
-
* @typedef QrFeature
|
|
436
|
-
* @property {boolean} [application] - Whether sharing of mobile app via QR code
|
|
437
|
-
* is allowed. Default value is false.
|
|
438
|
-
* @property {boolean} [products] - Whether sharing product via QR code is
|
|
439
|
-
* allowed. Default value is false.
|
|
440
|
-
* @property {boolean} [collections] - Whether sharing collection via QR code is
|
|
441
|
-
* allowed. Default value is false.
|
|
442
|
-
*/
|
|
443
|
-
|
|
444
|
-
/**
|
|
445
|
-
* @typedef PcrFeature
|
|
446
|
-
* @property {boolean} [staff_selection] - Allow staff selection. Default value is false.
|
|
447
|
-
*/
|
|
448
|
-
|
|
449
|
-
/**
|
|
450
|
-
* @typedef OrderFeature
|
|
451
|
-
* @property {boolean} [buy_again] - Allow buy again option for order. Default
|
|
452
|
-
* value is false.
|
|
453
|
-
*/
|
|
454
|
-
|
|
455
|
-
/**
|
|
456
|
-
* @typedef AppFeatureResponse
|
|
457
|
-
* @property {AppFeature} [feature]
|
|
458
|
-
*/
|
|
459
|
-
|
|
460
|
-
/**
|
|
461
|
-
* @typedef Currency
|
|
462
|
-
* @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
|
|
463
|
-
* of the current sales channel supported currency.
|
|
464
|
-
* @property {boolean} [is_active] - Shows currency is enabled or not in current
|
|
465
|
-
* sales channel.
|
|
466
|
-
* @property {string} [name] - Name of the currency, e.g Indian Rupee.
|
|
467
|
-
* @property {string} [code] - 3-character currency code, e.g. INR, USD, EUR.
|
|
468
|
-
* @property {string} [created_at] - ISO 8601 timestamp of sales channel support
|
|
469
|
-
* currency creation.
|
|
470
|
-
* @property {string} [modified_at] - ISO 8601 timestamp of sales channel
|
|
471
|
-
* support currency updation.
|
|
472
|
-
* @property {number} [decimal_digits] - Acceptable decimal limits for a given
|
|
473
|
-
* currency, e.g. 1.05$ means upto 2 decimal digits can be accepted as a valid
|
|
474
|
-
* value of a currency.
|
|
475
|
-
* @property {string} [symbol] - Unique symbol for identifying the currency, e.g. ₹.
|
|
476
|
-
* @property {string} [country_name] - Country name.
|
|
477
|
-
* @property {string} [country_code] - Country code.
|
|
478
|
-
*/
|
|
479
|
-
|
|
480
|
-
/**
|
|
481
|
-
* @typedef Domain
|
|
482
|
-
* @property {boolean} [verified] - Domain is verified or not. TXT and A records
|
|
483
|
-
* should propagate correctly.
|
|
484
|
-
* @property {boolean} [is_primary] - Domain is primary or not. Primary domain
|
|
485
|
-
* is the default/main domain.
|
|
486
|
-
* @property {boolean} [is_shortlink] - Shortlink is present or not for the domain.
|
|
487
|
-
* @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
|
|
488
|
-
* of the sales channel domain.
|
|
489
|
-
* @property {string} [name] - Domain name.
|
|
490
|
-
* @property {boolean} [is_predefined] - Domain is hosting domain or not.
|
|
491
|
-
*/
|
|
492
|
-
|
|
493
|
-
/**
|
|
494
|
-
* @typedef ApplicationWebsite
|
|
495
|
-
* @property {boolean} [enabled] - Shows whether sales channel website URL is
|
|
496
|
-
* enabled or not.
|
|
497
|
-
* @property {string} [basepath] - Base path for the current sales channel website.
|
|
498
|
-
*/
|
|
499
|
-
|
|
500
|
-
/**
|
|
501
|
-
* @typedef ApplicationCors
|
|
502
|
-
* @property {string[]} [domains] - List of domains added to the sales channel.
|
|
503
|
-
*/
|
|
504
|
-
|
|
505
|
-
/**
|
|
506
|
-
* @typedef ApplicationAuth
|
|
507
|
-
* @property {boolean} [enabled] - Shows sales channel auth is enabled or not enabled.
|
|
508
|
-
*/
|
|
509
|
-
|
|
510
|
-
/**
|
|
511
|
-
* @typedef ApplicationRedirections
|
|
512
|
-
* @property {string} [redirect_from] - Old domain url of the sales channel.
|
|
513
|
-
* @property {string} [redirect_to] - New domain URL of the sales channel. Users
|
|
514
|
-
* will be automatically redirected from old domain to new domain.
|
|
515
|
-
* @property {string} [type] - It shows domain redirection type. Permanent
|
|
516
|
-
* redirection is for long time period redirection, and temporary redirection
|
|
517
|
-
* for a short time period.
|
|
518
|
-
*/
|
|
519
|
-
|
|
520
|
-
/**
|
|
521
|
-
* @typedef ApplicationMeta
|
|
522
|
-
* @property {string} [name] - Indicates to name of application meta.
|
|
523
|
-
* @property {string} [value] - Value related to application meta name.
|
|
524
|
-
*/
|
|
525
|
-
|
|
526
|
-
/**
|
|
527
|
-
* @typedef SecureUrl
|
|
528
|
-
* @property {string} [secure_url] - Hosted URL of the image.
|
|
529
|
-
*/
|
|
530
|
-
|
|
531
|
-
/**
|
|
532
|
-
* @typedef Application
|
|
533
|
-
* @property {ApplicationWebsite} [website]
|
|
534
|
-
* @property {ApplicationCors} [cors]
|
|
535
|
-
* @property {ApplicationAuth} [auth]
|
|
536
|
-
* @property {string} [description] - It contains detailed information about the
|
|
537
|
-
* sales channel.
|
|
538
|
-
* @property {string} [channel_type] - It indicates different channel types like
|
|
539
|
-
* store, website-and-mobile-apps. Default value is store.
|
|
540
|
-
* @property {number} [cache_ttl] - An integer value that specifies the number
|
|
541
|
-
* of seconds until the key expires.
|
|
542
|
-
* @property {boolean} [is_internal] - Indicates whether a sales channel is
|
|
543
|
-
* internal or not.
|
|
544
|
-
* @property {boolean} [is_active] - Indicates sales channel is active or not active.
|
|
545
|
-
* @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
|
|
546
|
-
* of the sales channel.
|
|
547
|
-
* @property {string} [name] - Name of the sales channel, e.g. Zenz Fashion.
|
|
548
|
-
* @property {string} [owner] - The unique identifier (24-digit Mongo Object ID)
|
|
549
|
-
* of owner who owns the application.
|
|
550
|
-
* @property {number} [company_id] - Numeric ID allotted to a business account
|
|
551
|
-
* where the sales channel exists.
|
|
552
|
-
* @property {string} [token] - Random generated fix length string for sales
|
|
553
|
-
* channel. It is required and auto-generated.
|
|
554
|
-
* @property {ApplicationRedirections[]} [redirections] - List of redirections
|
|
555
|
-
* for the sales channel.
|
|
556
|
-
* @property {ApplicationMeta[]} [meta] - List of meta information for the sales channel.
|
|
557
|
-
* @property {string} [created_at] - ISO 8601 timestamp of sales channel creation.
|
|
558
|
-
* @property {string} [modified_at] - ISO 8601 timestamp of sales channel updation.
|
|
559
|
-
* @property {number} [__v] - Version key for tracking revisions. Default value is zero.
|
|
560
|
-
* @property {SecureUrl} [banner]
|
|
561
|
-
* @property {SecureUrl} [logo]
|
|
562
|
-
* @property {SecureUrl} [favicon]
|
|
563
|
-
* @property {Domain[]} [domains] - List of domains associated with the sales channel.
|
|
564
|
-
* @property {string} [app_type] - It shows application is live or in development mode.
|
|
565
|
-
* @property {SecureUrl} [mobile_logo]
|
|
566
|
-
* @property {Domain} [domain]
|
|
567
|
-
* @property {string} [slug] - Slug identifier.
|
|
568
|
-
* @property {string} [mode] - Application mode.
|
|
569
|
-
* @property {string} [status] - Current status of the application.
|
|
570
|
-
* @property {TokenSchema[]} [tokens] - List of tokens associated with the sales channel.
|
|
571
|
-
*/
|
|
572
|
-
|
|
573
|
-
/**
|
|
574
|
-
* @typedef TokenSchema
|
|
575
|
-
* @property {string} [token] - Token string.
|
|
576
|
-
* @property {Object} [created_by] - User details.
|
|
577
|
-
* @property {string} [created_at] - ISO 8601 timestamp of when token created.
|
|
578
|
-
*/
|
|
579
|
-
|
|
580
|
-
/**
|
|
581
|
-
* @typedef NotFound
|
|
582
|
-
* @property {string} [message] - Response message for not found.
|
|
583
|
-
*/
|
|
584
|
-
|
|
585
|
-
/**
|
|
586
|
-
* @typedef InvalidPayloadRequest
|
|
587
|
-
* @property {string} [message] - Error message when request body payload is improper.
|
|
588
|
-
*/
|
|
589
|
-
|
|
590
|
-
/**
|
|
591
|
-
* @typedef UnhandledError
|
|
592
|
-
* @property {string} [message] - Error message for unhandled errors.
|
|
593
|
-
*/
|
|
594
|
-
|
|
595
|
-
/**
|
|
596
|
-
* @typedef SuccessMessageResponse
|
|
597
|
-
* @property {string} [message] - Success message shown to the user (in a string format).
|
|
598
|
-
*/
|
|
599
|
-
|
|
600
|
-
/**
|
|
601
|
-
* @typedef CompanyAboutAddress
|
|
602
|
-
* @property {number} [pincode] - 6-digit PIN code of the city, e.g. 400001.
|
|
603
|
-
* @property {string} [address1] - Primary address line of the company.
|
|
604
|
-
* @property {string} [address2] - Secondary address line of the company.
|
|
605
|
-
* @property {string} [city] - City name, e.g. Mumbai.
|
|
606
|
-
* @property {string} [state] - State name, e.g. Maharashtra.
|
|
607
|
-
* @property {string} [country] - Country name, e.g. India.
|
|
608
|
-
* @property {string} [address_type] - Indicates different office types like
|
|
609
|
-
* office, registered, and home.
|
|
610
|
-
*/
|
|
611
|
-
|
|
612
|
-
/**
|
|
613
|
-
* @typedef UserEmail
|
|
614
|
-
* @property {boolean} [active] - Current email is active or not active.
|
|
615
|
-
* @property {boolean} [primary] - Indicates current email id primary email or
|
|
616
|
-
* not primary email of user.
|
|
617
|
-
* @property {boolean} [verified] - Indicates current email is verified email or
|
|
618
|
-
* not verified email.
|
|
619
|
-
* @property {string} [email] - Email address of the user.
|
|
620
|
-
*/
|
|
621
|
-
|
|
622
|
-
/**
|
|
623
|
-
* @typedef UserPhoneNumber
|
|
624
|
-
* @property {boolean} [active] - Current phone number is active or not active.
|
|
625
|
-
* @property {boolean} [primary] - Indicates current phone number is primary or
|
|
626
|
-
* not for a user.
|
|
627
|
-
* @property {boolean} [verified] - Indicates current phone number is verified
|
|
628
|
-
* or not verified.
|
|
629
|
-
* @property {number} [country_code] - Country code, e.g. +91.
|
|
630
|
-
* @property {string} [phone] - Phone number of the user.
|
|
631
|
-
*/
|
|
632
|
-
|
|
633
|
-
/**
|
|
634
|
-
* @typedef Page
|
|
635
|
-
* @property {number} [item_total] - The total number of items on the page.
|
|
636
|
-
* @property {string} [next_id] - The identifier for the next page.
|
|
637
|
-
* @property {boolean} [has_previous] - Indicates whether there is a previous page.
|
|
638
|
-
* @property {boolean} [has_next] - Indicates whether there is a next page.
|
|
639
|
-
* @property {number} [current] - The current page number.
|
|
640
|
-
* @property {string} type - The type of the page, such as 'PageType'.
|
|
641
|
-
* @property {number} [size] - The number of items per page.
|
|
642
|
-
*/
|
|
643
|
-
|
|
644
|
-
/**
|
|
645
|
-
* @typedef ApplicationInformation
|
|
646
|
-
* @property {InformationAddress} [address]
|
|
647
|
-
* @property {InformationSupport} [support]
|
|
648
|
-
* @property {SocialLinks} [social_links]
|
|
649
|
-
* @property {Links[]} [links] - Array of additional relevant web links related
|
|
650
|
-
* to the application.
|
|
651
|
-
* @property {string} [copyright_text] - Copyright statement usually seen at the
|
|
652
|
-
* site's footer.
|
|
653
|
-
* @property {string} [_id] - Unique identifier (24-digit Mongo Object ID) of
|
|
654
|
-
* the application information.
|
|
655
|
-
* @property {BusinessHighlights[]} [business_highlights] - Array of notable
|
|
656
|
-
* business highlights with icons and descriptions.
|
|
657
|
-
* @property {string} [application] - Alphanumeric ID allotted to a sales
|
|
658
|
-
* channel application created within a business account.
|
|
659
|
-
* @property {string} [created_at] - ISO 8601 timestamp of creation of the
|
|
660
|
-
* application information.
|
|
661
|
-
* @property {string} [modified_at] - ISO 8601 timestamp of updation of the
|
|
662
|
-
* application information.
|
|
663
|
-
* @property {number} [__v] - Version key for tracking revisions. Default value is zero.
|
|
664
|
-
*/
|
|
665
|
-
|
|
666
|
-
/**
|
|
667
|
-
* @typedef InformationAddress
|
|
668
|
-
* @property {InformationLoc} [loc]
|
|
669
|
-
* @property {string[]} [address_line] - Contact address of the sales channel.
|
|
670
|
-
* @property {InformationPhone[]} [phone] - Phone numbers with country codes.
|
|
671
|
-
* @property {string} [city] - Name of the city, e.g. Mumbai.
|
|
672
|
-
* @property {string} [country] - Name of the country, e.g. India.
|
|
673
|
-
* @property {number} [pincode] - 6-digit PIN Code of the city, e.g. 400001.
|
|
674
|
-
*/
|
|
675
|
-
|
|
676
|
-
/**
|
|
677
|
-
* @typedef InformationPhone
|
|
678
|
-
* @property {string} [code] - Country code for contact number, e.g. +91 (for India).
|
|
679
|
-
* @property {string} [number] - 10-digit mobile number.
|
|
680
|
-
*/
|
|
681
|
-
|
|
682
|
-
/**
|
|
683
|
-
* @typedef InformationSupportPhone
|
|
684
|
-
* @property {string} [code] - Country code for contact number, e.g. +91 (for India).
|
|
685
|
-
* @property {string} [number] - 10-digit mobile number.
|
|
686
|
-
* @property {string} [key] - Additional identifier or key for the contact number.
|
|
687
|
-
*/
|
|
688
|
-
|
|
689
|
-
/**
|
|
690
|
-
* @typedef InformationSupportEmail
|
|
691
|
-
* @property {string} [value] - Value of email.
|
|
692
|
-
* @property {string} [key] - Additional identifier or key for the email address.
|
|
693
|
-
*/
|
|
694
|
-
|
|
695
|
-
/**
|
|
696
|
-
* @typedef InformationLoc
|
|
697
|
-
* @property {string} [type] - Country code for contact number, e.g. +91 (for India).
|
|
698
|
-
* @property {number[]} [coordinates] - 10-digit mobile number.
|
|
699
|
-
*/
|
|
700
|
-
|
|
701
|
-
/**
|
|
702
|
-
* @typedef InformationSupport
|
|
703
|
-
* @property {InformationSupportPhone[]} [phone] - An array of phone contact
|
|
704
|
-
* details, including country code and number.
|
|
705
|
-
* @property {InformationSupportEmail[]} [email] - An array of email contact details.
|
|
706
|
-
* @property {string} [timing] - Working hours of support team, e.g. 9 AM to 9 PM.
|
|
707
|
-
*/
|
|
708
|
-
|
|
709
|
-
/**
|
|
710
|
-
* @typedef SocialLinks
|
|
711
|
-
* @property {FacebookLink} [facebook]
|
|
712
|
-
* @property {InstagramLink} [instagram]
|
|
713
|
-
* @property {TwitterLink} [twitter]
|
|
714
|
-
* @property {PinterestLink} [pinterest]
|
|
715
|
-
* @property {GooglePlusLink} [google_plus]
|
|
716
|
-
* @property {YoutubeLink} [youtube]
|
|
717
|
-
* @property {LinkedInLink} [linked_in]
|
|
718
|
-
* @property {VimeoLink} [vimeo]
|
|
719
|
-
* @property {BlogLink} [blog_link]
|
|
720
|
-
*/
|
|
721
|
-
|
|
722
|
-
/**
|
|
723
|
-
* @typedef FacebookLink
|
|
724
|
-
* @property {string} [title] - Name of the social media platform, e.g. Facebook.
|
|
725
|
-
* @property {string} [icon] - Hosted URL of social icon image shown on the website.
|
|
726
|
-
* @property {string} [link] - Web URL of brand's Facebook page.
|
|
727
|
-
*/
|
|
728
|
-
|
|
729
|
-
/**
|
|
730
|
-
* @typedef InstagramLink
|
|
731
|
-
* @property {string} [title] - Name of the social media platform, e.g. Instagram.
|
|
732
|
-
* @property {string} [icon] - Hosted URL of social icon image shown on the website.
|
|
733
|
-
* @property {string} [link] - Web URL of brand's Instagram page.
|
|
734
|
-
*/
|
|
735
|
-
|
|
736
|
-
/**
|
|
737
|
-
* @typedef TwitterLink
|
|
738
|
-
* @property {string} [title] - Name of the social media platform, e.g. Twitter.
|
|
739
|
-
* @property {string} [icon] - Hosted URL of social icon image shown on the website.
|
|
740
|
-
* @property {string} [link] - Web URL of brand's Twitter account.
|
|
741
|
-
*/
|
|
742
|
-
|
|
743
|
-
/**
|
|
744
|
-
* @typedef PinterestLink
|
|
745
|
-
* @property {string} [title] - Name of the social media platform, e.g. Pinterest.
|
|
746
|
-
* @property {string} [icon] - Hosted URL of social icon image shown on the website.
|
|
747
|
-
* @property {string} [link] - Web URL of brand's Pinterest page.
|
|
748
|
-
*/
|
|
749
|
-
|
|
750
|
-
/**
|
|
751
|
-
* @typedef GooglePlusLink
|
|
752
|
-
* @property {string} [title] - Name of the social media platform, e.g. Google+.
|
|
753
|
-
* @property {string} [icon] - Hosted URL of social icon image shown on the website.
|
|
754
|
-
* @property {string} [link] - Web URL of brand's Google+ account.
|
|
755
|
-
*/
|
|
756
|
-
|
|
757
|
-
/**
|
|
758
|
-
* @typedef YoutubeLink
|
|
759
|
-
* @property {string} [title] - Name of the social media platform, e.g. YouTube.
|
|
760
|
-
* @property {string} [icon] - Hosted URL of social icon image shown on the website.
|
|
761
|
-
* @property {string} [link] - Web URL of brand's YouTube channel.
|
|
762
|
-
*/
|
|
763
|
-
|
|
764
|
-
/**
|
|
765
|
-
* @typedef LinkedInLink
|
|
766
|
-
* @property {string} [title] - Name of the social media platform, e.g. LinkedIn.
|
|
767
|
-
* @property {string} [icon] - Hosted URL of social icon image shown on the website.
|
|
768
|
-
* @property {string} [link] - Web URL of brand's LinkedIn channel.
|
|
769
|
-
*/
|
|
770
|
-
|
|
771
|
-
/**
|
|
772
|
-
* @typedef VimeoLink
|
|
773
|
-
* @property {string} [title] - Name of the video hosting platform, e.g. Vimeo.
|
|
774
|
-
* @property {string} [icon] - Hosted URL of social icon image shown on the website.
|
|
775
|
-
* @property {string} [link] - Web URL of brand's Vimeo channel.
|
|
776
|
-
*/
|
|
777
|
-
|
|
778
|
-
/**
|
|
779
|
-
* @typedef BlogLink
|
|
780
|
-
* @property {string} [title] - Name of the brand's blog page.
|
|
781
|
-
* @property {string} [icon] - Hosted URL of icon image shown on the website.
|
|
782
|
-
* @property {string} [link] - Web URL of brand's blog page.
|
|
783
|
-
*/
|
|
784
|
-
|
|
785
|
-
/**
|
|
786
|
-
* @typedef Links
|
|
787
|
-
* @property {string} [title] - Name of the related page or link.
|
|
788
|
-
* @property {string} [link] - Web URL for redirecting to a related page.
|
|
789
|
-
*/
|
|
790
|
-
|
|
791
|
-
/**
|
|
792
|
-
* @typedef BusinessHighlights
|
|
793
|
-
* @property {string} [_id] - Unique identifier (24-digit Mongo Object ID) of
|
|
794
|
-
* the related business.
|
|
795
|
-
* @property {string} [title] - Title of the business highlight, e.g. Superfast Delivery.
|
|
796
|
-
* @property {string} [icon] - Hosted URL of icon image representing the
|
|
797
|
-
* business highlight.
|
|
798
|
-
* @property {string} [sub_title] - Detailed information about the highlight.
|
|
799
|
-
*/
|
|
800
|
-
|
|
801
|
-
/**
|
|
802
|
-
* @typedef ApplicationDetail
|
|
803
|
-
* @property {string} name - Name of the sales channel. It is required.
|
|
804
|
-
* @property {string} [description] - It gives a detailed information about the
|
|
805
|
-
* sales channel. It is required.
|
|
806
|
-
* @property {SecureUrl} [logo]
|
|
807
|
-
* @property {SecureUrl} [mobile_logo]
|
|
808
|
-
* @property {SecureUrl} [favicon]
|
|
809
|
-
* @property {SecureUrl} [banner]
|
|
810
|
-
* @property {Domain} [domain]
|
|
811
|
-
* @property {Domain[]} [domains] - List of domains associated with the sales channel.
|
|
812
|
-
* @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
|
|
813
|
-
* for the sales channel details.
|
|
814
|
-
* @property {string} [slug] - URL-friendly version of the sales channel name.
|
|
815
|
-
* @property {number} [company_id] - Numeric ID allotted to the business account
|
|
816
|
-
* where the sales channel is mapped.
|
|
817
|
-
*/
|
|
818
|
-
|
|
819
|
-
/**
|
|
820
|
-
* @typedef CurrenciesResponse
|
|
821
|
-
* @property {Currency[]} [items] - A list of currency objects. Each object
|
|
822
|
-
* represents a different currency.
|
|
823
|
-
*/
|
|
824
|
-
|
|
825
|
-
/**
|
|
826
|
-
* @typedef DefaultCurrency
|
|
827
|
-
* @property {string} [ref] - The unique identifier (24-digit Mongo Object ID)
|
|
828
|
-
* of the default currency.
|
|
829
|
-
* @property {string} [code] - 3-character code of the default currency, e.g.
|
|
830
|
-
* INR, EUR, USD.
|
|
831
|
-
*/
|
|
832
|
-
|
|
833
|
-
/**
|
|
834
|
-
* @typedef AppCurrencyResponse
|
|
835
|
-
* @property {string} [application] - Alphanumeric ID allotted to an application
|
|
836
|
-
* (sales channel website) created within a business account.
|
|
837
|
-
* @property {DefaultCurrency} [default_currency]
|
|
838
|
-
* @property {Currency[]} [supported_currency] - A list of currencies supported
|
|
839
|
-
* by the application.
|
|
840
|
-
* @property {string} [_id] - The unique identifier of the application.
|
|
841
|
-
* @property {string} [created_at] - ISO 8601 timestamp of when the application
|
|
842
|
-
* was created.
|
|
843
|
-
* @property {string} [modified_at] - ISO 8601 timestamp of when the application
|
|
844
|
-
* was last modified.
|
|
845
|
-
*/
|
|
846
|
-
|
|
847
|
-
/**
|
|
848
|
-
* @typedef StoreLatLong
|
|
849
|
-
* @property {string} [type] - Coordinates type of the opted store.
|
|
850
|
-
* @property {number[]} [coordinates] - Latitude and Longitude coordinates of the store.
|
|
851
|
-
*/
|
|
852
|
-
|
|
853
|
-
/**
|
|
854
|
-
* @typedef OptedStoreAddress
|
|
855
|
-
* @property {string} [state] - State of the opted store, e.g. Maharashtra.
|
|
856
|
-
* @property {string} [address1] - Address of the opted store.
|
|
857
|
-
* @property {StoreLatLong} [lat_long]
|
|
858
|
-
* @property {string} [address2] - Address of the opted store.
|
|
859
|
-
* @property {number} [pincode] - 6-digit PIN code of the opted store location.
|
|
860
|
-
* @property {string} [country] - Country of the opted store, e.g. India.
|
|
861
|
-
* @property {string} [city] - City of the opted store, e.g. Mumbai.
|
|
862
|
-
*/
|
|
863
|
-
|
|
864
|
-
/**
|
|
865
|
-
* @typedef OrderingStore
|
|
866
|
-
* @property {OptedStoreAddress} [address]
|
|
867
|
-
* @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
|
|
868
|
-
* of the ordering store.
|
|
869
|
-
* @property {number} [uid] - Ordering store UID.
|
|
870
|
-
* @property {string} [name] - Store name of the ordering store.
|
|
871
|
-
* @property {string} [display_name] - Display name of the ordering store.
|
|
872
|
-
* @property {string} [store_type] - Store type of the ordering store, e.g.
|
|
873
|
-
* high_street, mall, warehouse.
|
|
874
|
-
* @property {string} [store_code] - Store code of the ordering store, e.g. MUM-102.
|
|
875
|
-
* @property {number} [pincode] - 6-digit PIN Code of the ordering store, e.g. 400001.
|
|
876
|
-
* @property {string} [code] - Code of the ordering store (usually same as Store Code).
|
|
877
|
-
*/
|
|
878
|
-
|
|
879
|
-
/**
|
|
880
|
-
* @typedef OrderingStores
|
|
881
|
-
* @property {Page} [page]
|
|
882
|
-
* @property {OrderingStore[]} [items] - List of ordering stores.
|
|
883
|
-
* @property {number[]} [deployed_stores] - List of all deployed stores.
|
|
884
|
-
* @property {boolean} [all_stores] - Allow all stores of the ordering stores.
|
|
885
|
-
* @property {boolean} [enabled] - Allow ordering stores for current sales channel.
|
|
886
|
-
* @property {string} [type] - For hard type delivery, store selection is
|
|
887
|
-
* compulsory. For soft type, delivery store selection is optional.
|
|
888
|
-
* @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
|
|
889
|
-
* of the ordering store.
|
|
890
|
-
* @property {string} [app] - Alphanumeric ID allotted to an application (sales
|
|
891
|
-
* channel website) created within a business account.
|
|
892
|
-
* @property {number} [__v] - Version key for tracking ordering stores. Default
|
|
893
|
-
* value is zero.
|
|
894
|
-
*/
|
|
895
|
-
|
|
896
|
-
class ConfigurationApplicationModel {
|
|
897
|
-
/** @returns {ApplicationAboutResponse} */
|
|
898
|
-
static ApplicationAboutResponse() {
|
|
899
|
-
return Joi.object({
|
|
900
|
-
application_info: ConfigurationApplicationModel.ApplicationInfo(),
|
|
901
|
-
});
|
|
902
|
-
}
|
|
903
|
-
|
|
904
|
-
/** @returns {ApplicationInfo} */
|
|
905
|
-
static ApplicationInfo() {
|
|
906
|
-
return Joi.object({
|
|
907
|
-
company_info: ConfigurationApplicationModel.CompanyInfo(),
|
|
908
|
-
owner_info: ConfigurationApplicationModel.OwnerInfo(),
|
|
909
|
-
_id: Joi.string().allow(""),
|
|
910
|
-
domain: ConfigurationApplicationModel.Domain(),
|
|
911
|
-
website: ConfigurationApplicationModel.ApplicationWebsite(),
|
|
912
|
-
cors: ConfigurationApplicationModel.ApplicationCors(),
|
|
913
|
-
description: Joi.string().allow(""),
|
|
914
|
-
name: Joi.string().allow(""),
|
|
915
|
-
meta: Joi.array().items(ConfigurationApplicationModel.ApplicationMeta()),
|
|
916
|
-
token: Joi.string().allow(""),
|
|
917
|
-
secret: Joi.string().allow(""),
|
|
918
|
-
created_at: Joi.string().allow(""),
|
|
919
|
-
banner: ConfigurationApplicationModel.SecureUrl(),
|
|
920
|
-
logo: ConfigurationApplicationModel.SecureUrl(),
|
|
921
|
-
is_active: Joi.boolean(),
|
|
922
|
-
mode: Joi.string().allow(""),
|
|
923
|
-
tokens: Joi.array().items(ConfigurationApplicationModel.TokenSchema()),
|
|
924
|
-
domains: Joi.array().items(ConfigurationApplicationModel.Domain()),
|
|
925
|
-
favicon: ConfigurationApplicationModel.SecureUrl(),
|
|
926
|
-
mobile_logo: ConfigurationApplicationModel.SecureUrl(),
|
|
927
|
-
slug: Joi.string().allow(""),
|
|
928
|
-
});
|
|
929
|
-
}
|
|
930
|
-
|
|
931
|
-
/** @returns {CompanyInfo} */
|
|
932
|
-
static CompanyInfo() {
|
|
933
|
-
return Joi.object({
|
|
934
|
-
_id: Joi.string().allow(""),
|
|
935
|
-
uid: Joi.number(),
|
|
936
|
-
created_on: Joi.string().allow(""),
|
|
937
|
-
is_active: Joi.boolean(),
|
|
938
|
-
name: Joi.string().allow(""),
|
|
939
|
-
addresses: Joi.array().items(
|
|
940
|
-
ConfigurationApplicationModel.CompanyAboutAddress()
|
|
941
|
-
),
|
|
942
|
-
notification_emails: Joi.array().items(Joi.string().allow("")),
|
|
943
|
-
});
|
|
944
|
-
}
|
|
945
|
-
|
|
946
|
-
/** @returns {OwnerInfo} */
|
|
947
|
-
static OwnerInfo() {
|
|
948
|
-
return Joi.object({
|
|
949
|
-
_id: Joi.string().allow(""),
|
|
950
|
-
emails: Joi.array().items(ConfigurationApplicationModel.UserEmail()),
|
|
951
|
-
phone_numbers: Joi.array().items(
|
|
952
|
-
ConfigurationApplicationModel.UserPhoneNumber()
|
|
953
|
-
),
|
|
954
|
-
first_name: Joi.string().allow(""),
|
|
955
|
-
last_name: Joi.string().allow(""),
|
|
956
|
-
profile_pic: Joi.string().allow(""),
|
|
957
|
-
});
|
|
958
|
-
}
|
|
959
|
-
|
|
960
|
-
/** @returns {SupportedLanguage} */
|
|
961
|
-
static SupportedLanguage() {
|
|
962
|
-
return Joi.object({
|
|
963
|
-
name: Joi.string().allow(""),
|
|
964
|
-
code: Joi.string().allow(""),
|
|
965
|
-
});
|
|
966
|
-
}
|
|
967
|
-
|
|
968
|
-
/** @returns {LanguageResponse} */
|
|
969
|
-
static LanguageResponse() {
|
|
970
|
-
return Joi.object({
|
|
971
|
-
items: Joi.array().items(
|
|
972
|
-
ConfigurationApplicationModel.SupportedLanguage()
|
|
973
|
-
),
|
|
974
|
-
});
|
|
975
|
-
}
|
|
976
|
-
|
|
977
|
-
/** @returns {AppStaffResponse} */
|
|
978
|
-
static AppStaffResponse() {
|
|
979
|
-
return Joi.object({
|
|
980
|
-
staff_users: Joi.array().items(ConfigurationApplicationModel.AppStaff()),
|
|
981
|
-
});
|
|
982
|
-
}
|
|
983
|
-
|
|
984
|
-
/** @returns {AppStaffListResponse} */
|
|
985
|
-
static AppStaffListResponse() {
|
|
986
|
-
return Joi.object({
|
|
987
|
-
page: ConfigurationApplicationModel.Page(),
|
|
988
|
-
items: Joi.array().items(ConfigurationApplicationModel.AppStaff()),
|
|
989
|
-
});
|
|
990
|
-
}
|
|
991
|
-
|
|
992
|
-
/** @returns {OrderingStoreSelectRequest} */
|
|
993
|
-
static OrderingStoreSelectRequest() {
|
|
994
|
-
return Joi.object({
|
|
995
|
-
ordering_store: ConfigurationApplicationModel.OrderingStoreSelect().required(),
|
|
996
|
-
});
|
|
997
|
-
}
|
|
998
|
-
|
|
999
|
-
/** @returns {OrderingStoreSelect} */
|
|
1000
|
-
static OrderingStoreSelect() {
|
|
1001
|
-
return Joi.object({
|
|
1002
|
-
uid: Joi.number().required(),
|
|
1003
|
-
});
|
|
1004
|
-
}
|
|
1005
|
-
|
|
1006
|
-
/** @returns {AppStaff} */
|
|
1007
|
-
static AppStaff() {
|
|
1008
|
-
return Joi.object({
|
|
1009
|
-
_id: Joi.string().allow(""),
|
|
1010
|
-
order_incent: Joi.boolean(),
|
|
1011
|
-
stores: Joi.array().items(Joi.number()),
|
|
1012
|
-
application: Joi.string().allow(""),
|
|
1013
|
-
title: Joi.string().allow(""),
|
|
1014
|
-
user: Joi.string().allow(""),
|
|
1015
|
-
employee_code: Joi.string().allow(""),
|
|
1016
|
-
first_name: Joi.string().allow(""),
|
|
1017
|
-
last_name: Joi.string().allow(""),
|
|
1018
|
-
profile_pic_url: Joi.string().allow(""),
|
|
1019
|
-
});
|
|
1020
|
-
}
|
|
1021
|
-
|
|
1022
|
-
/** @returns {AppTokenResponse} */
|
|
1023
|
-
static AppTokenResponse() {
|
|
1024
|
-
return Joi.object({
|
|
1025
|
-
tokens: ConfigurationApplicationModel.Tokens(),
|
|
1026
|
-
_id: Joi.string().allow(""),
|
|
1027
|
-
application: Joi.string().allow(""),
|
|
1028
|
-
created_at: Joi.string().allow(""),
|
|
1029
|
-
modified_at: Joi.string().allow(""),
|
|
1030
|
-
__v: Joi.number(),
|
|
1031
|
-
});
|
|
1032
|
-
}
|
|
1033
|
-
|
|
1034
|
-
/** @returns {Tokens} */
|
|
1035
|
-
static Tokens() {
|
|
1036
|
-
return Joi.object({
|
|
1037
|
-
firebase: ConfigurationApplicationModel.Firebase(),
|
|
1038
|
-
moengage: ConfigurationApplicationModel.Moengage(),
|
|
1039
|
-
segment: ConfigurationApplicationModel.Segment(),
|
|
1040
|
-
gtm: ConfigurationApplicationModel.Gtm(),
|
|
1041
|
-
freshchat: ConfigurationApplicationModel.Freshchat(),
|
|
1042
|
-
safetynet: ConfigurationApplicationModel.Safetynet(),
|
|
1043
|
-
fynd_rewards: ConfigurationApplicationModel.FyndRewards(),
|
|
1044
|
-
google_map: ConfigurationApplicationModel.GoogleMap(),
|
|
1045
|
-
});
|
|
1046
|
-
}
|
|
1047
|
-
|
|
1048
|
-
/** @returns {Firebase} */
|
|
1049
|
-
static Firebase() {
|
|
1050
|
-
return Joi.object({
|
|
1051
|
-
credentials: ConfigurationApplicationModel.Credentials(),
|
|
1052
|
-
enabled: Joi.boolean(),
|
|
1053
|
-
});
|
|
1054
|
-
}
|
|
1055
|
-
|
|
1056
|
-
/** @returns {Credentials} */
|
|
1057
|
-
static Credentials() {
|
|
1058
|
-
return Joi.object({
|
|
1059
|
-
ios: ConfigurationApplicationModel.Ios(),
|
|
1060
|
-
android: ConfigurationApplicationModel.Android(),
|
|
1061
|
-
project_id: Joi.string().allow(""),
|
|
1062
|
-
gcm_sender_id: Joi.string().allow(""),
|
|
1063
|
-
application_id: Joi.string().allow(""),
|
|
1064
|
-
api_key: Joi.string().allow(""),
|
|
1065
|
-
});
|
|
1066
|
-
}
|
|
1067
|
-
|
|
1068
|
-
/** @returns {Ios} */
|
|
1069
|
-
static Ios() {
|
|
1070
|
-
return Joi.object({
|
|
1071
|
-
application_id: Joi.string().allow(""),
|
|
1072
|
-
api_key: Joi.string().allow(""),
|
|
1073
|
-
});
|
|
1074
|
-
}
|
|
1075
|
-
|
|
1076
|
-
/** @returns {Android} */
|
|
1077
|
-
static Android() {
|
|
1078
|
-
return Joi.object({
|
|
1079
|
-
application_id: Joi.string().allow(""),
|
|
1080
|
-
api_key: Joi.string().allow(""),
|
|
1081
|
-
});
|
|
1082
|
-
}
|
|
1083
|
-
|
|
1084
|
-
/** @returns {Moengage} */
|
|
1085
|
-
static Moengage() {
|
|
1086
|
-
return Joi.object({
|
|
1087
|
-
credentials: ConfigurationApplicationModel.MoengageCredentials(),
|
|
1088
|
-
enabled: Joi.boolean(),
|
|
1089
|
-
});
|
|
1090
|
-
}
|
|
1091
|
-
|
|
1092
|
-
/** @returns {MoengageCredentials} */
|
|
1093
|
-
static MoengageCredentials() {
|
|
1094
|
-
return Joi.object({
|
|
1095
|
-
app_id: Joi.string().allow(""),
|
|
1096
|
-
});
|
|
1097
|
-
}
|
|
1098
|
-
|
|
1099
|
-
/** @returns {Segment} */
|
|
1100
|
-
static Segment() {
|
|
1101
|
-
return Joi.object({
|
|
1102
|
-
credentials: ConfigurationApplicationModel.SegmentCredentials(),
|
|
1103
|
-
enabled: Joi.boolean(),
|
|
1104
|
-
});
|
|
1105
|
-
}
|
|
1106
|
-
|
|
1107
|
-
/** @returns {SegmentCredentials} */
|
|
1108
|
-
static SegmentCredentials() {
|
|
1109
|
-
return Joi.object({
|
|
1110
|
-
write_key: Joi.string().allow(""),
|
|
1111
|
-
});
|
|
1112
|
-
}
|
|
1113
|
-
|
|
1114
|
-
/** @returns {Gtm} */
|
|
1115
|
-
static Gtm() {
|
|
1116
|
-
return Joi.object({
|
|
1117
|
-
credentials: ConfigurationApplicationModel.GtmCredentials(),
|
|
1118
|
-
enabled: Joi.boolean(),
|
|
1119
|
-
});
|
|
1120
|
-
}
|
|
1121
|
-
|
|
1122
|
-
/** @returns {GtmCredentials} */
|
|
1123
|
-
static GtmCredentials() {
|
|
1124
|
-
return Joi.object({
|
|
1125
|
-
api_key: Joi.string().allow(""),
|
|
1126
|
-
});
|
|
1127
|
-
}
|
|
1128
|
-
|
|
1129
|
-
/** @returns {Freshchat} */
|
|
1130
|
-
static Freshchat() {
|
|
1131
|
-
return Joi.object({
|
|
1132
|
-
credentials: ConfigurationApplicationModel.FreshchatCredentials(),
|
|
1133
|
-
enabled: Joi.boolean(),
|
|
1134
|
-
});
|
|
1135
|
-
}
|
|
1136
|
-
|
|
1137
|
-
/** @returns {FreshchatCredentials} */
|
|
1138
|
-
static FreshchatCredentials() {
|
|
1139
|
-
return Joi.object({
|
|
1140
|
-
app_id: Joi.string().allow(""),
|
|
1141
|
-
app_key: Joi.string().allow(""),
|
|
1142
|
-
web_token: Joi.string().allow(""),
|
|
1143
|
-
});
|
|
1144
|
-
}
|
|
1145
|
-
|
|
1146
|
-
/** @returns {Safetynet} */
|
|
1147
|
-
static Safetynet() {
|
|
1148
|
-
return Joi.object({
|
|
1149
|
-
credentials: ConfigurationApplicationModel.SafetynetCredentials(),
|
|
1150
|
-
enabled: Joi.boolean(),
|
|
1151
|
-
});
|
|
1152
|
-
}
|
|
1153
|
-
|
|
1154
|
-
/** @returns {SafetynetCredentials} */
|
|
1155
|
-
static SafetynetCredentials() {
|
|
1156
|
-
return Joi.object({
|
|
1157
|
-
api_key: Joi.string().allow(""),
|
|
1158
|
-
});
|
|
1159
|
-
}
|
|
1160
|
-
|
|
1161
|
-
/** @returns {FyndRewards} */
|
|
1162
|
-
static FyndRewards() {
|
|
1163
|
-
return Joi.object({
|
|
1164
|
-
credentials: ConfigurationApplicationModel.FyndRewardsCredentials(),
|
|
1165
|
-
});
|
|
1166
|
-
}
|
|
1167
|
-
|
|
1168
|
-
/** @returns {FyndRewardsCredentials} */
|
|
1169
|
-
static FyndRewardsCredentials() {
|
|
1170
|
-
return Joi.object({
|
|
1171
|
-
public_key: Joi.string().allow(""),
|
|
1172
|
-
});
|
|
1173
|
-
}
|
|
1174
|
-
|
|
1175
|
-
/** @returns {GoogleMap} */
|
|
1176
|
-
static GoogleMap() {
|
|
1177
|
-
return Joi.object({
|
|
1178
|
-
enabled: Joi.boolean(),
|
|
1179
|
-
credentials: ConfigurationApplicationModel.GoogleMapCredentials(),
|
|
1180
|
-
});
|
|
1181
|
-
}
|
|
1182
|
-
|
|
1183
|
-
/** @returns {GoogleMapCredentials} */
|
|
1184
|
-
static GoogleMapCredentials() {
|
|
1185
|
-
return Joi.object({
|
|
1186
|
-
api_key: Joi.string().allow(""),
|
|
1187
|
-
});
|
|
1188
|
-
}
|
|
1189
|
-
|
|
1190
|
-
/** @returns {RewardPointsConfig} */
|
|
1191
|
-
static RewardPointsConfig() {
|
|
1192
|
-
return Joi.object({
|
|
1193
|
-
credit: ConfigurationApplicationModel.Credit(),
|
|
1194
|
-
debit: ConfigurationApplicationModel.Debit(),
|
|
1195
|
-
});
|
|
1196
|
-
}
|
|
1197
|
-
|
|
1198
|
-
/** @returns {Credit} */
|
|
1199
|
-
static Credit() {
|
|
1200
|
-
return Joi.object({
|
|
1201
|
-
enabled: Joi.boolean(),
|
|
1202
|
-
});
|
|
1203
|
-
}
|
|
1204
|
-
|
|
1205
|
-
/** @returns {Debit} */
|
|
1206
|
-
static Debit() {
|
|
1207
|
-
return Joi.object({
|
|
1208
|
-
enabled: Joi.boolean(),
|
|
1209
|
-
auto_apply: Joi.boolean(),
|
|
1210
|
-
strategy_channel: Joi.string().allow(""),
|
|
1211
|
-
});
|
|
1212
|
-
}
|
|
1213
|
-
|
|
1214
|
-
/** @returns {ProductDetailFeature} */
|
|
1215
|
-
static ProductDetailFeature() {
|
|
1216
|
-
return Joi.object({
|
|
1217
|
-
similar: Joi.array().items(Joi.string().allow("")),
|
|
1218
|
-
seller_selection: Joi.boolean(),
|
|
1219
|
-
update_product_meta: Joi.boolean(),
|
|
1220
|
-
request_product: Joi.boolean(),
|
|
1221
|
-
});
|
|
1222
|
-
}
|
|
1223
|
-
|
|
1224
|
-
/** @returns {LaunchPage} */
|
|
1225
|
-
static LaunchPage() {
|
|
1226
|
-
return Joi.object({
|
|
1227
|
-
page_type: Joi.string().allow(""),
|
|
1228
|
-
params: Joi.any(),
|
|
1229
|
-
query: Joi.any(),
|
|
1230
|
-
});
|
|
1231
|
-
}
|
|
1232
|
-
|
|
1233
|
-
/** @returns {LandingPageFeature} */
|
|
1234
|
-
static LandingPageFeature() {
|
|
1235
|
-
return Joi.object({
|
|
1236
|
-
launch_page: ConfigurationApplicationModel.LaunchPage(),
|
|
1237
|
-
continue_as_guest: Joi.boolean(),
|
|
1238
|
-
login_btn_text: Joi.string().allow(""),
|
|
1239
|
-
show_domain_textbox: Joi.boolean(),
|
|
1240
|
-
show_register_btn: Joi.boolean(),
|
|
1241
|
-
});
|
|
1242
|
-
}
|
|
1243
|
-
|
|
1244
|
-
/** @returns {RegistrationPageFeature} */
|
|
1245
|
-
static RegistrationPageFeature() {
|
|
1246
|
-
return Joi.object({
|
|
1247
|
-
ask_store_address: Joi.boolean(),
|
|
1248
|
-
});
|
|
1249
|
-
}
|
|
1250
|
-
|
|
1251
|
-
/** @returns {AppFeature} */
|
|
1252
|
-
static AppFeature() {
|
|
1253
|
-
return Joi.object({
|
|
1254
|
-
product_detail: ConfigurationApplicationModel.ProductDetailFeature(),
|
|
1255
|
-
landing_page: ConfigurationApplicationModel.LandingPageFeature(),
|
|
1256
|
-
registration_page: ConfigurationApplicationModel.RegistrationPageFeature(),
|
|
1257
|
-
home_page: ConfigurationApplicationModel.HomePageFeature(),
|
|
1258
|
-
common: ConfigurationApplicationModel.CommonFeature(),
|
|
1259
|
-
cart: ConfigurationApplicationModel.CartFeature(),
|
|
1260
|
-
qr: ConfigurationApplicationModel.QrFeature(),
|
|
1261
|
-
pcr: ConfigurationApplicationModel.PcrFeature(),
|
|
1262
|
-
order: ConfigurationApplicationModel.OrderFeature(),
|
|
1263
|
-
_id: Joi.string().allow(""),
|
|
1264
|
-
app: Joi.string().allow(""),
|
|
1265
|
-
created_at: Joi.string().allow(""),
|
|
1266
|
-
modified_at: Joi.string().allow(""),
|
|
1267
|
-
__v: Joi.number(),
|
|
1268
|
-
});
|
|
1269
|
-
}
|
|
1270
|
-
|
|
1271
|
-
/** @returns {HomePageFeature} */
|
|
1272
|
-
static HomePageFeature() {
|
|
1273
|
-
return Joi.object({
|
|
1274
|
-
order_processing: Joi.boolean(),
|
|
1275
|
-
});
|
|
1276
|
-
}
|
|
1277
|
-
|
|
1278
|
-
/** @returns {CommonFeature} */
|
|
1279
|
-
static CommonFeature() {
|
|
1280
|
-
return Joi.object({
|
|
1281
|
-
communication_optin_dialog: ConfigurationApplicationModel.CommunicationOptinDialogFeature(),
|
|
1282
|
-
deployment_store_selection: ConfigurationApplicationModel.DeploymentStoreSelectionFeature(),
|
|
1283
|
-
listing_price: ConfigurationApplicationModel.ListingPriceFeature(),
|
|
1284
|
-
currency: ConfigurationApplicationModel.CurrencyFeature(),
|
|
1285
|
-
revenue_engine: ConfigurationApplicationModel.RevenueEngineFeature(),
|
|
1286
|
-
feedback: ConfigurationApplicationModel.FeedbackFeature(),
|
|
1287
|
-
compare_products: ConfigurationApplicationModel.CompareProductsFeature(),
|
|
1288
|
-
reward_points: ConfigurationApplicationModel.RewardPointsConfig(),
|
|
1289
|
-
listing_page: ConfigurationApplicationModel.ListingPageFeature(),
|
|
1290
|
-
international_shipping: ConfigurationApplicationModel.InternationalShipping(),
|
|
1291
|
-
});
|
|
1292
|
-
}
|
|
1293
|
-
|
|
1294
|
-
/** @returns {InternationalShipping} */
|
|
1295
|
-
static InternationalShipping() {
|
|
1296
|
-
return Joi.object({
|
|
1297
|
-
enabled: Joi.boolean(),
|
|
1298
|
-
});
|
|
1299
|
-
}
|
|
1300
|
-
|
|
1301
|
-
/** @returns {CommunicationOptinDialogFeature} */
|
|
1302
|
-
static CommunicationOptinDialogFeature() {
|
|
1303
|
-
return Joi.object({
|
|
1304
|
-
visibility: Joi.boolean(),
|
|
1305
|
-
});
|
|
1306
|
-
}
|
|
1307
|
-
|
|
1308
|
-
/** @returns {DeploymentStoreSelectionFeature} */
|
|
1309
|
-
static DeploymentStoreSelectionFeature() {
|
|
1310
|
-
return Joi.object({
|
|
1311
|
-
enabled: Joi.boolean(),
|
|
1312
|
-
type: Joi.string().allow(""),
|
|
1313
|
-
});
|
|
1314
|
-
}
|
|
1315
|
-
|
|
1316
|
-
/** @returns {ListingPriceFeature} */
|
|
1317
|
-
static ListingPriceFeature() {
|
|
1318
|
-
return Joi.object({
|
|
1319
|
-
value: Joi.string().allow(""),
|
|
1320
|
-
sort: Joi.string().allow(""),
|
|
1321
|
-
});
|
|
1322
|
-
}
|
|
1323
|
-
|
|
1324
|
-
/** @returns {ListingPageFeature} */
|
|
1325
|
-
static ListingPageFeature() {
|
|
1326
|
-
return Joi.object({
|
|
1327
|
-
sort_on: Joi.string().allow(""),
|
|
1328
|
-
});
|
|
1329
|
-
}
|
|
1330
|
-
|
|
1331
|
-
/** @returns {CurrencyFeature} */
|
|
1332
|
-
static CurrencyFeature() {
|
|
1333
|
-
return Joi.object({
|
|
1334
|
-
value: Joi.array().items(Joi.string().allow("")),
|
|
1335
|
-
type: Joi.string().allow(""),
|
|
1336
|
-
default_currency: Joi.string().allow(""),
|
|
1337
|
-
});
|
|
1338
|
-
}
|
|
1339
|
-
|
|
1340
|
-
/** @returns {RevenueEngineFeature} */
|
|
1341
|
-
static RevenueEngineFeature() {
|
|
1342
|
-
return Joi.object({
|
|
1343
|
-
enabled: Joi.boolean(),
|
|
1344
|
-
});
|
|
1345
|
-
}
|
|
1346
|
-
|
|
1347
|
-
/** @returns {FeedbackFeature} */
|
|
1348
|
-
static FeedbackFeature() {
|
|
1349
|
-
return Joi.object({
|
|
1350
|
-
enabled: Joi.boolean(),
|
|
1351
|
-
});
|
|
1352
|
-
}
|
|
1353
|
-
|
|
1354
|
-
/** @returns {CompareProductsFeature} */
|
|
1355
|
-
static CompareProductsFeature() {
|
|
1356
|
-
return Joi.object({
|
|
1357
|
-
enabled: Joi.boolean(),
|
|
1358
|
-
});
|
|
1359
|
-
}
|
|
1360
|
-
|
|
1361
|
-
/** @returns {CartFeature} */
|
|
1362
|
-
static CartFeature() {
|
|
1363
|
-
return Joi.object({
|
|
1364
|
-
gst_input: Joi.boolean(),
|
|
1365
|
-
staff_selection: Joi.boolean(),
|
|
1366
|
-
placing_for_customer: Joi.boolean(),
|
|
1367
|
-
google_map: Joi.boolean(),
|
|
1368
|
-
revenue_engine_coupon: Joi.boolean(),
|
|
1369
|
-
});
|
|
1370
|
-
}
|
|
1371
|
-
|
|
1372
|
-
/** @returns {QrFeature} */
|
|
1373
|
-
static QrFeature() {
|
|
1374
|
-
return Joi.object({
|
|
1375
|
-
application: Joi.boolean(),
|
|
1376
|
-
products: Joi.boolean(),
|
|
1377
|
-
collections: Joi.boolean(),
|
|
1378
|
-
});
|
|
1379
|
-
}
|
|
1380
|
-
|
|
1381
|
-
/** @returns {PcrFeature} */
|
|
1382
|
-
static PcrFeature() {
|
|
1383
|
-
return Joi.object({
|
|
1384
|
-
staff_selection: Joi.boolean(),
|
|
1385
|
-
});
|
|
1386
|
-
}
|
|
1387
|
-
|
|
1388
|
-
/** @returns {OrderFeature} */
|
|
1389
|
-
static OrderFeature() {
|
|
1390
|
-
return Joi.object({
|
|
1391
|
-
buy_again: Joi.boolean(),
|
|
1392
|
-
});
|
|
1393
|
-
}
|
|
1394
|
-
|
|
1395
|
-
/** @returns {AppFeatureResponse} */
|
|
1396
|
-
static AppFeatureResponse() {
|
|
1397
|
-
return Joi.object({
|
|
1398
|
-
feature: ConfigurationApplicationModel.AppFeature(),
|
|
1399
|
-
});
|
|
1400
|
-
}
|
|
1401
|
-
|
|
1402
|
-
/** @returns {Currency} */
|
|
1403
|
-
static Currency() {
|
|
1404
|
-
return Joi.object({
|
|
1405
|
-
_id: Joi.string().allow(""),
|
|
1406
|
-
is_active: Joi.boolean(),
|
|
1407
|
-
name: Joi.string().allow(""),
|
|
1408
|
-
code: Joi.string().allow(""),
|
|
1409
|
-
created_at: Joi.string().allow(""),
|
|
1410
|
-
modified_at: Joi.string().allow(""),
|
|
1411
|
-
decimal_digits: Joi.number(),
|
|
1412
|
-
symbol: Joi.string().allow(""),
|
|
1413
|
-
country_name: Joi.string().allow(""),
|
|
1414
|
-
country_code: Joi.string().allow(""),
|
|
1415
|
-
});
|
|
1416
|
-
}
|
|
1417
|
-
|
|
1418
|
-
/** @returns {Domain} */
|
|
1419
|
-
static Domain() {
|
|
1420
|
-
return Joi.object({
|
|
1421
|
-
verified: Joi.boolean(),
|
|
1422
|
-
is_primary: Joi.boolean(),
|
|
1423
|
-
is_shortlink: Joi.boolean(),
|
|
1424
|
-
_id: Joi.string().allow(""),
|
|
1425
|
-
name: Joi.string().allow(""),
|
|
1426
|
-
is_predefined: Joi.boolean(),
|
|
1427
|
-
});
|
|
1428
|
-
}
|
|
1429
|
-
|
|
1430
|
-
/** @returns {ApplicationWebsite} */
|
|
1431
|
-
static ApplicationWebsite() {
|
|
1432
|
-
return Joi.object({
|
|
1433
|
-
enabled: Joi.boolean(),
|
|
1434
|
-
basepath: Joi.string().allow(""),
|
|
1435
|
-
});
|
|
1436
|
-
}
|
|
1437
|
-
|
|
1438
|
-
/** @returns {ApplicationCors} */
|
|
1439
|
-
static ApplicationCors() {
|
|
1440
|
-
return Joi.object({
|
|
1441
|
-
domains: Joi.array().items(Joi.string().allow("")),
|
|
1442
|
-
});
|
|
1443
|
-
}
|
|
1444
|
-
|
|
1445
|
-
/** @returns {ApplicationAuth} */
|
|
1446
|
-
static ApplicationAuth() {
|
|
1447
|
-
return Joi.object({
|
|
1448
|
-
enabled: Joi.boolean(),
|
|
1449
|
-
});
|
|
1450
|
-
}
|
|
1451
|
-
|
|
1452
|
-
/** @returns {ApplicationRedirections} */
|
|
1453
|
-
static ApplicationRedirections() {
|
|
1454
|
-
return Joi.object({
|
|
1455
|
-
redirect_from: Joi.string().allow(""),
|
|
1456
|
-
redirect_to: Joi.string().allow(""),
|
|
1457
|
-
type: Joi.string().allow(""),
|
|
1458
|
-
});
|
|
1459
|
-
}
|
|
1460
|
-
|
|
1461
|
-
/** @returns {ApplicationMeta} */
|
|
1462
|
-
static ApplicationMeta() {
|
|
1463
|
-
return Joi.object({
|
|
1464
|
-
name: Joi.string().allow(""),
|
|
1465
|
-
value: Joi.string().allow(""),
|
|
1466
|
-
});
|
|
1467
|
-
}
|
|
1468
|
-
|
|
1469
|
-
/** @returns {SecureUrl} */
|
|
1470
|
-
static SecureUrl() {
|
|
1471
|
-
return Joi.object({
|
|
1472
|
-
secure_url: Joi.string().allow(""),
|
|
1473
|
-
});
|
|
1474
|
-
}
|
|
1475
|
-
|
|
1476
|
-
/** @returns {Application} */
|
|
1477
|
-
static Application() {
|
|
1478
|
-
return Joi.object({
|
|
1479
|
-
website: ConfigurationApplicationModel.ApplicationWebsite(),
|
|
1480
|
-
cors: ConfigurationApplicationModel.ApplicationCors(),
|
|
1481
|
-
auth: ConfigurationApplicationModel.ApplicationAuth(),
|
|
1482
|
-
description: Joi.string().allow(""),
|
|
1483
|
-
channel_type: Joi.string().allow(""),
|
|
1484
|
-
cache_ttl: Joi.number(),
|
|
1485
|
-
is_internal: Joi.boolean(),
|
|
1486
|
-
is_active: Joi.boolean(),
|
|
1487
|
-
_id: Joi.string().allow(""),
|
|
1488
|
-
name: Joi.string().allow(""),
|
|
1489
|
-
owner: Joi.string().allow(""),
|
|
1490
|
-
company_id: Joi.number(),
|
|
1491
|
-
token: Joi.string().allow(""),
|
|
1492
|
-
redirections: Joi.array().items(
|
|
1493
|
-
ConfigurationApplicationModel.ApplicationRedirections()
|
|
1494
|
-
),
|
|
1495
|
-
meta: Joi.array().items(ConfigurationApplicationModel.ApplicationMeta()),
|
|
1496
|
-
created_at: Joi.string().allow(""),
|
|
1497
|
-
modified_at: Joi.string().allow(""),
|
|
1498
|
-
__v: Joi.number(),
|
|
1499
|
-
banner: ConfigurationApplicationModel.SecureUrl(),
|
|
1500
|
-
logo: ConfigurationApplicationModel.SecureUrl(),
|
|
1501
|
-
favicon: ConfigurationApplicationModel.SecureUrl(),
|
|
1502
|
-
domains: Joi.array().items(ConfigurationApplicationModel.Domain()),
|
|
1503
|
-
app_type: Joi.string().allow(""),
|
|
1504
|
-
mobile_logo: ConfigurationApplicationModel.SecureUrl(),
|
|
1505
|
-
domain: ConfigurationApplicationModel.Domain(),
|
|
1506
|
-
slug: Joi.string().allow(""),
|
|
1507
|
-
mode: Joi.string().allow(""),
|
|
1508
|
-
status: Joi.string().allow(""),
|
|
1509
|
-
tokens: Joi.array().items(ConfigurationApplicationModel.TokenSchema()),
|
|
1510
|
-
});
|
|
1511
|
-
}
|
|
1512
|
-
|
|
1513
|
-
/** @returns {TokenSchema} */
|
|
1514
|
-
static TokenSchema() {
|
|
1515
|
-
return Joi.object({
|
|
1516
|
-
token: Joi.string().allow(""),
|
|
1517
|
-
created_by: Joi.object().pattern(/\S/, Joi.any()),
|
|
1518
|
-
created_at: Joi.string().allow(""),
|
|
1519
|
-
});
|
|
1520
|
-
}
|
|
1521
|
-
|
|
1522
|
-
/** @returns {NotFound} */
|
|
1523
|
-
static NotFound() {
|
|
1524
|
-
return Joi.object({
|
|
1525
|
-
message: Joi.string().allow(""),
|
|
1526
|
-
});
|
|
1527
|
-
}
|
|
1528
|
-
|
|
1529
|
-
/** @returns {InvalidPayloadRequest} */
|
|
1530
|
-
static InvalidPayloadRequest() {
|
|
1531
|
-
return Joi.object({
|
|
1532
|
-
message: Joi.string().allow(""),
|
|
1533
|
-
});
|
|
1534
|
-
}
|
|
1535
|
-
|
|
1536
|
-
/** @returns {UnhandledError} */
|
|
1537
|
-
static UnhandledError() {
|
|
1538
|
-
return Joi.object({
|
|
1539
|
-
message: Joi.string().allow(""),
|
|
1540
|
-
});
|
|
1541
|
-
}
|
|
1542
|
-
|
|
1543
|
-
/** @returns {SuccessMessageResponse} */
|
|
1544
|
-
static SuccessMessageResponse() {
|
|
1545
|
-
return Joi.object({
|
|
1546
|
-
message: Joi.string().allow(""),
|
|
1547
|
-
});
|
|
1548
|
-
}
|
|
1549
|
-
|
|
1550
|
-
/** @returns {CompanyAboutAddress} */
|
|
1551
|
-
static CompanyAboutAddress() {
|
|
1552
|
-
return Joi.object({
|
|
1553
|
-
pincode: Joi.number(),
|
|
1554
|
-
address1: Joi.string().allow(""),
|
|
1555
|
-
address2: Joi.string().allow(""),
|
|
1556
|
-
city: Joi.string().allow(""),
|
|
1557
|
-
state: Joi.string().allow(""),
|
|
1558
|
-
country: Joi.string().allow(""),
|
|
1559
|
-
address_type: Joi.string().allow(""),
|
|
1560
|
-
});
|
|
1561
|
-
}
|
|
1562
|
-
|
|
1563
|
-
/** @returns {UserEmail} */
|
|
1564
|
-
static UserEmail() {
|
|
1565
|
-
return Joi.object({
|
|
1566
|
-
active: Joi.boolean(),
|
|
1567
|
-
primary: Joi.boolean(),
|
|
1568
|
-
verified: Joi.boolean(),
|
|
1569
|
-
email: Joi.string().allow(""),
|
|
1570
|
-
});
|
|
1571
|
-
}
|
|
1572
|
-
|
|
1573
|
-
/** @returns {UserPhoneNumber} */
|
|
1574
|
-
static UserPhoneNumber() {
|
|
1575
|
-
return Joi.object({
|
|
1576
|
-
active: Joi.boolean(),
|
|
1577
|
-
primary: Joi.boolean(),
|
|
1578
|
-
verified: Joi.boolean(),
|
|
1579
|
-
country_code: Joi.number(),
|
|
1580
|
-
phone: Joi.string().allow(""),
|
|
1581
|
-
});
|
|
1582
|
-
}
|
|
1583
|
-
|
|
1584
|
-
/** @returns {Page} */
|
|
1585
|
-
static Page() {
|
|
1586
|
-
return Joi.object({
|
|
1587
|
-
item_total: Joi.number(),
|
|
1588
|
-
next_id: Joi.string().allow(""),
|
|
1589
|
-
has_previous: Joi.boolean(),
|
|
1590
|
-
has_next: Joi.boolean(),
|
|
1591
|
-
current: Joi.number(),
|
|
1592
|
-
type: Joi.string().allow("").required(),
|
|
1593
|
-
size: Joi.number(),
|
|
1594
|
-
});
|
|
1595
|
-
}
|
|
1596
|
-
|
|
1597
|
-
/** @returns {ApplicationInformation} */
|
|
1598
|
-
static ApplicationInformation() {
|
|
1599
|
-
return Joi.object({
|
|
1600
|
-
address: ConfigurationApplicationModel.InformationAddress(),
|
|
1601
|
-
support: ConfigurationApplicationModel.InformationSupport(),
|
|
1602
|
-
social_links: ConfigurationApplicationModel.SocialLinks(),
|
|
1603
|
-
links: Joi.array().items(ConfigurationApplicationModel.Links()),
|
|
1604
|
-
copyright_text: Joi.string().allow(""),
|
|
1605
|
-
_id: Joi.string().allow(""),
|
|
1606
|
-
business_highlights: Joi.array().items(
|
|
1607
|
-
ConfigurationApplicationModel.BusinessHighlights()
|
|
1608
|
-
),
|
|
1609
|
-
application: Joi.string().allow(""),
|
|
1610
|
-
created_at: Joi.string().allow(""),
|
|
1611
|
-
modified_at: Joi.string().allow(""),
|
|
1612
|
-
__v: Joi.number(),
|
|
1613
|
-
});
|
|
1614
|
-
}
|
|
1615
|
-
|
|
1616
|
-
/** @returns {InformationAddress} */
|
|
1617
|
-
static InformationAddress() {
|
|
1618
|
-
return Joi.object({
|
|
1619
|
-
loc: ConfigurationApplicationModel.InformationLoc(),
|
|
1620
|
-
address_line: Joi.array().items(Joi.string().allow("")),
|
|
1621
|
-
phone: Joi.array().items(
|
|
1622
|
-
ConfigurationApplicationModel.InformationPhone()
|
|
1623
|
-
),
|
|
1624
|
-
city: Joi.string().allow(""),
|
|
1625
|
-
country: Joi.string().allow(""),
|
|
1626
|
-
pincode: Joi.number(),
|
|
1627
|
-
});
|
|
1628
|
-
}
|
|
1629
|
-
|
|
1630
|
-
/** @returns {InformationPhone} */
|
|
1631
|
-
static InformationPhone() {
|
|
1632
|
-
return Joi.object({
|
|
1633
|
-
code: Joi.string().allow(""),
|
|
1634
|
-
number: Joi.string().allow(""),
|
|
1635
|
-
});
|
|
1636
|
-
}
|
|
1637
|
-
|
|
1638
|
-
/** @returns {InformationSupportPhone} */
|
|
1639
|
-
static InformationSupportPhone() {
|
|
1640
|
-
return Joi.object({
|
|
1641
|
-
code: Joi.string().allow(""),
|
|
1642
|
-
number: Joi.string().allow(""),
|
|
1643
|
-
key: Joi.string().allow(""),
|
|
1644
|
-
});
|
|
1645
|
-
}
|
|
1646
|
-
|
|
1647
|
-
/** @returns {InformationSupportEmail} */
|
|
1648
|
-
static InformationSupportEmail() {
|
|
1649
|
-
return Joi.object({
|
|
1650
|
-
value: Joi.string().allow(""),
|
|
1651
|
-
key: Joi.string().allow(""),
|
|
1652
|
-
});
|
|
1653
|
-
}
|
|
1654
|
-
|
|
1655
|
-
/** @returns {InformationLoc} */
|
|
1656
|
-
static InformationLoc() {
|
|
1657
|
-
return Joi.object({
|
|
1658
|
-
type: Joi.string().allow(""),
|
|
1659
|
-
coordinates: Joi.array().items(Joi.number()),
|
|
1660
|
-
});
|
|
1661
|
-
}
|
|
1662
|
-
|
|
1663
|
-
/** @returns {InformationSupport} */
|
|
1664
|
-
static InformationSupport() {
|
|
1665
|
-
return Joi.object({
|
|
1666
|
-
phone: Joi.array().items(
|
|
1667
|
-
ConfigurationApplicationModel.InformationSupportPhone()
|
|
1668
|
-
),
|
|
1669
|
-
email: Joi.array().items(
|
|
1670
|
-
ConfigurationApplicationModel.InformationSupportEmail()
|
|
1671
|
-
),
|
|
1672
|
-
timing: Joi.string().allow(""),
|
|
1673
|
-
});
|
|
1674
|
-
}
|
|
1675
|
-
|
|
1676
|
-
/** @returns {SocialLinks} */
|
|
1677
|
-
static SocialLinks() {
|
|
1678
|
-
return Joi.object({
|
|
1679
|
-
facebook: ConfigurationApplicationModel.FacebookLink(),
|
|
1680
|
-
instagram: ConfigurationApplicationModel.InstagramLink(),
|
|
1681
|
-
twitter: ConfigurationApplicationModel.TwitterLink(),
|
|
1682
|
-
pinterest: ConfigurationApplicationModel.PinterestLink(),
|
|
1683
|
-
google_plus: ConfigurationApplicationModel.GooglePlusLink(),
|
|
1684
|
-
youtube: ConfigurationApplicationModel.YoutubeLink(),
|
|
1685
|
-
linked_in: ConfigurationApplicationModel.LinkedInLink(),
|
|
1686
|
-
vimeo: ConfigurationApplicationModel.VimeoLink(),
|
|
1687
|
-
blog_link: ConfigurationApplicationModel.BlogLink(),
|
|
1688
|
-
});
|
|
1689
|
-
}
|
|
1690
|
-
|
|
1691
|
-
/** @returns {FacebookLink} */
|
|
1692
|
-
static FacebookLink() {
|
|
1693
|
-
return Joi.object({
|
|
1694
|
-
title: Joi.string().allow(""),
|
|
1695
|
-
icon: Joi.string().allow(""),
|
|
1696
|
-
link: Joi.string().allow(""),
|
|
1697
|
-
});
|
|
1698
|
-
}
|
|
1699
|
-
|
|
1700
|
-
/** @returns {InstagramLink} */
|
|
1701
|
-
static InstagramLink() {
|
|
1702
|
-
return Joi.object({
|
|
1703
|
-
title: Joi.string().allow(""),
|
|
1704
|
-
icon: Joi.string().allow(""),
|
|
1705
|
-
link: Joi.string().allow(""),
|
|
1706
|
-
});
|
|
1707
|
-
}
|
|
1708
|
-
|
|
1709
|
-
/** @returns {TwitterLink} */
|
|
1710
|
-
static TwitterLink() {
|
|
1711
|
-
return Joi.object({
|
|
1712
|
-
title: Joi.string().allow(""),
|
|
1713
|
-
icon: Joi.string().allow(""),
|
|
1714
|
-
link: Joi.string().allow(""),
|
|
1715
|
-
});
|
|
1716
|
-
}
|
|
1717
|
-
|
|
1718
|
-
/** @returns {PinterestLink} */
|
|
1719
|
-
static PinterestLink() {
|
|
1720
|
-
return Joi.object({
|
|
1721
|
-
title: Joi.string().allow(""),
|
|
1722
|
-
icon: Joi.string().allow(""),
|
|
1723
|
-
link: Joi.string().allow(""),
|
|
1724
|
-
});
|
|
1725
|
-
}
|
|
1726
|
-
|
|
1727
|
-
/** @returns {GooglePlusLink} */
|
|
1728
|
-
static GooglePlusLink() {
|
|
1729
|
-
return Joi.object({
|
|
1730
|
-
title: Joi.string().allow(""),
|
|
1731
|
-
icon: Joi.string().allow(""),
|
|
1732
|
-
link: Joi.string().allow(""),
|
|
1733
|
-
});
|
|
1734
|
-
}
|
|
1735
|
-
|
|
1736
|
-
/** @returns {YoutubeLink} */
|
|
1737
|
-
static YoutubeLink() {
|
|
1738
|
-
return Joi.object({
|
|
1739
|
-
title: Joi.string().allow(""),
|
|
1740
|
-
icon: Joi.string().allow(""),
|
|
1741
|
-
link: Joi.string().allow(""),
|
|
1742
|
-
});
|
|
1743
|
-
}
|
|
1744
|
-
|
|
1745
|
-
/** @returns {LinkedInLink} */
|
|
1746
|
-
static LinkedInLink() {
|
|
1747
|
-
return Joi.object({
|
|
1748
|
-
title: Joi.string().allow(""),
|
|
1749
|
-
icon: Joi.string().allow(""),
|
|
1750
|
-
link: Joi.string().allow(""),
|
|
1751
|
-
});
|
|
1752
|
-
}
|
|
1753
|
-
|
|
1754
|
-
/** @returns {VimeoLink} */
|
|
1755
|
-
static VimeoLink() {
|
|
1756
|
-
return Joi.object({
|
|
1757
|
-
title: Joi.string().allow(""),
|
|
1758
|
-
icon: Joi.string().allow(""),
|
|
1759
|
-
link: Joi.string().allow(""),
|
|
1760
|
-
});
|
|
1761
|
-
}
|
|
1762
|
-
|
|
1763
|
-
/** @returns {BlogLink} */
|
|
1764
|
-
static BlogLink() {
|
|
1765
|
-
return Joi.object({
|
|
1766
|
-
title: Joi.string().allow(""),
|
|
1767
|
-
icon: Joi.string().allow(""),
|
|
1768
|
-
link: Joi.string().allow(""),
|
|
1769
|
-
});
|
|
1770
|
-
}
|
|
1771
|
-
|
|
1772
|
-
/** @returns {Links} */
|
|
1773
|
-
static Links() {
|
|
1774
|
-
return Joi.object({
|
|
1775
|
-
title: Joi.string().allow(""),
|
|
1776
|
-
link: Joi.string().allow(""),
|
|
1777
|
-
});
|
|
1778
|
-
}
|
|
1779
|
-
|
|
1780
|
-
/** @returns {BusinessHighlights} */
|
|
1781
|
-
static BusinessHighlights() {
|
|
1782
|
-
return Joi.object({
|
|
1783
|
-
_id: Joi.string().allow(""),
|
|
1784
|
-
title: Joi.string().allow(""),
|
|
1785
|
-
icon: Joi.string().allow(""),
|
|
1786
|
-
sub_title: Joi.string().allow(""),
|
|
1787
|
-
});
|
|
1788
|
-
}
|
|
1789
|
-
|
|
1790
|
-
/** @returns {ApplicationDetail} */
|
|
1791
|
-
static ApplicationDetail() {
|
|
1792
|
-
return Joi.object({
|
|
1793
|
-
name: Joi.string().allow("").required(),
|
|
1794
|
-
description: Joi.string().allow(""),
|
|
1795
|
-
logo: ConfigurationApplicationModel.SecureUrl(),
|
|
1796
|
-
mobile_logo: ConfigurationApplicationModel.SecureUrl(),
|
|
1797
|
-
favicon: ConfigurationApplicationModel.SecureUrl(),
|
|
1798
|
-
banner: ConfigurationApplicationModel.SecureUrl(),
|
|
1799
|
-
domain: ConfigurationApplicationModel.Domain(),
|
|
1800
|
-
domains: Joi.array().items(ConfigurationApplicationModel.Domain()),
|
|
1801
|
-
_id: Joi.string().allow(""),
|
|
1802
|
-
slug: Joi.string().allow(""),
|
|
1803
|
-
company_id: Joi.number(),
|
|
1804
|
-
});
|
|
1805
|
-
}
|
|
1806
|
-
|
|
1807
|
-
/** @returns {CurrenciesResponse} */
|
|
1808
|
-
static CurrenciesResponse() {
|
|
1809
|
-
return Joi.object({
|
|
1810
|
-
items: Joi.array().items(ConfigurationApplicationModel.Currency()),
|
|
1811
|
-
});
|
|
1812
|
-
}
|
|
1813
|
-
|
|
1814
|
-
/** @returns {DefaultCurrency} */
|
|
1815
|
-
static DefaultCurrency() {
|
|
1816
|
-
return Joi.object({
|
|
1817
|
-
ref: Joi.string().allow(""),
|
|
1818
|
-
code: Joi.string().allow(""),
|
|
1819
|
-
});
|
|
1820
|
-
}
|
|
1821
|
-
|
|
1822
|
-
/** @returns {AppCurrencyResponse} */
|
|
1823
|
-
static AppCurrencyResponse() {
|
|
1824
|
-
return Joi.object({
|
|
1825
|
-
application: Joi.string().allow(""),
|
|
1826
|
-
default_currency: ConfigurationApplicationModel.DefaultCurrency(),
|
|
1827
|
-
supported_currency: Joi.array().items(
|
|
1828
|
-
ConfigurationApplicationModel.Currency()
|
|
1829
|
-
),
|
|
1830
|
-
_id: Joi.string().allow(""),
|
|
1831
|
-
created_at: Joi.string().allow(""),
|
|
1832
|
-
modified_at: Joi.string().allow(""),
|
|
1833
|
-
});
|
|
1834
|
-
}
|
|
1835
|
-
|
|
1836
|
-
/** @returns {StoreLatLong} */
|
|
1837
|
-
static StoreLatLong() {
|
|
1838
|
-
return Joi.object({
|
|
1839
|
-
type: Joi.string().allow(""),
|
|
1840
|
-
coordinates: Joi.array().items(Joi.number()),
|
|
1841
|
-
});
|
|
1842
|
-
}
|
|
1843
|
-
|
|
1844
|
-
/** @returns {OptedStoreAddress} */
|
|
1845
|
-
static OptedStoreAddress() {
|
|
1846
|
-
return Joi.object({
|
|
1847
|
-
state: Joi.string().allow(""),
|
|
1848
|
-
address1: Joi.string().allow(""),
|
|
1849
|
-
lat_long: ConfigurationApplicationModel.StoreLatLong(),
|
|
1850
|
-
address2: Joi.string().allow(""),
|
|
1851
|
-
pincode: Joi.number(),
|
|
1852
|
-
country: Joi.string().allow(""),
|
|
1853
|
-
city: Joi.string().allow(""),
|
|
1854
|
-
});
|
|
1855
|
-
}
|
|
1856
|
-
|
|
1857
|
-
/** @returns {OrderingStore} */
|
|
1858
|
-
static OrderingStore() {
|
|
1859
|
-
return Joi.object({
|
|
1860
|
-
address: ConfigurationApplicationModel.OptedStoreAddress(),
|
|
1861
|
-
_id: Joi.string().allow(""),
|
|
1862
|
-
uid: Joi.number(),
|
|
1863
|
-
name: Joi.string().allow(""),
|
|
1864
|
-
display_name: Joi.string().allow(""),
|
|
1865
|
-
store_type: Joi.string().allow(""),
|
|
1866
|
-
store_code: Joi.string().allow(""),
|
|
1867
|
-
pincode: Joi.number(),
|
|
1868
|
-
code: Joi.string().allow(""),
|
|
1869
|
-
});
|
|
1870
|
-
}
|
|
1871
|
-
|
|
1872
|
-
/** @returns {OrderingStores} */
|
|
1873
|
-
static OrderingStores() {
|
|
1874
|
-
return Joi.object({
|
|
1875
|
-
page: ConfigurationApplicationModel.Page(),
|
|
1876
|
-
items: Joi.array().items(ConfigurationApplicationModel.OrderingStore()),
|
|
1877
|
-
deployed_stores: Joi.array().items(Joi.number()),
|
|
1878
|
-
all_stores: Joi.boolean(),
|
|
1879
|
-
enabled: Joi.boolean(),
|
|
1880
|
-
type: Joi.string().allow(""),
|
|
1881
|
-
_id: Joi.string().allow(""),
|
|
1882
|
-
app: Joi.string().allow(""),
|
|
1883
|
-
__v: Joi.number(),
|
|
1884
|
-
});
|
|
1885
|
-
}
|
|
1886
|
-
}
|
|
1887
|
-
module.exports = ConfigurationApplicationModel;
|