@gofynd/fdk-client-javascript 1.4.8-beta.3 → 1.4.9

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 (189) hide show
  1. package/README.md +26 -1
  2. package/package.json +2 -2
  3. package/sdk/application/ApplicationClient.d.ts +8 -0
  4. package/sdk/application/ApplicationClient.js +14 -0
  5. package/sdk/application/Cart/CartApplicationClient.d.ts +20 -20
  6. package/sdk/application/Cart/CartApplicationClient.js +20 -20
  7. package/sdk/application/Cart/CartApplicationModel.d.ts +2446 -664
  8. package/sdk/application/Cart/CartApplicationModel.js +783 -552
  9. package/sdk/application/Cart/CartApplicationValidator.d.ts +268 -194
  10. package/sdk/application/Cart/CartApplicationValidator.js +100 -114
  11. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +53 -53
  12. package/sdk/application/Catalog/CatalogApplicationClient.js +53 -53
  13. package/sdk/application/Catalog/CatalogApplicationModel.d.ts +2012 -503
  14. package/sdk/application/Catalog/CatalogApplicationModel.js +603 -453
  15. package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +64 -64
  16. package/sdk/application/Catalog/CatalogApplicationValidator.js +32 -32
  17. package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
  18. package/sdk/application/Common/CommonApplicationClient.js +2 -2
  19. package/sdk/application/Common/CommonApplicationModel.d.ts +170 -90
  20. package/sdk/application/Common/CommonApplicationModel.js +59 -58
  21. package/sdk/application/Common/CommonApplicationValidator.d.ts +8 -5
  22. package/sdk/application/Common/CommonApplicationValidator.js +3 -3
  23. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +2 -2
  24. package/sdk/application/Communication/CommunicationApplicationClient.js +2 -2
  25. package/sdk/application/Communication/CommunicationApplicationModel.d.ts +170 -35
  26. package/sdk/application/Communication/CommunicationApplicationModel.js +54 -33
  27. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +15 -15
  28. package/sdk/application/Configuration/ConfigurationApplicationClient.js +15 -15
  29. package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +624 -443
  30. package/sdk/application/Configuration/ConfigurationApplicationModel.js +259 -248
  31. package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +32 -24
  32. package/sdk/application/Configuration/ConfigurationApplicationValidator.js +14 -13
  33. package/sdk/application/Content/ContentApplicationClient.d.ts +16 -16
  34. package/sdk/application/Content/ContentApplicationClient.js +16 -16
  35. package/sdk/application/Content/ContentApplicationModel.d.ts +1205 -282
  36. package/sdk/application/Content/ContentApplicationModel.js +341 -277
  37. package/sdk/application/Content/ContentApplicationValidator.d.ts +28 -17
  38. package/sdk/application/Content/ContentApplicationValidator.js +11 -10
  39. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +3 -3
  40. package/sdk/application/FileStorage/FileStorageApplicationClient.js +3 -3
  41. package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +146 -37
  42. package/sdk/application/FileStorage/FileStorageApplicationModel.js +38 -36
  43. package/sdk/application/Lead/LeadApplicationClient.d.ts +3 -3
  44. package/sdk/application/Lead/LeadApplicationClient.js +3 -3
  45. package/sdk/application/Lead/LeadApplicationModel.d.ts +195 -134
  46. package/sdk/application/Lead/LeadApplicationModel.js +110 -67
  47. package/sdk/application/Lead/LeadApplicationValidator.d.ts +8 -8
  48. package/sdk/application/Lead/LeadApplicationValidator.js +4 -4
  49. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +10 -10
  50. package/sdk/application/Logistic/LogisticApplicationClient.js +10 -10
  51. package/sdk/application/Logistic/LogisticApplicationModel.d.ts +1039 -221
  52. package/sdk/application/Logistic/LogisticApplicationModel.js +342 -199
  53. package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +76 -82
  54. package/sdk/application/Logistic/LogisticApplicationValidator.js +38 -41
  55. package/sdk/application/Order/OrderApplicationClient.d.ts +10 -10
  56. package/sdk/application/Order/OrderApplicationClient.js +10 -10
  57. package/sdk/application/Order/OrderApplicationModel.d.ts +1400 -325
  58. package/sdk/application/Order/OrderApplicationModel.js +391 -317
  59. package/sdk/application/Order/OrderApplicationValidator.d.ts +32 -30
  60. package/sdk/application/Order/OrderApplicationValidator.js +15 -14
  61. package/sdk/application/Payment/PaymentApplicationClient.d.ts +43 -43
  62. package/sdk/application/Payment/PaymentApplicationClient.js +43 -43
  63. package/sdk/application/Payment/PaymentApplicationModel.d.ts +1111 -1022
  64. package/sdk/application/Payment/PaymentApplicationModel.js +537 -521
  65. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +82 -49
  66. package/sdk/application/Payment/PaymentApplicationValidator.js +30 -30
  67. package/sdk/application/Rewards/RewardsApplicationModel.d.ts +28 -7
  68. package/sdk/application/Rewards/RewardsApplicationModel.js +7 -7
  69. package/sdk/application/Share/ShareApplicationModel.d.ts +178 -38
  70. package/sdk/application/Share/ShareApplicationModel.js +53 -37
  71. package/sdk/application/Share/ShareApplicationValidator.d.ts +4 -2
  72. package/sdk/application/Share/ShareApplicationValidator.js +2 -1
  73. package/sdk/application/Theme/ThemeApplicationClient.d.ts +4 -4
  74. package/sdk/application/Theme/ThemeApplicationClient.js +14 -8
  75. package/sdk/application/Theme/ThemeApplicationModel.d.ts +528 -287
  76. package/sdk/application/Theme/ThemeApplicationModel.js +208 -172
  77. package/sdk/application/Theme/ThemeApplicationValidator.d.ts +17 -12
  78. package/sdk/application/Theme/ThemeApplicationValidator.js +8 -6
  79. package/sdk/application/User/UserApplicationClient.d.ts +36 -36
  80. package/sdk/application/User/UserApplicationClient.js +36 -36
  81. package/sdk/application/User/UserApplicationModel.d.ts +1062 -255
  82. package/sdk/application/User/UserApplicationModel.js +298 -244
  83. package/sdk/application/User/UserApplicationValidator.d.ts +80 -80
  84. package/sdk/application/User/UserApplicationValidator.js +40 -40
  85. package/sdk/application/Webhook/WebhookApplicationClient.d.ts +1 -1
  86. package/sdk/application/Webhook/WebhookApplicationClient.js +1 -1
  87. package/sdk/application/Webhook/WebhookApplicationModel.d.ts +20 -5
  88. package/sdk/application/Webhook/WebhookApplicationModel.js +5 -5
  89. package/sdk/common/Clickstream.js +95 -15
  90. package/sdk/common/Constant.d.ts +9 -0
  91. package/sdk/common/Constant.js +11 -0
  92. package/sdk/common/Utility.js +19 -0
  93. package/sdk/common/utils.js +8 -1
  94. package/sdk/partner/Lead/LeadPartnerModel.d.ts +28 -7
  95. package/sdk/partner/Lead/LeadPartnerModel.js +7 -7
  96. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +28 -7
  97. package/sdk/partner/Logistics/LogisticsPartnerModel.js +7 -7
  98. package/sdk/partner/PartnerClient.d.ts +8 -0
  99. package/sdk/partner/PartnerClient.js +14 -0
  100. package/sdk/partner/Theme/ThemePartnerClient.d.ts +20 -0
  101. package/sdk/partner/Theme/ThemePartnerClient.js +158 -0
  102. package/sdk/partner/Theme/ThemePartnerModel.d.ts +45 -6
  103. package/sdk/partner/Theme/ThemePartnerModel.js +33 -4
  104. package/sdk/partner/Theme/ThemePartnerValidator.d.ts +2 -0
  105. package/sdk/partner/Theme/ThemePartnerValidator.js +14 -0
  106. package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +28 -7
  107. package/sdk/partner/Webhook/WebhookPartnerModel.js +7 -7
  108. package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +28 -7
  109. package/sdk/platform/Analytics/AnalyticsPlatformModel.js +7 -7
  110. package/sdk/platform/Billing/BillingPlatformClient.d.ts +6 -397
  111. package/sdk/platform/Billing/BillingPlatformClient.js +77 -3215
  112. package/sdk/platform/Billing/BillingPlatformModel.d.ts +621 -2021
  113. package/sdk/platform/Billing/BillingPlatformModel.js +353 -2405
  114. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +12 -451
  115. package/sdk/platform/Billing/BillingPlatformValidator.js +8 -483
  116. package/sdk/platform/Cart/CartPlatformModel.d.ts +28 -7
  117. package/sdk/platform/Cart/CartPlatformModel.js +8 -8
  118. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +12 -2
  119. package/sdk/platform/Catalog/CatalogPlatformClient.js +41 -1
  120. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +46 -12
  121. package/sdk/platform/Catalog/CatalogPlatformModel.js +14 -11
  122. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +40 -0
  123. package/sdk/platform/Catalog/CatalogPlatformValidator.js +17 -0
  124. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +28 -7
  125. package/sdk/platform/Communication/CommunicationPlatformModel.js +7 -7
  126. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +28 -7
  127. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +7 -7
  128. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +0 -97
  129. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +77 -782
  130. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +24 -701
  131. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +7 -539
  132. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +1 -183
  133. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +0 -134
  134. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +0 -10
  135. package/sdk/platform/Content/ContentPlatformApplicationClient.js +0 -79
  136. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +1 -15
  137. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +0 -13
  138. package/sdk/platform/Content/ContentPlatformModel.d.ts +58 -17
  139. package/sdk/platform/Content/ContentPlatformModel.js +28 -15
  140. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +28 -7
  141. package/sdk/platform/Discount/DiscountPlatformModel.js +7 -7
  142. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +127 -25
  143. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +37 -25
  144. package/sdk/platform/Finance/FinancePlatformClient.d.ts +28 -28
  145. package/sdk/platform/Finance/FinancePlatformClient.js +28 -28
  146. package/sdk/platform/Finance/FinancePlatformModel.d.ts +1583 -347
  147. package/sdk/platform/Finance/FinancePlatformModel.js +463 -351
  148. package/sdk/platform/Lead/LeadPlatformModel.d.ts +28 -7
  149. package/sdk/platform/Lead/LeadPlatformModel.js +7 -7
  150. package/sdk/platform/Order/OrderPlatformClient.d.ts +22 -0
  151. package/sdk/platform/Order/OrderPlatformClient.js +165 -0
  152. package/sdk/platform/Order/OrderPlatformModel.d.ts +613 -39
  153. package/sdk/platform/Order/OrderPlatformModel.js +359 -41
  154. package/sdk/platform/Order/OrderPlatformValidator.d.ts +32 -1
  155. package/sdk/platform/Order/OrderPlatformValidator.js +28 -0
  156. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +30 -9
  157. package/sdk/platform/Payment/PaymentPlatformModel.js +9 -9
  158. package/sdk/platform/PlatformClient.d.ts +8 -0
  159. package/sdk/platform/PlatformClient.js +14 -0
  160. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +28 -7
  161. package/sdk/platform/Rewards/RewardsPlatformModel.js +7 -7
  162. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +12 -9
  163. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +12 -9
  164. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +120 -22
  165. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +76 -21
  166. package/sdk/platform/Share/SharePlatformModel.d.ts +28 -7
  167. package/sdk/platform/Share/SharePlatformModel.js +7 -7
  168. package/sdk/platform/Theme/ThemePlatformModel.d.ts +18 -5
  169. package/sdk/platform/Theme/ThemePlatformModel.js +7 -4
  170. package/sdk/platform/User/UserPlatformModel.d.ts +18 -18
  171. package/sdk/platform/User/UserPlatformModel.js +9 -9
  172. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +28 -7
  173. package/sdk/platform/Webhook/WebhookPlatformModel.js +7 -7
  174. package/sdk/public/PublicClient.d.ts +0 -4
  175. package/sdk/public/PublicClient.js +0 -8
  176. package/sdk/public/index.d.ts +0 -2
  177. package/sdk/public/index.js +0 -4
  178. package/sdk/public/Billing/BillingPublicClient.d.ts +0 -45
  179. package/sdk/public/Billing/BillingPublicClient.js +0 -269
  180. package/sdk/public/Billing/BillingPublicModel.d.ts +0 -434
  181. package/sdk/public/Billing/BillingPublicModel.js +0 -395
  182. package/sdk/public/Billing/BillingPublicValidator.d.ts +0 -34
  183. package/sdk/public/Billing/BillingPublicValidator.js +0 -38
  184. package/sdk/public/Inventory/InventoryPublicClient.d.ts +0 -87
  185. package/sdk/public/Inventory/InventoryPublicClient.js +0 -529
  186. package/sdk/public/Inventory/InventoryPublicModel.d.ts +0 -393
  187. package/sdk/public/Inventory/InventoryPublicModel.js +0 -448
  188. package/sdk/public/Inventory/InventoryPublicValidator.d.ts +0 -91
  189. package/sdk/public/Inventory/InventoryPublicValidator.js +0 -85
