@gofynd/fdk-client-javascript 1.4.16-beta.4 → 1.4.16-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.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/ApplicationClient.d.ts +2 -0
- package/sdk/application/ApplicationClient.js +2 -0
- package/sdk/application/Cart/CartApplicationClient.d.ts +68 -48
- package/sdk/application/Cart/CartApplicationClient.js +118 -27
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +59 -58
- package/sdk/application/Catalog/CatalogApplicationClient.js +30 -29
- package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
- package/sdk/application/Common/CommonApplicationClient.js +1 -1
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +20 -20
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +10 -10
- package/sdk/application/Content/ContentApplicationClient.d.ts +51 -30
- package/sdk/application/Content/ContentApplicationClient.js +161 -56
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +9 -11
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +7 -10
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +29 -0
- package/sdk/application/Finance/FinanceApplicationClient.js +111 -0
- package/sdk/application/Lead/LeadApplicationClient.d.ts +2 -2
- package/sdk/application/Lead/LeadApplicationClient.js +1 -1
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +35 -15
- package/sdk/application/Logistic/LogisticApplicationClient.js +101 -8
- package/sdk/application/Order/OrderApplicationClient.d.ts +22 -12
- package/sdk/application/Order/OrderApplicationClient.js +56 -8
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +87 -87
- package/sdk/application/Payment/PaymentApplicationClient.js +46 -46
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +13 -13
- package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +2 -2
- package/sdk/application/Theme/ThemeApplicationClient.js +4 -2
- package/sdk/application/User/UserApplicationClient.d.ts +10 -10
- package/sdk/application/User/UserApplicationClient.js +6 -6
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
- package/sdk/application/Webhook/WebhookApplicationClient.js +3 -3
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +86 -12
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +582 -24
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +116 -21
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +121 -16
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +8 -1
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +51 -4
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +2 -2
- package/sdk/partner/Lead/LeadPartnerClient.js +2 -2
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +5 -5
- package/sdk/partner/Lead/LeadPartnerModel.js +15 -15
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +126 -20
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +970 -20
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +1200 -167
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +571 -160
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +10 -0
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +121 -7
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +8 -10
- package/sdk/partner/Theme/ThemePartnerClient.js +14 -16
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +96 -37
- package/sdk/partner/Theme/ThemePartnerModel.js +90 -36
- package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +28 -18
- package/sdk/partner/Webhook/WebhookPartnerClient.js +103 -18
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +612 -179
- package/sdk/partner/Webhook/WebhookPartnerModel.js +253 -150
- package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +1 -0
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +11 -3
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +5 -4
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +14 -8
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +59 -9
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +40 -4
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +2 -32
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +3 -243
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +11 -130
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +12 -152
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -39
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +0 -35
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
- package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +443 -388
- package/sdk/platform/Billing/BillingPlatformModel.js +280 -263
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +16 -18
- package/sdk/platform/Billing/BillingPlatformValidator.js +8 -9
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +134 -103
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +419 -115
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +121 -65
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +109 -44
- package/sdk/platform/Cart/CartPlatformModel.d.ts +5070 -1296
- package/sdk/platform/Cart/CartPlatformModel.js +1992 -1217
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +209 -183
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +452 -395
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +185 -142
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +96 -78
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +154 -117
- package/sdk/platform/Catalog/CatalogPlatformClient.js +292 -172
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +6512 -1770
- package/sdk/platform/Catalog/CatalogPlatformModel.js +3228 -1687
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +72 -31
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +50 -24
- package/sdk/platform/Common/CommonPlatformClient.d.ts +3 -2
- package/sdk/platform/Common/CommonPlatformClient.js +3 -2
- package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
- package/sdk/platform/Common/CommonPlatformModel.js +6 -6
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +16 -17
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +16 -17
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +8 -8
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +8 -8
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +43 -33
- package/sdk/platform/Communication/CommunicationPlatformModel.js +38 -34
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +46 -42
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +47 -43
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +223 -223
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +210 -212
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +46 -33
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +67 -54
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +45 -24
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +134 -30
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +283 -124
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +219 -94
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +37 -9
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +27 -8
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +204 -141
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1076 -478
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +253 -141
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +256 -130
- package/sdk/platform/Content/ContentPlatformClient.d.ts +142 -106
- package/sdk/platform/Content/ContentPlatformClient.js +523 -336
- package/sdk/platform/Content/ContentPlatformModel.d.ts +1372 -400
- package/sdk/platform/Content/ContentPlatformModel.js +631 -394
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +168 -117
- package/sdk/platform/Content/ContentPlatformValidator.js +162 -108
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +14 -12
- package/sdk/platform/Discount/DiscountPlatformClient.js +14 -12
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +13 -13
- package/sdk/platform/Discount/DiscountPlatformModel.js +12 -12
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +95 -39
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +462 -63
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +62 -15
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +75 -13
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +20 -22
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +21 -24
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +370 -116
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +313 -104
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +2 -2
- package/sdk/platform/Lead/LeadPlatformClient.js +2 -2
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +5 -5
- package/sdk/platform/Lead/LeadPlatformModel.js +16 -16
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +17 -6
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +85 -7
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +95 -24
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +39 -19
- package/sdk/platform/Order/OrderPlatformClient.d.ts +153 -96
- package/sdk/platform/Order/OrderPlatformClient.js +416 -198
- package/sdk/platform/Order/OrderPlatformModel.d.ts +7607 -1267
- package/sdk/platform/Order/OrderPlatformModel.js +3929 -1269
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +270 -109
- package/sdk/platform/Order/OrderPlatformValidator.js +135 -77
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +6 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +9 -7
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
- package/sdk/platform/Partner/PartnerPlatformModel.js +8 -8
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +93 -105
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +129 -141
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +48 -48
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +48 -48
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
- package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +333 -319
- package/sdk/platform/Payment/PaymentPlatformModel.js +288 -278
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +8 -8
- package/sdk/platform/Payment/PaymentPlatformValidator.js +8 -8
- package/sdk/platform/PlatformClient.d.ts +0 -2
- package/sdk/platform/PlatformClient.js +0 -4
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +9 -9
- package/sdk/platform/Rewards/RewardsPlatformModel.js +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +46 -36
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +132 -41
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +46 -17
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +34 -14
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +40 -46
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +58 -64
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +1842 -609
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +886 -554
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +42 -46
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +26 -28
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +5 -5
- package/sdk/platform/Share/SharePlatformApplicationClient.js +9 -9
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +3 -6
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +2 -2
- package/sdk/platform/Share/SharePlatformModel.d.ts +46 -7
- package/sdk/platform/Share/SharePlatformModel.js +31 -6
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +3 -3
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +8 -4
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +5 -0
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +2 -0
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +37 -11
- package/sdk/platform/Theme/ThemePlatformModel.js +33 -15
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/User/UserPlatformApplicationClient.js +12 -12
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/User/UserPlatformApplicationValidator.js +2 -2
- package/sdk/platform/User/UserPlatformModel.d.ts +21 -21
- package/sdk/platform/User/UserPlatformModel.js +23 -23
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +25 -78
- package/sdk/platform/Webhook/WebhookPlatformClient.js +75 -470
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +720 -427
- package/sdk/platform/Webhook/WebhookPlatformModel.js +410 -386
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -55
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +12 -72
- package/sdk/platform/index.d.ts +0 -1
- package/sdk/platform/index.js +0 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +3 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.js +6 -5
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +9 -9
- package/sdk/public/Configuration/ConfigurationPublicModel.js +6 -6
- package/sdk/public/Content/ContentPublicClient.d.ts +112 -2
- package/sdk/public/Content/ContentPublicClient.js +810 -6
- package/sdk/public/Content/ContentPublicModel.d.ts +549 -3
- package/sdk/public/Content/ContentPublicModel.js +649 -3
- package/sdk/public/Content/ContentPublicValidator.d.ts +69 -3
- package/sdk/public/Content/ContentPublicValidator.js +88 -2
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
- package/sdk/public/Webhook/WebhookPublicClient.js +8 -8
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +21 -21
- package/sdk/public/Webhook/WebhookPublicModel.js +15 -15
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +0 -320
- package/sdk/platform/Finance/FinancePlatformClient.js +0 -2333
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +0 -2890
- package/sdk/platform/Finance/FinancePlatformModel.js +0 -2148
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +0 -284
- package/sdk/platform/Finance/FinancePlatformValidator.js +0 -354
|
@@ -59,20 +59,6 @@ declare class Content {
|
|
|
59
59
|
* @description: Generate and add a new announcement. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/createAnnouncement/).
|
|
60
60
|
*/
|
|
61
61
|
createAnnouncement({ body, requestHeaders }?: ContentPlatformApplicationValidator.CreateAnnouncementParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CreateAnnouncementSchema>;
|
|
62
|
-
/**
|
|
63
|
-
* @param {ContentPlatformApplicationValidator.CreateAppCustomFieldByResourceIdParam} arg
|
|
64
|
-
* - Arg object
|
|
65
|
-
*
|
|
66
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
67
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
68
|
-
* @returns {Promise<ContentPlatformModel.CustomFieldsResponseByResourceIdSchema>}
|
|
69
|
-
* - Success response
|
|
70
|
-
*
|
|
71
|
-
* @name createAppCustomFieldByResourceId
|
|
72
|
-
* @summary: Create custom field entries for gives resource and resource_id
|
|
73
|
-
* @description: You can add a custom field using this endpoint to any resource by providing the resource ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/createAppCustomFieldByResourceId/).
|
|
74
|
-
*/
|
|
75
|
-
createAppCustomFieldByResourceId({ resource, resourceId, body, requestHeaders }?: ContentPlatformApplicationValidator.CreateAppCustomFieldByResourceIdParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CustomFieldsResponseByResourceIdSchema>;
|
|
76
62
|
/**
|
|
77
63
|
* @param {ContentPlatformApplicationValidator.CreateAppCustomFieldDefinitionParam} arg
|
|
78
64
|
* - Arg object
|
|
@@ -83,35 +69,36 @@ declare class Content {
|
|
|
83
69
|
* - Success response
|
|
84
70
|
*
|
|
85
71
|
* @name createAppCustomFieldDefinition
|
|
86
|
-
* @summary: Create custom field definition
|
|
72
|
+
* @summary: Create custom field definition for a given resource type
|
|
87
73
|
* @description: You can create custom fields definition to any resource so you can extend property of resource. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/createAppCustomFieldDefinition/).
|
|
88
74
|
*/
|
|
89
|
-
createAppCustomFieldDefinition({ body, requestHeaders }?: ContentPlatformApplicationValidator.CreateAppCustomFieldDefinitionParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CustomFieldDefinitionDetailResSchema>;
|
|
75
|
+
createAppCustomFieldDefinition({ resource, body, requestHeaders }?: ContentPlatformApplicationValidator.CreateAppCustomFieldDefinitionParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CustomFieldDefinitionDetailResSchema>;
|
|
90
76
|
/**
|
|
91
|
-
* @param {ContentPlatformApplicationValidator.
|
|
77
|
+
* @param {ContentPlatformApplicationValidator.CreateAppCustomObjectBySlugParam} arg
|
|
92
78
|
* - Arg object
|
|
93
79
|
*
|
|
94
80
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
95
81
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
96
82
|
* @returns {Promise<ContentPlatformModel.CustomObjectSchema>} - Success response
|
|
97
|
-
* @name
|
|
83
|
+
* @name createAppCustomObjectBySlug
|
|
98
84
|
* @summary: Create custom object entries
|
|
99
|
-
* @description: Custom object entries against the custom object definition can be added using this API. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/
|
|
85
|
+
* @description: Custom object entries against the custom object definition can be added using this API. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/createAppCustomObjectBySlug/).
|
|
100
86
|
*/
|
|
101
|
-
|
|
87
|
+
createAppCustomObjectBySlug({ definitionSlug, body, requestHeaders }?: ContentPlatformApplicationValidator.CreateAppCustomObjectBySlugParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CustomObjectSchema>;
|
|
102
88
|
/**
|
|
103
89
|
* @param {ContentPlatformApplicationValidator.CreateAppCustomObjectDefinitionParam} arg
|
|
104
90
|
* - Arg object
|
|
105
91
|
*
|
|
106
92
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
107
93
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
108
|
-
* @returns {Promise<ContentPlatformModel.
|
|
109
|
-
* Success response
|
|
94
|
+
* @returns {Promise<ContentPlatformModel.CustomObjectDefinitionSlugSchema>}
|
|
95
|
+
* - Success response
|
|
96
|
+
*
|
|
110
97
|
* @name createAppCustomObjectDefinition
|
|
111
98
|
* @summary: Create custom object definition
|
|
112
99
|
* @description: Create a custom object that will have a collection of custom fields and can be used anywhere in the custom field for any resource. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/createAppCustomObjectDefinition/).
|
|
113
100
|
*/
|
|
114
|
-
createAppCustomObjectDefinition({ body, requestHeaders }?: ContentPlatformApplicationValidator.CreateAppCustomObjectDefinitionParam, { responseHeaders }?: object): Promise<ContentPlatformModel.
|
|
101
|
+
createAppCustomObjectDefinition({ body, requestHeaders }?: ContentPlatformApplicationValidator.CreateAppCustomObjectDefinitionParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CustomObjectDefinitionSlugSchema>;
|
|
115
102
|
/**
|
|
116
103
|
* @param {ContentPlatformApplicationValidator.CreateBlogParam} arg - Arg object
|
|
117
104
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -190,6 +177,17 @@ declare class Content {
|
|
|
190
177
|
* @description: Use this API to Create SEO Markup Schema - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/createSEOMarkupSchema/).
|
|
191
178
|
*/
|
|
192
179
|
createSEOMarkupSchema({ body, requestHeaders }?: ContentPlatformApplicationValidator.CreateSEOMarkupSchemaParam, { responseHeaders }?: object): Promise<ContentPlatformModel.SEOSchemaMarkupTemplate>;
|
|
180
|
+
/**
|
|
181
|
+
* @param {ContentPlatformApplicationValidator.CreateSitemapParam} arg - Arg object
|
|
182
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
183
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
184
|
+
* @returns {Promise<ContentPlatformModel.SitemapConfig>} - Success response
|
|
185
|
+
* @name createSitemap
|
|
186
|
+
* @summary: Create a new sitemap configuration
|
|
187
|
+
* @description: Create a new sitemap configuration for a specific company and application. The name must be unique within the scope of the application. The sitemap XML data must be valid XML following the sitemap protocol specification. Once created, the configuration can be activated or deactivated using the is_active flag.
|
|
188
|
+
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/createSitemap/).
|
|
189
|
+
*/
|
|
190
|
+
createSitemap({ body, requestHeaders }?: ContentPlatformApplicationValidator.CreateSitemapParam, { responseHeaders }?: object): Promise<ContentPlatformModel.SitemapConfig>;
|
|
193
191
|
/**
|
|
194
192
|
* @param {ContentPlatformApplicationValidator.CreateSlideshowParam} arg - Arg object
|
|
195
193
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -214,31 +212,31 @@ declare class Content {
|
|
|
214
212
|
*/
|
|
215
213
|
deleteAnnouncement({ announcementId, requestHeaders }?: ContentPlatformApplicationValidator.DeleteAnnouncementParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CreateAnnouncementSchema>;
|
|
216
214
|
/**
|
|
217
|
-
* @param {ContentPlatformApplicationValidator.
|
|
215
|
+
* @param {ContentPlatformApplicationValidator.DeleteAppCustomFieldDefinitionBySlugParam} arg
|
|
218
216
|
* - Arg object
|
|
219
217
|
*
|
|
220
218
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
221
219
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
222
220
|
* @returns {Promise<ContentPlatformModel.CustomDataDeleteSchema>} - Success response
|
|
223
|
-
* @name
|
|
221
|
+
* @name deleteAppCustomFieldDefinitionBySlug
|
|
224
222
|
* @summary: Delete custom fields definition
|
|
225
|
-
* @description: Custom field definition and its assosiated custom fields value can be deleted using this api on the basis of definition id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/
|
|
223
|
+
* @description: Custom field definition and its assosiated custom fields value can be deleted using this api on the basis of definition id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/deleteAppCustomFieldDefinitionBySlug/).
|
|
226
224
|
*/
|
|
227
|
-
|
|
225
|
+
deleteAppCustomFieldDefinitionBySlug({ slug, resource, namespace, requestHeaders }?: ContentPlatformApplicationValidator.DeleteAppCustomFieldDefinitionBySlugParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CustomDataDeleteSchema>;
|
|
228
226
|
/**
|
|
229
|
-
* @param {ContentPlatformApplicationValidator.
|
|
227
|
+
* @param {ContentPlatformApplicationValidator.DeleteAppCustomObjectBySlugParam} arg
|
|
230
228
|
* - Arg object
|
|
231
229
|
*
|
|
232
230
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
233
231
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
234
232
|
* @returns {Promise<ContentPlatformModel.CustomDataDeleteSchema>} - Success response
|
|
235
|
-
* @name
|
|
233
|
+
* @name deleteAppCustomObjectBySlug
|
|
236
234
|
* @summary: Delete custom object
|
|
237
|
-
* @description: Custom object
|
|
235
|
+
* @description: A Custom object entry can be deleted by providing the custom object definition slug and custom object entry slug using this endpoint. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/deleteAppCustomObjectBySlug/).
|
|
238
236
|
*/
|
|
239
|
-
|
|
237
|
+
deleteAppCustomObjectBySlug({ definitionSlug, slug, requestHeaders }?: ContentPlatformApplicationValidator.DeleteAppCustomObjectBySlugParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CustomDataDeleteSchema>;
|
|
240
238
|
/**
|
|
241
|
-
* @param {ContentPlatformApplicationValidator.
|
|
239
|
+
* @param {ContentPlatformApplicationValidator.DeleteAppCustomObjectDefinitionBySlugParam} arg
|
|
242
240
|
* - Arg object
|
|
243
241
|
*
|
|
244
242
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -246,11 +244,11 @@ declare class Content {
|
|
|
246
244
|
* @returns {Promise<ContentPlatformModel.CustomObjectDefinitionDeleteResponseSchema>}
|
|
247
245
|
* - Success response
|
|
248
246
|
*
|
|
249
|
-
* @name
|
|
247
|
+
* @name deleteAppCustomObjectDefinitionBySlug
|
|
250
248
|
* @summary: Delete custom object definition
|
|
251
|
-
* @description: Custom object definitions can be deleted using this endpoint by providing the definition ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/
|
|
249
|
+
* @description: Custom object definitions can be deleted using this endpoint by providing the definition ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/deleteAppCustomObjectDefinitionBySlug/).
|
|
252
250
|
*/
|
|
253
|
-
|
|
251
|
+
deleteAppCustomObjectDefinitionBySlug({ slug, requestHeaders }?: ContentPlatformApplicationValidator.DeleteAppCustomObjectDefinitionBySlugParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CustomObjectDefinitionDeleteResponseSchema>;
|
|
254
252
|
/**
|
|
255
253
|
* @param {ContentPlatformApplicationValidator.DeleteBlogParam} arg - Arg object
|
|
256
254
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -350,6 +348,17 @@ declare class Content {
|
|
|
350
348
|
* @description: Use this API to Delete SEO Markup Schema - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/deleteSEOMarkupSchema/).
|
|
351
349
|
*/
|
|
352
350
|
deleteSEOMarkupSchema({ id, requestHeaders }?: ContentPlatformApplicationValidator.DeleteSEOMarkupSchemaParam, { responseHeaders }?: object): Promise<ContentPlatformModel.SEOSchemaMarkupTemplate>;
|
|
351
|
+
/**
|
|
352
|
+
* @param {ContentPlatformApplicationValidator.DeleteSitemapParam} arg - Arg object
|
|
353
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
354
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
355
|
+
* @returns {Promise<ContentPlatformModel.SitemapConfig>} - Success response
|
|
356
|
+
* @name deleteSitemap
|
|
357
|
+
* @summary: Delete a specific sitemap configuration
|
|
358
|
+
* @description: Permanently delete a sitemap configuration identified by its name. This action cannot be undone. All associated data including the sitemap XML data will be removed.
|
|
359
|
+
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/deleteSitemap/).
|
|
360
|
+
*/
|
|
361
|
+
deleteSitemap({ name, requestHeaders }?: ContentPlatformApplicationValidator.DeleteSitemapParam, { responseHeaders }?: object): Promise<ContentPlatformModel.SitemapConfig>;
|
|
353
362
|
/**
|
|
354
363
|
* @param {ContentPlatformApplicationValidator.DeleteSlideshowParam} arg - Arg object
|
|
355
364
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -396,7 +405,7 @@ declare class Content {
|
|
|
396
405
|
*/
|
|
397
406
|
editSEOMarkupSchema({ id, body, requestHeaders }?: ContentPlatformApplicationValidator.EditSEOMarkupSchemaParam, { responseHeaders }?: object): Promise<ContentPlatformModel.SEOSchemaMarkupTemplate>;
|
|
398
407
|
/**
|
|
399
|
-
* @param {ContentPlatformApplicationValidator.
|
|
408
|
+
* @param {ContentPlatformApplicationValidator.ExportAppCustomObjectEntriesBySlugParam} arg
|
|
400
409
|
* - Arg object
|
|
401
410
|
*
|
|
402
411
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -404,11 +413,11 @@ declare class Content {
|
|
|
404
413
|
* @returns {Promise<ContentPlatformModel.CustomObjectBulkEntryInitiateDownload>}
|
|
405
414
|
* - Success response
|
|
406
415
|
*
|
|
407
|
-
* @name
|
|
416
|
+
* @name exportAppCustomObjectEntriesBySlug
|
|
408
417
|
* @summary: Initiate download for bulk custom object entries
|
|
409
|
-
* @description: Custom object bulk export of bulk entries can be perform using this endpoint. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/
|
|
418
|
+
* @description: Custom object bulk export of bulk entries can be perform using this endpoint. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/exportAppCustomObjectEntriesBySlug/).
|
|
410
419
|
*/
|
|
411
|
-
|
|
420
|
+
exportAppCustomObjectEntriesBySlug({ slug, requestHeaders }?: ContentPlatformApplicationValidator.ExportAppCustomObjectEntriesBySlugParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CustomObjectBulkEntryInitiateDownload>;
|
|
412
421
|
/**
|
|
413
422
|
* @param {ContentPlatformApplicationValidator.GenerateSEOTitleParam} arg - Arg object
|
|
414
423
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -445,19 +454,32 @@ declare class Content {
|
|
|
445
454
|
*/
|
|
446
455
|
getAnnouncementsList({ pageNo, pageSize, requestHeaders }?: ContentPlatformApplicationValidator.GetAnnouncementsListParam, { responseHeaders }?: object): Promise<ContentPlatformModel.GetAnnouncementListSchema>;
|
|
447
456
|
/**
|
|
448
|
-
* @param {ContentPlatformApplicationValidator.
|
|
457
|
+
* @param {ContentPlatformApplicationValidator.GetAppCustomFieldDefinitionByResourceParam} arg
|
|
449
458
|
* - Arg object
|
|
450
459
|
*
|
|
451
460
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
452
461
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
453
|
-
* @returns {Promise<ContentPlatformModel.
|
|
462
|
+
* @returns {Promise<ContentPlatformModel.CustomFieldDefinitionsSchema>} -
|
|
463
|
+
* Success response
|
|
464
|
+
* @name getAppCustomFieldDefinitionByResource
|
|
465
|
+
* @summary: Get custom fields definitions for a given resource type
|
|
466
|
+
* @description: Custom field definitions enable you to include data validation for custom fields, and enable sellers to add custom fields values for resources. With the help of this seller can retrive list of custom field definitions list. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getAppCustomFieldDefinitionByResource/).
|
|
467
|
+
*/
|
|
468
|
+
getAppCustomFieldDefinitionByResource({ pageNo, pageSize, resource, types, search, slugs, namespaces, requestHeaders, }?: ContentPlatformApplicationValidator.GetAppCustomFieldDefinitionByResourceParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CustomFieldDefinitionsSchema>;
|
|
469
|
+
/**
|
|
470
|
+
* @param {ContentPlatformApplicationValidator.GetAppCustomFieldDefinitionBySlugParam} arg
|
|
471
|
+
* - Arg object
|
|
472
|
+
*
|
|
473
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
474
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
475
|
+
* @returns {Promise<ContentPlatformModel.MetaFieldDefinitionDetailResSchema>}
|
|
454
476
|
* - Success response
|
|
455
477
|
*
|
|
456
|
-
* @name
|
|
457
|
-
* @summary: Get custom fields definition
|
|
458
|
-
* @description: Custom field definitions can be
|
|
478
|
+
* @name getAppCustomFieldDefinitionBySlug
|
|
479
|
+
* @summary: Get custom fields definition by resource, slug and namespace
|
|
480
|
+
* @description: Custom field definitions can be retrived from this using its slug, namespace and resource - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getAppCustomFieldDefinitionBySlug/).
|
|
459
481
|
*/
|
|
460
|
-
|
|
482
|
+
getAppCustomFieldDefinitionBySlug({ slug, resource, namespace, requestHeaders }?: ContentPlatformApplicationValidator.GetAppCustomFieldDefinitionBySlugParam, { responseHeaders }?: object): Promise<ContentPlatformModel.MetaFieldDefinitionDetailResSchema>;
|
|
461
483
|
/**
|
|
462
484
|
* @param {ContentPlatformApplicationValidator.GetAppCustomFieldDefinitionsParam} arg
|
|
463
485
|
* - Arg object
|
|
@@ -470,34 +492,21 @@ declare class Content {
|
|
|
470
492
|
* @summary: Get custom fields definitions
|
|
471
493
|
* @description: Custom field definitions enable you to include data validation for custom fields, and enable sellers to add custom fields values for resources. With the help of this seller can retrive list of custom field definitions list. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getAppCustomFieldDefinitions/).
|
|
472
494
|
*/
|
|
473
|
-
getAppCustomFieldDefinitions({ pageNo, pageSize,
|
|
495
|
+
getAppCustomFieldDefinitions({ pageNo, pageSize, resources, types, search, slugs, namespaces, requestHeaders, }?: ContentPlatformApplicationValidator.GetAppCustomFieldDefinitionsParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CustomFieldDefinitionsSchema>;
|
|
474
496
|
/**
|
|
475
497
|
* @param {ContentPlatformApplicationValidator.GetAppCustomFieldTypesParam} arg
|
|
476
498
|
* - Arg object
|
|
477
499
|
*
|
|
478
500
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
479
501
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
480
|
-
* @returns {Promise<ContentPlatformModel.
|
|
502
|
+
* @returns {Promise<ContentPlatformModel.MetafieldTypesSchema>} - Success response
|
|
481
503
|
* @name getAppCustomFieldTypes
|
|
482
504
|
* @summary: Get custom field types
|
|
483
505
|
* @description: Each custom field and custom field definition has a type, which defines the type of information that it can store. The custom field types have built-in validation. This api will give list of supported custom fields types - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getAppCustomFieldTypes/).
|
|
484
506
|
*/
|
|
485
|
-
getAppCustomFieldTypes({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentPlatformModel.
|
|
486
|
-
/**
|
|
487
|
-
* @param {ContentPlatformApplicationValidator.GetAppCustomFieldsParam} arg
|
|
488
|
-
* - Arg object
|
|
489
|
-
*
|
|
490
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
491
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
492
|
-
* @returns {Promise<ContentPlatformModel.CustomFieldsResponseSchema>} -
|
|
493
|
-
* Success response
|
|
494
|
-
* @name getAppCustomFields
|
|
495
|
-
* @summary: Get list of custom fields of gives resource
|
|
496
|
-
* @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/platform/content/getAppCustomFields/).
|
|
497
|
-
*/
|
|
498
|
-
getAppCustomFields({ resource, requestHeaders }?: ContentPlatformApplicationValidator.GetAppCustomFieldsParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CustomFieldsResponseSchema>;
|
|
507
|
+
getAppCustomFieldTypes({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentPlatformModel.MetafieldTypesSchema>;
|
|
499
508
|
/**
|
|
500
|
-
* @param {ContentPlatformApplicationValidator.
|
|
509
|
+
* @param {ContentPlatformApplicationValidator.GetAppCustomFieldsByResourceSlugParam} arg
|
|
501
510
|
* - Arg object
|
|
502
511
|
*
|
|
503
512
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -505,36 +514,38 @@ declare class Content {
|
|
|
505
514
|
* @returns {Promise<ContentPlatformModel.CustomFieldsResponseByResourceIdSchema>}
|
|
506
515
|
* - Success response
|
|
507
516
|
*
|
|
508
|
-
* @name
|
|
509
|
-
* @summary: Get list of custom fields of given resource and resource
|
|
510
|
-
* @description: Retrieves a list of custom fields attached to a particular resource by using the resource and resource
|
|
517
|
+
* @name getAppCustomFieldsByResourceSlug
|
|
518
|
+
* @summary: Get list of custom fields of given resource and resource slug
|
|
519
|
+
* @description: Retrieves a list of custom fields attached to a particular resource by using the resource and resource slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getAppCustomFieldsByResourceSlug/).
|
|
511
520
|
*/
|
|
512
|
-
|
|
521
|
+
getAppCustomFieldsByResourceSlug({ resource, resourceSlug, requestHeaders }?: ContentPlatformApplicationValidator.GetAppCustomFieldsByResourceSlugParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CustomFieldsResponseByResourceIdSchema>;
|
|
513
522
|
/**
|
|
514
|
-
* @param {ContentPlatformApplicationValidator.
|
|
523
|
+
* @param {ContentPlatformApplicationValidator.GetAppCustomObjectBySlugParam} arg
|
|
515
524
|
* - Arg object
|
|
516
525
|
*
|
|
517
526
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
518
527
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
519
|
-
* @returns {Promise<ContentPlatformModel.
|
|
520
|
-
*
|
|
528
|
+
* @returns {Promise<ContentPlatformModel.CustomObjectBySlugSchema>} -
|
|
529
|
+
* Success response
|
|
530
|
+
* @name getAppCustomObjectBySlug
|
|
521
531
|
* @summary: Get custom object details
|
|
522
|
-
* @description: Details of custom
|
|
532
|
+
* @description: Details of a custom object entry can be obtained using this endpoint. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getAppCustomObjectBySlug/).
|
|
523
533
|
*/
|
|
524
|
-
|
|
534
|
+
getAppCustomObjectBySlug({ definitionSlug, slug, requestHeaders }?: ContentPlatformApplicationValidator.GetAppCustomObjectBySlugParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CustomObjectBySlugSchema>;
|
|
525
535
|
/**
|
|
526
|
-
* @param {ContentPlatformApplicationValidator.
|
|
536
|
+
* @param {ContentPlatformApplicationValidator.GetAppCustomObjectDefinitionBySlugParam} arg
|
|
527
537
|
* - Arg object
|
|
528
538
|
*
|
|
529
539
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
530
540
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
531
|
-
* @returns {Promise<ContentPlatformModel.
|
|
532
|
-
* Success response
|
|
533
|
-
*
|
|
541
|
+
* @returns {Promise<ContentPlatformModel.CustomObjectDefinitionSlugSchema>}
|
|
542
|
+
* - Success response
|
|
543
|
+
*
|
|
544
|
+
* @name getAppCustomObjectDefinitionBySlug
|
|
534
545
|
* @summary: Get custom object definition
|
|
535
|
-
* @description: Custom object definitions can be fetched using their definition
|
|
546
|
+
* @description: Custom object definitions can be fetched using their custom object definition slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getAppCustomObjectDefinitionBySlug/).
|
|
536
547
|
*/
|
|
537
|
-
|
|
548
|
+
getAppCustomObjectDefinitionBySlug({ slug, requestHeaders }?: ContentPlatformApplicationValidator.GetAppCustomObjectDefinitionBySlugParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CustomObjectDefinitionSlugSchema>;
|
|
538
549
|
/**
|
|
539
550
|
* @param {ContentPlatformApplicationValidator.GetAppCustomObjectDefinitionsParam} arg
|
|
540
551
|
* - Arg object
|
|
@@ -549,17 +560,17 @@ declare class Content {
|
|
|
549
560
|
*/
|
|
550
561
|
getAppCustomObjectDefinitions({ pageNo, pageSize, search, requestHeaders }?: ContentPlatformApplicationValidator.GetAppCustomObjectDefinitionsParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CustomObjectDefinitionsSchema>;
|
|
551
562
|
/**
|
|
552
|
-
* @param {ContentPlatformApplicationValidator.
|
|
563
|
+
* @param {ContentPlatformApplicationValidator.GetAppCustomObjectsBySlugParam} arg
|
|
553
564
|
* - Arg object
|
|
554
565
|
*
|
|
555
566
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
556
567
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
557
568
|
* @returns {Promise<ContentPlatformModel.CustomObjectsSchema>} - Success response
|
|
558
|
-
* @name
|
|
569
|
+
* @name getAppCustomObjectsBySlug
|
|
559
570
|
* @summary: Get list of custom objects
|
|
560
|
-
* @description: Custom object entries can fetch using this endpoint. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/
|
|
571
|
+
* @description: Custom object entries can fetch using this endpoint. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getAppCustomObjectsBySlug/).
|
|
561
572
|
*/
|
|
562
|
-
|
|
573
|
+
getAppCustomObjectsBySlug({ pageNo, pageSize, definitionSlug, requestHeaders }?: ContentPlatformApplicationValidator.GetAppCustomObjectsBySlugParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CustomObjectsSchema>;
|
|
563
574
|
/**
|
|
564
575
|
* @param {ContentPlatformApplicationValidator.GetAppJobsParam} arg - Arg object
|
|
565
576
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -594,12 +605,12 @@ declare class Content {
|
|
|
594
605
|
* @param {ContentPlatformApplicationValidator.GetBlogsParam} arg - Arg object
|
|
595
606
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
596
607
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
597
|
-
* @returns {Promise<ContentPlatformModel.
|
|
608
|
+
* @returns {Promise<ContentPlatformModel.BlogGetDetails>} - Success response
|
|
598
609
|
* @name getBlogs
|
|
599
610
|
* @summary: List blogs
|
|
600
611
|
* @description: List all blogs - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getBlogs/).
|
|
601
612
|
*/
|
|
602
|
-
getBlogs({ pageNo, pageSize, tags, q, slug, title, status, requestHeaders }?: ContentPlatformApplicationValidator.GetBlogsParam, { responseHeaders }?: object): Promise<ContentPlatformModel.
|
|
613
|
+
getBlogs({ pageNo, pageSize, tags, q, slug, title, status, requestHeaders }?: ContentPlatformApplicationValidator.GetBlogsParam, { responseHeaders }?: object): Promise<ContentPlatformModel.BlogGetDetails>;
|
|
603
614
|
/**
|
|
604
615
|
* @param {ContentPlatformApplicationValidator.GetDataLoadersParam} arg - Arg object
|
|
605
616
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -629,13 +640,13 @@ declare class Content {
|
|
|
629
640
|
*
|
|
630
641
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
631
642
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
632
|
-
* @returns {Promise<ContentPlatformModel.
|
|
643
|
+
* @returns {Promise<ContentPlatformModel.DefaultNavigationDetails>} -
|
|
633
644
|
* Success response
|
|
634
645
|
* @name getDefaultNavigations
|
|
635
646
|
* @summary: Get default navigations
|
|
636
647
|
* @description: Retrieve default navigation elements. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getDefaultNavigations/).
|
|
637
648
|
*/
|
|
638
|
-
getDefaultNavigations({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentPlatformModel.
|
|
649
|
+
getDefaultNavigations({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentPlatformModel.DefaultNavigationDetails>;
|
|
639
650
|
/**
|
|
640
651
|
* @param {ContentPlatformApplicationValidator.GetDefaultSEOMarkupSchemaParam} arg
|
|
641
652
|
* - Arg object
|
|
@@ -648,6 +659,18 @@ declare class Content {
|
|
|
648
659
|
* @description: Use this API to List default SEO Markup Schemas - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getDefaultSEOMarkupSchema/).
|
|
649
660
|
*/
|
|
650
661
|
getDefaultSEOMarkupSchema({ pageType, requestHeaders }?: ContentPlatformApplicationValidator.GetDefaultSEOMarkupSchemaParam, { responseHeaders }?: object): Promise<ContentPlatformModel.DefaultSchemaComponent>;
|
|
662
|
+
/**
|
|
663
|
+
* @param {ContentPlatformApplicationValidator.GetDefaultSitemapConfigParam} arg
|
|
664
|
+
* - Arg object
|
|
665
|
+
*
|
|
666
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
667
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
668
|
+
* @returns {Promise<ContentPlatformModel.DefaultSitemapConfig>} - Success response
|
|
669
|
+
* @name getDefaultSitemapConfig
|
|
670
|
+
* @summary: Get default sitemap configuration
|
|
671
|
+
* @description: Retrieves the current default sitemap configuration settings - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getDefaultSitemapConfig/).
|
|
672
|
+
*/
|
|
673
|
+
getDefaultSitemapConfig({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentPlatformModel.DefaultSitemapConfig>;
|
|
651
674
|
/**
|
|
652
675
|
* @param {ContentPlatformApplicationValidator.GetFaqByIdOrSlugParam} arg - Arg object
|
|
653
676
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -709,12 +732,12 @@ declare class Content {
|
|
|
709
732
|
* @param {ContentPlatformApplicationValidator.GetLandingPagesParam} arg - Arg object
|
|
710
733
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
711
734
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
712
|
-
* @returns {Promise<ContentPlatformModel.
|
|
735
|
+
* @returns {Promise<ContentPlatformModel.LandingPageGetDetails>} - Success response
|
|
713
736
|
* @name getLandingPages
|
|
714
737
|
* @summary: Get landing pages
|
|
715
738
|
* @description: Lists a list landing pages as per device types - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getLandingPages/).
|
|
716
739
|
*/
|
|
717
|
-
getLandingPages({ pageNo, pageSize, requestHeaders }?: ContentPlatformApplicationValidator.GetLandingPagesParam, { responseHeaders }?: object): Promise<ContentPlatformModel.
|
|
740
|
+
getLandingPages({ pageNo, pageSize, requestHeaders }?: ContentPlatformApplicationValidator.GetLandingPagesParam, { responseHeaders }?: object): Promise<ContentPlatformModel.LandingPageGetDetails>;
|
|
718
741
|
/**
|
|
719
742
|
* @param {ContentPlatformApplicationValidator.GetLegalInformationParam} arg
|
|
720
743
|
* - Arg object
|
|
@@ -743,12 +766,12 @@ declare class Content {
|
|
|
743
766
|
* @param {ContentPlatformApplicationValidator.GetNavigationsParam} arg - Arg object
|
|
744
767
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
745
768
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
746
|
-
* @returns {Promise<ContentPlatformModel.
|
|
769
|
+
* @returns {Promise<ContentPlatformModel.NavigationGetDetails>} - Success response
|
|
747
770
|
* @name getNavigations
|
|
748
771
|
* @summary: Get navigation items
|
|
749
772
|
* @description: Retrieve a list of navigational elements. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getNavigations/).
|
|
750
773
|
*/
|
|
751
|
-
getNavigations({ devicePlatform, pageNo, pageSize, requestHeaders }?: ContentPlatformApplicationValidator.GetNavigationsParam, { responseHeaders }?: object): Promise<ContentPlatformModel.
|
|
774
|
+
getNavigations({ devicePlatform, pageNo, pageSize, requestHeaders }?: ContentPlatformApplicationValidator.GetNavigationsParam, { responseHeaders }?: object): Promise<ContentPlatformModel.NavigationGetDetails>;
|
|
752
775
|
/**
|
|
753
776
|
* @param {ContentPlatformApplicationValidator.GetPageBySlugParam} arg - Arg object
|
|
754
777
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -783,12 +806,12 @@ declare class Content {
|
|
|
783
806
|
* @param {ContentPlatformApplicationValidator.GetPagesParam} arg - Arg object
|
|
784
807
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
785
808
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
786
|
-
* @returns {Promise<ContentPlatformModel.
|
|
809
|
+
* @returns {Promise<ContentPlatformModel.PageGetDetails>} - Success response
|
|
787
810
|
* @name getPages
|
|
788
811
|
* @summary: Get pages
|
|
789
812
|
* @description: Retrieve a list of available pages. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getPages/).
|
|
790
813
|
*/
|
|
791
|
-
getPages({ pageNo, pageSize, requestHeaders }?: ContentPlatformApplicationValidator.GetPagesParam, { responseHeaders }?: object): Promise<ContentPlatformModel.
|
|
814
|
+
getPages({ pageNo, pageSize, requestHeaders }?: ContentPlatformApplicationValidator.GetPagesParam, { responseHeaders }?: object): Promise<ContentPlatformModel.PageGetDetails>;
|
|
792
815
|
/**
|
|
793
816
|
* @param {ContentPlatformApplicationValidator.GetPathRedirectionRuleParam} arg
|
|
794
817
|
* - Arg object
|
|
@@ -849,6 +872,29 @@ declare class Content {
|
|
|
849
872
|
* @description: Use this API to List default SEO Markup Schemas - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getSEOMarkupSchemas/).
|
|
850
873
|
*/
|
|
851
874
|
getSEOMarkupSchemas({ title, active, pageNo, pageSize, requestHeaders }?: ContentPlatformApplicationValidator.GetSEOMarkupSchemasParam, { responseHeaders }?: object): Promise<ContentPlatformModel.SeoSchemaComponent>;
|
|
875
|
+
/**
|
|
876
|
+
* @param {ContentPlatformApplicationValidator.GetSitemapParam} arg - Arg object
|
|
877
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
878
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
879
|
+
* @returns {Promise<ContentPlatformModel.SitemapConfig>} - Success response
|
|
880
|
+
* @name getSitemap
|
|
881
|
+
* @summary: Get a specific sitemap configuration
|
|
882
|
+
* @description: Retrieve a specific sitemap configuration by its name. Returns the complete configuration including the sitemap XML data, activation status, and timestamps.
|
|
883
|
+
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getSitemap/).
|
|
884
|
+
*/
|
|
885
|
+
getSitemap({ name, requestHeaders }?: ContentPlatformApplicationValidator.GetSitemapParam, { responseHeaders }?: object): Promise<ContentPlatformModel.SitemapConfig>;
|
|
886
|
+
/**
|
|
887
|
+
* @param {ContentPlatformApplicationValidator.GetSitemapsParam} arg - Arg object
|
|
888
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
889
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
890
|
+
* @returns {Promise<ContentPlatformModel.SitemapConfigurationList>} -
|
|
891
|
+
* Success response
|
|
892
|
+
* @name getSitemaps
|
|
893
|
+
* @summary: List sitemap configurations
|
|
894
|
+
* @description: Retrieve a list of sitemap configurations for a specific company and application. Each configuration contains the sitemap XML data and its activation status.
|
|
895
|
+
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getSitemaps/).
|
|
896
|
+
*/
|
|
897
|
+
getSitemaps({ pageNo, pageSize, isActive, name, requestHeaders }?: ContentPlatformApplicationValidator.GetSitemapsParam, { responseHeaders }?: object): Promise<ContentPlatformModel.SitemapConfigurationList>;
|
|
852
898
|
/**
|
|
853
899
|
* @param {ContentPlatformApplicationValidator.GetSlideshowBySlugParam} arg
|
|
854
900
|
* - Arg object
|
|
@@ -865,32 +911,12 @@ declare class Content {
|
|
|
865
911
|
* @param {ContentPlatformApplicationValidator.GetSlideshowsParam} arg - Arg object
|
|
866
912
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
867
913
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
868
|
-
* @returns {Promise<ContentPlatformModel.
|
|
914
|
+
* @returns {Promise<ContentPlatformModel.SlideshowGetDetails>} - Success response
|
|
869
915
|
* @name getSlideshows
|
|
870
916
|
* @summary: List Slideshows
|
|
871
917
|
* @description: Use this API to list all Slideshows - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getSlideshows/).
|
|
872
918
|
*/
|
|
873
|
-
getSlideshows({ devicePlatform, pageNo, pageSize, requestHeaders }?: ContentPlatformApplicationValidator.GetSlideshowsParam, { responseHeaders }?: object): Promise<ContentPlatformModel.
|
|
874
|
-
/**
|
|
875
|
-
* @param {Object} arg - Arg object.
|
|
876
|
-
* @param {string} arg.companyId - Numeric ID allotted to a business account
|
|
877
|
-
* on Fynd Platform
|
|
878
|
-
* @param {string} arg.applicationId - Numeric ID allotted to an application
|
|
879
|
-
* created within a business account.
|
|
880
|
-
* @param {string} arg.devicePlatform - Filter slideshows by platform.
|
|
881
|
-
* Acceptable values are: web, android, ios and all
|
|
882
|
-
* @param {number} [arg.pageSize] - The number of items to retrieve in each
|
|
883
|
-
* page. Default value is 10.
|
|
884
|
-
* @returns {Paginator<ContentPlatformModel.SlideshowGetResponse>}
|
|
885
|
-
* @summary: List Slideshows
|
|
886
|
-
* @description: Use this API to list all Slideshows
|
|
887
|
-
*/
|
|
888
|
-
getSlideshowsPaginator({ companyId, applicationId, devicePlatform, pageSize, }?: {
|
|
889
|
-
companyId: string;
|
|
890
|
-
applicationId: string;
|
|
891
|
-
devicePlatform: string;
|
|
892
|
-
pageSize?: number;
|
|
893
|
-
}): Paginator<ContentPlatformModel.SlideshowGetResponse>;
|
|
919
|
+
getSlideshows({ devicePlatform, pageNo, pageSize, requestHeaders }?: ContentPlatformApplicationValidator.GetSlideshowsParam, { responseHeaders }?: object): Promise<ContentPlatformModel.SlideshowGetDetails>;
|
|
894
920
|
/**
|
|
895
921
|
* @param {ContentPlatformApplicationValidator.GetSupportInformationParam} arg
|
|
896
922
|
* - Arg object
|
|
@@ -904,32 +930,31 @@ declare class Content {
|
|
|
904
930
|
*/
|
|
905
931
|
getSupportInformation({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentPlatformModel.Support>;
|
|
906
932
|
/**
|
|
907
|
-
* @param {ContentPlatformApplicationValidator.
|
|
933
|
+
* @param {ContentPlatformApplicationValidator.ImportAppCustomObjectEntriesBySlugParam} arg
|
|
908
934
|
* - Arg object
|
|
909
935
|
*
|
|
910
936
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
911
937
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
912
|
-
* @returns {Promise<ContentPlatformModel.
|
|
938
|
+
* @returns {Promise<ContentPlatformModel.CustomObjectEntryBulkUploadDetails>}
|
|
913
939
|
* - Success response
|
|
914
940
|
*
|
|
915
|
-
* @name
|
|
941
|
+
* @name importAppCustomObjectEntriesBySlug
|
|
916
942
|
* @summary: Bulk custom object entries upload
|
|
917
|
-
* @description: Custom object bulk import of bulk entries can be performed using this endpoint. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/
|
|
943
|
+
* @description: Custom object bulk import of bulk entries can be performed using this endpoint. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/importAppCustomObjectEntriesBySlug/).
|
|
918
944
|
*/
|
|
919
|
-
|
|
945
|
+
importAppCustomObjectEntriesBySlug({ slug, body, requestHeaders }?: ContentPlatformApplicationValidator.ImportAppCustomObjectEntriesBySlugParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CustomObjectEntryBulkUploadDetails>;
|
|
920
946
|
/**
|
|
921
947
|
* @param {ContentPlatformApplicationValidator.RemoveInjectableTagParam} arg
|
|
922
948
|
* - Arg object
|
|
923
949
|
*
|
|
924
950
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
925
951
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
926
|
-
* @returns {Promise<ContentPlatformModel.
|
|
927
|
-
* Success response
|
|
952
|
+
* @returns {Promise<ContentPlatformModel.TagDeleteSuccessDetails>} - Success response
|
|
928
953
|
* @name removeInjectableTag
|
|
929
954
|
* @summary: Remove HTML tag
|
|
930
955
|
* @description: Delete a specific injectable tag. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/removeInjectableTag/).
|
|
931
956
|
*/
|
|
932
|
-
removeInjectableTag({ body, requestHeaders }?: ContentPlatformApplicationValidator.RemoveInjectableTagParam, { responseHeaders }?: object): Promise<ContentPlatformModel.
|
|
957
|
+
removeInjectableTag({ body, requestHeaders }?: ContentPlatformApplicationValidator.RemoveInjectableTagParam, { responseHeaders }?: object): Promise<ContentPlatformModel.TagDeleteSuccessDetails>;
|
|
933
958
|
/**
|
|
934
959
|
* @param {ContentPlatformApplicationValidator.ResetDataLoaderParam} arg - Arg object
|
|
935
960
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -942,17 +967,17 @@ declare class Content {
|
|
|
942
967
|
*/
|
|
943
968
|
resetDataLoader({ service, operationId, requestHeaders }?: ContentPlatformApplicationValidator.ResetDataLoaderParam, { responseHeaders }?: object): Promise<ContentPlatformModel.DataLoaderResetResponseSchema>;
|
|
944
969
|
/**
|
|
945
|
-
* @param {ContentPlatformApplicationValidator.
|
|
970
|
+
* @param {ContentPlatformApplicationValidator.SampleAppCustomObjectBulkEntryBySlugParam} arg
|
|
946
971
|
* - Arg object
|
|
947
972
|
*
|
|
948
973
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
949
974
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
950
975
|
* @returns {Promise<string>} - Success response
|
|
951
|
-
* @name
|
|
976
|
+
* @name sampleAppCustomObjectBulkEntryBySlug
|
|
952
977
|
* @summary: Download sample for custom object bulk entry
|
|
953
|
-
* @description: Sample files for custom object bulk import can be obtained from this endpoint. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/
|
|
978
|
+
* @description: Sample files for custom object bulk import can be obtained from this endpoint. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/sampleAppCustomObjectBulkEntryBySlug/).
|
|
954
979
|
*/
|
|
955
|
-
|
|
980
|
+
sampleAppCustomObjectBulkEntryBySlug({ slug, requestHeaders }?: ContentPlatformApplicationValidator.SampleAppCustomObjectBulkEntryBySlugParam, { responseHeaders }?: object): Promise<string>;
|
|
956
981
|
/**
|
|
957
982
|
* @param {ContentPlatformApplicationValidator.SelectDataLoaderParam} arg - Arg object
|
|
958
983
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -991,7 +1016,21 @@ declare class Content {
|
|
|
991
1016
|
*/
|
|
992
1017
|
updateAnnouncementSchedule({ announcementId, body, requestHeaders }?: ContentPlatformApplicationValidator.UpdateAnnouncementScheduleParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CreateAnnouncementSchema>;
|
|
993
1018
|
/**
|
|
994
|
-
* @param {ContentPlatformApplicationValidator.
|
|
1019
|
+
* @param {ContentPlatformApplicationValidator.UpdateAppCustomFieldByResourceSlugParam} arg
|
|
1020
|
+
* - Arg object
|
|
1021
|
+
*
|
|
1022
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1023
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1024
|
+
* @returns {Promise<ContentPlatformModel.CustomFieldsResponseByResourceIdSchema>}
|
|
1025
|
+
* - Success response
|
|
1026
|
+
*
|
|
1027
|
+
* @name updateAppCustomFieldByResourceSlug
|
|
1028
|
+
* @summary: Create custom field entries for gives resource and resource slug
|
|
1029
|
+
* @description: You can add a custom field using this endpoint to any resource by providing the resource slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updateAppCustomFieldByResourceSlug/).
|
|
1030
|
+
*/
|
|
1031
|
+
updateAppCustomFieldByResourceSlug({ resource, resourceSlug, body, requestHeaders }?: ContentPlatformApplicationValidator.UpdateAppCustomFieldByResourceSlugParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CustomFieldsResponseByResourceIdSchema>;
|
|
1032
|
+
/**
|
|
1033
|
+
* @param {ContentPlatformApplicationValidator.UpdateAppCustomFieldDefinitionBySlugParam} arg
|
|
995
1034
|
* - Arg object
|
|
996
1035
|
*
|
|
997
1036
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -999,36 +1038,38 @@ declare class Content {
|
|
|
999
1038
|
* @returns {Promise<ContentPlatformModel.CustomFieldDefinitionDetailResSchema>}
|
|
1000
1039
|
* - Success response
|
|
1001
1040
|
*
|
|
1002
|
-
* @name
|
|
1041
|
+
* @name updateAppCustomFieldDefinitionBySlug
|
|
1003
1042
|
* @summary: Update custom field definition
|
|
1004
|
-
* @description: Custom fields definition can be update using this api, You can update custom field definition name and description. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/
|
|
1043
|
+
* @description: Custom fields definition can be update using this api, You can update custom field definition name and description. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updateAppCustomFieldDefinitionBySlug/).
|
|
1005
1044
|
*/
|
|
1006
|
-
|
|
1045
|
+
updateAppCustomFieldDefinitionBySlug({ slug, resource, namespace, body, requestHeaders }?: ContentPlatformApplicationValidator.UpdateAppCustomFieldDefinitionBySlugParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CustomFieldDefinitionDetailResSchema>;
|
|
1007
1046
|
/**
|
|
1008
|
-
* @param {ContentPlatformApplicationValidator.
|
|
1047
|
+
* @param {ContentPlatformApplicationValidator.UpdateAppCustomObjectBySlugParam} arg
|
|
1009
1048
|
* - Arg object
|
|
1010
1049
|
*
|
|
1011
1050
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1012
1051
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1013
|
-
* @returns {Promise<ContentPlatformModel.
|
|
1014
|
-
*
|
|
1052
|
+
* @returns {Promise<ContentPlatformModel.CustomObjectBySlugSchema>} -
|
|
1053
|
+
* Success response
|
|
1054
|
+
* @name updateAppCustomObjectBySlug
|
|
1015
1055
|
* @summary: Update custom object details
|
|
1016
|
-
* @description: Custom object entries can be updated using this endpoint. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/
|
|
1056
|
+
* @description: Custom object entries can be updated using this endpoint. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updateAppCustomObjectBySlug/).
|
|
1017
1057
|
*/
|
|
1018
|
-
|
|
1058
|
+
updateAppCustomObjectBySlug({ definitionSlug, slug, body, requestHeaders }?: ContentPlatformApplicationValidator.UpdateAppCustomObjectBySlugParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CustomObjectBySlugSchema>;
|
|
1019
1059
|
/**
|
|
1020
|
-
* @param {ContentPlatformApplicationValidator.
|
|
1060
|
+
* @param {ContentPlatformApplicationValidator.UpdateAppCustomObjectDefinitionBySlugParam} arg
|
|
1021
1061
|
* - Arg object
|
|
1022
1062
|
*
|
|
1023
1063
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1024
1064
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1025
|
-
* @returns {Promise<ContentPlatformModel.
|
|
1026
|
-
* Success response
|
|
1027
|
-
*
|
|
1065
|
+
* @returns {Promise<ContentPlatformModel.CustomObjectDefinitionSlugSchema>}
|
|
1066
|
+
* - Success response
|
|
1067
|
+
*
|
|
1068
|
+
* @name updateAppCustomObjectDefinitionBySlug
|
|
1028
1069
|
* @summary: Update custom object definition
|
|
1029
|
-
* @description: Custom object definitions can be updated using this endpoint. You can update the name and description of the custom object and add more custom field definitions to the existing custom object. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/
|
|
1070
|
+
* @description: Custom object definitions can be updated using this endpoint. You can update the name and description of the custom object and add more custom field definitions to the existing custom object. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updateAppCustomObjectDefinitionBySlug/).
|
|
1030
1071
|
*/
|
|
1031
|
-
|
|
1072
|
+
updateAppCustomObjectDefinitionBySlug({ slug, body, requestHeaders }?: ContentPlatformApplicationValidator.UpdateAppCustomObjectDefinitionBySlugParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CustomObjectDefinitionSlugSchema>;
|
|
1032
1073
|
/**
|
|
1033
1074
|
* @param {ContentPlatformApplicationValidator.UpdateBlogParam} arg - Arg object
|
|
1034
1075
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -1039,6 +1080,18 @@ declare class Content {
|
|
|
1039
1080
|
* @description: Modify the content and settings of a specific blog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updateBlog/).
|
|
1040
1081
|
*/
|
|
1041
1082
|
updateBlog({ id, body, requestHeaders }?: ContentPlatformApplicationValidator.UpdateBlogParam, { responseHeaders }?: object): Promise<ContentPlatformModel.BlogSchema>;
|
|
1083
|
+
/**
|
|
1084
|
+
* @param {ContentPlatformApplicationValidator.UpdateDefaultSitemapConfigParam} arg
|
|
1085
|
+
* - Arg object
|
|
1086
|
+
*
|
|
1087
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1088
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1089
|
+
* @returns {Promise<ContentPlatformModel.DefaultSitemapConfig>} - Success response
|
|
1090
|
+
* @name updateDefaultSitemapConfig
|
|
1091
|
+
* @summary: Update default sitemap configuration
|
|
1092
|
+
* @description: Updates the default sitemap configuration settings - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updateDefaultSitemapConfig/).
|
|
1093
|
+
*/
|
|
1094
|
+
updateDefaultSitemapConfig({ body, requestHeaders }?: ContentPlatformApplicationValidator.UpdateDefaultSitemapConfigParam, { responseHeaders }?: object): Promise<ContentPlatformModel.DefaultSitemapConfig>;
|
|
1042
1095
|
/**
|
|
1043
1096
|
* @param {ContentPlatformApplicationValidator.UpdateFaqParam} arg - Arg object
|
|
1044
1097
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -1153,6 +1206,17 @@ declare class Content {
|
|
|
1153
1206
|
* @description: Modify configuration settings for SEO. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updateSEOConfiguration/).
|
|
1154
1207
|
*/
|
|
1155
1208
|
updateSEOConfiguration({ body, requestHeaders }?: ContentPlatformApplicationValidator.UpdateSEOConfigurationParam, { responseHeaders }?: object): Promise<ContentPlatformModel.SeoSchema>;
|
|
1209
|
+
/**
|
|
1210
|
+
* @param {ContentPlatformApplicationValidator.UpdateSitemapParam} arg - Arg object
|
|
1211
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1212
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1213
|
+
* @returns {Promise<ContentPlatformModel.SitemapConfig>} - Success response
|
|
1214
|
+
* @name updateSitemap
|
|
1215
|
+
* @summary: Update a specific sitemap configuration
|
|
1216
|
+
* @description: Update an existing sitemap configuration identified by its name. You can update the activation status and/or the sitemap XML data. The name cannot be modified once the configuration is created. The updated sitemap XML data must be valid XML following the sitemap protocol specification.
|
|
1217
|
+
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updateSitemap/).
|
|
1218
|
+
*/
|
|
1219
|
+
updateSitemap({ name, body, requestHeaders }?: ContentPlatformApplicationValidator.UpdateSitemapParam, { responseHeaders }?: object): Promise<ContentPlatformModel.SitemapConfig>;
|
|
1156
1220
|
/**
|
|
1157
1221
|
* @param {ContentPlatformApplicationValidator.UpdateSlideshowParam} arg - Arg object
|
|
1158
1222
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -1178,4 +1242,3 @@ declare class Content {
|
|
|
1178
1242
|
}
|
|
1179
1243
|
import ContentPlatformApplicationValidator = require("./ContentPlatformApplicationValidator");
|
|
1180
1244
|
import ContentPlatformModel = require("./ContentPlatformModel");
|
|
1181
|
-
import Paginator = require("../../common/Paginator");
|