@gofynd/fdk-client-javascript 1.4.7 → 1.4.8-beta.3
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/Cart/CartApplicationClient.d.ts +16 -3
- package/sdk/application/Cart/CartApplicationClient.js +118 -13
- package/sdk/application/Cart/CartApplicationModel.d.ts +121 -45
- package/sdk/application/Cart/CartApplicationModel.js +98 -26
- package/sdk/application/Cart/CartApplicationValidator.d.ts +45 -1
- package/sdk/application/Cart/CartApplicationValidator.js +26 -0
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +4 -2
- package/sdk/application/Catalog/CatalogApplicationModel.js +4 -2
- package/sdk/application/Content/ContentApplicationClient.d.ts +1 -1
- package/sdk/application/Content/ContentApplicationClient.js +5 -3
- package/sdk/application/Content/ContentApplicationModel.d.ts +7 -18
- package/sdk/application/Content/ContentApplicationModel.js +6 -20
- package/sdk/application/Content/ContentApplicationValidator.d.ts +10 -0
- package/sdk/application/Content/ContentApplicationValidator.js +4 -0
- package/sdk/application/Lead/LeadApplicationClient.d.ts +0 -27
- package/sdk/application/Lead/LeadApplicationClient.js +0 -167
- package/sdk/application/Lead/LeadApplicationModel.d.ts +1 -146
- package/sdk/application/Lead/LeadApplicationModel.js +0 -126
- package/sdk/application/Lead/LeadApplicationValidator.d.ts +1 -25
- package/sdk/application/Lead/LeadApplicationValidator.js +0 -24
- package/sdk/application/Logistic/LogisticApplicationClient.js +1 -1
- package/sdk/application/Logistic/LogisticApplicationModel.d.ts +2 -0
- package/sdk/application/Logistic/LogisticApplicationModel.js +2 -0
- package/sdk/application/Order/OrderApplicationModel.d.ts +4 -0
- package/sdk/application/Order/OrderApplicationModel.js +4 -0
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +9 -2
- package/sdk/application/Payment/PaymentApplicationModel.js +5 -2
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +2 -0
- package/sdk/application/Theme/ThemeApplicationModel.js +2 -0
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +0 -23
- package/sdk/partner/Lead/LeadPartnerClient.js +0 -157
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +12 -581
- package/sdk/partner/Lead/LeadPartnerModel.js +14 -403
- package/sdk/partner/Lead/LeadPartnerValidator.d.ts +0 -2
- package/sdk/partner/Lead/LeadPartnerValidator.js +0 -12
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +47 -1
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +56 -4
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +2 -2
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +22 -0
- package/sdk/partner/Theme/ThemePartnerClient.js +162 -0
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +119 -1
- package/sdk/partner/Theme/ThemePartnerModel.js +142 -0
- package/sdk/partner/Theme/ThemePartnerValidator.d.ts +2 -0
- package/sdk/partner/Theme/ThemePartnerValidator.js +14 -0
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +304 -43
- package/sdk/platform/Billing/BillingPlatformClient.js +2218 -118
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +1330 -282
- package/sdk/platform/Billing/BillingPlatformModel.js +1808 -590
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +324 -16
- package/sdk/platform/Billing/BillingPlatformValidator.js +340 -12
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +28 -5
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +198 -5
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +81 -1
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +48 -0
- package/sdk/platform/Cart/CartPlatformModel.d.ts +214 -40
- package/sdk/platform/Cart/CartPlatformModel.js +164 -24
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +20 -0
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +37 -0
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +16 -0
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +2 -2
- package/sdk/platform/Catalog/CatalogPlatformClient.js +18 -2
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +4 -0
- package/sdk/platform/Catalog/CatalogPlatformModel.js +4 -0
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +28 -0
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +12 -0
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +18 -1
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +25 -0
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +10 -0
- package/sdk/platform/Content/ContentPlatformModel.d.ts +8 -4
- package/sdk/platform/Content/ContentPlatformModel.js +8 -4
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +49 -28
- package/sdk/platform/Finance/FinancePlatformClient.js +181 -28
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +369 -129
- package/sdk/platform/Finance/FinancePlatformModel.js +404 -110
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +56 -43
- package/sdk/platform/Finance/FinancePlatformValidator.js +61 -42
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +0 -47
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +0 -321
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +1 -46
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +0 -48
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +2 -25
- package/sdk/platform/Lead/LeadPlatformClient.js +2 -167
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +82 -204
- package/sdk/platform/Lead/LeadPlatformModel.js +98 -178
- package/sdk/platform/Lead/LeadPlatformValidator.d.ts +1 -25
- package/sdk/platform/Lead/LeadPlatformValidator.js +0 -24
- package/sdk/platform/Order/OrderPlatformModel.d.ts +126 -15
- package/sdk/platform/Order/OrderPlatformModel.js +55 -14
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +12 -0
- package/sdk/platform/Payment/PaymentPlatformModel.js +5 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +1 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +4 -4
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +20 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +26 -4
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +4 -4
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +4 -4
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +12 -0
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +82 -0
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +18 -1
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +14 -0
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +67 -1
- package/sdk/platform/Theme/ThemePlatformModel.js +78 -0
- package/sdk/platform/User/UserPlatformModel.d.ts +0 -2
- package/sdk/platform/User/UserPlatformModel.js +0 -2
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +0 -40
- package/sdk/platform/Webhook/WebhookPlatformClient.js +0 -307
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +94 -146
- package/sdk/platform/Webhook/WebhookPlatformModel.js +100 -151
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +9 -35
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +8 -46
- package/sdk/public/Billing/BillingPublicClient.d.ts +24 -2
- package/sdk/public/Billing/BillingPublicClient.js +156 -3
- package/sdk/public/Billing/BillingPublicModel.d.ts +368 -26
- package/sdk/public/Billing/BillingPublicModel.js +317 -18
- package/sdk/public/Billing/BillingPublicValidator.d.ts +19 -3
- package/sdk/public/Billing/BillingPublicValidator.js +22 -3
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +22 -22
- package/sdk/public/Webhook/WebhookPublicModel.js +22 -22
|
@@ -1829,6 +1829,11 @@ class Catalog {
|
|
|
1829
1829
|
timestamp,
|
|
1830
1830
|
pageSize,
|
|
1831
1831
|
pageId,
|
|
1832
|
+
qtyGt,
|
|
1833
|
+
qtyLt,
|
|
1834
|
+
qtyType,
|
|
1835
|
+
fromDate,
|
|
1836
|
+
toDate,
|
|
1832
1837
|
requestHeaders,
|
|
1833
1838
|
} = { requestHeaders: {} },
|
|
1834
1839
|
{ responseHeaders } = { responseHeaders: false }
|
|
@@ -1844,6 +1849,11 @@ class Catalog {
|
|
|
1844
1849
|
timestamp,
|
|
1845
1850
|
pageSize,
|
|
1846
1851
|
pageId,
|
|
1852
|
+
qtyGt,
|
|
1853
|
+
qtyLt,
|
|
1854
|
+
qtyType,
|
|
1855
|
+
fromDate,
|
|
1856
|
+
toDate,
|
|
1847
1857
|
},
|
|
1848
1858
|
{ abortEarly: false, allowUnknown: true }
|
|
1849
1859
|
);
|
|
@@ -1863,6 +1873,11 @@ class Catalog {
|
|
|
1863
1873
|
timestamp,
|
|
1864
1874
|
pageSize,
|
|
1865
1875
|
pageId,
|
|
1876
|
+
qtyGt,
|
|
1877
|
+
qtyLt,
|
|
1878
|
+
qtyType,
|
|
1879
|
+
fromDate,
|
|
1880
|
+
toDate,
|
|
1866
1881
|
},
|
|
1867
1882
|
{ abortEarly: false, allowUnknown: false }
|
|
1868
1883
|
);
|
|
@@ -1881,6 +1896,11 @@ class Catalog {
|
|
|
1881
1896
|
query_params["timestamp"] = timestamp;
|
|
1882
1897
|
query_params["page_size"] = pageSize;
|
|
1883
1898
|
query_params["page_id"] = pageId;
|
|
1899
|
+
query_params["qty_gt"] = qtyGt;
|
|
1900
|
+
query_params["qty_lt"] = qtyLt;
|
|
1901
|
+
query_params["qty_type"] = qtyType;
|
|
1902
|
+
query_params["from_date"] = fromDate;
|
|
1903
|
+
query_params["to_date"] = toDate;
|
|
1884
1904
|
|
|
1885
1905
|
const response = await PlatformAPIClient.execute(
|
|
1886
1906
|
this.config,
|
|
@@ -106,6 +106,17 @@ export = CatalogPlatformApplicationValidator;
|
|
|
106
106
|
* @property {string} [timestamp] - Timestamp in UTC format (2020-07-23T10:27:50Z)
|
|
107
107
|
* @property {number} [pageSize] - The number of items to retrieve in each page.
|
|
108
108
|
* @property {string} [pageId] - Page ID to retrieve next set of results.
|
|
109
|
+
* @property {number} [qtyGt] - This field allows you to filter for inventories
|
|
110
|
+
* that have quantity greater than to the specified value based on qty_type filter.
|
|
111
|
+
* @property {number} [qtyLt] - This field allows you to filter for inventories
|
|
112
|
+
* that have a quantity less than to the specified value based on qty_type filter.
|
|
113
|
+
* @property {string} [qtyType] - This field provides flexibility in selecting
|
|
114
|
+
* filter for inventory quantity counts and date queries. For example, you
|
|
115
|
+
* might use this field to specify "total" or "sellable" quantity.
|
|
116
|
+
* @property {string} [fromDate] - Inventory updated on filter to get
|
|
117
|
+
* inventories greater then or equal to provided date based on qty_type value.
|
|
118
|
+
* @property {string} [toDate] - Inventory updated on filter to get inventories
|
|
119
|
+
* less then or equal to provided date based on qty_type value.
|
|
109
120
|
*/
|
|
110
121
|
/**
|
|
111
122
|
* @typedef GetAppLocationsParam
|
|
@@ -709,6 +720,32 @@ type GetAppInventoryParam = {
|
|
|
709
720
|
* - Page ID to retrieve next set of results.
|
|
710
721
|
*/
|
|
711
722
|
pageId?: string;
|
|
723
|
+
/**
|
|
724
|
+
* - This field allows you to filter for inventories
|
|
725
|
+
* that have quantity greater than to the specified value based on qty_type filter.
|
|
726
|
+
*/
|
|
727
|
+
qtyGt?: number;
|
|
728
|
+
/**
|
|
729
|
+
* - This field allows you to filter for inventories
|
|
730
|
+
* that have a quantity less than to the specified value based on qty_type filter.
|
|
731
|
+
*/
|
|
732
|
+
qtyLt?: number;
|
|
733
|
+
/**
|
|
734
|
+
* - This field provides flexibility in selecting
|
|
735
|
+
* filter for inventory quantity counts and date queries. For example, you
|
|
736
|
+
* might use this field to specify "total" or "sellable" quantity.
|
|
737
|
+
*/
|
|
738
|
+
qtyType?: string;
|
|
739
|
+
/**
|
|
740
|
+
* - Inventory updated on filter to get
|
|
741
|
+
* inventories greater then or equal to provided date based on qty_type value.
|
|
742
|
+
*/
|
|
743
|
+
fromDate?: string;
|
|
744
|
+
/**
|
|
745
|
+
* - Inventory updated on filter to get inventories
|
|
746
|
+
* less then or equal to provided date based on qty_type value.
|
|
747
|
+
*/
|
|
748
|
+
toDate?: string;
|
|
712
749
|
};
|
|
713
750
|
type GetAppLocationsParam = {
|
|
714
751
|
/**
|
|
@@ -130,6 +130,17 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
|
|
|
130
130
|
* @property {string} [timestamp] - Timestamp in UTC format (2020-07-23T10:27:50Z)
|
|
131
131
|
* @property {number} [pageSize] - The number of items to retrieve in each page.
|
|
132
132
|
* @property {string} [pageId] - Page ID to retrieve next set of results.
|
|
133
|
+
* @property {number} [qtyGt] - This field allows you to filter for inventories
|
|
134
|
+
* that have quantity greater than to the specified value based on qty_type filter.
|
|
135
|
+
* @property {number} [qtyLt] - This field allows you to filter for inventories
|
|
136
|
+
* that have a quantity less than to the specified value based on qty_type filter.
|
|
137
|
+
* @property {string} [qtyType] - This field provides flexibility in selecting
|
|
138
|
+
* filter for inventory quantity counts and date queries. For example, you
|
|
139
|
+
* might use this field to specify "total" or "sellable" quantity.
|
|
140
|
+
* @property {string} [fromDate] - Inventory updated on filter to get
|
|
141
|
+
* inventories greater then or equal to provided date based on qty_type value.
|
|
142
|
+
* @property {string} [toDate] - Inventory updated on filter to get inventories
|
|
143
|
+
* less then or equal to provided date based on qty_type value.
|
|
133
144
|
*/
|
|
134
145
|
|
|
135
146
|
/**
|
|
@@ -645,6 +656,11 @@ class CatalogPlatformApplicationValidator {
|
|
|
645
656
|
timestamp: Joi.string().allow(""),
|
|
646
657
|
pageSize: Joi.number(),
|
|
647
658
|
pageId: Joi.string().allow(""),
|
|
659
|
+
qtyGt: Joi.number(),
|
|
660
|
+
qtyLt: Joi.number(),
|
|
661
|
+
qtyType: Joi.string().allow(""),
|
|
662
|
+
fromDate: Joi.string().allow(""),
|
|
663
|
+
toDate: Joi.string().allow(""),
|
|
648
664
|
}).required();
|
|
649
665
|
}
|
|
650
666
|
|
|
@@ -640,7 +640,7 @@ declare class Catalog {
|
|
|
640
640
|
* @summary: Get product export jobs
|
|
641
641
|
* @description: Get product export jobs specific to a company based on queries like query param, date range and status. View details including trigger data, task id , etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductExportJobs/).
|
|
642
642
|
*/
|
|
643
|
-
getProductExportJobs({ status, fromDate, toDate, q, requestHeaders }?: CatalogPlatformValidator.GetProductExportJobsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductDownloadsResponse>;
|
|
643
|
+
getProductExportJobs({ status, fromDate, toDate, q, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetProductExportJobsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductDownloadsResponse>;
|
|
644
644
|
/**
|
|
645
645
|
* @param {CatalogPlatformValidator.GetProductSizeParam} arg - Arg object
|
|
646
646
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -883,7 +883,7 @@ declare class Catalog {
|
|
|
883
883
|
* @summary: List inventory export jobs
|
|
884
884
|
* @description: Retrieve the history of inventory export jobs associated with the company - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listInventoryExport/).
|
|
885
885
|
*/
|
|
886
|
-
listInventoryExport({ status, fromDate, toDate, q, requestHeaders }?: CatalogPlatformValidator.ListInventoryExportParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryExportJobListResponse>;
|
|
886
|
+
listInventoryExport({ status, fromDate, toDate, q, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.ListInventoryExportParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryExportJobListResponse>;
|
|
887
887
|
/**
|
|
888
888
|
* @param {CatalogPlatformValidator.ListProductTemplateParam} arg - Arg object
|
|
889
889
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -4273,7 +4273,9 @@ class Catalog {
|
|
|
4273
4273
|
* @description: Get product export jobs specific to a company based on queries like query param, date range and status. View details including trigger data, task id , etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductExportJobs/).
|
|
4274
4274
|
*/
|
|
4275
4275
|
async getProductExportJobs(
|
|
4276
|
-
{ status, fromDate, toDate, q, requestHeaders } = {
|
|
4276
|
+
{ status, fromDate, toDate, q, pageNo, pageSize, requestHeaders } = {
|
|
4277
|
+
requestHeaders: {},
|
|
4278
|
+
},
|
|
4277
4279
|
{ responseHeaders } = { responseHeaders: false }
|
|
4278
4280
|
) {
|
|
4279
4281
|
const { error } = CatalogPlatformValidator.getProductExportJobs().validate(
|
|
@@ -4282,6 +4284,8 @@ class Catalog {
|
|
|
4282
4284
|
fromDate,
|
|
4283
4285
|
toDate,
|
|
4284
4286
|
q,
|
|
4287
|
+
pageNo,
|
|
4288
|
+
pageSize,
|
|
4285
4289
|
},
|
|
4286
4290
|
{ abortEarly: false, allowUnknown: true }
|
|
4287
4291
|
);
|
|
@@ -4298,6 +4302,8 @@ class Catalog {
|
|
|
4298
4302
|
fromDate,
|
|
4299
4303
|
toDate,
|
|
4300
4304
|
q,
|
|
4305
|
+
pageNo,
|
|
4306
|
+
pageSize,
|
|
4301
4307
|
},
|
|
4302
4308
|
{ abortEarly: false, allowUnknown: false }
|
|
4303
4309
|
);
|
|
@@ -4313,6 +4319,8 @@ class Catalog {
|
|
|
4313
4319
|
query_params["from_date"] = fromDate;
|
|
4314
4320
|
query_params["to_date"] = toDate;
|
|
4315
4321
|
query_params["q"] = q;
|
|
4322
|
+
query_params["page_no"] = pageNo;
|
|
4323
|
+
query_params["page_size"] = pageSize;
|
|
4316
4324
|
|
|
4317
4325
|
const xHeaders = {};
|
|
4318
4326
|
|
|
@@ -5708,7 +5716,9 @@ class Catalog {
|
|
|
5708
5716
|
* @description: Retrieve the history of inventory export jobs associated with the company - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listInventoryExport/).
|
|
5709
5717
|
*/
|
|
5710
5718
|
async listInventoryExport(
|
|
5711
|
-
{ status, fromDate, toDate, q, requestHeaders } = {
|
|
5719
|
+
{ status, fromDate, toDate, q, pageNo, pageSize, requestHeaders } = {
|
|
5720
|
+
requestHeaders: {},
|
|
5721
|
+
},
|
|
5712
5722
|
{ responseHeaders } = { responseHeaders: false }
|
|
5713
5723
|
) {
|
|
5714
5724
|
const { error } = CatalogPlatformValidator.listInventoryExport().validate(
|
|
@@ -5717,6 +5727,8 @@ class Catalog {
|
|
|
5717
5727
|
fromDate,
|
|
5718
5728
|
toDate,
|
|
5719
5729
|
q,
|
|
5730
|
+
pageNo,
|
|
5731
|
+
pageSize,
|
|
5720
5732
|
},
|
|
5721
5733
|
{ abortEarly: false, allowUnknown: true }
|
|
5722
5734
|
);
|
|
@@ -5733,6 +5745,8 @@ class Catalog {
|
|
|
5733
5745
|
fromDate,
|
|
5734
5746
|
toDate,
|
|
5735
5747
|
q,
|
|
5748
|
+
pageNo,
|
|
5749
|
+
pageSize,
|
|
5736
5750
|
},
|
|
5737
5751
|
{ abortEarly: false, allowUnknown: false }
|
|
5738
5752
|
);
|
|
@@ -5748,6 +5762,8 @@ class Catalog {
|
|
|
5748
5762
|
query_params["from_date"] = fromDate;
|
|
5749
5763
|
query_params["to_date"] = toDate;
|
|
5750
5764
|
query_params["q"] = q;
|
|
5765
|
+
query_params["page_no"] = pageNo;
|
|
5766
|
+
query_params["page_size"] = pageSize;
|
|
5751
5767
|
|
|
5752
5768
|
const xHeaders = {};
|
|
5753
5769
|
|
|
@@ -1729,6 +1729,7 @@ export = CatalogPlatformModel;
|
|
|
1729
1729
|
* @typedef InventoryExportJobListResponse
|
|
1730
1730
|
* @property {InventoryJobDetailResponse} items - This is the list/history of
|
|
1731
1731
|
* all the jobs.
|
|
1732
|
+
* @property {Page} [page]
|
|
1732
1733
|
*/
|
|
1733
1734
|
/**
|
|
1734
1735
|
* @typedef InventoryExportQuantityFilter
|
|
@@ -2479,6 +2480,7 @@ export = CatalogPlatformModel;
|
|
|
2479
2480
|
/**
|
|
2480
2481
|
* @typedef ProductDownloadsResponse
|
|
2481
2482
|
* @property {ProductTemplateExportResponse[]} [items] - The items of the job.
|
|
2483
|
+
* @property {Page} [page]
|
|
2482
2484
|
*/
|
|
2483
2485
|
/**
|
|
2484
2486
|
* @typedef ProductFilters
|
|
@@ -5835,6 +5837,7 @@ type InventoryExportJobListResponse = {
|
|
|
5835
5837
|
* all the jobs.
|
|
5836
5838
|
*/
|
|
5837
5839
|
items: InventoryJobDetailResponse;
|
|
5840
|
+
page?: Page;
|
|
5838
5841
|
};
|
|
5839
5842
|
/** @returns {InventoryExportQuantityFilter} */
|
|
5840
5843
|
declare function InventoryExportQuantityFilter(): InventoryExportQuantityFilter;
|
|
@@ -7009,6 +7012,7 @@ type ProductDownloadsResponse = {
|
|
|
7009
7012
|
* - The items of the job.
|
|
7010
7013
|
*/
|
|
7011
7014
|
items?: ProductTemplateExportResponse[];
|
|
7015
|
+
page?: Page;
|
|
7012
7016
|
};
|
|
7013
7017
|
/** @returns {ProductFilters} */
|
|
7014
7018
|
declare function ProductFilters(): ProductFilters;
|
|
@@ -1929,6 +1929,7 @@ const Joi = require("joi");
|
|
|
1929
1929
|
* @typedef InventoryExportJobListResponse
|
|
1930
1930
|
* @property {InventoryJobDetailResponse} items - This is the list/history of
|
|
1931
1931
|
* all the jobs.
|
|
1932
|
+
* @property {Page} [page]
|
|
1932
1933
|
*/
|
|
1933
1934
|
|
|
1934
1935
|
/**
|
|
@@ -2758,6 +2759,7 @@ const Joi = require("joi");
|
|
|
2758
2759
|
/**
|
|
2759
2760
|
* @typedef ProductDownloadsResponse
|
|
2760
2761
|
* @property {ProductTemplateExportResponse[]} [items] - The items of the job.
|
|
2762
|
+
* @property {Page} [page]
|
|
2761
2763
|
*/
|
|
2762
2764
|
|
|
2763
2765
|
/**
|
|
@@ -6028,6 +6030,7 @@ class CatalogPlatformModel {
|
|
|
6028
6030
|
static InventoryExportJobListResponse() {
|
|
6029
6031
|
return Joi.object({
|
|
6030
6032
|
items: CatalogPlatformModel.InventoryJobDetailResponse().required(),
|
|
6033
|
+
page: CatalogPlatformModel.Page(),
|
|
6031
6034
|
});
|
|
6032
6035
|
}
|
|
6033
6036
|
|
|
@@ -7012,6 +7015,7 @@ class CatalogPlatformModel {
|
|
|
7012
7015
|
items: Joi.array().items(
|
|
7013
7016
|
CatalogPlatformModel.ProductTemplateExportResponse()
|
|
7014
7017
|
),
|
|
7018
|
+
page: CatalogPlatformModel.Page(),
|
|
7015
7019
|
});
|
|
7016
7020
|
}
|
|
7017
7021
|
|
|
@@ -269,6 +269,10 @@ export = CatalogPlatformValidator;
|
|
|
269
269
|
* the from_date specified to the to_date.
|
|
270
270
|
* @property {string} [q] - It is a query parameter to search the export job
|
|
271
271
|
* with the task ID.
|
|
272
|
+
* @property {number} [pageNo] - The page number to navigate through the given
|
|
273
|
+
* set of results
|
|
274
|
+
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
275
|
+
* Default is 12.
|
|
272
276
|
*/
|
|
273
277
|
/**
|
|
274
278
|
* @typedef GetProductSizeParam
|
|
@@ -368,6 +372,10 @@ export = CatalogPlatformValidator;
|
|
|
368
372
|
* to from_date.
|
|
369
373
|
* @property {string} [toDate] - Inventory export history filtered according to from_date.
|
|
370
374
|
* @property {string} [q] - Inventory export history filtered according to task ID.
|
|
375
|
+
* @property {number} [pageNo] - The page number to navigate through the given
|
|
376
|
+
* set of results
|
|
377
|
+
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
378
|
+
* Default is 12.
|
|
371
379
|
*/
|
|
372
380
|
/**
|
|
373
381
|
* @typedef ListProductTemplateParam
|
|
@@ -1079,6 +1087,16 @@ type GetProductExportJobsParam = {
|
|
|
1079
1087
|
* with the task ID.
|
|
1080
1088
|
*/
|
|
1081
1089
|
q?: string;
|
|
1090
|
+
/**
|
|
1091
|
+
* - The page number to navigate through the given
|
|
1092
|
+
* set of results
|
|
1093
|
+
*/
|
|
1094
|
+
pageNo?: number;
|
|
1095
|
+
/**
|
|
1096
|
+
* - Number of items to retrieve in each page.
|
|
1097
|
+
* Default is 12.
|
|
1098
|
+
*/
|
|
1099
|
+
pageSize?: number;
|
|
1082
1100
|
};
|
|
1083
1101
|
type GetProductSizeParam = {
|
|
1084
1102
|
/**
|
|
@@ -1305,6 +1323,16 @@ type ListInventoryExportParam = {
|
|
|
1305
1323
|
* - Inventory export history filtered according to task ID.
|
|
1306
1324
|
*/
|
|
1307
1325
|
q?: string;
|
|
1326
|
+
/**
|
|
1327
|
+
* - The page number to navigate through the given
|
|
1328
|
+
* set of results
|
|
1329
|
+
*/
|
|
1330
|
+
pageNo?: number;
|
|
1331
|
+
/**
|
|
1332
|
+
* - Number of items to retrieve in each page.
|
|
1333
|
+
* Default is 12.
|
|
1334
|
+
*/
|
|
1335
|
+
pageSize?: number;
|
|
1308
1336
|
};
|
|
1309
1337
|
type ListProductTemplateParam = {
|
|
1310
1338
|
/**
|
|
@@ -320,6 +320,10 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
|
|
|
320
320
|
* the from_date specified to the to_date.
|
|
321
321
|
* @property {string} [q] - It is a query parameter to search the export job
|
|
322
322
|
* with the task ID.
|
|
323
|
+
* @property {number} [pageNo] - The page number to navigate through the given
|
|
324
|
+
* set of results
|
|
325
|
+
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
326
|
+
* Default is 12.
|
|
323
327
|
*/
|
|
324
328
|
|
|
325
329
|
/**
|
|
@@ -433,6 +437,10 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
|
|
|
433
437
|
* to from_date.
|
|
434
438
|
* @property {string} [toDate] - Inventory export history filtered according to from_date.
|
|
435
439
|
* @property {string} [q] - Inventory export history filtered according to task ID.
|
|
440
|
+
* @property {number} [pageNo] - The page number to navigate through the given
|
|
441
|
+
* set of results
|
|
442
|
+
* @property {number} [pageSize] - Number of items to retrieve in each page.
|
|
443
|
+
* Default is 12.
|
|
436
444
|
*/
|
|
437
445
|
|
|
438
446
|
/**
|
|
@@ -922,6 +930,8 @@ class CatalogPlatformValidator {
|
|
|
922
930
|
fromDate: Joi.string().allow(""),
|
|
923
931
|
toDate: Joi.string().allow(""),
|
|
924
932
|
q: Joi.string().allow(""),
|
|
933
|
+
pageNo: Joi.number(),
|
|
934
|
+
pageSize: Joi.number(),
|
|
925
935
|
}).required();
|
|
926
936
|
}
|
|
927
937
|
|
|
@@ -1050,6 +1060,8 @@ class CatalogPlatformValidator {
|
|
|
1050
1060
|
fromDate: Joi.string().allow(""),
|
|
1051
1061
|
toDate: Joi.string().allow(""),
|
|
1052
1062
|
q: Joi.string().allow(""),
|
|
1063
|
+
pageNo: Joi.number(),
|
|
1064
|
+
pageSize: Joi.number(),
|
|
1053
1065
|
}).required();
|
|
1054
1066
|
}
|
|
1055
1067
|
|
|
@@ -599,7 +599,7 @@ declare class Content {
|
|
|
599
599
|
* @summary: List blogs
|
|
600
600
|
* @description: List all blogs - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getBlogs/).
|
|
601
601
|
*/
|
|
602
|
-
getBlogs({ pageNo, pageSize, requestHeaders }?: ContentPlatformApplicationValidator.GetBlogsParam, { responseHeaders }?: object): Promise<ContentPlatformModel.BlogGetResponse>;
|
|
602
|
+
getBlogs({ pageNo, pageSize, tags, q, slug, title, status, requestHeaders }?: ContentPlatformApplicationValidator.GetBlogsParam, { responseHeaders }?: object): Promise<ContentPlatformModel.BlogGetResponse>;
|
|
603
603
|
/**
|
|
604
604
|
* @param {ContentPlatformApplicationValidator.GetComponentByIdParam} arg - Arg object
|
|
605
605
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -4096,13 +4096,20 @@ class Content {
|
|
|
4096
4096
|
* @description: List all blogs - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getBlogs/).
|
|
4097
4097
|
*/
|
|
4098
4098
|
async getBlogs(
|
|
4099
|
-
{ pageNo, pageSize,
|
|
4099
|
+
{ pageNo, pageSize, tags, q, slug, title, status, requestHeaders } = {
|
|
4100
|
+
requestHeaders: {},
|
|
4101
|
+
},
|
|
4100
4102
|
{ responseHeaders } = { responseHeaders: false }
|
|
4101
4103
|
) {
|
|
4102
4104
|
const { error } = ContentPlatformApplicationValidator.getBlogs().validate(
|
|
4103
4105
|
{
|
|
4104
4106
|
pageNo,
|
|
4105
4107
|
pageSize,
|
|
4108
|
+
tags,
|
|
4109
|
+
q,
|
|
4110
|
+
slug,
|
|
4111
|
+
title,
|
|
4112
|
+
status,
|
|
4106
4113
|
},
|
|
4107
4114
|
{ abortEarly: false, allowUnknown: true }
|
|
4108
4115
|
);
|
|
@@ -4117,6 +4124,11 @@ class Content {
|
|
|
4117
4124
|
{
|
|
4118
4125
|
pageNo,
|
|
4119
4126
|
pageSize,
|
|
4127
|
+
tags,
|
|
4128
|
+
q,
|
|
4129
|
+
slug,
|
|
4130
|
+
title,
|
|
4131
|
+
status,
|
|
4120
4132
|
},
|
|
4121
4133
|
{ abortEarly: false, allowUnknown: false }
|
|
4122
4134
|
);
|
|
@@ -4130,6 +4142,11 @@ class Content {
|
|
|
4130
4142
|
const query_params = {};
|
|
4131
4143
|
query_params["page_no"] = pageNo;
|
|
4132
4144
|
query_params["page_size"] = pageSize;
|
|
4145
|
+
query_params["tags"] = tags;
|
|
4146
|
+
query_params["q"] = q;
|
|
4147
|
+
query_params["slug"] = slug;
|
|
4148
|
+
query_params["title"] = title;
|
|
4149
|
+
query_params["status"] = status;
|
|
4133
4150
|
|
|
4134
4151
|
const response = await PlatformAPIClient.execute(
|
|
4135
4152
|
this.config,
|
|
@@ -226,6 +226,11 @@ export = ContentPlatformApplicationValidator;
|
|
|
226
226
|
* set of results. Default value is 1.
|
|
227
227
|
* @property {number} [pageSize] - The number of items to retrieve in each page.
|
|
228
228
|
* Default value is 10.
|
|
229
|
+
* @property {string} [tags] - Blogs retrieve based on the list of tags passed.
|
|
230
|
+
* @property {string} [q] - Blogs retrieve based on the title or slug passed.
|
|
231
|
+
* @property {string} [slug] - Blogs retrieve based on the slug passed.
|
|
232
|
+
* @property {string} [title] - Blogs retrieve based on the title passed.
|
|
233
|
+
* @property {string} [status] - Blogs retrieve based on the status passed.
|
|
229
234
|
*/
|
|
230
235
|
/**
|
|
231
236
|
* @typedef GetComponentByIdParam
|
|
@@ -907,6 +912,26 @@ type GetBlogsParam = {
|
|
|
907
912
|
* Default value is 10.
|
|
908
913
|
*/
|
|
909
914
|
pageSize?: number;
|
|
915
|
+
/**
|
|
916
|
+
* - Blogs retrieve based on the list of tags passed.
|
|
917
|
+
*/
|
|
918
|
+
tags?: string;
|
|
919
|
+
/**
|
|
920
|
+
* - Blogs retrieve based on the title or slug passed.
|
|
921
|
+
*/
|
|
922
|
+
q?: string;
|
|
923
|
+
/**
|
|
924
|
+
* - Blogs retrieve based on the slug passed.
|
|
925
|
+
*/
|
|
926
|
+
slug?: string;
|
|
927
|
+
/**
|
|
928
|
+
* - Blogs retrieve based on the title passed.
|
|
929
|
+
*/
|
|
930
|
+
title?: string;
|
|
931
|
+
/**
|
|
932
|
+
* - Blogs retrieve based on the status passed.
|
|
933
|
+
*/
|
|
934
|
+
status?: string;
|
|
910
935
|
};
|
|
911
936
|
type GetComponentByIdParam = {
|
|
912
937
|
/**
|
|
@@ -279,6 +279,11 @@ const ContentPlatformModel = require("./ContentPlatformModel");
|
|
|
279
279
|
* set of results. Default value is 1.
|
|
280
280
|
* @property {number} [pageSize] - The number of items to retrieve in each page.
|
|
281
281
|
* Default value is 10.
|
|
282
|
+
* @property {string} [tags] - Blogs retrieve based on the list of tags passed.
|
|
283
|
+
* @property {string} [q] - Blogs retrieve based on the title or slug passed.
|
|
284
|
+
* @property {string} [slug] - Blogs retrieve based on the slug passed.
|
|
285
|
+
* @property {string} [title] - Blogs retrieve based on the title passed.
|
|
286
|
+
* @property {string} [status] - Blogs retrieve based on the status passed.
|
|
282
287
|
*/
|
|
283
288
|
|
|
284
289
|
/**
|
|
@@ -932,6 +937,11 @@ class ContentPlatformApplicationValidator {
|
|
|
932
937
|
return Joi.object({
|
|
933
938
|
pageNo: Joi.number(),
|
|
934
939
|
pageSize: Joi.number(),
|
|
940
|
+
tags: Joi.string().allow(""),
|
|
941
|
+
q: Joi.string().allow(""),
|
|
942
|
+
slug: Joi.string().allow(""),
|
|
943
|
+
title: Joi.string().allow(""),
|
|
944
|
+
status: Joi.string().allow(""),
|
|
935
945
|
}).required();
|
|
936
946
|
}
|
|
937
947
|
|
|
@@ -159,6 +159,7 @@ export = ContentPlatformModel;
|
|
|
159
159
|
* @typedef BlogGetResponse
|
|
160
160
|
* @property {BlogSchema[]} [items]
|
|
161
161
|
* @property {Page} [page]
|
|
162
|
+
* @property {string[]} [filters]
|
|
162
163
|
*/
|
|
163
164
|
/**
|
|
164
165
|
* @typedef ResourceContent
|
|
@@ -192,9 +193,9 @@ export = ContentPlatformModel;
|
|
|
192
193
|
* @property {string} [publish_date]
|
|
193
194
|
* @property {string[]} [tags]
|
|
194
195
|
* @property {SEO} [seo]
|
|
195
|
-
* @property {CronSchedule} [_schedule]
|
|
196
196
|
* @property {string} [title]
|
|
197
197
|
* @property {DateMeta} [date_meta]
|
|
198
|
+
* @property {string} [summary]
|
|
198
199
|
*/
|
|
199
200
|
/**
|
|
200
201
|
* @typedef SEO
|
|
@@ -248,7 +249,7 @@ export = ContentPlatformModel;
|
|
|
248
249
|
* @property {string[]} [tags]
|
|
249
250
|
* @property {string} [title]
|
|
250
251
|
* @property {SEO} [seo]
|
|
251
|
-
* @property {
|
|
252
|
+
* @property {string} [summary]
|
|
252
253
|
*/
|
|
253
254
|
/**
|
|
254
255
|
* @typedef GetAnnouncementListSchema
|
|
@@ -675,6 +676,7 @@ export = ContentPlatformModel;
|
|
|
675
676
|
* @property {string} [key]
|
|
676
677
|
* @property {string} [code]
|
|
677
678
|
* @property {string} [number]
|
|
679
|
+
* @property {string} [phone_type]
|
|
678
680
|
*/
|
|
679
681
|
/**
|
|
680
682
|
* @typedef PhoneSchema
|
|
@@ -1413,6 +1415,7 @@ declare function BlogGetResponse(): BlogGetResponse;
|
|
|
1413
1415
|
type BlogGetResponse = {
|
|
1414
1416
|
items?: BlogSchema[];
|
|
1415
1417
|
page?: Page;
|
|
1418
|
+
filters?: string[];
|
|
1416
1419
|
};
|
|
1417
1420
|
/** @returns {ResourceContent} */
|
|
1418
1421
|
declare function ResourceContent(): ResourceContent;
|
|
@@ -1450,9 +1453,9 @@ type BlogSchema = {
|
|
|
1450
1453
|
publish_date?: string;
|
|
1451
1454
|
tags?: string[];
|
|
1452
1455
|
seo?: SEO;
|
|
1453
|
-
_schedule?: CronSchedule;
|
|
1454
1456
|
title?: string;
|
|
1455
1457
|
date_meta?: DateMeta;
|
|
1458
|
+
summary?: string;
|
|
1456
1459
|
};
|
|
1457
1460
|
/** @returns {SEO} */
|
|
1458
1461
|
declare function SEO(): SEO;
|
|
@@ -1514,7 +1517,7 @@ type BlogRequest = {
|
|
|
1514
1517
|
tags?: string[];
|
|
1515
1518
|
title?: string;
|
|
1516
1519
|
seo?: SEO;
|
|
1517
|
-
|
|
1520
|
+
summary?: string;
|
|
1518
1521
|
};
|
|
1519
1522
|
/** @returns {GetAnnouncementListSchema} */
|
|
1520
1523
|
declare function GetAnnouncementListSchema(): GetAnnouncementListSchema;
|
|
@@ -2003,6 +2006,7 @@ type PhoneProperties = {
|
|
|
2003
2006
|
key?: string;
|
|
2004
2007
|
code?: string;
|
|
2005
2008
|
number?: string;
|
|
2009
|
+
phone_type?: string;
|
|
2006
2010
|
};
|
|
2007
2011
|
/** @returns {PhoneSchema} */
|
|
2008
2012
|
declare function PhoneSchema(): PhoneSchema;
|
|
@@ -181,6 +181,7 @@ const Joi = require("joi");
|
|
|
181
181
|
* @typedef BlogGetResponse
|
|
182
182
|
* @property {BlogSchema[]} [items]
|
|
183
183
|
* @property {Page} [page]
|
|
184
|
+
* @property {string[]} [filters]
|
|
184
185
|
*/
|
|
185
186
|
|
|
186
187
|
/**
|
|
@@ -218,9 +219,9 @@ const Joi = require("joi");
|
|
|
218
219
|
* @property {string} [publish_date]
|
|
219
220
|
* @property {string[]} [tags]
|
|
220
221
|
* @property {SEO} [seo]
|
|
221
|
-
* @property {CronSchedule} [_schedule]
|
|
222
222
|
* @property {string} [title]
|
|
223
223
|
* @property {DateMeta} [date_meta]
|
|
224
|
+
* @property {string} [summary]
|
|
224
225
|
*/
|
|
225
226
|
|
|
226
227
|
/**
|
|
@@ -282,7 +283,7 @@ const Joi = require("joi");
|
|
|
282
283
|
* @property {string[]} [tags]
|
|
283
284
|
* @property {string} [title]
|
|
284
285
|
* @property {SEO} [seo]
|
|
285
|
-
* @property {
|
|
286
|
+
* @property {string} [summary]
|
|
286
287
|
*/
|
|
287
288
|
|
|
288
289
|
/**
|
|
@@ -768,6 +769,7 @@ const Joi = require("joi");
|
|
|
768
769
|
* @property {string} [key]
|
|
769
770
|
* @property {string} [code]
|
|
770
771
|
* @property {string} [number]
|
|
772
|
+
* @property {string} [phone_type]
|
|
771
773
|
*/
|
|
772
774
|
|
|
773
775
|
/**
|
|
@@ -1610,6 +1612,7 @@ class ContentPlatformModel {
|
|
|
1610
1612
|
return Joi.object({
|
|
1611
1613
|
items: Joi.array().items(ContentPlatformModel.BlogSchema()),
|
|
1612
1614
|
page: ContentPlatformModel.Page(),
|
|
1615
|
+
filters: Joi.array().items(Joi.string().allow("")),
|
|
1613
1616
|
});
|
|
1614
1617
|
}
|
|
1615
1618
|
|
|
@@ -1655,9 +1658,9 @@ class ContentPlatformModel {
|
|
|
1655
1658
|
publish_date: Joi.string().allow(""),
|
|
1656
1659
|
tags: Joi.array().items(Joi.string().allow("")),
|
|
1657
1660
|
seo: ContentPlatformModel.SEO(),
|
|
1658
|
-
_schedule: ContentPlatformModel.CronSchedule(),
|
|
1659
1661
|
title: Joi.string().allow(""),
|
|
1660
1662
|
date_meta: ContentPlatformModel.DateMeta(),
|
|
1663
|
+
summary: Joi.string().allow(""),
|
|
1661
1664
|
});
|
|
1662
1665
|
}
|
|
1663
1666
|
|
|
@@ -1735,7 +1738,7 @@ class ContentPlatformModel {
|
|
|
1735
1738
|
tags: Joi.array().items(Joi.string().allow("")),
|
|
1736
1739
|
title: Joi.string().allow(""),
|
|
1737
1740
|
seo: ContentPlatformModel.SEO(),
|
|
1738
|
-
|
|
1741
|
+
summary: Joi.string().allow(""),
|
|
1739
1742
|
});
|
|
1740
1743
|
}
|
|
1741
1744
|
|
|
@@ -2338,6 +2341,7 @@ class ContentPlatformModel {
|
|
|
2338
2341
|
key: Joi.string().allow(""),
|
|
2339
2342
|
code: Joi.string().allow(""),
|
|
2340
2343
|
number: Joi.string().allow(""),
|
|
2344
|
+
phone_type: Joi.string().allow(""),
|
|
2341
2345
|
});
|
|
2342
2346
|
}
|
|
2343
2347
|
|