@@ -2,24 +2,25 @@ export = ConfigurationApplicationValidator;
2
2
  /** @typedef GetAppCurrenciesParam */
3
3
  /**
4
4
  * @typedef GetAppStaffListParam
5
- * @property {number} [pageNo]
6
- * @property {number} [pageSize]
7
- * @property {boolean} [orderIncent] - This is a boolean value. Select `true` to
8
- * retrieve the staff members eligible for getting incentives on orders.
5
+ * @property {number} [pageNo] - The page number to navigate through the given
6
+ * set of results. Default value is 1.
7
+ * @property {number} [pageSize] - The number of items to retrieve in each page.
8
+ * @property {boolean} [orderIncent] - Select `true` to retrieve the staff
9
+ * members eligible for getting incentives on orders.
9
10
  * @property {number} [orderingStore] - ID of the ordering store. Helps in
10
11
  * retrieving staff members working at a particular ordering store.
11
- * @property {string} [user] - Mongo ID of the staff. Helps in retrieving the
12
- * details of a particular staff member.
13
- * @property {string} [userName] - User name of the member
12
+ * @property {string} [user] - ID of the staff. Helps in retrieving the details
13
+ * of a particular staff member.
14
+ * @property {string} [userName] - Username of the member.
14
15
  */
15
16
  /**
16
17
  * @typedef GetAppStaffsParam
17
- * @property {boolean} [orderIncent] - This is a boolean value. Select `true` to
18
- * retrieve the staff members eligible for getting incentives on orders.
18
+ * @property {boolean} [orderIncent] - Select `true` to retrieve the staff
19
+ * members eligible for getting incentives on orders.
19
20
  * @property {number} [orderingStore] - ID of the ordering store. Helps in
20
21
  * retrieving staff members working at a particular ordering store.
21
- * @property {string} [user] - Mongo ID of the staff. Helps in retrieving the
22
- * details of a particular staff member.
22
+ * @property {string} [user] - ID of the staff. Helps in retrieving the details
23
+ * of a particular staff member.
23
24
  */
