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