@gofynd/fdk-client-javascript 1.4.2-beta.4 → 1.4.2-beta.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (140) hide show
  1. package/README.md +1 -1
  2. package/package.json +1 -1
  3. package/sdk/application/Cart/CartApplicationClient.d.ts +62 -62
  4. package/sdk/application/Cart/CartApplicationClient.js +82 -71
  5. package/sdk/application/Cart/CartApplicationValidator.d.ts +189 -34
  6. package/sdk/application/Cart/CartApplicationValidator.js +59 -34
  7. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +78 -78
  8. package/sdk/application/Catalog/CatalogApplicationClient.js +78 -78
  9. package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
  10. package/sdk/application/Common/CommonApplicationClient.js +4 -4
  11. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +6 -6
  12. package/sdk/application/Communication/CommunicationApplicationClient.js +6 -6
  13. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +32 -67
  14. package/sdk/application/Configuration/ConfigurationApplicationClient.js +32 -106
  15. package/sdk/application/Content/ContentApplicationClient.d.ts +34 -64
  16. package/sdk/application/Content/ContentApplicationClient.js +34 -115
  17. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +6 -42
  18. package/sdk/application/FileStorage/FileStorageApplicationClient.js +6 -42
  19. package/sdk/application/Lead/LeadApplicationClient.d.ts +14 -14
  20. package/sdk/application/Lead/LeadApplicationClient.js +14 -14
  21. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +12 -12
  22. package/sdk/application/Logistic/LogisticApplicationClient.js +12 -12
  23. package/sdk/application/Order/OrderApplicationClient.d.ts +24 -24
  24. package/sdk/application/Order/OrderApplicationClient.js +24 -24
  25. package/sdk/application/Order/OrderApplicationModel.d.ts +23 -1
  26. package/sdk/application/Order/OrderApplicationModel.js +28 -0
  27. package/sdk/application/Payment/PaymentApplicationClient.d.ts +89 -89
  28. package/sdk/application/Payment/PaymentApplicationClient.js +94 -94
  29. package/sdk/application/Payment/PaymentApplicationModel.d.ts +498 -3
  30. package/sdk/application/Payment/PaymentApplicationModel.js +316 -2
  31. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +5 -5
  32. package/sdk/application/Payment/PaymentApplicationValidator.js +3 -3
  33. package/sdk/application/PosCart/PosCartApplicationClient.d.ts +54 -54
  34. package/sdk/application/PosCart/PosCartApplicationClient.js +54 -54
  35. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +14 -25
  36. package/sdk/application/Rewards/RewardsApplicationClient.js +14 -41
  37. package/sdk/application/Share/ShareApplicationClient.d.ts +14 -14
  38. package/sdk/application/Share/ShareApplicationClient.js +14 -14
  39. package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -8
  40. package/sdk/application/Theme/ThemeApplicationClient.js +8 -8
  41. package/sdk/application/User/UserApplicationClient.d.ts +64 -64
  42. package/sdk/application/User/UserApplicationClient.js +64 -64
  43. package/sdk/partner/Theme/ThemePartnerClient.d.ts +38 -38
  44. package/sdk/partner/Theme/ThemePartnerClient.js +38 -38
  45. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +8 -8
  46. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +8 -8
  47. package/sdk/platform/Billing/BillingPlatformClient.d.ts +34 -36
  48. package/sdk/platform/Billing/BillingPlatformClient.js +34 -36
  49. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +98 -175
  50. package/sdk/platform/Cart/CartPlatformApplicationClient.js +98 -254
  51. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +92 -18
  52. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +28 -18
  53. package/sdk/platform/Cart/CartPlatformModel.d.ts +12 -0
  54. package/sdk/platform/Cart/CartPlatformModel.js +12 -0
  55. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +195 -108
  56. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +278 -113
  57. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +2 -2
  58. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +2 -2
  59. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +335 -136
  60. package/sdk/platform/Catalog/CatalogPlatformClient.js +551 -136
  61. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +5 -5
  62. package/sdk/platform/Catalog/CatalogPlatformModel.js +3 -3
  63. package/sdk/platform/Common/CommonPlatformClient.d.ts +3 -3
  64. package/sdk/platform/Common/CommonPlatformClient.js +3 -3
  65. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +115 -290
  66. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +115 -510
  67. package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +2 -13
  68. package/sdk/platform/Communication/CommunicationPlatformClient.js +2 -29
  69. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +32 -32
  70. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +32 -32
  71. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +52 -127
  72. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +52 -204
  73. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +35 -111
  74. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +35 -212
  75. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +142 -1
  76. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +96 -0
  77. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +130 -218
  78. package/sdk/platform/Content/ContentPlatformApplicationClient.js +136 -314
  79. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +4 -4
  80. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +4 -4
  81. package/sdk/platform/Content/ContentPlatformClient.d.ts +1 -1
  82. package/sdk/platform/Content/ContentPlatformClient.js +7 -7
  83. package/sdk/platform/Content/ContentPlatformValidator.d.ts +4 -4
  84. package/sdk/platform/Content/ContentPlatformValidator.js +4 -4
  85. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +22 -48
  86. package/sdk/platform/Discount/DiscountPlatformClient.js +22 -73
  87. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +19 -55
  88. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +19 -55
  89. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +14 -50
  90. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +16 -55
  91. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +13 -12
  92. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +12 -14
  93. package/sdk/platform/Finance/FinancePlatformClient.d.ts +44 -44
  94. package/sdk/platform/Finance/FinancePlatformClient.js +44 -44
  95. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +12 -12
  96. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +12 -12
  97. package/sdk/platform/Lead/LeadPlatformClient.d.ts +22 -48
  98. package/sdk/platform/Lead/LeadPlatformClient.js +22 -72
  99. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +4 -4
  100. package/sdk/platform/Order/OrderPlatformApplicationClient.js +4 -4
  101. package/sdk/platform/Order/OrderPlatformClient.d.ts +79 -208
  102. package/sdk/platform/Order/OrderPlatformClient.js +79 -294
  103. package/sdk/platform/Order/OrderPlatformModel.d.ts +32 -3
  104. package/sdk/platform/Order/OrderPlatformModel.js +34 -2
  105. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -4
  106. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +4 -4
  107. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +4 -4
  108. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +2 -2
  109. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +81 -81
  110. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +81 -81
  111. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
  112. package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
  113. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +23 -40
  114. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +23 -61
  115. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +8 -8
  116. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +8 -8
  117. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +5 -5
  118. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +8 -8
  119. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +2 -2
  120. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +2 -2
  121. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +10 -10
  122. package/sdk/platform/Share/SharePlatformApplicationClient.js +10 -10
  123. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +56 -56
  124. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +56 -56
  125. package/sdk/platform/Theme/ThemePlatformClient.d.ts +6 -6
  126. package/sdk/platform/Theme/ThemePlatformClient.js +6 -6
  127. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +33 -33
  128. package/sdk/platform/User/UserPlatformApplicationClient.js +33 -33
  129. package/sdk/platform/User/UserPlatformModel.d.ts +2 -2
  130. package/sdk/platform/User/UserPlatformModel.js +2 -2
  131. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +32 -45
  132. package/sdk/platform/Webhook/WebhookPlatformClient.js +32 -45
  133. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +58 -1
  134. package/sdk/platform/Webhook/WebhookPlatformModel.js +66 -0
  135. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +2 -2
  136. package/sdk/public/Configuration/ConfigurationPublicClient.js +2 -2
  137. package/sdk/public/Partner/PartnerPublicClient.d.ts +2 -2
  138. package/sdk/public/Partner/PartnerPublicClient.js +2 -2
  139. package/sdk/public/Webhook/WebhookPublicClient.d.ts +4 -4
  140. package/sdk/public/Webhook/WebhookPublicClient.js +4 -4