24
25
  /** @typedef GetApplicationParam */
25
26
  /** @typedef GetBasicDetailsParam */
@@ -27,7 +28,7 @@ export = ConfigurationApplicationValidator;
27
28
  /** @typedef GetCurrenciesParam */
28
29
  /**
29
30
  * @typedef GetCurrencyByIdParam
30
- * @property {string} id - Object ID assigned to the currency
31
+ * @property {string} id - ID assigned to the currency.
31
32
  */
32
33
  /** @typedef GetFeaturesParam */
33
34
  /** @typedef GetIntegrationTokensParam */
@@ -47,7 +48,7 @@ export = ConfigurationApplicationValidator;
47
48
  /** @typedef GetOwnerInfoParam */
48
49
  /**
49
50
  * @typedef GetStoreDetailByIdParam
50
- * @property {number} storeId - Store uid
51
+ * @property {number} storeId - Unique identifier for a store.
51
52
  */
52
53
  /** @typedef RemoveOrderingStoreCookieParam */
53
54
  declare class ConfigurationApplicationValidator {
@@ -88,11 +89,18 @@ declare namespace ConfigurationApplicationValidator {
88
89
  export { GetAppCurrenciesParam, GetAppStaffListParam, GetAppStaffsParam, GetApplicationParam, GetBasicDetailsParam, GetContactInfoParam, GetCurrenciesParam, GetCurrencyByIdParam, GetFeaturesParam, GetIntegrationTokensParam, GetLanguagesParam, GetOrderingStoreCookieParam, GetOrderingStoresParam, GetOwnerInfoParam, GetStoreDetailByIdParam, RemoveOrderingStoreCookieParam };
89
90
  }
90
91
  type GetAppStaffListParam = {
92
+ /**
93
+ * - The page number to navigate through the given
94
+ * set of results. Default value is 1.
95
+ */
91
96
  pageNo?: number;
97
+ /**
98
+ * - The number of items to retrieve in each page.
99
+ */
92
100
  pageSize?: number;
93
101
  /**
94
- * - This is a boolean value. Select `true` to
95
- * retrieve the staff members eligible for getting incentives on orders.
102
+ * - Select `true` to retrieve the staff
103
+ * members eligible for getting incentives on orders.
96
104
  */
97
105
  orderIncent?: boolean;
98
106
  /**
@@ -101,19 +109,19 @@ type GetAppStaffListParam = {
101
109
  */
102
110
  orderingStore?: number;
103
111
  /**
104
- * - Mongo ID of the staff. Helps in retrieving the
105
- * details of a particular staff member.
112
+ * - ID of the staff. Helps in retrieving the details
113
+ * of a particular staff member.
106
114
  */
107
115
  user?: string;
108
116
  /**
109
- * - User name of the member
117
+ * - Username of the member.
110
118
  */
111
119
  userName?: string;
112
120
  };
113
121
  type GetAppStaffsParam = {
114
122
  /**
115
- * - This is a boolean value. Select `true` to
116
- * retrieve the staff members eligible for getting incentives on orders.
123
+ * - Select `true` to retrieve the staff
124
+ * members eligible for getting incentives on orders.
117
125
  */
118
126
  orderIncent?: boolean;
119
127
  /**
@@ -122,14 +130,14 @@ type GetAppStaffsParam = {
122
130
  */
123
131
  orderingStore?: number;
124
132
  /**
125
- * - Mongo ID of the staff. Helps in retrieving the
126
- * details of a particular staff member.
133
+ * - ID of the staff. Helps in retrieving the details
134
+ * of a particular staff member.
127
135
  */
128
136
  user?: string;
129
137
  };
130
138
  type GetCurrencyByIdParam = {
131
139
  /**
132
- * - Object ID assigned to the currency
140
+ * - ID assigned to the currency.
133
141
  */
134
142
  id: string;
135
143
  };
@@ -154,7 +162,7 @@ type GetOrderingStoresParam = {
154
162
  };
155
163
  type GetStoreDetailByIdParam = {
156
164
  /**
157
- * - Store uid
165
+ * - Unique identifier for a store.
158
166
  */
159
167
  storeId: number;
160
168
  };
@@ -6,25 +6,26 @@ const ConfigurationApplicationModel = require("./ConfigurationApplicationModel")
6
6
 
7
7
  /**
8
8
  * @typedef GetAppStaffListParam
9
- * @property {number} [pageNo]
10
- * @property {number} [pageSize]
11
- * @property {boolean} [orderIncent] - This is a boolean value. Select `true` to
12
- * retrieve the staff members eligible for getting incentives on orders.
9
+ * @property {number} [pageNo] - The page number to navigate through the given
10
+ * set of results. Default value is 1.
11
+ * @property {number} [pageSize] - The number of items to retrieve in each page.
12
+ * @property {boolean} [orderIncent] - Select `true` to retrieve the staff
13
+ * members eligible for getting incentives on orders.
13
14
  * @property {number} [orderingStore] - ID of the ordering store. Helps in
14
15
  * retrieving staff members working at a particular ordering store.
15
- * @property {string} [user] - Mongo ID of the staff. Helps in retrieving the
16
- * details of a particular staff member.
17
- * @property {string} [userName] - User name of the member
16
+ * @property {string} [user] - ID of the staff. Helps in retrieving the details
17
+ * of a particular staff member.
18
+ * @property {string} [userName] - Username of the member.
18
19
  */
19
20
 
20
21
  /**
21
22
  * @typedef GetAppStaffsParam
22
- * @property {boolean} [orderIncent] - This is a boolean value. Select `true` to
23
- * retrieve the staff members eligible for getting incentives on orders.
23
+ * @property {boolean} [orderIncent] - Select `true` to retrieve the staff
24
+ * members eligible for getting incentives on orders.
24
25
  * @property {number} [orderingStore] - ID of the ordering store. Helps in
25
26
  * retrieving staff members working at a particular ordering store.
26
- * @property {string} [user] - Mongo ID of the staff. Helps in retrieving the
27
- * details of a particular staff member.
27
+ * @property {string} [user] - ID of the staff. Helps in retrieving the details
28
+ * of a particular staff member.
28
29
  */
29
30
 
30
31
  /** @typedef GetApplicationParam */
@@ -37,7 +38,7 @@ const ConfigurationApplicationModel = require("./ConfigurationApplicationModel")
37
38
 
38
39
  /**
39
40
  * @typedef GetCurrencyByIdParam
40
- * @property {string} id - Object ID assigned to the currency
41
+ * @property {string} id - ID assigned to the currency.
41
42
  */
42
43
 
43
44
  /** @typedef GetFeaturesParam */
@@ -64,7 +65,7 @@ const ConfigurationApplicationModel = require("./ConfigurationApplicationModel")
64
65
 
65
66
  /**
66
67
  * @typedef GetStoreDetailByIdParam
67
- * @property {number} storeId - Store uid
68
+ * @property {number} storeId - Unique identifier for a store.
68
69
  */
69
70
 
70
71
  /** @typedef RemoveOrderingStoreCookieParam */
@@ -47,7 +47,7 @@ declare class Content {
47
47
  * @returns {Promise<ContentApplicationModel.BlogSchema>} - Success response
48
48
  * @name getBlog
49
49
  * @summary: Get a blog
50
- * @description: Get all information related to a specific blog such as it's contents, author, publish date, SEO related information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getBlog/).
50
+ * @description: Get information related to a specific blog such as it's contents, author, publish date, SEO related information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getBlog/).
51
51
  */
52
52
  getBlog({ slug, rootId, requestHeaders }?: ContentApplicationValidator.GetBlogParam, { responseHeaders }?: object): Promise<ContentApplicationModel.BlogSchema>;
53
53
  /**
@@ -57,7 +57,7 @@ declare class Content {
57
57
  * @returns {Promise<ContentApplicationModel.BlogGetResponse>} - Success response
58
58
  * @name getBlogs
59
59
  * @summary: List blogs
60
- * @description: List all the blogs against an application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getBlogs/).
60
+ * @description: List all the blogs against an application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getBlogs/).
61
61
  */
62
62
  getBlogs({ pageNo, pageSize, tags, search, requestHeaders }?: ContentApplicationValidator.GetBlogsParam, { responseHeaders }?: object): Promise<ContentApplicationModel.BlogGetResponse>;
63
63
  /**
@@ -69,7 +69,7 @@ declare class Content {
69
69
  *
70
70
  * @name getCustomFields
71
71
  * @summary: Get list of custom fields
72
- * @description: Retrieves a list of custom fields attached to a particular resource by using the resource. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getCustomFields/).
72
+ * @description: List custom fields attached to a particular resource by using the resource. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getCustomFields/).
73
73
  */
74
74
  getCustomFields({ resource, resourceId, requestHeaders }?: ContentApplicationValidator.GetCustomFieldsParam, { responseHeaders }?: object): Promise<ContentApplicationModel.CustomFieldsResponseByResourceIdSchema>;
75
75
  /**
@@ -80,7 +80,7 @@ declare class Content {
80
80
  * Success response
81
81
  * @name getCustomObject
82
82
  * @summary: Get custom object
83
- * @description: Details of custom objects, their field details, definitions, and references can be obtained using this endpoint. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getCustomObject/).
83
+ * @description: Get details of custom objects, their field details, definitions, and references can be obtained using this endpoint. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getCustomObject/).
84
84
  */
85
85
  getCustomObject({ metaobjectId, requestHeaders }?: ContentApplicationValidator.GetCustomObjectParam, { responseHeaders }?: object): Promise<ContentApplicationModel.CustomObjectByIdSchema>;
86
86
  /**
@@ -90,7 +90,7 @@ declare class Content {
90
90
  * @returns {Promise<ContentApplicationModel.DataLoadersSchema>} - Success response
91
91
  * @name getDataLoaders
92
92
  * @summary: List Dataloaders
93
- * @description: List all the data loaders that are enabled for an application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getDataLoaders/).
93
+ * @description: List all the data loaders that are enabled for an application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getDataLoaders/).
94
94
  */
95
95
  getDataLoaders({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentApplicationModel.DataLoadersSchema>;
96
96
  /**
@@ -111,7 +111,7 @@ declare class Content {
111
111
  * Success response
112
112
  * @name getFaqCategories
113
113
  * @summary: List FAQ Categories
114
- * @description: Lists categories for organizing FAQs. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getFaqCategories/).
114
+ * @description: List categories for organizing FAQs. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getFaqCategories/).
115
115
  */
116
116
  getFaqCategories({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentApplicationModel.GetFaqCategoriesSchema>;
117
117
  /**
@@ -132,7 +132,7 @@ declare class Content {
132
132
  * @returns {Promise<ContentApplicationModel.FaqResponseSchema>} - Success response
133
133
  * @name getFaqs
134
134
  * @summary: List FAQs
135
- * @description: List a list of frequently asked questions and ansers - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getFaqs/).
135
+ * @description: List frequently asked questions and answers. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getFaqs/).
136
136
  */
137
137
  getFaqs({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentApplicationModel.FaqResponseSchema>;
138
138
  /**
@@ -142,7 +142,7 @@ declare class Content {
142
142
  * @returns {Promise<ContentApplicationModel.GetFaqSchema>} - Success response
143
143
  * @name getFaqsByCategorySlug
144
144
  * @summary: List FAQs by category
145
- * @description: Get FAQs belonging to a specific category slug - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getFaqsByCategorySlug/).
145
+ * @description: Get FAQs belonging to a specific category slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getFaqsByCategorySlug/).
146
146
  */
147
147
  getFaqsByCategorySlug({ slug, requestHeaders }?: ContentApplicationValidator.GetFaqsByCategorySlugParam, { responseHeaders }?: object): Promise<ContentApplicationModel.GetFaqSchema>;
148
148
  /**
@@ -152,7 +152,7 @@ declare class Content {
152
152
  * @returns {Promise<ContentApplicationModel.LandingPageSchema>} - Success response
153
153
  * @name getLandingPage
154
154
  * @summary: Get a landing page
155
- * @description: Gets the content of the application's landing page. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getLandingPage/).
155
+ * @description: Get content of the application's landing page. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getLandingPage/).
156
156
  */
157
157
  getLandingPage({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentApplicationModel.LandingPageSchema>;
158
158
  /**
@@ -173,7 +173,7 @@ declare class Content {
173
173
  * Success response
174
174
  * @name getNavigations
175
175
  * @summary: List navigation items
176
- * @description: Get the navigation link items which can be powered to genreate menus on application's website or equivalent mobile apps - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getNavigations/).
176
+ * @description: Get the navigation link items which can be powered to generate menus on application's website or equivalent mobile apps. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getNavigations/).
177
177
  */
178
178
  getNavigations({ pageNo, pageSize, requestHeaders }?: ContentApplicationValidator.GetNavigationsParam, { responseHeaders }?: object): Promise<ContentApplicationModel.NavigationGetResponse>;
179
179
  /**
@@ -193,7 +193,7 @@ declare class Content {
193
193
  * @returns {Promise<ContentApplicationModel.PageGetResponse>} - Success response
194
194
  * @name getPages
195
195
  * @summary: Lists pages
196
- * @description: Lists all Custom Pages - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getPages/).
196
+ * @description: Lists all Custom Pages. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getPages/).
197
197
  */
198
198
  getPages({ pageNo, pageSize, requestHeaders }?: ContentApplicationValidator.GetPagesParam, { responseHeaders }?: object): Promise<ContentApplicationModel.PageGetResponse>;
199
199
  /**
@@ -203,7 +203,7 @@ declare class Content {
203
203
  * @returns {Promise<ContentApplicationModel.SeoComponent>} - Success response
204
204
  * @name getSEOConfiguration
205
205
  * @summary: Get SEO settings
206
- * @description: Get search engine optimization configurations of an application. Details include the title, description and an image - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getSEOConfiguration/).
206
+ * @description: Get search engine optimization configurations of an application. Details include the title, description and an image. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getSEOConfiguration/).
207
207
  */
208
208
  getSEOConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentApplicationModel.SeoComponent>;
209
209
  /**
@@ -213,7 +213,7 @@ declare class Content {
213
213
  * @returns {Promise<ContentApplicationModel.SeoSchemaComponent>} - Success response
214
214
  * @name getSEOMarkupSchemas
215
215
  * @summary: List SEO Markup schemas
216
- * @description: Get all SEO Markup schema Templates setup for an application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getSEOMarkupSchemas/).
216
+ * @description: Get all SEO Markup schema Templates setup for an application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getSEOMarkupSchemas/).
217
217
  */
218
218
  getSEOMarkupSchemas({ pageType, active, requestHeaders }?: ContentApplicationValidator.GetSEOMarkupSchemasParam, { responseHeaders }?: object): Promise<ContentApplicationModel.SeoSchemaComponent>;
219
219
  /**
@@ -233,7 +233,7 @@ declare class Content {
233
233
  * @returns {Promise<ContentApplicationModel.SlideshowGetResponse>} - Success response
234
234
  * @name getSlideshows
235
235
  * @summary: List Slideshows
236
- * @description: Get a list of slideshows along with their details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getSlideshows/).
236
+ * @description: List slideshows along with their details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getSlideshows/).
237
237
  */
238
238
  getSlideshows({ pageNo, pageSize, requestHeaders }?: ContentApplicationValidator.GetSlideshowsParam, { responseHeaders }?: object): Promise<ContentApplicationModel.SlideshowGetResponse>;
239
239
  /**
@@ -241,7 +241,7 @@ declare class Content {
241
241
  * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
242
242
  * @returns {Paginator<ContentApplicationModel.SlideshowGetResponse>}
243
243
  * @summary: List Slideshows
244
- * @description: Get a list of slideshows along with their details.
244
+ * @description: List slideshows along with their details.
245
245
  */
246
246
  getSlideshowsPaginator({ pageSize }?: {
247
247
  pageSize?: number;
@@ -253,7 +253,7 @@ declare class Content {
253
253
  * @returns {Promise<ContentApplicationModel.Support>} - Success response
254
254
  * @name getSupportInformation
255
255
  * @summary: Get customer support information
256
- * @description: Get customer support contact details. Contact Details can be either a phone number or an email-id or both - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getSupportInformation/).
256
+ * @description: Get customer support contact details. Contact Details can be either a phone number or an email-id or both. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getSupportInformation/).
257
257
  */
258
258
  getSupportInformation({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentApplicationModel.Support>;
259
259
  /**
@@ -144,7 +144,7 @@ class Content {
144
144
  * @returns {Promise<ContentApplicationModel.BlogSchema>} - Success response
145
145
  * @name getBlog
146
146
  * @summary: Get a blog
147
- * @description: Get all information related to a specific blog such as it's contents, author, publish date, SEO related information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getBlog/).
147
+ * @description: Get information related to a specific blog such as it's contents, author, publish date, SEO related information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getBlog/).
148
148
  */
149
149
  async getBlog(
150
150
  { slug, rootId, requestHeaders } = { requestHeaders: {} },
@@ -221,7 +221,7 @@ class Content {
221
221
  * @returns {Promise<ContentApplicationModel.BlogGetResponse>} - Success response
222
222
  * @name getBlogs
223
223
  * @summary: List blogs
224
- * @description: List all the blogs against an application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getBlogs/).
224
+ * @description: List all the blogs against an application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getBlogs/).
225
225
  */
226
226
  async getBlogs(
227
227
  { pageNo, pageSize, tags, search, requestHeaders } = { requestHeaders: {} },
@@ -303,7 +303,7 @@ class Content {
303
303
  *
304
304
  * @name getCustomFields
305
305
  * @summary: Get list of custom fields
306
- * @description: Retrieves a list of custom fields attached to a particular resource by using the resource. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getCustomFields/).
306
+ * @description: List custom fields attached to a particular resource by using the resource. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getCustomFields/).
307
307
  */
308
308
  async getCustomFields(
309
309
  { resource, resourceId, requestHeaders } = { requestHeaders: {} },
@@ -382,7 +382,7 @@ class Content {
382
382
  * Success response
383
383
  * @name getCustomObject
384
384
  * @summary: Get custom object
385
- * @description: Details of custom objects, their field details, definitions, and references can be obtained using this endpoint. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getCustomObject/).
385
+ * @description: Get details of custom objects, their field details, definitions, and references can be obtained using this endpoint. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getCustomObject/).
386
386
  */
387
387
  async getCustomObject(
388
388
  { metaobjectId, requestHeaders } = { requestHeaders: {} },
@@ -460,7 +460,7 @@ class Content {
460
460
  * @returns {Promise<ContentApplicationModel.DataLoadersSchema>} - Success response
461
461
  * @name getDataLoaders
462
462
  * @summary: List Dataloaders
463
- * @description: List all the data loaders that are enabled for an application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getDataLoaders/).
463
+ * @description: List all the data loaders that are enabled for an application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getDataLoaders/).
464
464
  */
465
465
  async getDataLoaders(
466
466
  { requestHeaders } = { requestHeaders: {} },
@@ -617,7 +617,7 @@ class Content {
617
617
  * Success response
618
618
  * @name getFaqCategories
619
619
  * @summary: List FAQ Categories
620
- * @description: Lists categories for organizing FAQs. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getFaqCategories/).
620
+ * @description: List categories for organizing FAQs. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getFaqCategories/).
621
621
  */
622
622
  async getFaqCategories(
623
623
  { requestHeaders } = { requestHeaders: {} },
@@ -776,7 +776,7 @@ class Content {
776
776
  * @returns {Promise<ContentApplicationModel.FaqResponseSchema>} - Success response
777
777
  * @name getFaqs
778
778
  * @summary: List FAQs
779
- * @description: List a list of frequently asked questions and ansers - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getFaqs/).
779
+ * @description: List frequently asked questions and answers. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getFaqs/).
780
780
  */
781
781
  async getFaqs(
782
782
  { requestHeaders } = { requestHeaders: {} },
@@ -852,7 +852,7 @@ class Content {
852
852
  * @returns {Promise<ContentApplicationModel.GetFaqSchema>} - Success response
853
853
  * @name getFaqsByCategorySlug
854
854
  * @summary: List FAQs by category
855
- * @description: Get FAQs belonging to a specific category slug - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getFaqsByCategorySlug/).
855
+ * @description: Get FAQs belonging to a specific category slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getFaqsByCategorySlug/).
856
856
  */
857
857
  async getFaqsByCategorySlug(
858
858
  { slug, requestHeaders } = { requestHeaders: {} },
@@ -932,7 +932,7 @@ class Content {
932
932
  * @returns {Promise<ContentApplicationModel.LandingPageSchema>} - Success response
933
933
  * @name getLandingPage
934
934
  * @summary: Get a landing page
935
- * @description: Gets the content of the application's landing page. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getLandingPage/).
935
+ * @description: Get content of the application's landing page. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getLandingPage/).
936
936
  */
937
937
  async getLandingPage(
938
938
  { requestHeaders } = { requestHeaders: {} },
@@ -1091,7 +1091,7 @@ class Content {
1091
1091
  * Success response
1092
1092
  * @name getNavigations
1093
1093
  * @summary: List navigation items
1094
- * @description: Get the navigation link items which can be powered to genreate menus on application's website or equivalent mobile apps - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getNavigations/).
1094
+ * @description: Get the navigation link items which can be powered to generate menus on application's website or equivalent mobile apps. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getNavigations/).
1095
1095
  */
1096
1096
  async getNavigations(
1097
1097
  { pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
@@ -1248,7 +1248,7 @@ class Content {
1248
1248
  * @returns {Promise<ContentApplicationModel.PageGetResponse>} - Success response
1249
1249
  * @name getPages
1250
1250
  * @summary: Lists pages
1251
- * @description: Lists all Custom Pages - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getPages/).
1251
+ * @description: Lists all Custom Pages. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getPages/).
1252
1252
  */
1253
1253
  async getPages(
1254
1254
  { pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
@@ -1326,7 +1326,7 @@ class Content {
1326
1326
  * @returns {Promise<ContentApplicationModel.SeoComponent>} - Success response
1327
1327
  * @name getSEOConfiguration
1328
1328
  * @summary: Get SEO settings
1329
- * @description: Get search engine optimization configurations of an application. Details include the title, description and an image - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getSEOConfiguration/).
1329
+ * @description: Get search engine optimization configurations of an application. Details include the title, description and an image. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getSEOConfiguration/).
1330
1330
  */
1331
1331
  async getSEOConfiguration(
1332
1332
  { requestHeaders } = { requestHeaders: {} },
@@ -1406,7 +1406,7 @@ class Content {
1406
1406
  * @returns {Promise<ContentApplicationModel.SeoSchemaComponent>} - Success response
1407
1407
  * @name getSEOMarkupSchemas
1408
1408
  * @summary: List SEO Markup schemas
1409
- * @description: Get all SEO Markup schema Templates setup for an application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getSEOMarkupSchemas/).
1409
+ * @description: Get all SEO Markup schema Templates setup for an application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getSEOMarkupSchemas/).
1410
1410
  */
1411
1411
  async getSEOMarkupSchemas(
1412
1412
  { pageType, active, requestHeaders } = { requestHeaders: {} },
@@ -1566,7 +1566,7 @@ class Content {
1566
1566
  * @returns {Promise<ContentApplicationModel.SlideshowGetResponse>} - Success response
1567
1567
  * @name getSlideshows
1568
1568
  * @summary: List Slideshows
1569
- * @description: Get a list of slideshows along with their details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getSlideshows/).
1569
+ * @description: List slideshows along with their details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getSlideshows/).
1570
1570
  */
1571
1571
  async getSlideshows(
1572
1572
  { pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
@@ -1644,7 +1644,7 @@ class Content {
1644
1644
  * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
1645
1645
  * @returns {Paginator<ContentApplicationModel.SlideshowGetResponse>}
1646
1646
  * @summary: List Slideshows
1647
- * @description: Get a list of slideshows along with their details.
1647
+ * @description: List slideshows along with their details.
1648
1648
  */
1649
1649
  getSlideshowsPaginator({ pageSize } = {}) {
1650
1650
  const paginator = new Paginator();
@@ -1673,7 +1673,7 @@ class Content {
1673
1673
  * @returns {Promise<ContentApplicationModel.Support>} - Success response
1674
1674
  * @name getSupportInformation
1675
1675
  * @summary: Get customer support information
1676
- * @description: Get customer support contact details. Contact Details can be either a phone number or an email-id or both - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getSupportInformation/).
1676
+ * @description: Get customer support contact details. Contact Details can be either a phone number or an email-id or both. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getSupportInformation/).
1677
1677
  */
1678
1678
  async getSupportInformation(
1679
1679
  { requestHeaders } = { requestHeaders: {} },