@gofynd/fdk-client-javascript 1.4.2-beta.4 → 1.4.2-beta.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +3 -2
- package/sdk/application/ApplicationClient.js +20 -0
- package/sdk/application/Cart/CartApplicationClient.d.ts +62 -62
- package/sdk/application/Cart/CartApplicationClient.js +82 -71
- package/sdk/application/Cart/CartApplicationValidator.d.ts +189 -34
- package/sdk/application/Cart/CartApplicationValidator.js +59 -34
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +78 -78
- package/sdk/application/Catalog/CatalogApplicationClient.js +78 -78
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
- package/sdk/application/Common/CommonApplicationClient.js +4 -4
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +6 -6
- package/sdk/application/Communication/CommunicationApplicationClient.js +6 -6
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +32 -67
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +32 -106
- package/sdk/application/Content/ContentApplicationClient.d.ts +34 -64
- package/sdk/application/Content/ContentApplicationClient.js +34 -115
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +6 -42
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +6 -42
- package/sdk/application/Lead/LeadApplicationClient.d.ts +14 -14
- package/sdk/application/Lead/LeadApplicationClient.js +14 -14
- package/sdk/application/Lead/LeadApplicationModel.js +1 -1
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +12 -12
- package/sdk/application/Logistic/LogisticApplicationClient.js +12 -12
- package/sdk/application/Order/OrderApplicationClient.d.ts +24 -24
- package/sdk/application/Order/OrderApplicationClient.js +24 -24
- package/sdk/application/Order/OrderApplicationModel.d.ts +23 -1
- package/sdk/application/Order/OrderApplicationModel.js +28 -0
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +89 -89
- package/sdk/application/Payment/PaymentApplicationClient.js +94 -94
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +498 -3
- package/sdk/application/Payment/PaymentApplicationModel.js +316 -2
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +5 -5
- package/sdk/application/Payment/PaymentApplicationValidator.js +3 -3
- package/sdk/application/PosCart/PosCartApplicationClient.d.ts +54 -54
- package/sdk/application/PosCart/PosCartApplicationClient.js +54 -54
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +14 -25
- package/sdk/application/Rewards/RewardsApplicationClient.js +14 -41
- package/sdk/application/Share/ShareApplicationClient.d.ts +14 -14
- package/sdk/application/Share/ShareApplicationClient.js +14 -14
- package/sdk/application/Share/ShareApplicationModel.d.ts +0 -4
- package/sdk/application/Share/ShareApplicationModel.js +0 -4
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -8
- package/sdk/application/Theme/ThemeApplicationClient.js +8 -8
- package/sdk/application/User/UserApplicationClient.d.ts +64 -64
- package/sdk/application/User/UserApplicationClient.js +64 -64
- package/sdk/common/Clickstream.d.ts +1 -0
- package/sdk/common/Clickstream.js +246 -0
- package/sdk/common/Utility.js +1 -4
- package/sdk/partner/Lead/LeadPartnerModel.js +1 -1
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +38 -38
- package/sdk/partner/Theme/ThemePartnerClient.js +38 -38
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +8 -8
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +8 -8
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +34 -36
- package/sdk/platform/Billing/BillingPlatformClient.js +34 -36
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +98 -175
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +98 -254
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +92 -18
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +28 -18
- package/sdk/platform/Cart/CartPlatformModel.d.ts +12 -0
- package/sdk/platform/Cart/CartPlatformModel.js +12 -0
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +195 -108
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +278 -113
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +335 -136
- package/sdk/platform/Catalog/CatalogPlatformClient.js +551 -136
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +5 -5
- package/sdk/platform/Catalog/CatalogPlatformModel.js +3 -3
- package/sdk/platform/Common/CommonPlatformClient.d.ts +3 -3
- package/sdk/platform/Common/CommonPlatformClient.js +3 -3
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +115 -290
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +115 -510
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +2 -13
- package/sdk/platform/Communication/CommunicationPlatformClient.js +2 -29
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +32 -32
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +32 -32
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +52 -127
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +52 -204
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +35 -111
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +35 -212
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +142 -1
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +96 -0
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +130 -218
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +136 -314
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +4 -4
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +4 -4
- package/sdk/platform/Content/ContentPlatformClient.d.ts +1 -1
- package/sdk/platform/Content/ContentPlatformClient.js +7 -7
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +4 -4
- package/sdk/platform/Content/ContentPlatformValidator.js +4 -4
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +22 -48
- package/sdk/platform/Discount/DiscountPlatformClient.js +22 -73
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +20 -56
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +20 -59
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +0 -2
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +0 -2
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +14 -50
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +16 -55
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +13 -14
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +12 -16
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +44 -44
- package/sdk/platform/Finance/FinancePlatformClient.js +44 -44
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +12 -12
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +22 -48
- package/sdk/platform/Lead/LeadPlatformClient.js +22 -72
- package/sdk/platform/Lead/LeadPlatformModel.js +1 -1
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +4 -4
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +4 -4
- package/sdk/platform/Order/OrderPlatformClient.d.ts +79 -208
- package/sdk/platform/Order/OrderPlatformClient.js +79 -294
- package/sdk/platform/Order/OrderPlatformModel.d.ts +32 -3
- package/sdk/platform/Order/OrderPlatformModel.js +34 -2
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +4 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +4 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +81 -81
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +81 -81
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
- package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +23 -40
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +23 -61
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +5 -5
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +4 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +5 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +2 -2
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +2 -2
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +10 -10
- package/sdk/platform/Share/SharePlatformApplicationClient.js +10 -10
- package/sdk/platform/Share/SharePlatformModel.d.ts +0 -4
- package/sdk/platform/Share/SharePlatformModel.js +0 -4
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +56 -56
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +56 -56
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +6 -6
- package/sdk/platform/Theme/ThemePlatformClient.js +6 -6
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +33 -33
- package/sdk/platform/User/UserPlatformApplicationClient.js +33 -33
- package/sdk/platform/User/UserPlatformModel.d.ts +4 -4
- package/sdk/platform/User/UserPlatformModel.js +4 -4
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +32 -45
- package/sdk/platform/Webhook/WebhookPlatformClient.js +32 -45
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +58 -1
- package/sdk/platform/Webhook/WebhookPlatformModel.js +66 -0
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +2 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.js +2 -2
- package/sdk/public/Partner/PartnerPublicClient.d.ts +2 -2
- package/sdk/public/Partner/PartnerPublicClient.js +2 -2
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicClient.js +4 -4
|
@@ -36,8 +36,8 @@ declare class Content {
|
|
|
36
36
|
* - Success response
|
|
37
37
|
*
|
|
38
38
|
* @name getAnnouncements
|
|
39
|
-
* @summary:
|
|
40
|
-
* @description:
|
|
39
|
+
* @summary: Fetches announcements of an Application
|
|
40
|
+
* @description: Retrieves all current announcements in the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getAnnouncements/).
|
|
41
41
|
*/
|
|
42
42
|
getAnnouncements({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentApplicationModel.AnnouncementsResponseSchema>;
|
|
43
43
|
/**
|
|
@@ -46,8 +46,8 @@ declare class Content {
|
|
|
46
46
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
47
47
|
* @returns {Promise<ContentApplicationModel.BlogSchema>} - Success response
|
|
48
48
|
* @name getBlog
|
|
49
|
-
* @summary:
|
|
50
|
-
* @description:
|
|
49
|
+
* @summary: Retrieves a single blog post.
|
|
50
|
+
* @description: Retrieves all information relate 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
|
/**
|
|
@@ -56,20 +56,10 @@ declare class Content {
|
|
|
56
56
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
57
57
|
* @returns {Promise<ContentApplicationModel.BlogGetResponse>} - Success response
|
|
58
58
|
* @name getBlogs
|
|
59
|
-
* @summary:
|
|
60
|
-
* @description:
|
|
59
|
+
* @summary: Lists all blog posts
|
|
60
|
+
* @description: Retrieve all the blogs which are present in the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getBlogs/).
|
|
61
61
|
*/
|
|
62
62
|
getBlogs({ pageNo, pageSize, requestHeaders }?: ContentApplicationValidator.GetBlogsParam, { responseHeaders }?: object): Promise<ContentApplicationModel.BlogGetResponse>;
|
|
63
|
-
/**
|
|
64
|
-
* @param {Object} arg - Arg object.
|
|
65
|
-
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
66
|
-
* @returns {Paginator<ContentApplicationModel.BlogGetResponse>}
|
|
67
|
-
* @summary: Get a list of blogs
|
|
68
|
-
* @description: Use this API to get all the blogs.
|
|
69
|
-
*/
|
|
70
|
-
getBlogsPaginator({ pageSize }?: {
|
|
71
|
-
pageSize?: number;
|
|
72
|
-
}): Paginator<ContentApplicationModel.BlogGetResponse>;
|
|
73
63
|
/**
|
|
74
64
|
* @param {ContentApplicationValidator.GetCustomFieldsParam} arg - Arg object.
|
|
75
65
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -99,8 +89,8 @@ declare class Content {
|
|
|
99
89
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
100
90
|
* @returns {Promise<ContentApplicationModel.DataLoadersSchema>} - Success response
|
|
101
91
|
* @name getDataLoaders
|
|
102
|
-
* @summary:
|
|
103
|
-
* @description:
|
|
92
|
+
* @summary: Retrieves data loaders enabled for an application
|
|
93
|
+
* @description: Retrieves all the data loaders that are added and enabled for an application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getDataLoaders/).
|
|
104
94
|
*/
|
|
105
95
|
getDataLoaders({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentApplicationModel.DataLoadersSchema>;
|
|
106
96
|
/**
|
|
@@ -109,8 +99,8 @@ declare class Content {
|
|
|
109
99
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
110
100
|
* @returns {Promise<ContentApplicationModel.FaqSchema>} - Success response
|
|
111
101
|
* @name getFaqBySlug
|
|
112
|
-
* @summary:
|
|
113
|
-
* @description:
|
|
102
|
+
* @summary: Retrieves FAQ by slug.
|
|
103
|
+
* @description: Retrieves a specific FAQ using its slug identifier. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getFaqBySlug/).
|
|
114
104
|
*/
|
|
115
105
|
getFaqBySlug({ slug, requestHeaders }?: ContentApplicationValidator.GetFaqBySlugParam, { responseHeaders }?: object): Promise<ContentApplicationModel.FaqSchema>;
|
|
116
106
|
/**
|
|
@@ -120,8 +110,8 @@ declare class Content {
|
|
|
120
110
|
* @returns {Promise<ContentApplicationModel.GetFaqCategoriesSchema>} -
|
|
121
111
|
* Success response
|
|
122
112
|
* @name getFaqCategories
|
|
123
|
-
* @summary:
|
|
124
|
-
* @description:
|
|
113
|
+
* @summary: Lists FAQ categories.
|
|
114
|
+
* @description: Retrieve categories for organizing FAQs. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getFaqCategories/).
|
|
125
115
|
*/
|
|
126
116
|
getFaqCategories({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentApplicationModel.GetFaqCategoriesSchema>;
|
|
127
117
|
/**
|
|
@@ -131,8 +121,8 @@ declare class Content {
|
|
|
131
121
|
* @returns {Promise<ContentApplicationModel.GetFaqCategoryBySlugSchema>} -
|
|
132
122
|
* Success response
|
|
133
123
|
* @name getFaqCategoryBySlug
|
|
134
|
-
* @summary:
|
|
135
|
-
* @description:
|
|
124
|
+
* @summary: Retrieves FAQ category by slug.
|
|
125
|
+
* @description: Retrieve a specific FAQ category using its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getFaqCategoryBySlug/).
|
|
136
126
|
*/
|
|
137
127
|
getFaqCategoryBySlug({ slug, requestHeaders }?: ContentApplicationValidator.GetFaqCategoryBySlugParam, { responseHeaders }?: object): Promise<ContentApplicationModel.GetFaqCategoryBySlugSchema>;
|
|
138
128
|
/**
|
|
@@ -141,8 +131,8 @@ declare class Content {
|
|
|
141
131
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
142
132
|
* @returns {Promise<ContentApplicationModel.FaqResponseSchema>} - Success response
|
|
143
133
|
* @name getFaqs
|
|
144
|
-
* @summary:
|
|
145
|
-
* @description:
|
|
134
|
+
* @summary: Fetches FAQs of an applicaiton
|
|
135
|
+
* @description: Retrieves a list of frequently asked questions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getFaqs/).
|
|
146
136
|
*/
|
|
147
137
|
getFaqs({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentApplicationModel.FaqResponseSchema>;
|
|
148
138
|
/**
|
|
@@ -151,8 +141,8 @@ declare class Content {
|
|
|
151
141
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
152
142
|
* @returns {Promise<ContentApplicationModel.GetFaqSchema>} - Success response
|
|
153
143
|
* @name getFaqsByCategorySlug
|
|
154
|
-
* @summary:
|
|
155
|
-
* @description:
|
|
144
|
+
* @summary: Retrieves FAQs by category.
|
|
145
|
+
* @description: Retrieves FAQs belonging to a specific category slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getFaqsByCategorySlug/).
|
|
156
146
|
*/
|
|
157
147
|
getFaqsByCategorySlug({ slug, requestHeaders }?: ContentApplicationValidator.GetFaqsByCategorySlugParam, { responseHeaders }?: object): Promise<ContentApplicationModel.GetFaqSchema>;
|
|
158
148
|
/**
|
|
@@ -161,8 +151,8 @@ declare class Content {
|
|
|
161
151
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
162
152
|
* @returns {Promise<ContentApplicationModel.LandingPageSchema>} - Success response
|
|
163
153
|
* @name getLandingPage
|
|
164
|
-
* @summary:
|
|
165
|
-
* @description:
|
|
154
|
+
* @summary: Fetches 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/).
|
|
166
156
|
*/
|
|
167
157
|
getLandingPage({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentApplicationModel.LandingPageSchema>;
|
|
168
158
|
/**
|
|
@@ -171,8 +161,8 @@ declare class Content {
|
|
|
171
161
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
172
162
|
* @returns {Promise<ContentApplicationModel.ApplicationLegal>} - Success response
|
|
173
163
|
* @name getLegalInformation
|
|
174
|
-
* @summary:
|
|
175
|
-
* @description:
|
|
164
|
+
* @summary: Retrieves legal information.
|
|
165
|
+
* @description: Retrieve legal policies for an application which includes Terms and conditions, return policy, shipping policy and privacy policy. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getLegalInformation/).
|
|
176
166
|
*/
|
|
177
167
|
getLegalInformation({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentApplicationModel.ApplicationLegal>;
|
|
178
168
|
/**
|
|
@@ -182,28 +172,18 @@ declare class Content {
|
|
|
182
172
|
* @returns {Promise<ContentApplicationModel.NavigationGetResponse>} -
|
|
183
173
|
* Success response
|
|
184
174
|
* @name getNavigations
|
|
185
|
-
* @summary:
|
|
186
|
-
* @description:
|
|
175
|
+
* @summary: Retrieves navigation items
|
|
176
|
+
* @description: Retrieves 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/).
|
|
187
177
|
*/
|
|
188
178
|
getNavigations({ pageNo, pageSize, requestHeaders }?: ContentApplicationValidator.GetNavigationsParam, { responseHeaders }?: object): Promise<ContentApplicationModel.NavigationGetResponse>;
|
|
189
|
-
/**
|
|
190
|
-
* @param {Object} arg - Arg object.
|
|
191
|
-
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
192
|
-
* @returns {Paginator<ContentApplicationModel.NavigationGetResponse>}
|
|
193
|
-
* @summary: Get the navigation
|
|
194
|
-
* @description: Use this API to fetch the navigations details which includes the items of the navigation panel. It also shows the links and sub-navigations.
|
|
195
|
-
*/
|
|
196
|
-
getNavigationsPaginator({ pageSize }?: {
|
|
197
|
-
pageSize?: number;
|
|
198
|
-
}): Paginator<ContentApplicationModel.NavigationGetResponse>;
|
|
199
179
|
/**
|
|
200
180
|
* @param {ContentApplicationValidator.GetPageParam} arg - Arg object.
|
|
201
181
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
202
182
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
203
183
|
* @returns {Promise<ContentApplicationModel.PageSchema>} - Success response
|
|
204
184
|
* @name getPage
|
|
205
|
-
* @summary:
|
|
206
|
-
* @description:
|
|
185
|
+
* @summary: Single page details.
|
|
186
|
+
* @description: Retrieve detailed information for a specific page within the theme. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getPage/).
|
|
207
187
|
*/
|
|
208
188
|
getPage({ slug, rootId, requestHeaders }?: ContentApplicationValidator.GetPageParam, { responseHeaders }?: object): Promise<ContentApplicationModel.PageSchema>;
|
|
209
189
|
/**
|
|
@@ -212,28 +192,18 @@ declare class Content {
|
|
|
212
192
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
213
193
|
* @returns {Promise<ContentApplicationModel.PageGetResponse>} - Success response
|
|
214
194
|
* @name getPages
|
|
215
|
-
* @summary:
|
|
216
|
-
* @description:
|
|
195
|
+
* @summary: Lists all pages.
|
|
196
|
+
* @description: Retrieve all available content pages in the app. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getPages/).
|
|
217
197
|
*/
|
|
218
198
|
getPages({ pageNo, pageSize, requestHeaders }?: ContentApplicationValidator.GetPagesParam, { responseHeaders }?: object): Promise<ContentApplicationModel.PageGetResponse>;
|
|
219
|
-
/**
|
|
220
|
-
* @param {Object} arg - Arg object.
|
|
221
|
-
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
222
|
-
* @returns {Paginator<ContentApplicationModel.PageGetResponse>}
|
|
223
|
-
* @summary: Get all pages
|
|
224
|
-
* @description: Use this API to get a list of pages.
|
|
225
|
-
*/
|
|
226
|
-
getPagesPaginator({ pageSize }?: {
|
|
227
|
-
pageSize?: number;
|
|
228
|
-
}): Paginator<ContentApplicationModel.PageGetResponse>;
|
|
229
199
|
/**
|
|
230
200
|
* @param {ContentApplicationValidator.GetSEOConfigurationParam} arg - Arg object.
|
|
231
201
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
232
202
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
233
203
|
* @returns {Promise<ContentApplicationModel.SeoComponent>} - Success response
|
|
234
204
|
* @name getSEOConfiguration
|
|
235
|
-
* @summary:
|
|
236
|
-
* @description:
|
|
205
|
+
* @summary: Retrieves SEO settings of an applicaiton
|
|
206
|
+
* @description: Retrieve 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/).
|
|
237
207
|
*/
|
|
238
208
|
getSEOConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentApplicationModel.SeoComponent>;
|
|
239
209
|
/**
|
|
@@ -282,8 +252,8 @@ declare class Content {
|
|
|
282
252
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
283
253
|
* @returns {Promise<ContentApplicationModel.Support>} - Success response
|
|
284
254
|
* @name getSupportInformation
|
|
285
|
-
* @summary:
|
|
286
|
-
* @description:
|
|
255
|
+
* @summary: Retrieves support related info of an applicaiton
|
|
256
|
+
* @description: Retrieves customer support contact details. Contact Details can be either phone number or email-id or both. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getSupportInformation/).
|
|
287
257
|
*/
|
|
288
258
|
getSupportInformation({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentApplicationModel.Support>;
|
|
289
259
|
/**
|
|
@@ -292,8 +262,8 @@ declare class Content {
|
|
|
292
262
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
293
263
|
* @returns {Promise<ContentApplicationModel.TagsSchema>} - Success response
|
|
294
264
|
* @name getTags
|
|
295
|
-
* @summary:
|
|
296
|
-
* @description:
|
|
265
|
+
* @summary: Retrieves HTML tags
|
|
266
|
+
* @description: Retrieve any HTML tags to power additional functionalities within an application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getTags/).
|
|
297
267
|
*/
|
|
298
268
|
getTags({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentApplicationModel.TagsSchema>;
|
|
299
269
|
}
|
|
@@ -65,8 +65,8 @@ class Content {
|
|
|
65
65
|
* - Success response
|
|
66
66
|
*
|
|
67
67
|
* @name getAnnouncements
|
|
68
|
-
* @summary:
|
|
69
|
-
* @description:
|
|
68
|
+
* @summary: Fetches announcements of an Application
|
|
69
|
+
* @description: Retrieves all current announcements in the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getAnnouncements/).
|
|
70
70
|
*/
|
|
71
71
|
async getAnnouncements(
|
|
72
72
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -143,8 +143,8 @@ class Content {
|
|
|
143
143
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
144
144
|
* @returns {Promise<ContentApplicationModel.BlogSchema>} - Success response
|
|
145
145
|
* @name getBlog
|
|
146
|
-
* @summary:
|
|
147
|
-
* @description:
|
|
146
|
+
* @summary: Retrieves a single blog post.
|
|
147
|
+
* @description: Retrieves all information relate 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: {} },
|
|
@@ -220,8 +220,8 @@ class Content {
|
|
|
220
220
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
221
221
|
* @returns {Promise<ContentApplicationModel.BlogGetResponse>} - Success response
|
|
222
222
|
* @name getBlogs
|
|
223
|
-
* @summary:
|
|
224
|
-
* @description:
|
|
223
|
+
* @summary: Lists all blog posts
|
|
224
|
+
* @description: Retrieve all the blogs which are present in the 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, requestHeaders } = { requestHeaders: {} },
|
|
@@ -292,33 +292,6 @@ class Content {
|
|
|
292
292
|
return response;
|
|
293
293
|
}
|
|
294
294
|
|
|
295
|
-
/**
|
|
296
|
-
* @param {Object} arg - Arg object.
|
|
297
|
-
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
298
|
-
* @returns {Paginator<ContentApplicationModel.BlogGetResponse>}
|
|
299
|
-
* @summary: Get a list of blogs
|
|
300
|
-
* @description: Use this API to get all the blogs.
|
|
301
|
-
*/
|
|
302
|
-
getBlogsPaginator({ pageSize } = {}) {
|
|
303
|
-
const paginator = new Paginator();
|
|
304
|
-
const callback = async () => {
|
|
305
|
-
const pageId = paginator.nextId;
|
|
306
|
-
const pageNo = paginator.pageNo;
|
|
307
|
-
const pageType = "number";
|
|
308
|
-
const data = await this.getBlogs({
|
|
309
|
-
pageNo: pageNo,
|
|
310
|
-
pageSize: pageSize,
|
|
311
|
-
});
|
|
312
|
-
paginator.setPaginator({
|
|
313
|
-
hasNext: data.page.has_next ? true : false,
|
|
314
|
-
nextId: data.page.next_id,
|
|
315
|
-
});
|
|
316
|
-
return data;
|
|
317
|
-
};
|
|
318
|
-
paginator.setCallback(callback.bind(this));
|
|
319
|
-
return paginator;
|
|
320
|
-
}
|
|
321
|
-
|
|
322
295
|
/**
|
|
323
296
|
* @param {ContentApplicationValidator.GetCustomFieldsParam} arg - Arg object.
|
|
324
297
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -484,8 +457,8 @@ class Content {
|
|
|
484
457
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
485
458
|
* @returns {Promise<ContentApplicationModel.DataLoadersSchema>} - Success response
|
|
486
459
|
* @name getDataLoaders
|
|
487
|
-
* @summary:
|
|
488
|
-
* @description:
|
|
460
|
+
* @summary: Retrieves data loaders enabled for an application
|
|
461
|
+
* @description: Retrieves all the data loaders that are added and enabled for an application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getDataLoaders/).
|
|
489
462
|
*/
|
|
490
463
|
async getDataLoaders(
|
|
491
464
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -562,8 +535,8 @@ class Content {
|
|
|
562
535
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
563
536
|
* @returns {Promise<ContentApplicationModel.FaqSchema>} - Success response
|
|
564
537
|
* @name getFaqBySlug
|
|
565
|
-
* @summary:
|
|
566
|
-
* @description:
|
|
538
|
+
* @summary: Retrieves FAQ by slug.
|
|
539
|
+
* @description: Retrieves a specific FAQ using its slug identifier. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getFaqBySlug/).
|
|
567
540
|
*/
|
|
568
541
|
async getFaqBySlug(
|
|
569
542
|
{ slug, requestHeaders } = { requestHeaders: {} },
|
|
@@ -641,8 +614,8 @@ class Content {
|
|
|
641
614
|
* @returns {Promise<ContentApplicationModel.GetFaqCategoriesSchema>} -
|
|
642
615
|
* Success response
|
|
643
616
|
* @name getFaqCategories
|
|
644
|
-
* @summary:
|
|
645
|
-
* @description:
|
|
617
|
+
* @summary: Lists FAQ categories.
|
|
618
|
+
* @description: Retrieve categories for organizing FAQs. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getFaqCategories/).
|
|
646
619
|
*/
|
|
647
620
|
async getFaqCategories(
|
|
648
621
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -720,8 +693,8 @@ class Content {
|
|
|
720
693
|
* @returns {Promise<ContentApplicationModel.GetFaqCategoryBySlugSchema>} -
|
|
721
694
|
* Success response
|
|
722
695
|
* @name getFaqCategoryBySlug
|
|
723
|
-
* @summary:
|
|
724
|
-
* @description:
|
|
696
|
+
* @summary: Retrieves FAQ category by slug.
|
|
697
|
+
* @description: Retrieve a specific FAQ category using its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getFaqCategoryBySlug/).
|
|
725
698
|
*/
|
|
726
699
|
async getFaqCategoryBySlug(
|
|
727
700
|
{ slug, requestHeaders } = { requestHeaders: {} },
|
|
@@ -800,8 +773,8 @@ class Content {
|
|
|
800
773
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
801
774
|
* @returns {Promise<ContentApplicationModel.FaqResponseSchema>} - Success response
|
|
802
775
|
* @name getFaqs
|
|
803
|
-
* @summary:
|
|
804
|
-
* @description:
|
|
776
|
+
* @summary: Fetches FAQs of an applicaiton
|
|
777
|
+
* @description: Retrieves a list of frequently asked questions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getFaqs/).
|
|
805
778
|
*/
|
|
806
779
|
async getFaqs(
|
|
807
780
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -876,8 +849,8 @@ class Content {
|
|
|
876
849
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
877
850
|
* @returns {Promise<ContentApplicationModel.GetFaqSchema>} - Success response
|
|
878
851
|
* @name getFaqsByCategorySlug
|
|
879
|
-
* @summary:
|
|
880
|
-
* @description:
|
|
852
|
+
* @summary: Retrieves FAQs by category.
|
|
853
|
+
* @description: Retrieves FAQs belonging to a specific category slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getFaqsByCategorySlug/).
|
|
881
854
|
*/
|
|
882
855
|
async getFaqsByCategorySlug(
|
|
883
856
|
{ slug, requestHeaders } = { requestHeaders: {} },
|
|
@@ -956,8 +929,8 @@ class Content {
|
|
|
956
929
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
957
930
|
* @returns {Promise<ContentApplicationModel.LandingPageSchema>} - Success response
|
|
958
931
|
* @name getLandingPage
|
|
959
|
-
* @summary:
|
|
960
|
-
* @description:
|
|
932
|
+
* @summary: Fetches landing page.
|
|
933
|
+
* @description: Gets the content of the application's landing page. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getLandingPage/).
|
|
961
934
|
*/
|
|
962
935
|
async getLandingPage(
|
|
963
936
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -1034,8 +1007,8 @@ class Content {
|
|
|
1034
1007
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
1035
1008
|
* @returns {Promise<ContentApplicationModel.ApplicationLegal>} - Success response
|
|
1036
1009
|
* @name getLegalInformation
|
|
1037
|
-
* @summary:
|
|
1038
|
-
* @description:
|
|
1010
|
+
* @summary: Retrieves legal information.
|
|
1011
|
+
* @description: Retrieve legal policies for an application which includes Terms and conditions, return policy, shipping policy and privacy policy. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getLegalInformation/).
|
|
1039
1012
|
*/
|
|
1040
1013
|
async getLegalInformation(
|
|
1041
1014
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -1115,8 +1088,8 @@ class Content {
|
|
|
1115
1088
|
* @returns {Promise<ContentApplicationModel.NavigationGetResponse>} -
|
|
1116
1089
|
* Success response
|
|
1117
1090
|
* @name getNavigations
|
|
1118
|
-
* @summary:
|
|
1119
|
-
* @description:
|
|
1091
|
+
* @summary: Retrieves navigation items
|
|
1092
|
+
* @description: Retrieves 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/).
|
|
1120
1093
|
*/
|
|
1121
1094
|
async getNavigations(
|
|
1122
1095
|
{ pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1189,41 +1162,14 @@ class Content {
|
|
|
1189
1162
|
return response;
|
|
1190
1163
|
}
|
|
1191
1164
|
|
|
1192
|
-
/**
|
|
1193
|
-
* @param {Object} arg - Arg object.
|
|
1194
|
-
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
1195
|
-
* @returns {Paginator<ContentApplicationModel.NavigationGetResponse>}
|
|
1196
|
-
* @summary: Get the navigation
|
|
1197
|
-
* @description: Use this API to fetch the navigations details which includes the items of the navigation panel. It also shows the links and sub-navigations.
|
|
1198
|
-
*/
|
|
1199
|
-
getNavigationsPaginator({ pageSize } = {}) {
|
|
1200
|
-
const paginator = new Paginator();
|
|
1201
|
-
const callback = async () => {
|
|
1202
|
-
const pageId = paginator.nextId;
|
|
1203
|
-
const pageNo = paginator.pageNo;
|
|
1204
|
-
const pageType = "number";
|
|
1205
|
-
const data = await this.getNavigations({
|
|
1206
|
-
pageNo: pageNo,
|
|
1207
|
-
pageSize: pageSize,
|
|
1208
|
-
});
|
|
1209
|
-
paginator.setPaginator({
|
|
1210
|
-
hasNext: data.page.has_next ? true : false,
|
|
1211
|
-
nextId: data.page.next_id,
|
|
1212
|
-
});
|
|
1213
|
-
return data;
|
|
1214
|
-
};
|
|
1215
|
-
paginator.setCallback(callback.bind(this));
|
|
1216
|
-
return paginator;
|
|
1217
|
-
}
|
|
1218
|
-
|
|
1219
1165
|
/**
|
|
1220
1166
|
* @param {ContentApplicationValidator.GetPageParam} arg - Arg object.
|
|
1221
1167
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1222
1168
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
1223
1169
|
* @returns {Promise<ContentApplicationModel.PageSchema>} - Success response
|
|
1224
1170
|
* @name getPage
|
|
1225
|
-
* @summary:
|
|
1226
|
-
* @description:
|
|
1171
|
+
* @summary: Single page details.
|
|
1172
|
+
* @description: Retrieve detailed information for a specific page within the theme. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getPage/).
|
|
1227
1173
|
*/
|
|
1228
1174
|
async getPage(
|
|
1229
1175
|
{ slug, rootId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1299,8 +1245,8 @@ class Content {
|
|
|
1299
1245
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
1300
1246
|
* @returns {Promise<ContentApplicationModel.PageGetResponse>} - Success response
|
|
1301
1247
|
* @name getPages
|
|
1302
|
-
* @summary:
|
|
1303
|
-
* @description:
|
|
1248
|
+
* @summary: Lists all pages.
|
|
1249
|
+
* @description: Retrieve all available content pages in the app. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getPages/).
|
|
1304
1250
|
*/
|
|
1305
1251
|
async getPages(
|
|
1306
1252
|
{ pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1371,41 +1317,14 @@ class Content {
|
|
|
1371
1317
|
return response;
|
|
1372
1318
|
}
|
|
1373
1319
|
|
|
1374
|
-
/**
|
|
1375
|
-
* @param {Object} arg - Arg object.
|
|
1376
|
-
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
1377
|
-
* @returns {Paginator<ContentApplicationModel.PageGetResponse>}
|
|
1378
|
-
* @summary: Get all pages
|
|
1379
|
-
* @description: Use this API to get a list of pages.
|
|
1380
|
-
*/
|
|
1381
|
-
getPagesPaginator({ pageSize } = {}) {
|
|
1382
|
-
const paginator = new Paginator();
|
|
1383
|
-
const callback = async () => {
|
|
1384
|
-
const pageId = paginator.nextId;
|
|
1385
|
-
const pageNo = paginator.pageNo;
|
|
1386
|
-
const pageType = "number";
|
|
1387
|
-
const data = await this.getPages({
|
|
1388
|
-
pageNo: pageNo,
|
|
1389
|
-
pageSize: pageSize,
|
|
1390
|
-
});
|
|
1391
|
-
paginator.setPaginator({
|
|
1392
|
-
hasNext: data.page.has_next ? true : false,
|
|
1393
|
-
nextId: data.page.next_id,
|
|
1394
|
-
});
|
|
1395
|
-
return data;
|
|
1396
|
-
};
|
|
1397
|
-
paginator.setCallback(callback.bind(this));
|
|
1398
|
-
return paginator;
|
|
1399
|
-
}
|
|
1400
|
-
|
|
1401
1320
|
/**
|
|
1402
1321
|
* @param {ContentApplicationValidator.GetSEOConfigurationParam} arg - Arg object.
|
|
1403
1322
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1404
1323
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
1405
1324
|
* @returns {Promise<ContentApplicationModel.SeoComponent>} - Success response
|
|
1406
1325
|
* @name getSEOConfiguration
|
|
1407
|
-
* @summary:
|
|
1408
|
-
* @description:
|
|
1326
|
+
* @summary: Retrieves SEO settings of an applicaiton
|
|
1327
|
+
* @description: Retrieve 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/).
|
|
1409
1328
|
*/
|
|
1410
1329
|
async getSEOConfiguration(
|
|
1411
1330
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -1751,8 +1670,8 @@ class Content {
|
|
|
1751
1670
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
1752
1671
|
* @returns {Promise<ContentApplicationModel.Support>} - Success response
|
|
1753
1672
|
* @name getSupportInformation
|
|
1754
|
-
* @summary:
|
|
1755
|
-
* @description:
|
|
1673
|
+
* @summary: Retrieves support related info of an applicaiton
|
|
1674
|
+
* @description: Retrieves customer support contact details. Contact Details can be either phone number or email-id or both. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getSupportInformation/).
|
|
1756
1675
|
*/
|
|
1757
1676
|
async getSupportInformation(
|
|
1758
1677
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -1831,8 +1750,8 @@ class Content {
|
|
|
1831
1750
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
1832
1751
|
* @returns {Promise<ContentApplicationModel.TagsSchema>} - Success response
|
|
1833
1752
|
* @name getTags
|
|
1834
|
-
* @summary:
|
|
1835
|
-
* @description:
|
|
1753
|
+
* @summary: Retrieves HTML tags
|
|
1754
|
+
* @description: Retrieve any HTML tags to power additional functionalities within an application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getTags/).
|
|
1836
1755
|
*/
|
|
1837
1756
|
async getTags(
|
|
1838
1757
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -15,26 +15,8 @@ declare class FileStorage {
|
|
|
15
15
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
16
16
|
* @returns {Promise<FileStorageApplicationModel.CompleteResponse>} - Success response
|
|
17
17
|
* @name completeUpload
|
|
18
|
-
* @summary:
|
|
19
|
-
* @description:
|
|
20
|
-
*
|
|
21
|
-
* The three major steps are:
|
|
22
|
-
* Start
|
|
23
|
-
* Upload
|
|
24
|
-
* Complete
|
|
25
|
-
*
|
|
26
|
-
* ### Start
|
|
27
|
-
* Initiates the assets upload using `startUpload`.
|
|
28
|
-
* It returns a storage link in response.
|
|
29
|
-
*
|
|
30
|
-
* ### Upload
|
|
31
|
-
* Use the storage link to upload a file (Buffer or Blob) to the File Storage.
|
|
32
|
-
* Make a `PUT` request on storage link received from `startUpload` API with the file (Buffer or Blob) in the request body.
|
|
33
|
-
*
|
|
34
|
-
* ### Complete
|
|
35
|
-
* After successfully upload, call the `completeUpload` API to finish the upload process.
|
|
36
|
-
* This operation will return the URL of the uploaded file.
|
|
37
|
-
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/filestorage/completeUpload/).
|
|
18
|
+
* @summary: Finalizes upload process.
|
|
19
|
+
* @description: Complete the process of uploading the file, and will return the URL of the uploaded file - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/filestorage/completeUpload/).
|
|
38
20
|
*/
|
|
39
21
|
completeUpload({ namespace, body, requestHeaders }?: FileStorageApplicationValidator.CompleteUploadParam, { responseHeaders }?: object): Promise<FileStorageApplicationModel.CompleteResponse>;
|
|
40
22
|
/**
|
|
@@ -43,8 +25,8 @@ declare class FileStorage {
|
|
|
43
25
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
44
26
|
* @returns {Promise<FileStorageApplicationModel.SignUrlResponse>} - Success response
|
|
45
27
|
* @name signUrls
|
|
46
|
-
* @summary:
|
|
47
|
-
* @description:
|
|
28
|
+
* @summary: Signs file URLs.
|
|
29
|
+
* @description: Generates secure, signed URLs that is valid for certain expiry time for accessing stored files. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/filestorage/signUrls/).
|
|
48
30
|
*/
|
|
49
31
|
signUrls({ body, requestHeaders }?: FileStorageApplicationValidator.SignUrlsParam, { responseHeaders }?: object): Promise<FileStorageApplicationModel.SignUrlResponse>;
|
|
50
32
|
/**
|
|
@@ -53,26 +35,8 @@ declare class FileStorage {
|
|
|
53
35
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
54
36
|
* @returns {Promise<FileStorageApplicationModel.StartResponse>} - Success response
|
|
55
37
|
* @name startUpload
|
|
56
|
-
* @summary: Initiates
|
|
57
|
-
* @description:
|
|
58
|
-
*
|
|
59
|
-
* The three major steps are:
|
|
60
|
-
* Start
|
|
61
|
-
* Upload
|
|
62
|
-
* Complete
|
|
63
|
-
*
|
|
64
|
-
* ### Start
|
|
65
|
-
* Initiates the assets upload using `startUpload`.
|
|
66
|
-
* It returns a storage link in response.
|
|
67
|
-
*
|
|
68
|
-
* ### Upload
|
|
69
|
-
* Use the storage link to upload a file (Buffer or Blob) to the File Storage.
|
|
70
|
-
* Make a `PUT` request on storage link received from `startUpload` API with the file (Buffer or Blob) in the request body.
|
|
71
|
-
*
|
|
72
|
-
* ### Complete
|
|
73
|
-
* After successfully upload, call the `completeUpload` API to finish the upload process.
|
|
74
|
-
* This operation will return the URL of the uploaded file.
|
|
75
|
-
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/filestorage/startUpload/).
|
|
38
|
+
* @summary: Initiates file upload
|
|
39
|
+
* @description: Starts the process of uploading a file to storage location, and returns a storage link in response. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/filestorage/startUpload/).
|
|
76
40
|
*/
|
|
77
41
|
startUpload({ namespace, body, requestHeaders }?: FileStorageApplicationValidator.StartUploadParam, { responseHeaders }?: object): Promise<FileStorageApplicationModel.StartResponse>;
|
|
78
42
|
/**
|