@@ -29,8 +29,8 @@ declare class Configuration {
29
29
  * @returns {Promise<ConfigurationApplicationModel.AppCurrencyResponse>} -
30
30
  * Success response
31
31
  * @name getAppCurrencies
32
- * @summary: Get currencies enabled in the application
33
- * @description: Use this API to get a list of currencies allowed in the current application. Moreover, get the name, code, symbol, and the decimal digits of the currencies. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getAppCurrencies/).
32
+ * @summary: Retrieves app-specific currencies.
33
+ * @description: Retrieve a list of currencies allowed in the current application. Moreover, get the name, code, symbol, and the decimal digits of the currencies. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getAppCurrencies/).
34
34
  */
35
35
  getAppCurrencies({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationApplicationModel.AppCurrencyResponse>;
36
36
  /**
@@ -40,31 +40,10 @@ declare class Configuration {
40
40
  * @returns {Promise<ConfigurationApplicationModel.AppStaffListResponse>} -
41
41
  * Success response
42
42
  * @name getAppStaffList
43
- * @summary: Get a list of staff.
44
- * @description: Use this API to get a list of staff including the names, employee code, incentive status, assigned ordering stores, and title of each staff added to the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getAppStaffList/).
43
+ * @summary: Lists app staff members.
44
+ * @description: Retrieve a list of staff including the names, employee code, incentive status, assigned ordering stores, and title of each staff added to the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getAppStaffList/).
45
45
  */
46
46
  getAppStaffList({ pageNo, pageSize, orderIncent, orderingStore, user, userName, requestHeaders, }?: ConfigurationApplicationValidator.GetAppStaffListParam, { responseHeaders }?: object): Promise<ConfigurationApplicationModel.AppStaffListResponse>;
47
- /**
48
- * @param {Object} arg - Arg object.
49
- * @param {number} [arg.pageSize] -
50
- * @param {boolean} [arg.orderIncent] - This is a boolean value. Select
51
- * `true` to retrieve the staff members eligible for getting incentives on orders.
52
- * @param {number} [arg.orderingStore] - ID of the ordering store. Helps in
53
- * retrieving staff members working at a particular ordering store.
54
- * @param {string} [arg.user] - Mongo ID of the staff. Helps in retrieving
55
- * the details of a particular staff member.
56
- * @param {string} [arg.userName] - User name of the member
57
- * @returns {Paginator<ConfigurationApplicationModel.AppStaffListResponse>}
58
- * @summary: Get a list of staff.
59
- * @description: Use this API to get a list of staff including the names, employee code, incentive status, assigned ordering stores, and title of each staff added to the application.
60
- */
61
- getAppStaffListPaginator({ pageSize, orderIncent, orderingStore, user, userName, }?: {
62
- pageSize?: number;
63
- orderIncent?: boolean;
64
- orderingStore?: number;
65
- user?: string;
66
- userName?: string;
67
- }): Paginator<ConfigurationApplicationModel.AppStaffListResponse>;
68
47
  /**
69
48
  * @param {ConfigurationApplicationValidator.GetAppStaffsParam} arg - Arg object.
70
49
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -72,8 +51,8 @@ declare class Configuration {
72
51
  * @returns {Promise<ConfigurationApplicationModel.AppStaffResponse>} -
73
52
  * Success response
74
53
  * @name getAppStaffs
75
- * @summary: Get a list of staff.
76
- * @description: Use this API to get a list of staff including the names, employee code, incentive status, assigned ordering stores, and title of each staff added to the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getAppStaffs/).
54
+ * @summary: Fetches detailed staff info.
55
+ * @description: Retrieve a list of staff including the names, employee code, incentive status, assigned ordering stores, and title of each staff added to the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getAppStaffs/).
77
56
  */
78
57
  getAppStaffs({ orderIncent, orderingStore, user, requestHeaders }?: ConfigurationApplicationValidator.GetAppStaffsParam, { responseHeaders }?: object): Promise<ConfigurationApplicationModel.AppStaffResponse>;
79
58
  /**
@@ -82,8 +61,8 @@ declare class Configuration {
82
61
  * @param {import("../ApplicationAPIClient").Options} - Options
83
62
  * @returns {Promise<ConfigurationApplicationModel.Application>} - Success response
84
63
  * @name getApplication
85
- * @summary: Get current sales channel details
86
- * @description: Use this API to get the current sales channel details which includes configurations that indicate the status of the website, domain, ID, tokens, images, etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getApplication/).
64
+ * @summary: Fetches application details.
65
+ * @description: Retrieve the current sales channel details which includes configurations that indicate the status of the website, domain, ID, tokens, images, etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getApplication/).
87
66
  */
88
67
  getApplication({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationApplicationModel.Application>;
89
68
  /**
@@ -93,8 +72,8 @@ declare class Configuration {
93
72
  * @returns {Promise<ConfigurationApplicationModel.ApplicationDetail>} -
94
73
  * Success response
95
74
  * @name getBasicDetails
96
- * @summary: Get basic details of the application
97
- * @description: Use this API to retrieve only the basic details of the application which includes channel name, description, banner, logo, favicon, domain details, etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getBasicDetails/).
75
+ * @summary: Retrieves basic app info.
76
+ * @description: Retrieve only the basic details of the application which includes channel name, description, banner, logo, favicon, domain details, etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getBasicDetails/).
98
77
  */
99
78
  getBasicDetails({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationApplicationModel.ApplicationDetail>;
100
79
  /**
@@ -105,8 +84,8 @@ declare class Configuration {
105
84
  * - Success response
106
85
  *
107
86
  * @name getContactInfo
108
- * @summary: Get application information
109
- * @description: Use this API to retrieve information about the social links, address and contact information of the company/seller/brand operating the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getContactInfo/).
87
+ * @summary: Retrieves contact details.
88
+ * @description: Retrieve information about the social links, address and contact information of the company/seller/brand operating the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getContactInfo/).
110
89
  */
111
90
  getContactInfo({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationApplicationModel.ApplicationInformation>;
112
91
  /**
@@ -116,8 +95,8 @@ declare class Configuration {
116
95
  * @returns {Promise<ConfigurationApplicationModel.CurrenciesResponse>} -
117
96
  * Success response
118
97
  * @name getCurrencies
119
- * @summary: Get all currencies list
120
- * @description: Use this API to get a list of currencies available. Moreover, get the name, code, symbol, and the decimal digits of the currencies. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getCurrencies/).
98
+ * @summary: Lists supported currencies.
99
+ * @description: Retrieve a list of currencies available. Also get the name, code, symbol, and the decimal digits of the currencies. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getCurrencies/).
121
100
  */
122
101
  getCurrencies({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationApplicationModel.CurrenciesResponse>;
123
102
  /**
@@ -126,8 +105,8 @@ declare class Configuration {
126
105
  * @param {import("../ApplicationAPIClient").Options} - Options
127
106
  * @returns {Promise<ConfigurationApplicationModel.Currency>} - Success response
128
107
  * @name getCurrencyById
129
- * @summary: Get currency by its ID
130
- * @description: Use this API to retrieve a currency using its ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getCurrencyById/).
108
+ * @summary: Fetches currency by ID.
109
+ * @description: Retrieve details of a specific currency using its ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getCurrencyById/).
131
110
  */
132
111
  getCurrencyById({ id, requestHeaders }?: ConfigurationApplicationValidator.GetCurrencyByIdParam, { responseHeaders }?: object): Promise<ConfigurationApplicationModel.Currency>;
133
112
  /**
@@ -137,8 +116,8 @@ declare class Configuration {
137
116
  * @returns {Promise<ConfigurationApplicationModel.AppFeatureResponse>} -
138
117
  * Success response
139
118
  * @name getFeatures
140
- * @summary: Get features of application
141
- * @description: Use this API to retrieve the configuration of features such as product detail, landing page, options in the login/registration screen, communication opt-in, cart options and many more. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getFeatures/).
119
+ * @summary: Fetches app features.
120
+ * @description: Retrieve the configuration of features such as product detail, landing page, options in the login/registration screen, communication opt-in, cart options and many more. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getFeatures/).
142
121
  */
143
122
  getFeatures({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationApplicationModel.AppFeatureResponse>;
144
123
  /**
@@ -150,8 +129,8 @@ declare class Configuration {
150
129
  * @returns {Promise<ConfigurationApplicationModel.AppTokenResponse>} -
151
130
  * Success response
152
131
  * @name getIntegrationTokens
153
- * @summary: Get integration tokens
154
- * @description: Use this API to retrieve the tokens used while integrating Firebase, MoEngage, Segment, GTM, Freshchat, Safetynet, Google Map and Facebook. **Note** - Token values are encrypted with AES encryption using a secret key. Kindly reach out to the developers for obtaining the secret key. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getIntegrationTokens/).
132
+ * @summary: Fetches API tokens.
133
+ * @description: Retrieve the tokens used while integrating Firebase, MoEngage, Segment, GTM, Freshchat, Safetynet, Google Map and Facebook. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getIntegrationTokens/).
155
134
  */
156
135
  getIntegrationTokens({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationApplicationModel.AppTokenResponse>;
157
136
  /**
@@ -161,8 +140,8 @@ declare class Configuration {
161
140
  * @returns {Promise<ConfigurationApplicationModel.LanguageResponse>} -
162
141
  * Success response
163
142
  * @name getLanguages
164
- * @summary: Get list of languages
165
- * @description: Use this API to get a list of languages supported in the application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getLanguages/).
143
+ * @summary: Lists available languages.
144
+ * @description: Retrieves all languages supported by the app. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getLanguages/).
166
145
  */
167
146
  getLanguages({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationApplicationModel.LanguageResponse>;
168
147
  /**
@@ -175,8 +154,8 @@ declare class Configuration {
175
154
  * - Success response
176
155
  *
177
156
  * @name getOrderingStoreCookie
178
- * @summary: Get an Ordering Store signed cookie on selection of ordering store.
179
- * @description: Use this API to get an Ordering Store signed cookie upon selecting an ordering store. This will be used by the cart service to verify a coupon against the selected ordering store in cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getOrderingStoreCookie/).
157
+ * @summary: Retrieves store selection cookie.
158
+ * @description: Retrieve an Ordering Store signed cookie upon selecting an ordering store. This will be used by the cart service to verify a coupon against the selected ordering store in cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getOrderingStoreCookie/).
180
159
  */
181
160
  getOrderingStoreCookie({ body, requestHeaders }?: ConfigurationApplicationValidator.GetOrderingStoreCookieParam, { responseHeaders }?: object): Promise<ConfigurationApplicationModel.SuccessMessageResponse>;
182
161
  /**
@@ -185,23 +164,10 @@ declare class Configuration {
185
164
  * @param {import("../ApplicationAPIClient").Options} - Options
186
165
  * @returns {Promise<ConfigurationApplicationModel.OrderingStores>} - Success response
187
166
  * @name getOrderingStores
188
- * @summary: Get all deployment stores
189
- * @description: Use this API to retrieve the details of all the deployment stores (the selling locations where the application will be utilized for placing orders). - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getOrderingStores/).
167
+ * @summary: Lists order-enabled stores.
168
+ * @description: Retrieve the details of all the deployment stores (the selling locations where the application will be utilized for placing orders). - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getOrderingStores/).
190
169
  */
191
170
  getOrderingStores({ pageNo, pageSize, q, requestHeaders }?: ConfigurationApplicationValidator.GetOrderingStoresParam, { responseHeaders }?: object): Promise<ConfigurationApplicationModel.OrderingStores>;
192
- /**
193
- * @param {Object} arg - Arg object.
194
- * @param {number} [arg.pageSize] - The number of items to retrieve in each
195
- * page. Default value is 10.
196
- * @param {string} [arg.q] - Store code or name of the ordering store.
197
- * @returns {Paginator<ConfigurationApplicationModel.OrderingStores>}
198
- * @summary: Get all deployment stores
199
- * @description: Use this API to retrieve the details of all the deployment stores (the selling locations where the application will be utilized for placing orders).
200
- */
201
- getOrderingStoresPaginator({ pageSize, q }?: {
202
- pageSize?: number;
203
- q?: string;
204
- }): Paginator<ConfigurationApplicationModel.OrderingStores>;
205
171
  /**
206
172
  * @param {ConfigurationApplicationValidator.GetOwnerInfoParam} arg - Arg object.
207
173
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -210,8 +176,8 @@ declare class Configuration {
210
176
  * - Success response
211
177
  *
212
178
  * @name getOwnerInfo
213
- * @summary: Get sales channel, owner and seller information
214
- * @description: Use this API to get the current sales channel details which includes channel name, description, banner, logo, favicon, domain details, etc. This API also retrieves the seller and owner information such as address, email address, and phone number. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getOwnerInfo/).
179
+ * @summary: Retrieves application owner details.
180
+ * @description: Retrieve the current sales channel details which includes channel name, description, banner, logo, favicon, domain details, etc. Also retrieves the seller and owner information such as address, email address, and phone number. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getOwnerInfo/).
215
181
  */
216
182
  getOwnerInfo({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationApplicationModel.ApplicationAboutResponse>;
217
183
  /**
@@ -221,8 +187,8 @@ declare class Configuration {
221
187
  * @param {import("../ApplicationAPIClient").Options} - Options
222
188
  * @returns {Promise<ConfigurationApplicationModel.OrderingStore>} - Success response
223
189
  * @name getStoreDetailById
224
- * @summary: Get ordering store details
225
- * @description: Use this API to retrieve the details of given stores uid (the selling locations where the application will be utilized for placing orders). - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getStoreDetailById/).
190
+ * @summary: Retrieves store details by ID.
191
+ * @description: Retrieve the details of given stores uid (the selling locations where the application will be utilized for placing orders). - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getStoreDetailById/).
226
192
  */
227
193
  getStoreDetailById({ storeId, requestHeaders }?: ConfigurationApplicationValidator.GetStoreDetailByIdParam, { responseHeaders }?: object): Promise<ConfigurationApplicationModel.OrderingStore>;
228
194
  /**
@@ -235,11 +201,10 @@ declare class Configuration {
235
201
  * - Success response
236
202
  *
237
203
  * @name removeOrderingStoreCookie
238
- * @summary: Unset the Ordering Store signed cookie.
239
- * @description: Use this API to unset the Ordering Store cookie upon changing the sales channel, by its domain URL, in the Universal Fynd Store app. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/removeOrderingStoreCookie/).
204
+ * @summary: Deletes store cookie.
205
+ * @description: Unset the Ordering Store cookie upon changing the sales channel, by its domain URL, in the Universal Fynd Store app. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/removeOrderingStoreCookie/).
240
206
  */
241
207
  removeOrderingStoreCookie({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationApplicationModel.SuccessMessageResponse>;
242
208
  }
243
209
  import ConfigurationApplicationModel = require("./ConfigurationApplicationModel");
244
210
  import ConfigurationApplicationValidator = require("./ConfigurationApplicationValidator");
245
- import Paginator = require("../../common/Paginator");
@@ -58,8 +58,8 @@ class Configuration {
58
58
  * @returns {Promise<ConfigurationApplicationModel.AppCurrencyResponse>} -
59
59
  * Success response
60
60
  * @name getAppCurrencies
61
- * @summary: Get currencies enabled in the application
62
- * @description: Use this API to get a list of currencies allowed in the current application. Moreover, get the name, code, symbol, and the decimal digits of the currencies. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getAppCurrencies/).
61
+ * @summary: Retrieves app-specific currencies.
62
+ * @description: Retrieve a list of currencies allowed in the current application. Moreover, get the name, code, symbol, and the decimal digits of the currencies. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getAppCurrencies/).
63
63
  */
64
64
  async getAppCurrencies(
65
65
  { requestHeaders } = { requestHeaders: {} },
@@ -139,8 +139,8 @@ class Configuration {
139
139
  * @returns {Promise<ConfigurationApplicationModel.AppStaffListResponse>} -
140
140
  * Success response
141
141
  * @name getAppStaffList
142
- * @summary: Get a list of staff.
143
- * @description: Use this API to get a list of staff including the names, employee code, incentive status, assigned ordering stores, and title of each staff added to the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getAppStaffList/).
142
+ * @summary: Lists app staff members.
143
+ * @description: Retrieve a list of staff including the names, employee code, incentive status, assigned ordering stores, and title of each staff added to the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getAppStaffList/).
144
144
  */
145
145
  async getAppStaffList(
146
146
  {
@@ -227,50 +227,6 @@ class Configuration {
227
227
  return response;
228
228
  }
229
229
 
230
- /**
231
- * @param {Object} arg - Arg object.
232
- * @param {number} [arg.pageSize] -
233
- * @param {boolean} [arg.orderIncent] - This is a boolean value. Select
234
- * `true` to retrieve the staff members eligible for getting incentives on orders.
235
- * @param {number} [arg.orderingStore] - ID of the ordering store. Helps in
236
- * retrieving staff members working at a particular ordering store.
237
- * @param {string} [arg.user] - Mongo ID of the staff. Helps in retrieving
238
- * the details of a particular staff member.
239
- * @param {string} [arg.userName] - User name of the member
240
- * @returns {Paginator<ConfigurationApplicationModel.AppStaffListResponse>}
241
- * @summary: Get a list of staff.
242
- * @description: Use this API to get a list of staff including the names, employee code, incentive status, assigned ordering stores, and title of each staff added to the application.
243
- */
244
- getAppStaffListPaginator({
245
- pageSize,
246
- orderIncent,
247
- orderingStore,
248
- user,
249
- userName,
250
- } = {}) {
251
- const paginator = new Paginator();
252
- const callback = async () => {
253
- const pageId = paginator.nextId;
254
- const pageNo = paginator.pageNo;
255
- const pageType = "number";
256
- const data = await this.getAppStaffList({
257
- pageNo: pageNo,
258
- pageSize: pageSize,
259
- orderIncent: orderIncent,
260
- orderingStore: orderingStore,
261
- user: user,
262
- userName: userName,
263
- });
264
- paginator.setPaginator({
265
- hasNext: data.page.has_next ? true : false,
266
- nextId: data.page.next_id,
267
- });
268
- return data;
269
- };
270
- paginator.setCallback(callback.bind(this));
271
- return paginator;
272
- }
273
-
274
230
  /**
275
231
  * @param {ConfigurationApplicationValidator.GetAppStaffsParam} arg - Arg object.
276
232
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -278,8 +234,8 @@ class Configuration {
278
234
  * @returns {Promise<ConfigurationApplicationModel.AppStaffResponse>} -
279
235
  * Success response
280
236
  * @name getAppStaffs
281
- * @summary: Get a list of staff.
282
- * @description: Use this API to get a list of staff including the names, employee code, incentive status, assigned ordering stores, and title of each staff added to the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getAppStaffs/).
237
+ * @summary: Fetches detailed staff info.
238
+ * @description: Retrieve a list of staff including the names, employee code, incentive status, assigned ordering stores, and title of each staff added to the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getAppStaffs/).
283
239
  */
284
240
  async getAppStaffs(
285
241
  { orderIncent, orderingStore, user, requestHeaders } = {
@@ -361,8 +317,8 @@ class Configuration {
361
317
  * @param {import("../ApplicationAPIClient").Options} - Options
362
318
  * @returns {Promise<ConfigurationApplicationModel.Application>} - Success response
363
319
  * @name getApplication
364
- * @summary: Get current sales channel details
365
- * @description: Use this API to get the current sales channel details which includes configurations that indicate the status of the website, domain, ID, tokens, images, etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getApplication/).
320
+ * @summary: Fetches application details.
321
+ * @description: Retrieve the current sales channel details which includes configurations that indicate the status of the website, domain, ID, tokens, images, etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getApplication/).
366
322
  */
367
323
  async getApplication(
368
324
  { requestHeaders } = { requestHeaders: {} },
@@ -442,8 +398,8 @@ class Configuration {
442
398
  * @returns {Promise<ConfigurationApplicationModel.ApplicationDetail>} -
443
399
  * Success response
444
400
  * @name getBasicDetails
445
- * @summary: Get basic details of the application
446
- * @description: Use this API to retrieve only the basic details of the application which includes channel name, description, banner, logo, favicon, domain details, etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getBasicDetails/).
401
+ * @summary: Retrieves basic app info.
402
+ * @description: Retrieve only the basic details of the application which includes channel name, description, banner, logo, favicon, domain details, etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getBasicDetails/).
447
403
  */
448
404
  async getBasicDetails(
449
405
  { requestHeaders } = { requestHeaders: {} },
@@ -524,8 +480,8 @@ class Configuration {
524
480
  * - Success response
525
481
  *
526
482
  * @name getContactInfo
527
- * @summary: Get application information
528
- * @description: Use this API to retrieve information about the social links, address and contact information of the company/seller/brand operating the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getContactInfo/).
483
+ * @summary: Retrieves contact details.
484
+ * @description: Retrieve information about the social links, address and contact information of the company/seller/brand operating the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getContactInfo/).
529
485
  */
530
486
  async getContactInfo(
531
487
  { requestHeaders } = { requestHeaders: {} },
@@ -605,8 +561,8 @@ class Configuration {
605
561
  * @returns {Promise<ConfigurationApplicationModel.CurrenciesResponse>} -
606
562
  * Success response
607
563
  * @name getCurrencies
608
- * @summary: Get all currencies list
609
- * @description: Use this API to get a list of currencies available. Moreover, get the name, code, symbol, and the decimal digits of the currencies. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getCurrencies/).
564
+ * @summary: Lists supported currencies.
565
+ * @description: Retrieve a list of currencies available. Also get the name, code, symbol, and the decimal digits of the currencies. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getCurrencies/).
610
566
  */
611
567
  async getCurrencies(
612
568
  { requestHeaders } = { requestHeaders: {} },
@@ -685,8 +641,8 @@ class Configuration {
685
641
  * @param {import("../ApplicationAPIClient").Options} - Options
686
642
  * @returns {Promise<ConfigurationApplicationModel.Currency>} - Success response
687
643
  * @name getCurrencyById
688
- * @summary: Get currency by its ID
689
- * @description: Use this API to retrieve a currency using its ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getCurrencyById/).
644
+ * @summary: Fetches currency by ID.
645
+ * @description: Retrieve details of a specific currency using its ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getCurrencyById/).
690
646
  */
691
647
  async getCurrencyById(
692
648
  { id, requestHeaders } = { requestHeaders: {} },
@@ -766,8 +722,8 @@ class Configuration {
766
722
  * @returns {Promise<ConfigurationApplicationModel.AppFeatureResponse>} -
767
723
  * Success response
768
724
  * @name getFeatures
769
- * @summary: Get features of application
770
- * @description: Use this API to retrieve the configuration of features such as product detail, landing page, options in the login/registration screen, communication opt-in, cart options and many more. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getFeatures/).
725
+ * @summary: Fetches app features.
726
+ * @description: Retrieve the configuration of features such as product detail, landing page, options in the login/registration screen, communication opt-in, cart options and many more. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getFeatures/).
771
727
  */
772
728
  async getFeatures(
773
729
  { requestHeaders } = { requestHeaders: {} },
@@ -847,8 +803,8 @@ class Configuration {
847
803
  * @returns {Promise<ConfigurationApplicationModel.AppTokenResponse>} -
848
804
  * Success response
849
805
  * @name getIntegrationTokens
850
- * @summary: Get integration tokens
851
- * @description: Use this API to retrieve the tokens used while integrating Firebase, MoEngage, Segment, GTM, Freshchat, Safetynet, Google Map and Facebook. **Note** - Token values are encrypted with AES encryption using a secret key. Kindly reach out to the developers for obtaining the secret key. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getIntegrationTokens/).
806
+ * @summary: Fetches API tokens.
807
+ * @description: Retrieve the tokens used while integrating Firebase, MoEngage, Segment, GTM, Freshchat, Safetynet, Google Map and Facebook. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getIntegrationTokens/).
852
808
  */
853
809
  async getIntegrationTokens(
854
810
  { requestHeaders } = { requestHeaders: {} },
@@ -928,8 +884,8 @@ class Configuration {
928
884
  * @returns {Promise<ConfigurationApplicationModel.LanguageResponse>} -
929
885
  * Success response
930
886
  * @name getLanguages
931
- * @summary: Get list of languages
932
- * @description: Use this API to get a list of languages supported in the application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getLanguages/).
887
+ * @summary: Lists available languages.
888
+ * @description: Retrieves all languages supported by the app. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getLanguages/).
933
889
  */
934
890
  async getLanguages(
935
891
  { requestHeaders } = { requestHeaders: {} },
@@ -1010,8 +966,8 @@ class Configuration {
1010
966
  * - Success response
1011
967
  *
1012
968
  * @name getOrderingStoreCookie
1013
- * @summary: Get an Ordering Store signed cookie on selection of ordering store.
1014
- * @description: Use this API to get an Ordering Store signed cookie upon selecting an ordering store. This will be used by the cart service to verify a coupon against the selected ordering store in cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getOrderingStoreCookie/).
969
+ * @summary: Retrieves store selection cookie.
970
+ * @description: Retrieve an Ordering Store signed cookie upon selecting an ordering store. This will be used by the cart service to verify a coupon against the selected ordering store in cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getOrderingStoreCookie/).
1015
971
  */
1016
972
  async getOrderingStoreCookie(
1017
973
  { body, requestHeaders } = { requestHeaders: {} },
@@ -1090,8 +1046,8 @@ class Configuration {
1090
1046
  * @param {import("../ApplicationAPIClient").Options} - Options
1091
1047
  * @returns {Promise<ConfigurationApplicationModel.OrderingStores>} - Success response
1092
1048
  * @name getOrderingStores
1093
- * @summary: Get all deployment stores
1094
- * @description: Use this API to retrieve the details of all the deployment stores (the selling locations where the application will be utilized for placing orders). - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getOrderingStores/).
1049
+ * @summary: Lists order-enabled stores.
1050
+ * @description: Retrieve the details of all the deployment stores (the selling locations where the application will be utilized for placing orders). - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getOrderingStores/).
1095
1051
  */
1096
1052
  async getOrderingStores(
1097
1053
  { pageNo, pageSize, q, requestHeaders } = { requestHeaders: {} },
@@ -1167,36 +1123,6 @@ class Configuration {
1167
1123
  return response;
1168
1124
  }
1169
1125
 
1170
- /**
1171
- * @param {Object} arg - Arg object.
1172
- * @param {number} [arg.pageSize] - The number of items to retrieve in each
1173
- * page. Default value is 10.
1174
- * @param {string} [arg.q] - Store code or name of the ordering store.
1175
- * @returns {Paginator<ConfigurationApplicationModel.OrderingStores>}
1176
- * @summary: Get all deployment stores
1177
- * @description: Use this API to retrieve the details of all the deployment stores (the selling locations where the application will be utilized for placing orders).
1178
- */
1179
- getOrderingStoresPaginator({ pageSize, q } = {}) {
1180
- const paginator = new Paginator();
1181
- const callback = async () => {
1182
- const pageId = paginator.nextId;
1183
- const pageNo = paginator.pageNo;
1184
- const pageType = "number";
1185
- const data = await this.getOrderingStores({
1186
- pageNo: pageNo,
1187
- pageSize: pageSize,
1188
- q: q,
1189
- });
1190
- paginator.setPaginator({
1191
- hasNext: data.page.has_next ? true : false,
1192
- nextId: data.page.next_id,
1193
- });
1194
- return data;
1195
- };
1196
- paginator.setCallback(callback.bind(this));
1197
- return paginator;
1198
- }
1199
-
1200
1126
  /**
1201
1127
  * @param {ConfigurationApplicationValidator.GetOwnerInfoParam} arg - Arg object.
1202
1128
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -1205,8 +1131,8 @@ class Configuration {
1205
1131
  * - Success response
1206
1132
  *
1207
1133
  * @name getOwnerInfo
1208
- * @summary: Get sales channel, owner and seller information
1209
- * @description: Use this API to get the current sales channel details which includes channel name, description, banner, logo, favicon, domain details, etc. This API also retrieves the seller and owner information such as address, email address, and phone number. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getOwnerInfo/).
1134
+ * @summary: Retrieves application owner details.
1135
+ * @description: Retrieve the current sales channel details which includes channel name, description, banner, logo, favicon, domain details, etc. Also retrieves the seller and owner information such as address, email address, and phone number. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getOwnerInfo/).
1210
1136
  */
1211
1137
  async getOwnerInfo(
1212
1138
  { requestHeaders } = { requestHeaders: {} },
@@ -1284,8 +1210,8 @@ class Configuration {
1284
1210
  * @param {import("../ApplicationAPIClient").Options} - Options
1285
1211
  * @returns {Promise<ConfigurationApplicationModel.OrderingStore>} - Success response
1286
1212
  * @name getStoreDetailById
1287
- * @summary: Get ordering store details
1288
- * @description: Use this API to retrieve the details of given stores uid (the selling locations where the application will be utilized for placing orders). - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getStoreDetailById/).
1213
+ * @summary: Retrieves store details by ID.
1214
+ * @description: Retrieve the details of given stores uid (the selling locations where the application will be utilized for placing orders). - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getStoreDetailById/).
1289
1215
  */
1290
1216
  async getStoreDetailById(
1291
1217
  { storeId, requestHeaders } = { requestHeaders: {} },
@@ -1368,8 +1294,8 @@ class Configuration {
1368
1294
  * - Success response
1369
1295
  *
1370
1296
  * @name removeOrderingStoreCookie
1371
- * @summary: Unset the Ordering Store signed cookie.
1372
- * @description: Use this API to unset the Ordering Store cookie upon changing the sales channel, by its domain URL, in the Universal Fynd Store app. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/removeOrderingStoreCookie/).
1297
+ * @summary: Deletes store cookie.
1298
+ * @description: Unset the Ordering Store cookie upon changing the sales channel, by its domain URL, in the Universal Fynd Store app. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/removeOrderingStoreCookie/).
1373
1299
  */
1374
1300
  async removeOrderingStoreCookie(
1375
1301
  { requestHeaders } = { requestHeaders: {} },