@gofynd/fdk-client-javascript 3.26.0 → 3.28.0
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/Configuration/ConfigurationApplicationClient.d.ts +4 -2
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +5 -0
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +11 -1
- package/sdk/application/Payment/PaymentApplicationClient.js +50 -0
- package/sdk/platform/Cart/CartPlatformModel.d.ts +61 -1
- package/sdk/platform/Cart/CartPlatformModel.js +40 -0
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +10 -0
- package/sdk/platform/Catalog/CatalogPlatformClient.js +75 -0
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +203 -1
- package/sdk/platform/Catalog/CatalogPlatformModel.js +103 -0
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +5 -1
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +7 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +27 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +52 -0
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +20 -0
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +41 -0
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +30 -1
- package/sdk/platform/Lead/LeadPlatformModel.js +19 -0
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +22 -0
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +163 -0
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +27 -1
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +26 -0
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +106 -1
- package/sdk/platform/Payment/PaymentPlatformModel.js +79 -0
- package/sdk/platform/PlatformApplicationClient.d.ts +0 -2
- package/sdk/platform/PlatformApplicationClient.js +0 -4
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +14 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +83 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +10 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +12 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +121 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +112 -0
- package/sdk/platform/index.d.ts +0 -1
- package/sdk/platform/index.js +0 -2
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +0 -44
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +0 -263
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +0 -42
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +0 -45
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +0 -136
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +0 -95
|
@@ -1,5 +1,15 @@
|
|
|
1
1
|
const Joi = require("joi");
|
|
2
2
|
|
|
3
|
+
/**
|
|
4
|
+
* @typedef InventoryTransaction
|
|
5
|
+
* @property {string} [type] - Reason category for the inventory change.
|
|
6
|
+
* @property {string} [reference_id] - External transaction reference id (e.g.
|
|
7
|
+
* inbound / PO / transfer id).
|
|
8
|
+
* @property {string} [reason] - Free-text reason for the inventory change.
|
|
9
|
+
* @property {string} [source] - Origin system of the change.
|
|
10
|
+
* @property {string} [user_ref] - Reference to the user who initiated the change.
|
|
11
|
+
*/
|
|
12
|
+
|
|
3
13
|
/**
|
|
4
14
|
* @typedef Action
|
|
5
15
|
* @property {string} [type] - Type of action to be taken e.g, page.
|
|
@@ -1731,6 +1741,12 @@ const Joi = require("joi");
|
|
|
1731
1741
|
* @property {string} [state] - The state or region where the address is located.
|
|
1732
1742
|
*/
|
|
1733
1743
|
|
|
1744
|
+
/**
|
|
1745
|
+
* @typedef RegionDetailsSchema
|
|
1746
|
+
* @property {string} [slug] - Base region slug.
|
|
1747
|
+
* @property {string} [zone] - Zone or cluster slug.
|
|
1748
|
+
*/
|
|
1749
|
+
|
|
1734
1750
|
/**
|
|
1735
1751
|
* @typedef GetAllSizes
|
|
1736
1752
|
* @property {AllSizes[]} [all_sizes]
|
|
@@ -1849,6 +1865,10 @@ const Joi = require("joi");
|
|
|
1849
1865
|
* @property {string} [modified_on] - The date and time when the company record
|
|
1850
1866
|
* was last updated.
|
|
1851
1867
|
* @property {string} [name] - The registered name of the company.
|
|
1868
|
+
* @property {string} [region] - Deployment region slug for the company profile.
|
|
1869
|
+
* When the zone is default, this is the region slug; otherwise it is
|
|
1870
|
+
* formatted as region/zone.
|
|
1871
|
+
* @property {RegionDetailsSchema} [region_details]
|
|
1852
1872
|
* @property {string} [reject_reason] - If applicable, the reason why the
|
|
1853
1873
|
* company's application or status was rejected.
|
|
1854
1874
|
* @property {string} [stage] - Current operational stage of the company, such
|
|
@@ -2403,6 +2423,13 @@ const Joi = require("joi");
|
|
|
2403
2423
|
* @property {number} company_id
|
|
2404
2424
|
* @property {InventoryJobPayload[]} sizes
|
|
2405
2425
|
* @property {Object} [user]
|
|
2426
|
+
* @property {string} [transaction_type] - Reason for the bulk inventory update.
|
|
2427
|
+
* Recorded in the audit-trail event; per-row values on
|
|
2428
|
+
* `sizes[].transaction_type` override this top-level value. Optional;
|
|
2429
|
+
* defaults to "other" when omitted.
|
|
2430
|
+
* @property {InventoryTransaction} [transaction] - Audit transaction context;
|
|
2431
|
+
* supersedes the flat `transaction_type` (its `type` carries the same value).
|
|
2432
|
+
* All fields optional; recorded in the audit-trail event.
|
|
2406
2433
|
*/
|
|
2407
2434
|
|
|
2408
2435
|
/**
|
|
@@ -2551,6 +2578,12 @@ const Joi = require("joi");
|
|
|
2551
2578
|
* @property {string[]} [tags] - The tags associated with the item.
|
|
2552
2579
|
* @property {number} [total_quantity] - The total quantity of the item.
|
|
2553
2580
|
* @property {string} [trace_id] - The trace ID of the inventory job payload.
|
|
2581
|
+
* @property {string} [transaction_type] - Reason for this row's inventory
|
|
2582
|
+
* update. Recorded in the audit-trail event. Overrides the request-level
|
|
2583
|
+
* `transaction_type` when both are present. Optional.
|
|
2584
|
+
* @property {InventoryTransaction} [transaction] - Audit transaction context;
|
|
2585
|
+
* supersedes the flat `transaction_type` (its `type` carries the same value).
|
|
2586
|
+
* All fields optional; recorded in the audit-trail event.
|
|
2554
2587
|
*/
|
|
2555
2588
|
|
|
2556
2589
|
/**
|
|
@@ -2575,6 +2608,7 @@ const Joi = require("joi");
|
|
|
2575
2608
|
* @property {string} [expiration_date] - The expiration date of the inventory item.
|
|
2576
2609
|
* @property {number} [price_effective] - The effective price of the inventory item.
|
|
2577
2610
|
* @property {number} [price_marked] - The marked price of the inventory item.
|
|
2611
|
+
* @property {number} [price_cost] - The cost price of the article.
|
|
2578
2612
|
* @property {string} seller_identifier - The identifier of the seller.
|
|
2579
2613
|
* @property {number} store_id - The ID of the store.
|
|
2580
2614
|
* @property {string[]} [tags] - The tags associated with the inventory item.
|
|
@@ -2585,6 +2619,12 @@ const Joi = require("joi");
|
|
|
2585
2619
|
* the inventory item.
|
|
2586
2620
|
* @property {string} [trace_id] - The trace ID of the inventory payload.
|
|
2587
2621
|
* @property {Object} [meta]
|
|
2622
|
+
* @property {string} [transaction_type] - Reason for this row's inventory
|
|
2623
|
+
* update. Recorded in the audit-trail event. Overrides the request-level
|
|
2624
|
+
* `transaction_type` when both are present. Optional.
|
|
2625
|
+
* @property {InventoryTransaction} [transaction] - Audit transaction context;
|
|
2626
|
+
* supersedes the flat `transaction_type` (its `type` carries the same value).
|
|
2627
|
+
* All fields optional; recorded in the audit-trail event.
|
|
2588
2628
|
*/
|
|
2589
2629
|
|
|
2590
2630
|
/**
|
|
@@ -2592,6 +2632,12 @@ const Joi = require("joi");
|
|
|
2592
2632
|
* @property {number} company_id
|
|
2593
2633
|
* @property {ItemQuery} item
|
|
2594
2634
|
* @property {InvSize[]} sizes
|
|
2635
|
+
* @property {string} [transaction_type] - Reason for the inventory update.
|
|
2636
|
+
* Recorded in the audit-trail event for the resulting article mutation.
|
|
2637
|
+
* Optional; defaults to "other" when omitted.
|
|
2638
|
+
* @property {InventoryTransaction} [transaction] - Audit transaction context;
|
|
2639
|
+
* supersedes the flat `transaction_type` (its `type` carries the same value).
|
|
2640
|
+
* All fields optional; recorded in the audit-trail event.
|
|
2595
2641
|
*/
|
|
2596
2642
|
|
|
2597
2643
|
/**
|
|
@@ -2599,6 +2645,13 @@ const Joi = require("joi");
|
|
|
2599
2645
|
* @property {number} company_id - The ID of the company.
|
|
2600
2646
|
* @property {Object} [meta] - Additional metadata for the inventory request.
|
|
2601
2647
|
* @property {InventoryPayload[]} [payload] - The list of inventory payloads.
|
|
2648
|
+
* @property {string} [transaction_type] - Reason for the inventory update.
|
|
2649
|
+
* Recorded in the audit-trail event for the resulting article mutation;
|
|
2650
|
+
* per-row values on `payload[].transaction_type` override this top-level
|
|
2651
|
+
* value. Optional; defaults to "other" when omitted.
|
|
2652
|
+
* @property {InventoryTransaction} [transaction] - Audit transaction context;
|
|
2653
|
+
* supersedes the flat `transaction_type` (its `type` carries the same value).
|
|
2654
|
+
* All fields optional; recorded in the audit-trail event.
|
|
2602
2655
|
*/
|
|
2603
2656
|
|
|
2604
2657
|
/**
|
|
@@ -3053,7 +3106,14 @@ const Joi = require("joi");
|
|
|
3053
3106
|
* @typedef LocationPriceRequestSchema
|
|
3054
3107
|
* @property {number} price_effective - The effective price of the inventory item.
|
|
3055
3108
|
* @property {number} price_marked - The marked price of the inventory item.
|
|
3109
|
+
* @property {number} [price_cost] - The cost price of the article.
|
|
3056
3110
|
* @property {string[]} [tags] - Tags associated with inventory item.
|
|
3111
|
+
* @property {string} [transaction_type] - Reason for the price update. Recorded
|
|
3112
|
+
* in the audit-trail event for the resulting article mutation. Optional;
|
|
3113
|
+
* defaults to "other" when omitted.
|
|
3114
|
+
* @property {InventoryTransaction} [transaction] - Audit transaction context;
|
|
3115
|
+
* supersedes the flat `transaction_type` (its `type` carries the same value).
|
|
3116
|
+
* All fields optional; recorded in the audit-trail event.
|
|
3057
3117
|
*/
|
|
3058
3118
|
|
|
3059
3119
|
/**
|
|
@@ -3069,6 +3129,12 @@ const Joi = require("joi");
|
|
|
3069
3129
|
* the inventory item. Any one of total_quantity, damaged_quantity,
|
|
3070
3130
|
* not_available_quantity should be provided.
|
|
3071
3131
|
* @property {string} [mode] - Indicates whether delta or replace operation for inventory
|
|
3132
|
+
* @property {string} [transaction_type] - Reason for the quantity update.
|
|
3133
|
+
* Recorded in the audit-trail event for the resulting article mutation.
|
|
3134
|
+
* Optional; defaults to "other" when omitted.
|
|
3135
|
+
* @property {InventoryTransaction} [transaction] - Audit transaction context;
|
|
3136
|
+
* supersedes the flat `transaction_type` (its `type` carries the same value).
|
|
3137
|
+
* All fields optional; recorded in the audit-trail event.
|
|
3072
3138
|
*/
|
|
3073
3139
|
|
|
3074
3140
|
/**
|
|
@@ -5478,6 +5544,17 @@ const Joi = require("joi");
|
|
|
5478
5544
|
*/
|
|
5479
5545
|
|
|
5480
5546
|
class CatalogPlatformModel {
|
|
5547
|
+
/** @returns {InventoryTransaction} */
|
|
5548
|
+
static InventoryTransaction() {
|
|
5549
|
+
return Joi.object({
|
|
5550
|
+
type: Joi.string().allow(""),
|
|
5551
|
+
reference_id: Joi.string().allow(""),
|
|
5552
|
+
reason: Joi.string().allow(""),
|
|
5553
|
+
source: Joi.string().allow(""),
|
|
5554
|
+
user_ref: Joi.string().allow(""),
|
|
5555
|
+
}).allow(null);
|
|
5556
|
+
}
|
|
5557
|
+
|
|
5481
5558
|
/** @returns {Action} */
|
|
5482
5559
|
static Action() {
|
|
5483
5560
|
return Joi.object({
|
|
@@ -7280,6 +7357,14 @@ class CatalogPlatformModel {
|
|
|
7280
7357
|
});
|
|
7281
7358
|
}
|
|
7282
7359
|
|
|
7360
|
+
/** @returns {RegionDetailsSchema} */
|
|
7361
|
+
static RegionDetailsSchema() {
|
|
7362
|
+
return Joi.object({
|
|
7363
|
+
slug: Joi.string().allow(""),
|
|
7364
|
+
zone: Joi.string().allow(""),
|
|
7365
|
+
});
|
|
7366
|
+
}
|
|
7367
|
+
|
|
7283
7368
|
/** @returns {GetAllSizes} */
|
|
7284
7369
|
static GetAllSizes() {
|
|
7285
7370
|
return Joi.object({
|
|
@@ -7411,6 +7496,8 @@ class CatalogPlatformModel {
|
|
|
7411
7496
|
modified_by: CatalogPlatformModel.UserSchema(),
|
|
7412
7497
|
modified_on: Joi.string().allow(""),
|
|
7413
7498
|
name: Joi.string().allow(""),
|
|
7499
|
+
region: Joi.string().allow(""),
|
|
7500
|
+
region_details: CatalogPlatformModel.RegionDetailsSchema(),
|
|
7414
7501
|
reject_reason: Joi.string().allow(""),
|
|
7415
7502
|
stage: Joi.string().allow(""),
|
|
7416
7503
|
uid: Joi.number(),
|
|
@@ -8008,6 +8095,8 @@ class CatalogPlatformModel {
|
|
|
8008
8095
|
.items(CatalogPlatformModel.InventoryJobPayload())
|
|
8009
8096
|
.required(),
|
|
8010
8097
|
user: Joi.object().pattern(/\S/, Joi.any()),
|
|
8098
|
+
transaction_type: Joi.string().allow("").allow(null),
|
|
8099
|
+
transaction: CatalogPlatformModel.InventoryTransaction(),
|
|
8011
8100
|
});
|
|
8012
8101
|
}
|
|
8013
8102
|
|
|
@@ -8164,6 +8253,8 @@ class CatalogPlatformModel {
|
|
|
8164
8253
|
tags: Joi.array().items(Joi.string().allow("")).allow(null, ""),
|
|
8165
8254
|
total_quantity: Joi.number(),
|
|
8166
8255
|
trace_id: Joi.string().allow("").allow(null),
|
|
8256
|
+
transaction_type: Joi.string().allow("").allow(null),
|
|
8257
|
+
transaction: CatalogPlatformModel.InventoryTransaction(),
|
|
8167
8258
|
});
|
|
8168
8259
|
}
|
|
8169
8260
|
|
|
@@ -8191,6 +8282,7 @@ class CatalogPlatformModel {
|
|
|
8191
8282
|
expiration_date: Joi.string().allow(""),
|
|
8192
8283
|
price_effective: Joi.number(),
|
|
8193
8284
|
price_marked: Joi.number(),
|
|
8285
|
+
price_cost: Joi.number(),
|
|
8194
8286
|
seller_identifier: Joi.string().allow("").required(),
|
|
8195
8287
|
store_id: Joi.number().required(),
|
|
8196
8288
|
tags: Joi.array().items(Joi.string().allow("")).allow(null, ""),
|
|
@@ -8200,6 +8292,8 @@ class CatalogPlatformModel {
|
|
|
8200
8292
|
not_available_quantity: Joi.number().allow(null),
|
|
8201
8293
|
trace_id: Joi.string().allow(""),
|
|
8202
8294
|
meta: Joi.object().pattern(/\S/, Joi.any()),
|
|
8295
|
+
transaction_type: Joi.string().allow("").allow(null),
|
|
8296
|
+
transaction: CatalogPlatformModel.InventoryTransaction(),
|
|
8203
8297
|
});
|
|
8204
8298
|
}
|
|
8205
8299
|
|
|
@@ -8209,6 +8303,8 @@ class CatalogPlatformModel {
|
|
|
8209
8303
|
company_id: Joi.number().required(),
|
|
8210
8304
|
item: CatalogPlatformModel.ItemQuery().required(),
|
|
8211
8305
|
sizes: Joi.array().items(CatalogPlatformModel.InvSize()).required(),
|
|
8306
|
+
transaction_type: Joi.string().allow("").allow(null),
|
|
8307
|
+
transaction: CatalogPlatformModel.InventoryTransaction(),
|
|
8212
8308
|
});
|
|
8213
8309
|
}
|
|
8214
8310
|
|
|
@@ -8218,6 +8314,8 @@ class CatalogPlatformModel {
|
|
|
8218
8314
|
company_id: Joi.number().required(),
|
|
8219
8315
|
meta: Joi.object().pattern(/\S/, Joi.any()),
|
|
8220
8316
|
payload: Joi.array().items(CatalogPlatformModel.InventoryPayload()),
|
|
8317
|
+
transaction_type: Joi.string().allow("").allow(null),
|
|
8318
|
+
transaction: CatalogPlatformModel.InventoryTransaction(),
|
|
8221
8319
|
});
|
|
8222
8320
|
}
|
|
8223
8321
|
|
|
@@ -8719,7 +8817,10 @@ class CatalogPlatformModel {
|
|
|
8719
8817
|
return Joi.object({
|
|
8720
8818
|
price_effective: Joi.number().required(),
|
|
8721
8819
|
price_marked: Joi.number().required(),
|
|
8820
|
+
price_cost: Joi.number(),
|
|
8722
8821
|
tags: Joi.array().items(Joi.string().allow("")),
|
|
8822
|
+
transaction_type: Joi.string().allow("").allow(null),
|
|
8823
|
+
transaction: CatalogPlatformModel.InventoryTransaction(),
|
|
8723
8824
|
});
|
|
8724
8825
|
}
|
|
8725
8826
|
|
|
@@ -8731,6 +8832,8 @@ class CatalogPlatformModel {
|
|
|
8731
8832
|
damaged_quantity: Joi.number(),
|
|
8732
8833
|
not_available_quantity: Joi.number(),
|
|
8733
8834
|
mode: Joi.string().allow(""),
|
|
8835
|
+
transaction_type: Joi.string().allow("").allow(null),
|
|
8836
|
+
transaction: CatalogPlatformModel.InventoryTransaction(),
|
|
8734
8837
|
});
|
|
8735
8838
|
}
|
|
8736
8839
|
|
|
@@ -13,6 +13,7 @@ export = CatalogPlatformValidator;
|
|
|
13
13
|
* @typedef BulkHsnCodeParam
|
|
14
14
|
* @property {CatalogPlatformModel.BulkHsnUpsert} body
|
|
15
15
|
*/
|
|
16
|
+
/** @typedef CbsOnboardGetParam */
|
|
16
17
|
/**
|
|
17
18
|
* @typedef CreateBulkInventoryParam
|
|
18
19
|
* @property {string} batchId - Batch Id of the bulk create job.
|
|
@@ -535,6 +536,8 @@ declare class CatalogPlatformValidator {
|
|
|
535
536
|
static allSizes(): AllSizesParam;
|
|
536
537
|
/** @returns {BulkHsnCodeParam} */
|
|
537
538
|
static bulkHsnCode(): BulkHsnCodeParam;
|
|
539
|
+
/** @returns {CbsOnboardGetParam} */
|
|
540
|
+
static cbsOnboardGet(): any;
|
|
538
541
|
/** @returns {CreateBulkInventoryParam} */
|
|
539
542
|
static createBulkInventory(): CreateBulkInventoryParam;
|
|
540
543
|
/** @returns {CreateBulkInventoryJobParam} */
|
|
@@ -699,7 +702,7 @@ declare class CatalogPlatformValidator {
|
|
|
699
702
|
static validateProductTemplateSchema(): ValidateProductTemplateSchemaParam;
|
|
700
703
|
}
|
|
701
704
|
declare namespace CatalogPlatformValidator {
|
|
702
|
-
export { AddInventoryParam, AllSizesParam, BulkHsnCodeParam, CreateBulkInventoryParam, CreateBulkInventoryJobParam, CreateBulkProductUploadJobParam, CreateHsCodeParam, CreateInventoryExportParam, CreateInventoryExportJobParam, CreateMarketplaceOptinParam, CreateProductParam, CreateProductAssetsInBulkParam, CreateProductExportJobParam, CreateProductsInBulkParam, CreateSizeGuideParam, CreateTaxParam, CreateTaxComponentNameParam, CreateTaxVersionParam, DeleteBulkInventoryJobParam, DeleteProductParam, DeleteProductBulkJobParam, DeleteRealtimeInventoryParam, DeleteSizeParam, DeleteTaxRuleParam, DeleteTaxVersionParam, DownloadInventoryTemplateViewParam, DownloadProductTemplateViewsParam, EditProductParam, ExportInventoryConfigParam, GetAllProductHsnCodesParam, GetAllTaxRulesParam, GetAttributeParam, GetCategoryDataParam, GetCompanyBrandDetailParam, GetCompanyDetailParam, GetCompanyMetricsParam, GetDepartmentDataParam, GetHsCodesParam, GetHsnCodeParam, GetInventoriesParam, GetInventoryBulkUploadHistoryParam, GetInventoryBySizeParam, GetInventoryBySizeIdentifierParam, GetInventoryExportParam, GetMarketplaceOptinDetailParam, GetMarketplacesParam, GetProductParam, GetProductAssetsInBulkParam, GetProductAttributesParam, GetProductBulkUploadHistoryParam, GetProductExportJobsParam, GetProductSizeParam, GetProductTagsParam, GetProductValidationParam, GetProductsParam, GetSellerInsightsParam, GetSingleProductHSNCodeParam, GetSizeGuideParam, GetSizeGuidesParam, GetStoreDetailParam, GetTaxComponentNamesParam, GetTaxVersionDetailsParam, GetVariantsOfProductsParam, ListCategoriesParam, ListDepartmentsDataParam, ListHSNCodesParam, ListInventoryExportParam, ListProductTemplateParam, ListProductTemplateCategoriesParam, ListProductTemplateExportDetailsParam, ListTemplateBrandTypeValuesParam, PartialUpdateProductParam, UpdateHsnCodeParam, UpdateInventoriesParam, UpdateLocationPriceParam, UpdateLocationQuantityParam, UpdateMarketplaceOptinParam, UpdateRealtimeInventoryParam, UpdateSizeGuideParam, UpdateTaxRuleParam, UpdateTaxVersionParam, ValidateProductGlobalTemplateParam, ValidateProductTemplateParam, ValidateProductTemplateSchemaParam };
|
|
705
|
+
export { AddInventoryParam, AllSizesParam, BulkHsnCodeParam, CbsOnboardGetParam, CreateBulkInventoryParam, CreateBulkInventoryJobParam, CreateBulkProductUploadJobParam, CreateHsCodeParam, CreateInventoryExportParam, CreateInventoryExportJobParam, CreateMarketplaceOptinParam, CreateProductParam, CreateProductAssetsInBulkParam, CreateProductExportJobParam, CreateProductsInBulkParam, CreateSizeGuideParam, CreateTaxParam, CreateTaxComponentNameParam, CreateTaxVersionParam, DeleteBulkInventoryJobParam, DeleteProductParam, DeleteProductBulkJobParam, DeleteRealtimeInventoryParam, DeleteSizeParam, DeleteTaxRuleParam, DeleteTaxVersionParam, DownloadInventoryTemplateViewParam, DownloadProductTemplateViewsParam, EditProductParam, ExportInventoryConfigParam, GetAllProductHsnCodesParam, GetAllTaxRulesParam, GetAttributeParam, GetCategoryDataParam, GetCompanyBrandDetailParam, GetCompanyDetailParam, GetCompanyMetricsParam, GetDepartmentDataParam, GetHsCodesParam, GetHsnCodeParam, GetInventoriesParam, GetInventoryBulkUploadHistoryParam, GetInventoryBySizeParam, GetInventoryBySizeIdentifierParam, GetInventoryExportParam, GetMarketplaceOptinDetailParam, GetMarketplacesParam, GetProductParam, GetProductAssetsInBulkParam, GetProductAttributesParam, GetProductBulkUploadHistoryParam, GetProductExportJobsParam, GetProductSizeParam, GetProductTagsParam, GetProductValidationParam, GetProductsParam, GetSellerInsightsParam, GetSingleProductHSNCodeParam, GetSizeGuideParam, GetSizeGuidesParam, GetStoreDetailParam, GetTaxComponentNamesParam, GetTaxVersionDetailsParam, GetVariantsOfProductsParam, ListCategoriesParam, ListDepartmentsDataParam, ListHSNCodesParam, ListInventoryExportParam, ListProductTemplateParam, ListProductTemplateCategoriesParam, ListProductTemplateExportDetailsParam, ListTemplateBrandTypeValuesParam, PartialUpdateProductParam, UpdateHsnCodeParam, UpdateInventoriesParam, UpdateLocationPriceParam, UpdateLocationQuantityParam, UpdateMarketplaceOptinParam, UpdateRealtimeInventoryParam, UpdateSizeGuideParam, UpdateTaxRuleParam, UpdateTaxVersionParam, ValidateProductGlobalTemplateParam, ValidateProductTemplateParam, ValidateProductTemplateSchemaParam };
|
|
703
706
|
}
|
|
704
707
|
type AddInventoryParam = {
|
|
705
708
|
/**
|
|
@@ -1704,6 +1707,7 @@ type ValidateProductTemplateSchemaParam = {
|
|
|
1704
1707
|
*/
|
|
1705
1708
|
schemaType?: string;
|
|
1706
1709
|
};
|
|
1710
|
+
type CbsOnboardGetParam = any;
|
|
1707
1711
|
type GetCompanyDetailParam = any;
|
|
1708
1712
|
type GetCompanyMetricsParam = any;
|
|
1709
1713
|
type GetInventoryExportParam = any;
|
|
@@ -19,6 +19,8 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
|
|
|
19
19
|
* @property {CatalogPlatformModel.BulkHsnUpsert} body
|
|
20
20
|
*/
|
|
21
21
|
|
|
22
|
+
/** @typedef CbsOnboardGetParam */
|
|
23
|
+
|
|
22
24
|
/**
|
|
23
25
|
* @typedef CreateBulkInventoryParam
|
|
24
26
|
* @property {string} batchId - Batch Id of the bulk create job.
|
|
@@ -639,6 +641,11 @@ class CatalogPlatformValidator {
|
|
|
639
641
|
}).required();
|
|
640
642
|
}
|
|
641
643
|
|
|
644
|
+
/** @returns {CbsOnboardGetParam} */
|
|
645
|
+
static cbsOnboardGet() {
|
|
646
|
+
return Joi.object({}).required();
|
|
647
|
+
}
|
|
648
|
+
|
|
642
649
|
/** @returns {CreateBulkInventoryParam} */
|
|
643
650
|
static createBulkInventory() {
|
|
644
651
|
return Joi.object({
|
|
@@ -155,6 +155,33 @@ declare class CompanyProfile {
|
|
|
155
155
|
* @description: Retrieve a list of locations associated with the company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/companyprofile/getLocations/).
|
|
156
156
|
*/
|
|
157
157
|
getLocations({ storeType, q, stage, pageNo, pageSize, locationIds, types, tags, requestHeaders, }?: CompanyProfilePlatformValidator.GetLocationsParam, { responseHeaders }?: object): Promise<CompanyProfilePlatformModel.LocationListSchema>;
|
|
158
|
+
/**
|
|
159
|
+
* @param {Object} arg - Arg object.
|
|
160
|
+
* @param {string} [arg.storeType] - Helps to sort the location list on the
|
|
161
|
+
* basis of location type.
|
|
162
|
+
* @param {string} [arg.q] - Query that is to be searched.
|
|
163
|
+
* @param {string} [arg.stage] - To filter companies on basis of verified or
|
|
164
|
+
* unverified companies.
|
|
165
|
+
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
166
|
+
* page. Default is 10.
|
|
167
|
+
* @param {number[]} [arg.locationIds] - Helps to filter stores on the basis of uids.
|
|
168
|
+
* @param {string[]} [arg.types] - Helps to get the location list on the
|
|
169
|
+
* basis of multiple location type.
|
|
170
|
+
* @param {string[]} [arg.tags] - Helps to get the location list on the
|
|
171
|
+
* basis of multiple location tag.
|
|
172
|
+
* @returns {Paginator<CompanyProfilePlatformModel.LocationListSchema>}
|
|
173
|
+
* @summary: Get company specific stores
|
|
174
|
+
* @description: Retrieve a list of locations associated with the company.
|
|
175
|
+
*/
|
|
176
|
+
getLocationsPaginator({ storeType, q, stage, pageSize, locationIds, types, tags, }?: {
|
|
177
|
+
storeType?: string;
|
|
178
|
+
q?: string;
|
|
179
|
+
stage?: string;
|
|
180
|
+
pageSize?: number;
|
|
181
|
+
locationIds?: number[];
|
|
182
|
+
types?: string[];
|
|
183
|
+
tags?: string[];
|
|
184
|
+
}): Paginator<CompanyProfilePlatformModel.LocationListSchema>;
|
|
158
185
|
/**
|
|
159
186
|
* @param {CompanyProfilePlatformValidator.UpdateCompanyParam} arg - Arg object
|
|
160
187
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -1051,6 +1051,58 @@ class CompanyProfile {
|
|
|
1051
1051
|
return response;
|
|
1052
1052
|
}
|
|
1053
1053
|
|
|
1054
|
+
/**
|
|
1055
|
+
* @param {Object} arg - Arg object.
|
|
1056
|
+
* @param {string} [arg.storeType] - Helps to sort the location list on the
|
|
1057
|
+
* basis of location type.
|
|
1058
|
+
* @param {string} [arg.q] - Query that is to be searched.
|
|
1059
|
+
* @param {string} [arg.stage] - To filter companies on basis of verified or
|
|
1060
|
+
* unverified companies.
|
|
1061
|
+
* @param {number} [arg.pageSize] - Number of items to retrieve in each
|
|
1062
|
+
* page. Default is 10.
|
|
1063
|
+
* @param {number[]} [arg.locationIds] - Helps to filter stores on the basis of uids.
|
|
1064
|
+
* @param {string[]} [arg.types] - Helps to get the location list on the
|
|
1065
|
+
* basis of multiple location type.
|
|
1066
|
+
* @param {string[]} [arg.tags] - Helps to get the location list on the
|
|
1067
|
+
* basis of multiple location tag.
|
|
1068
|
+
* @returns {Paginator<CompanyProfilePlatformModel.LocationListSchema>}
|
|
1069
|
+
* @summary: Get company specific stores
|
|
1070
|
+
* @description: Retrieve a list of locations associated with the company.
|
|
1071
|
+
*/
|
|
1072
|
+
getLocationsPaginator({
|
|
1073
|
+
storeType,
|
|
1074
|
+
q,
|
|
1075
|
+
stage,
|
|
1076
|
+
pageSize,
|
|
1077
|
+
locationIds,
|
|
1078
|
+
types,
|
|
1079
|
+
tags,
|
|
1080
|
+
} = {}) {
|
|
1081
|
+
const paginator = new Paginator();
|
|
1082
|
+
const callback = async () => {
|
|
1083
|
+
const pageId = paginator.nextId;
|
|
1084
|
+
const pageNo = paginator.pageNo;
|
|
1085
|
+
const pageType = "number";
|
|
1086
|
+
const data = await this.getLocations({
|
|
1087
|
+
storeType: storeType,
|
|
1088
|
+
q: q,
|
|
1089
|
+
stage: stage,
|
|
1090
|
+
pageNo: pageNo,
|
|
1091
|
+
pageSize: pageSize,
|
|
1092
|
+
locationIds: locationIds,
|
|
1093
|
+
types: types,
|
|
1094
|
+
tags: tags,
|
|
1095
|
+
});
|
|
1096
|
+
paginator.setPaginator({
|
|
1097
|
+
hasNext: data.page.has_next ? true : false,
|
|
1098
|
+
nextId: data.page.next_id,
|
|
1099
|
+
});
|
|
1100
|
+
return data;
|
|
1101
|
+
};
|
|
1102
|
+
paginator.setCallback(callback.bind(this));
|
|
1103
|
+
return paginator;
|
|
1104
|
+
}
|
|
1105
|
+
|
|
1054
1106
|
/**
|
|
1055
1107
|
* @param {CompanyProfilePlatformValidator.UpdateCompanyParam} arg - Arg object
|
|
1056
1108
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -260,6 +260,25 @@ declare class Configuration {
|
|
|
260
260
|
* @description: Retrieve ordering stores accessible to staff members. Retrieve the details of all stores access given to the staff member (the selling locations where the sales channel will be utilized for placing orders). - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/getStaffOrderingStores/).
|
|
261
261
|
*/
|
|
262
262
|
getStaffOrderingStores({ pageNo, pageSize, q, requestHeaders }?: ConfigurationPlatformApplicationValidator.GetStaffOrderingStoresParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.OrderingStoresResponseSchema>;
|
|
263
|
+
/**
|
|
264
|
+
* @param {Object} arg - Arg object.
|
|
265
|
+
* @param {number} arg.companyId - Numeric ID allotted to a business account
|
|
266
|
+
* on Fynd Platform
|
|
267
|
+
* @param {string} arg.applicationId - Alphanumeric ID allotted to an
|
|
268
|
+
* application (sales channel website) created within a business account
|
|
269
|
+
* @param {number} [arg.pageSize] - The number of items to retrieve in each
|
|
270
|
+
* page. Default value is 10.
|
|
271
|
+
* @param {string} [arg.q] - Store code or name of the ordering store.
|
|
272
|
+
* @returns {Paginator<ConfigurationPlatformModel.OrderingStoresResponseSchema>}
|
|
273
|
+
* @summary: Get staff ordering stores
|
|
274
|
+
* @description: Retrieve ordering stores accessible to staff members. Retrieve the details of all stores access given to the staff member (the selling locations where the sales channel will be utilized for placing orders).
|
|
275
|
+
*/
|
|
276
|
+
getStaffOrderingStoresPaginator({ companyId, applicationId, pageSize, q, }?: {
|
|
277
|
+
companyId: number;
|
|
278
|
+
applicationId: string;
|
|
279
|
+
pageSize?: number;
|
|
280
|
+
q?: string;
|
|
281
|
+
}): Paginator<ConfigurationPlatformModel.OrderingStoresResponseSchema>;
|
|
263
282
|
/**
|
|
264
283
|
* @param {ConfigurationPlatformApplicationValidator.ModifyAppFeaturesParam} arg
|
|
265
284
|
* - Arg object
|
|
@@ -417,3 +436,4 @@ declare class Configuration {
|
|
|
417
436
|
}
|
|
418
437
|
import ConfigurationPlatformApplicationValidator = require("./ConfigurationPlatformApplicationValidator");
|
|
419
438
|
import ConfigurationPlatformModel = require("./ConfigurationPlatformModel");
|
|
439
|
+
import Paginator = require("../../common/Paginator");
|
|
@@ -1636,6 +1636,47 @@ class Configuration {
|
|
|
1636
1636
|
return response;
|
|
1637
1637
|
}
|
|
1638
1638
|
|
|
1639
|
+
/**
|
|
1640
|
+
* @param {Object} arg - Arg object.
|
|
1641
|
+
* @param {number} arg.companyId - Numeric ID allotted to a business account
|
|
1642
|
+
* on Fynd Platform
|
|
1643
|
+
* @param {string} arg.applicationId - Alphanumeric ID allotted to an
|
|
1644
|
+
* application (sales channel website) created within a business account
|
|
1645
|
+
* @param {number} [arg.pageSize] - The number of items to retrieve in each
|
|
1646
|
+
* page. Default value is 10.
|
|
1647
|
+
* @param {string} [arg.q] - Store code or name of the ordering store.
|
|
1648
|
+
* @returns {Paginator<ConfigurationPlatformModel.OrderingStoresResponseSchema>}
|
|
1649
|
+
* @summary: Get staff ordering stores
|
|
1650
|
+
* @description: Retrieve ordering stores accessible to staff members. Retrieve the details of all stores access given to the staff member (the selling locations where the sales channel will be utilized for placing orders).
|
|
1651
|
+
*/
|
|
1652
|
+
getStaffOrderingStoresPaginator({
|
|
1653
|
+
companyId,
|
|
1654
|
+
applicationId,
|
|
1655
|
+
pageSize,
|
|
1656
|
+
q,
|
|
1657
|
+
} = {}) {
|
|
1658
|
+
const paginator = new Paginator();
|
|
1659
|
+
const callback = async () => {
|
|
1660
|
+
const pageId = paginator.nextId;
|
|
1661
|
+
const pageNo = paginator.pageNo;
|
|
1662
|
+
const pageType = "number";
|
|
1663
|
+
const data = await this.getStaffOrderingStores({
|
|
1664
|
+
companyId: companyId,
|
|
1665
|
+
applicationId: applicationId,
|
|
1666
|
+
pageNo: pageNo,
|
|
1667
|
+
pageSize: pageSize,
|
|
1668
|
+
q: q,
|
|
1669
|
+
});
|
|
1670
|
+
paginator.setPaginator({
|
|
1671
|
+
hasNext: data.page.has_next ? true : false,
|
|
1672
|
+
nextId: data.page.next_id,
|
|
1673
|
+
});
|
|
1674
|
+
return data;
|
|
1675
|
+
};
|
|
1676
|
+
paginator.setCallback(callback.bind(this));
|
|
1677
|
+
return paginator;
|
|
1678
|
+
}
|
|
1679
|
+
|
|
1639
1680
|
/**
|
|
1640
1681
|
* @param {ConfigurationPlatformApplicationValidator.ModifyAppFeaturesParam} arg
|
|
1641
1682
|
* - Arg object
|
|
@@ -135,6 +135,12 @@ export = LeadPlatformModel;
|
|
|
135
135
|
* @property {string} [description] - Long description of issue
|
|
136
136
|
* @property {TicketAsset[]} [attachments] - List of all attachments related to the ticket
|
|
137
137
|
*/
|
|
138
|
+
/**
|
|
139
|
+
* @typedef AdditionalInfo
|
|
140
|
+
* @property {string} [display_name] - Human readable name for this info
|
|
141
|
+
* @property {string} [display_value] - Human readable value for the info
|
|
142
|
+
* @property {number} [priority] - Priority of this additional info
|
|
143
|
+
*/
|
|
138
144
|
/**
|
|
139
145
|
* @typedef AddTicketPayload
|
|
140
146
|
* @property {Object} [created_by] - Creator of the ticket
|
|
@@ -143,6 +149,8 @@ export = LeadPlatformModel;
|
|
|
143
149
|
* @property {string} category - Category of the ticket
|
|
144
150
|
* @property {TicketContent} content
|
|
145
151
|
* @property {Object} [_custom_json] - Optional custom data that needs to be sent
|
|
152
|
+
* @property {AdditionalInfo[]} [additional_info] - Additional information
|
|
153
|
+
* related to the ticket
|
|
146
154
|
*/
|
|
147
155
|
/**
|
|
148
156
|
* @typedef Priority
|
|
@@ -289,7 +297,7 @@ export = LeadPlatformModel;
|
|
|
289
297
|
declare class LeadPlatformModel {
|
|
290
298
|
}
|
|
291
299
|
declare namespace LeadPlatformModel {
|
|
292
|
-
export { GeneralConfigDetails, SupportCommunicationSchema, SupportSchema, GeneralConfigIntegrationSchema, TicketList, Page, TicketHistoryList, CustomFormList, CreateCustomFormPayload, EditCustomFormPayload, EditTicketPayload, AgentChangePayload, Filter, TicketHistoryPayload, TicketContext, CreatedOn, TicketAsset, TicketContent, AddTicketPayload, Priority, SLA, Status, TicketFeedbackList, TicketFeedbackPayload, SubmitButton, PollForAssignment, CustomForm, FeedbackForm, TicketCategory, FeedbackResponseItem, TicketFeedback, TicketHistory, Ticket, ErrorMessage, PriorityEnum, HistoryTypeEnum, TicketAssetTypeEnum, TicketSourceEnum };
|
|
300
|
+
export { GeneralConfigDetails, SupportCommunicationSchema, SupportSchema, GeneralConfigIntegrationSchema, TicketList, Page, TicketHistoryList, CustomFormList, CreateCustomFormPayload, EditCustomFormPayload, EditTicketPayload, AgentChangePayload, Filter, TicketHistoryPayload, TicketContext, CreatedOn, TicketAsset, TicketContent, AdditionalInfo, AddTicketPayload, Priority, SLA, Status, TicketFeedbackList, TicketFeedbackPayload, SubmitButton, PollForAssignment, CustomForm, FeedbackForm, TicketCategory, FeedbackResponseItem, TicketFeedback, TicketHistory, Ticket, ErrorMessage, PriorityEnum, HistoryTypeEnum, TicketAssetTypeEnum, TicketSourceEnum };
|
|
293
301
|
}
|
|
294
302
|
/** @returns {GeneralConfigDetails} */
|
|
295
303
|
declare function GeneralConfigDetails(): GeneralConfigDetails;
|
|
@@ -577,6 +585,22 @@ type TicketContent = {
|
|
|
577
585
|
*/
|
|
578
586
|
attachments?: TicketAsset[];
|
|
579
587
|
};
|
|
588
|
+
/** @returns {AdditionalInfo} */
|
|
589
|
+
declare function AdditionalInfo(): AdditionalInfo;
|
|
590
|
+
type AdditionalInfo = {
|
|
591
|
+
/**
|
|
592
|
+
* - Human readable name for this info
|
|
593
|
+
*/
|
|
594
|
+
display_name?: string;
|
|
595
|
+
/**
|
|
596
|
+
* - Human readable value for the info
|
|
597
|
+
*/
|
|
598
|
+
display_value?: string;
|
|
599
|
+
/**
|
|
600
|
+
* - Priority of this additional info
|
|
601
|
+
*/
|
|
602
|
+
priority?: number;
|
|
603
|
+
};
|
|
580
604
|
/** @returns {AddTicketPayload} */
|
|
581
605
|
declare function AddTicketPayload(): AddTicketPayload;
|
|
582
606
|
type AddTicketPayload = {
|
|
@@ -598,6 +622,11 @@ type AddTicketPayload = {
|
|
|
598
622
|
* - Optional custom data that needs to be sent
|
|
599
623
|
*/
|
|
600
624
|
_custom_json?: any;
|
|
625
|
+
/**
|
|
626
|
+
* - Additional information
|
|
627
|
+
* related to the ticket
|
|
628
|
+
*/
|
|
629
|
+
additional_info?: AdditionalInfo[];
|
|
601
630
|
};
|
|
602
631
|
/** @returns {Priority} */
|
|
603
632
|
declare function Priority(): Priority;
|
|
@@ -154,6 +154,13 @@ const Joi = require("joi");
|
|
|
154
154
|
* @property {TicketAsset[]} [attachments] - List of all attachments related to the ticket
|
|
155
155
|
*/
|
|
156
156
|
|
|
157
|
+
/**
|
|
158
|
+
* @typedef AdditionalInfo
|
|
159
|
+
* @property {string} [display_name] - Human readable name for this info
|
|
160
|
+
* @property {string} [display_value] - Human readable value for the info
|
|
161
|
+
* @property {number} [priority] - Priority of this additional info
|
|
162
|
+
*/
|
|
163
|
+
|
|
157
164
|
/**
|
|
158
165
|
* @typedef AddTicketPayload
|
|
159
166
|
* @property {Object} [created_by] - Creator of the ticket
|
|
@@ -162,6 +169,8 @@ const Joi = require("joi");
|
|
|
162
169
|
* @property {string} category - Category of the ticket
|
|
163
170
|
* @property {TicketContent} content
|
|
164
171
|
* @property {Object} [_custom_json] - Optional custom data that needs to be sent
|
|
172
|
+
* @property {AdditionalInfo[]} [additional_info] - Additional information
|
|
173
|
+
* related to the ticket
|
|
165
174
|
*/
|
|
166
175
|
|
|
167
176
|
/**
|
|
@@ -514,6 +523,15 @@ class LeadPlatformModel {
|
|
|
514
523
|
});
|
|
515
524
|
}
|
|
516
525
|
|
|
526
|
+
/** @returns {AdditionalInfo} */
|
|
527
|
+
static AdditionalInfo() {
|
|
528
|
+
return Joi.object({
|
|
529
|
+
display_name: Joi.string().allow(""),
|
|
530
|
+
display_value: Joi.string().allow(""),
|
|
531
|
+
priority: Joi.number(),
|
|
532
|
+
});
|
|
533
|
+
}
|
|
534
|
+
|
|
517
535
|
/** @returns {AddTicketPayload} */
|
|
518
536
|
static AddTicketPayload() {
|
|
519
537
|
return Joi.object({
|
|
@@ -523,6 +541,7 @@ class LeadPlatformModel {
|
|
|
523
541
|
category: Joi.string().allow("").required(),
|
|
524
542
|
content: LeadPlatformModel.TicketContent().required(),
|
|
525
543
|
_custom_json: Joi.object().pattern(/\S/, Joi.any()),
|
|
544
|
+
additional_info: Joi.array().items(LeadPlatformModel.AdditionalInfo()),
|
|
526
545
|
});
|
|
527
546
|
}
|
|
528
547
|
|
|
@@ -164,6 +164,18 @@ declare class Payment {
|
|
|
164
164
|
* @description: Retrieve merchant refund priority configurations, returning the status of the update and the refund sources priority with their descriptions and priorities. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/payment/getMerchantRefundPriority/).
|
|
165
165
|
*/
|
|
166
166
|
getMerchantRefundPriority({ configType, requestHeaders }?: PaymentPlatformApplicationValidator.GetMerchantRefundPriorityParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.RefundPriorityDetails>;
|
|
167
|
+
/**
|
|
168
|
+
* @param {PaymentPlatformApplicationValidator.GetOrderTransactionsParam} arg
|
|
169
|
+
* - Arg object
|
|
170
|
+
*
|
|
171
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
172
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
173
|
+
* @returns {Promise<PaymentPlatformModel.OrderTransactionList>} - Success response
|
|
174
|
+
* @name getOrderTransactions
|
|
175
|
+
* @summary: List all transactions for an order
|
|
176
|
+
* @description: Returns all payment transactions associated with the given order ID, ordered by creation timestamp ascending. Each entry includes the merchant transaction ID, payment mode name, logo URL (small, falling back to large), transaction amount, latest status, and creation timestamp. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/payment/getOrderTransactions/).
|
|
177
|
+
*/
|
|
178
|
+
getOrderTransactions({ orderId, requestHeaders }?: PaymentPlatformApplicationValidator.GetOrderTransactionsParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.OrderTransactionList>;
|
|
167
179
|
/**
|
|
168
180
|
* @param {PaymentPlatformApplicationValidator.GetPGConfigAggregatorsParam} arg
|
|
169
181
|
* - Arg object
|
|
@@ -502,6 +514,16 @@ declare class Payment {
|
|
|
502
514
|
* @description: Update merchant refund priority configurations, with the provided refund sources priority details, and return the status of the operation. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/payment/updateMerchantRefundPriority/).
|
|
503
515
|
*/
|
|
504
516
|
updateMerchantRefundPriority({ configType, body, requestHeaders }?: PaymentPlatformApplicationValidator.UpdateMerchantRefundPriorityParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.RefundPriorityDetails>;
|
|
517
|
+
/**
|
|
518
|
+
* @param {PaymentPlatformApplicationValidator.UpdateOrderMetaParam} arg - Arg object
|
|
519
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
520
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
521
|
+
* @returns {Promise<PaymentPlatformModel.OrderMetaResult>} - Success response
|
|
522
|
+
* @name updateOrderMeta
|
|
523
|
+
* @summary: Update order metadata
|
|
524
|
+
* @description: Update metadata associated with a payment order. Use this to set or update PAN (Permanent Account Number) for an order. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/payment/updateOrderMeta/).
|
|
525
|
+
*/
|
|
526
|
+
updateOrderMeta({ orderId, body, requestHeaders }?: PaymentPlatformApplicationValidator.UpdateOrderMetaParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.OrderMetaResult>;
|
|
505
527
|
/**
|
|
506
528
|
* @param {PaymentPlatformApplicationValidator.UpdatePaymentSessionParam} arg
|
|
507
529
|
* - Arg object
|