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