@gofynd/fdk-client-javascript 0.1.35 → 0.1.37

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (118) hide show
  1. package/README.md +1 -1
  2. package/documentation/application/CART.md +272 -249
  3. package/documentation/application/CATALOG.md +417 -413
  4. package/documentation/application/COMMON.md +4 -0
  5. package/documentation/application/COMMUNICATION.md +4 -0
  6. package/documentation/application/CONFIGURATION.md +4 -0
  7. package/documentation/application/CONTENT.md +7 -20
  8. package/documentation/application/FILESTORAGE.md +85 -0
  9. package/documentation/application/LEAD.md +6 -2
  10. package/documentation/application/LOGISTIC.md +427 -101
  11. package/documentation/application/ORDER.md +292 -288
  12. package/documentation/application/PAYMENT.md +445 -259
  13. package/documentation/application/POSCART.md +309 -286
  14. package/documentation/application/README.md +1 -1
  15. package/documentation/application/REWARDS.md +153 -160
  16. package/documentation/application/SHARE.md +4 -0
  17. package/documentation/application/THEME.md +4 -0
  18. package/documentation/application/USER.md +4 -0
  19. package/documentation/platform/ANALYTICS.md +4 -0
  20. package/documentation/platform/AUDITTRAIL.md +6 -2
  21. package/documentation/platform/BILLING.md +4 -0
  22. package/documentation/platform/CART.md +476 -459
  23. package/documentation/platform/CATALOG.md +4138 -2968
  24. package/documentation/platform/COMMON.md +4 -0
  25. package/documentation/platform/COMMUNICATION.md +4 -0
  26. package/documentation/platform/COMPANYPROFILE.md +258 -206
  27. package/documentation/platform/CONFIGURATION.md +4 -0
  28. package/documentation/platform/CONTENT.md +8 -21
  29. package/documentation/platform/DISCOUNT.md +4 -0
  30. package/documentation/platform/FILESTORAGE.md +85 -0
  31. package/documentation/platform/INVENTORY.md +4 -0
  32. package/documentation/platform/LEAD.md +6 -2
  33. package/documentation/platform/ORDER.md +6298 -1448
  34. package/documentation/platform/PARTNER.md +12 -8
  35. package/documentation/platform/PAYMENT.md +107 -103
  36. package/documentation/platform/README.md +2 -2
  37. package/documentation/platform/REWARDS.md +219 -152
  38. package/documentation/platform/SHARE.md +4 -0
  39. package/documentation/platform/THEME.md +4 -0
  40. package/documentation/platform/USER.md +4 -0
  41. package/documentation/platform/WEBHOOK.md +4 -0
  42. package/documentation/public/CONFIGURATION.md +4 -0
  43. package/documentation/public/INVENTORY.md +4 -0
  44. package/documentation/public/WEBHOOK.md +4 -0
  45. package/package.json +2 -2
  46. package/sdk/application/ApplicationAPIClient.js +3 -0
  47. package/sdk/application/ApplicationClient.d.ts +1 -0
  48. package/sdk/application/ApplicationClient.js +11 -1
  49. package/sdk/application/ApplicationConfig.d.ts +1 -0
  50. package/sdk/application/ApplicationConfig.js +1 -0
  51. package/sdk/application/ApplicationModels.d.ts +94 -85
  52. package/sdk/application/ApplicationModels.js +1909 -1792
  53. package/sdk/application/client/CartApplicationClient.d.ts +36 -36
  54. package/sdk/application/client/CatalogApplicationClient.d.ts +39 -39
  55. package/sdk/application/client/CatalogApplicationClient.js +16 -16
  56. package/sdk/application/client/CommonApplicationClient.d.ts +2 -2
  57. package/sdk/application/client/CommunicationApplicationClient.d.ts +5 -5
  58. package/sdk/application/client/ConfigurationApplicationClient.d.ts +17 -17
  59. package/sdk/application/client/ContentApplicationClient.d.ts +19 -19
  60. package/sdk/application/client/FileStorageApplicationClient.d.ts +14 -6
  61. package/sdk/application/client/FileStorageApplicationClient.js +2 -0
  62. package/sdk/application/client/LeadApplicationClient.d.ts +10 -10
  63. package/sdk/application/client/LogisticApplicationClient.d.ts +32 -21
  64. package/sdk/application/client/LogisticApplicationClient.js +62 -27
  65. package/sdk/application/client/OrderApplicationClient.d.ts +15 -15
  66. package/sdk/application/client/OrderApplicationClient.js +1 -1
  67. package/sdk/application/client/PaymentApplicationClient.d.ts +79 -57
  68. package/sdk/application/client/PaymentApplicationClient.js +66 -0
  69. package/sdk/application/client/PosCartApplicationClient.d.ts +38 -38
  70. package/sdk/application/client/RewardsApplicationClient.d.ts +34 -34
  71. package/sdk/application/client/RewardsApplicationClient.js +77 -77
  72. package/sdk/application/client/ShareApplicationClient.d.ts +8 -8
  73. package/sdk/application/client/ThemeApplicationClient.d.ts +4 -4
  74. package/sdk/application/client/UserApplicationClient.d.ts +63 -63
  75. package/sdk/application/models/CatalogValidator.d.ts +1 -1
  76. package/sdk/application/models/CatalogValidator.js +2 -2
  77. package/sdk/application/models/LogisticValidator.d.ts +2 -1
  78. package/sdk/application/models/LogisticValidator.js +11 -6
  79. package/sdk/application/models/PaymentValidator.d.ts +2 -0
  80. package/sdk/application/models/PaymentValidator.js +12 -0
  81. package/sdk/application/models/RewardsValidator.d.ts +3 -3
  82. package/sdk/application/models/RewardsValidator.js +12 -12
  83. package/sdk/common/AxiosHelper.js +1 -1
  84. package/sdk/common/Constant.d.ts +9 -0
  85. package/sdk/common/Constant.js +11 -0
  86. package/sdk/platform/PlatformApplicationClient.d.ts +7962 -6505
  87. package/sdk/platform/PlatformApplicationClient.js +4377 -3635
  88. package/sdk/platform/PlatformApplicationModels.d.ts +26 -31
  89. package/sdk/platform/PlatformApplicationModels.js +5530 -4134
  90. package/sdk/platform/PlatformClient.d.ts +3495 -2780
  91. package/sdk/platform/PlatformClient.js +3985 -3108
  92. package/sdk/platform/PlatformModels.d.ts +354 -273
  93. package/sdk/platform/PlatformModels.js +5635 -4211
  94. package/sdk/platform/client/AnalyticsPlatformClient.d.ts +5 -5
  95. package/sdk/platform/client/AuditTrailPlatformClient.d.ts +1 -1
  96. package/sdk/platform/client/BillingPlatformClient.d.ts +4 -4
  97. package/sdk/platform/client/CatalogPlatformClient.d.ts +222 -154
  98. package/sdk/platform/client/CatalogPlatformClient.js +473 -295
  99. package/sdk/platform/client/CompanyProfilePlatformClient.d.ts +8 -8
  100. package/sdk/platform/client/ConfigurationPlatformClient.d.ts +9 -9
  101. package/sdk/platform/client/DiscountPlatformClient.d.ts +4 -4
  102. package/sdk/platform/client/FileStoragePlatformClient.d.ts +20 -4
  103. package/sdk/platform/client/FileStoragePlatformClient.js +49 -0
  104. package/sdk/platform/client/InventoryPlatformClient.d.ts +3 -3
  105. package/sdk/platform/client/LeadPlatformClient.d.ts +6 -6
  106. package/sdk/platform/client/OrderPlatformClient.d.ts +557 -131
  107. package/sdk/platform/client/OrderPlatformClient.js +1551 -247
  108. package/sdk/platform/client/PaymentPlatformClient.d.ts +4 -4
  109. package/sdk/platform/client/WebhookPlatformClient.d.ts +2 -2
  110. package/sdk/platform/models/CatalogValidator.d.ts +26 -22
  111. package/sdk/platform/models/CatalogValidator.js +109 -72
  112. package/sdk/platform/models/OrderValidator.d.ts +43 -11
  113. package/sdk/platform/models/OrderValidator.js +312 -51
  114. package/sdk/public/client/ConfigurationPublicClient.d.ts +2 -2
  115. package/sdk/public/client/InventoryPublicClient.d.ts +7 -7
  116. package/sdk/public/client/WebhookPublicClient.d.ts +3 -3
  117. package/tests/common/schema/action-url.json +15 -0
  118. package/tests/common/schema/url-action.json +16 -0
@@ -2,10 +2,12 @@
2
2
 
3
3
 
4
4
 
5
+
5
6
  ##### [Back to Platform docs](./README.md)
6
7
 
7
8
  ## CompanyProfile Methods
8
9
 
10
+
9
11
  * [cbsOnboardGet](#cbsonboardget)
10
12
  * [updateCompany](#updatecompany)
11
13
  * [getCompanyMetrics](#getcompanymetrics)
@@ -26,6 +28,8 @@
26
28
  ## Methods with example and description
27
29
 
28
30
 
31
+
32
+
29
33
  ### cbsOnboardGet
30
34
  Get company profile
31
35
 
@@ -1431,120 +1435,120 @@ Returns a success response
1431
1435
 
1432
1436
 
1433
1437
 
1434
- #### [GetAddressSerializer](#GetAddressSerializer)
1438
+ #### [Document](#Document)
1435
1439
 
1436
1440
  | Properties | Type | Nullable | Description |
1437
1441
  | ---------- | ---- | -------- | ----------- |
1438
- | address1 | string | no | |
1439
- | longitude | number | no | |
1440
- | state | string | no | |
1441
- | latitude | number | no | |
1442
- | country | string | no | |
1443
- | address_type | string | no | |
1444
- | city | string | no | |
1445
- | country_code | string | no | |
1446
- | landmark | string | no | |
1447
- | pincode | number | no | |
1448
- | address2 | string | no | |
1442
+ | value | string | yes | |
1443
+ | verified | boolean | no | |
1444
+ | legal_name | string | no | |
1445
+ | type | string | yes | |
1446
+ | url | string | no | |
1449
1447
 
1450
1448
  ---
1451
1449
 
1452
1450
 
1453
1451
 
1454
1452
 
1455
- #### [BusinessCountryInfo](#BusinessCountryInfo)
1453
+ #### [SellerPhoneNumber](#SellerPhoneNumber)
1456
1454
 
1457
1455
  | Properties | Type | Nullable | Description |
1458
1456
  | ---------- | ---- | -------- | ----------- |
1459
- | country_code | string | no | |
1460
- | country | string | no | |
1457
+ | number | string | yes | |
1458
+ | country_code | number | yes | |
1461
1459
 
1462
1460
  ---
1463
1461
 
1464
1462
 
1465
1463
 
1466
1464
 
1467
- #### [UserSerializer](#UserSerializer)
1465
+ #### [ContactDetails](#ContactDetails)
1468
1466
 
1469
1467
  | Properties | Type | Nullable | Description |
1470
1468
  | ---------- | ---- | -------- | ----------- |
1471
- | user_id | string | no | |
1472
- | username | string | no | |
1473
- | contact | string | no | |
1469
+ | emails | [string] | no | |
1470
+ | phone | [[SellerPhoneNumber](#SellerPhoneNumber)] | no | |
1474
1471
 
1475
1472
  ---
1476
1473
 
1477
1474
 
1478
1475
 
1479
1476
 
1480
- #### [CompanyTaxesSerializer](#CompanyTaxesSerializer)
1477
+ #### [UserSerializer](#UserSerializer)
1481
1478
 
1482
1479
  | Properties | Type | Nullable | Description |
1483
1480
  | ---------- | ---- | -------- | ----------- |
1484
- | rate | number | no | |
1485
- | effective_date | string | no | |
1486
- | enable | boolean | no | |
1481
+ | contact | string | no | |
1482
+ | user_id | string | no | |
1483
+ | username | string | no | |
1487
1484
 
1488
1485
  ---
1489
1486
 
1490
1487
 
1491
1488
 
1492
1489
 
1493
- #### [Website](#Website)
1490
+ #### [BusinessCountryInfo](#BusinessCountryInfo)
1494
1491
 
1495
1492
  | Properties | Type | Nullable | Description |
1496
1493
  | ---------- | ---- | -------- | ----------- |
1497
- | url | string | no | |
1494
+ | country | string | no | |
1495
+ | country_code | string | no | |
1498
1496
 
1499
1497
  ---
1500
1498
 
1501
1499
 
1502
1500
 
1503
1501
 
1504
- #### [BusinessDetails](#BusinessDetails)
1502
+ #### [Website](#Website)
1505
1503
 
1506
1504
  | Properties | Type | Nullable | Description |
1507
1505
  | ---------- | ---- | -------- | ----------- |
1508
- | website | [Website](#Website) | no | |
1506
+ | url | string | no | |
1509
1507
 
1510
1508
  ---
1511
1509
 
1512
1510
 
1513
1511
 
1514
1512
 
1515
- #### [SellerPhoneNumber](#SellerPhoneNumber)
1513
+ #### [BusinessDetails](#BusinessDetails)
1516
1514
 
1517
1515
  | Properties | Type | Nullable | Description |
1518
1516
  | ---------- | ---- | -------- | ----------- |
1519
- | country_code | number | yes | |
1520
- | number | string | yes | |
1517
+ | website | [Website](#Website) | no | |
1521
1518
 
1522
1519
  ---
1523
1520
 
1524
1521
 
1525
1522
 
1526
1523
 
1527
- #### [ContactDetails](#ContactDetails)
1524
+ #### [CompanyTaxesSerializer](#CompanyTaxesSerializer)
1528
1525
 
1529
1526
  | Properties | Type | Nullable | Description |
1530
1527
  | ---------- | ---- | -------- | ----------- |
1531
- | phone | [[SellerPhoneNumber](#SellerPhoneNumber)] | no | |
1532
- | emails | [string] | no | |
1528
+ | rate | number | no | |
1529
+ | effective_date | string | no | |
1530
+ | enable | boolean | no | |
1533
1531
 
1534
1532
  ---
1535
1533
 
1536
1534
 
1537
1535
 
1538
1536
 
1539
- #### [Document](#Document)
1537
+ #### [GetAddressSerializer](#GetAddressSerializer)
1540
1538
 
1541
1539
  | Properties | Type | Nullable | Description |
1542
1540
  | ---------- | ---- | -------- | ----------- |
1543
- | type | string | yes | |
1544
- | url | string | no | |
1545
- | verified | boolean | no | |
1546
- | value | string | yes | |
1547
- | legal_name | string | no | |
1541
+ | address_type | string | no | |
1542
+ | latitude | number | yes | |
1543
+ | address1 | string | no | |
1544
+ | landmark | string | no | |
1545
+ | longitude | number | yes | |
1546
+ | city | string | no | |
1547
+ | pincode | number | no | |
1548
+ | state | string | no | |
1549
+ | country | string | no | |
1550
+ | address2 | string | no | |
1551
+ | country_code | string | no | |
1548
1552
 
1549
1553
  ---
1550
1554
 
@@ -1555,29 +1559,29 @@ Returns a success response
1555
1559
 
1556
1560
  | Properties | Type | Nullable | Description |
1557
1561
  | ---------- | ---- | -------- | ----------- |
1558
- | uid | number | yes | |
1562
+ | documents | [[Document](#Document)] | no | |
1563
+ | contact_details | [ContactDetails](#ContactDetails) | no | |
1564
+ | verified_by | [UserSerializer](#UserSerializer) | no | |
1565
+ | business_country_info | [BusinessCountryInfo](#BusinessCountryInfo) | no | |
1566
+ | name | string | no | |
1567
+ | company_type | string | yes | |
1559
1568
  | business_type | string | yes | |
1560
- | franchise_enabled | boolean | no | |
1569
+ | modified_by | [UserSerializer](#UserSerializer) | no | |
1561
1570
  | warnings | string | no | |
1571
+ | notification_emails | [string] | no | |
1572
+ | uid | number | yes | |
1573
+ | verified_on | string | no | |
1574
+ | modified_on | string | no | |
1575
+ | created_by | [UserSerializer](#UserSerializer) | no | |
1576
+ | franchise_enabled | boolean | no | |
1562
1577
  | mode | string | no | |
1578
+ | business_details | [BusinessDetails](#BusinessDetails) | no | |
1579
+ | _custom_json | string | no | |
1580
+ | taxes | [[CompanyTaxesSerializer](#CompanyTaxesSerializer)] | no | |
1563
1581
  | addresses | [[GetAddressSerializer](#GetAddressSerializer)] | no | |
1564
- | name | string | no | |
1565
- | business_country_info | [BusinessCountryInfo](#BusinessCountryInfo) | no | |
1566
1582
  | stage | string | no | |
1567
- | created_by | [UserSerializer](#UserSerializer) | no | |
1568
- | taxes | [[CompanyTaxesSerializer](#CompanyTaxesSerializer)] | no | |
1569
- | business_details | [BusinessDetails](#BusinessDetails) | no | |
1570
1583
  | business_info | string | no | |
1571
- | verified_by | [UserSerializer](#UserSerializer) | no | |
1572
- | modified_on | string | no | |
1573
- | company_type | string | yes | |
1574
- | contact_details | [ContactDetails](#ContactDetails) | no | |
1575
1584
  | created_on | string | no | |
1576
- | documents | [[Document](#Document)] | no | |
1577
- | notification_emails | [string] | no | |
1578
- | _custom_json | string | no | |
1579
- | modified_by | [UserSerializer](#UserSerializer) | no | |
1580
- | verified_on | string | no | |
1581
1585
 
1582
1586
  ---
1583
1587
 
@@ -1589,9 +1593,9 @@ Returns a success response
1589
1593
  | Properties | Type | Nullable | Description |
1590
1594
  | ---------- | ---- | -------- | ----------- |
1591
1595
  | message | string | no | |
1596
+ | code | string | no | |
1592
1597
  | meta | string | no | |
1593
1598
  | status | number | no | |
1594
- | code | string | no | |
1595
1599
 
1596
1600
  ---
1597
1601
 
@@ -1615,17 +1619,17 @@ Returns a success response
1615
1619
 
1616
1620
  | Properties | Type | Nullable | Description |
1617
1621
  | ---------- | ---- | -------- | ----------- |
1622
+ | address_type | string | yes | |
1623
+ | latitude | number | yes | |
1618
1624
  | address1 | string | yes | |
1625
+ | landmark | string | no | |
1619
1626
  | longitude | number | yes | |
1620
- | state | string | yes | |
1621
- | latitude | number | yes | |
1622
- | country | string | yes | |
1623
- | country_code | string | no | |
1624
1627
  | city | string | yes | |
1625
- | address_type | string | yes | |
1626
- | landmark | string | no | |
1628
+ | state | string | yes | |
1627
1629
  | pincode | number | yes | |
1630
+ | country | string | yes | |
1628
1631
  | address2 | string | no | |
1632
+ | country_code | string | no | |
1629
1633
 
1630
1634
  ---
1631
1635
 
@@ -1636,20 +1640,20 @@ Returns a success response
1636
1640
 
1637
1641
  | Properties | Type | Nullable | Description |
1638
1642
  | ---------- | ---- | -------- | ----------- |
1639
- | name | string | no | |
1640
- | business_info | string | no | |
1641
1643
  | business_type | string | no | |
1642
- | franchise_enabled | boolean | no | |
1643
- | documents | [[Document](#Document)] | no | |
1644
- | notification_emails | [string] | no | |
1645
- | _custom_json | string | no | |
1646
1644
  | taxes | [[CompanyTaxesSerializer1](#CompanyTaxesSerializer1)] | no | |
1647
- | warnings | string | no | |
1645
+ | documents | [[Document](#Document)] | no | |
1646
+ | franchise_enabled | boolean | no | |
1647
+ | addresses | [[CreateUpdateAddressSerializer](#CreateUpdateAddressSerializer)] | no | |
1648
+ | contact_details | [ContactDetails](#ContactDetails) | no | |
1648
1649
  | business_details | [BusinessDetails](#BusinessDetails) | no | |
1650
+ | warnings | string | no | |
1649
1651
  | company_type | string | no | |
1650
- | contact_details | [ContactDetails](#ContactDetails) | no | |
1652
+ | name | string | no | |
1651
1653
  | reject_reason | string | no | |
1652
- | addresses | [[CreateUpdateAddressSerializer](#CreateUpdateAddressSerializer)] | no | |
1654
+ | notification_emails | [string] | no | |
1655
+ | _custom_json | string | no | |
1656
+ | business_info | string | no | |
1653
1657
 
1654
1658
  ---
1655
1659
 
@@ -1684,13 +1688,13 @@ Returns a success response
1684
1688
 
1685
1689
  | Properties | Type | Nullable | Description |
1686
1690
  | ---------- | ---- | -------- | ----------- |
1687
- | uid | number | no | |
1691
+ | store | [DocumentsObj](#DocumentsObj) | no | |
1688
1692
  | stage | string | no | |
1689
- | store_documents | [DocumentsObj](#DocumentsObj) | no | |
1690
- | brand | [DocumentsObj](#DocumentsObj) | no | |
1691
1693
  | company_documents | [DocumentsObj](#DocumentsObj) | no | |
1692
- | store | [DocumentsObj](#DocumentsObj) | no | |
1694
+ | brand | [DocumentsObj](#DocumentsObj) | no | |
1695
+ | uid | number | no | |
1693
1696
  | product | [DocumentsObj](#DocumentsObj) | no | |
1697
+ | store_documents | [DocumentsObj](#DocumentsObj) | no | |
1694
1698
 
1695
1699
  ---
1696
1700
 
@@ -1713,25 +1717,25 @@ Returns a success response
1713
1717
 
1714
1718
  | Properties | Type | Nullable | Description |
1715
1719
  | ---------- | ---- | -------- | ----------- |
1716
- | uid | number | no | |
1720
+ | verified_by | [UserSerializer](#UserSerializer) | no | |
1721
+ | name | string | yes | |
1722
+ | reject_reason | string | no | |
1723
+ | _locale_language | string | no | |
1724
+ | banner | [BrandBannerSerializer](#BrandBannerSerializer) | no | |
1725
+ | modified_by | [UserSerializer](#UserSerializer) | no | |
1717
1726
  | warnings | string | no | |
1727
+ | uid | number | no | |
1728
+ | verified_on | string | no | |
1729
+ | modified_on | string | no | |
1730
+ | created_by | [UserSerializer](#UserSerializer) | no | |
1731
+ | slug_key | string | no | |
1718
1732
  | mode | string | no | |
1719
- | reject_reason | string | no | |
1720
- | name | string | yes | |
1733
+ | description | string | no | |
1734
+ | _custom_json | string | no | |
1721
1735
  | stage | string | no | |
1722
- | created_by | [UserSerializer](#UserSerializer) | no | |
1723
1736
  | synonyms | [string] | no | |
1724
- | verified_by | [UserSerializer](#UserSerializer) | no | |
1725
- | modified_on | string | no | |
1726
- | description | string | no | |
1727
- | _locale_language | string | no | |
1728
- | slug_key | string | no | |
1729
1737
  | logo | string | no | |
1730
- | banner | [BrandBannerSerializer](#BrandBannerSerializer) | no | |
1731
1738
  | created_on | string | no | |
1732
- | _custom_json | string | no | |
1733
- | modified_by | [UserSerializer](#UserSerializer) | no | |
1734
- | verified_on | string | no | |
1735
1739
 
1736
1740
  ---
1737
1741
 
@@ -1742,33 +1746,16 @@ Returns a success response
1742
1746
 
1743
1747
  | Properties | Type | Nullable | Description |
1744
1748
  | ---------- | ---- | -------- | ----------- |
1745
- | uid | number | no | |
1746
- | name | string | yes | |
1749
+ | banner | [BrandBannerSerializer](#BrandBannerSerializer) | no | |
1750
+ | brand_tier | string | no | |
1747
1751
  | company_id | number | no | |
1748
- | synonyms | [string] | no | |
1752
+ | name | string | yes | |
1753
+ | uid | number | no | |
1749
1754
  | _custom_json | string | no | |
1755
+ | synonyms | [string] | no | |
1750
1756
  | description | string | no | |
1751
1757
  | _locale_language | string | no | |
1752
- | brand_tier | string | no | |
1753
1758
  | logo | string | yes | |
1754
- | banner | [BrandBannerSerializer](#BrandBannerSerializer) | no | |
1755
-
1756
- ---
1757
-
1758
-
1759
-
1760
-
1761
- #### [Page](#Page)
1762
-
1763
- | Properties | Type | Nullable | Description |
1764
- | ---------- | ---- | -------- | ----------- |
1765
- | size | number | no | |
1766
- | next_id | string | no | |
1767
- | has_previous | boolean | no | |
1768
- | current | number | no | |
1769
- | type | string | yes | |
1770
- | has_next | boolean | no | |
1771
- | item_total | number | no | |
1772
1759
 
1773
1760
  ---
1774
1761
 
@@ -1791,8 +1778,8 @@ Returns a success response
1791
1778
 
1792
1779
  | Properties | Type | Nullable | Description |
1793
1780
  | ---------- | ---- | -------- | ----------- |
1794
- | socials | [[CompanySocialAccounts](#CompanySocialAccounts)] | no | |
1795
1781
  | website_url | string | no | |
1782
+ | socials | [[CompanySocialAccounts](#CompanySocialAccounts)] | no | |
1796
1783
 
1797
1784
  ---
1798
1785
 
@@ -1803,24 +1790,24 @@ Returns a success response
1803
1790
 
1804
1791
  | Properties | Type | Nullable | Description |
1805
1792
  | ---------- | ---- | -------- | ----------- |
1806
- | uid | number | no | |
1807
- | name | string | no | |
1808
- | verified_by | [UserSerializer](#UserSerializer) | no | |
1809
1793
  | business_type | string | yes | |
1794
+ | modified_by | [UserSerializer](#UserSerializer) | no | |
1810
1795
  | created_by | [UserSerializer](#UserSerializer) | no | |
1796
+ | addresses | [[GetAddressSerializer](#GetAddressSerializer)] | no | |
1811
1797
  | stage | string | no | |
1798
+ | verified_by | [UserSerializer](#UserSerializer) | no | |
1812
1799
  | business_country_info | [BusinessCountryInfo](#BusinessCountryInfo) | no | |
1813
- | modified_on | string | no | |
1814
- | details | [CompanyDetails](#CompanyDetails) | no | |
1800
+ | name | string | no | |
1801
+ | company_type | string | yes | |
1815
1802
  | notification_emails | [string] | no | |
1803
+ | reject_reason | string | no | |
1804
+ | details | [CompanyDetails](#CompanyDetails) | no | |
1816
1805
  | _custom_json | string | no | |
1806
+ | uid | number | no | |
1807
+ | verified_on | string | no | |
1817
1808
  | created_on | string | no | |
1809
+ | modified_on | string | no | |
1818
1810
  | market_channels | [string] | no | |
1819
- | modified_by | [UserSerializer](#UserSerializer) | no | |
1820
- | company_type | string | yes | |
1821
- | reject_reason | string | no | |
1822
- | verified_on | string | no | |
1823
- | addresses | [[GetAddressSerializer](#GetAddressSerializer)] | no | |
1824
1811
 
1825
1812
  ---
1826
1813
 
@@ -1831,18 +1818,35 @@ Returns a success response
1831
1818
 
1832
1819
  | Properties | Type | Nullable | Description |
1833
1820
  | ---------- | ---- | -------- | ----------- |
1834
- | uid | number | no | |
1821
+ | modified_by | [UserSerializer](#UserSerializer) | no | |
1822
+ | created_by | [UserSerializer](#UserSerializer) | no | |
1835
1823
  | stage | string | no | |
1836
1824
  | verified_by | [UserSerializer](#UserSerializer) | no | |
1837
- | company | [CompanySerializer](#CompanySerializer) | no | |
1838
- | created_by | [UserSerializer](#UserSerializer) | no | |
1839
- | modified_on | string | no | |
1840
1825
  | warnings | string | no | |
1841
- | created_on | string | no | |
1842
- | brand | [GetBrandResponseSerializer](#GetBrandResponseSerializer) | no | |
1843
- | modified_by | [UserSerializer](#UserSerializer) | no | |
1826
+ | company | [CompanySerializer](#CompanySerializer) | no | |
1844
1827
  | reject_reason | string | no | |
1828
+ | brand | [GetBrandResponseSerializer](#GetBrandResponseSerializer) | no | |
1829
+ | uid | number | no | |
1845
1830
  | verified_on | string | no | |
1831
+ | created_on | string | no | |
1832
+ | modified_on | string | no | |
1833
+
1834
+ ---
1835
+
1836
+
1837
+
1838
+
1839
+ #### [Page](#Page)
1840
+
1841
+ | Properties | Type | Nullable | Description |
1842
+ | ---------- | ---- | -------- | ----------- |
1843
+ | item_total | number | no | |
1844
+ | current | number | no | |
1845
+ | has_next | boolean | no | |
1846
+ | has_previous | boolean | no | |
1847
+ | size | number | no | |
1848
+ | next_id | string | no | |
1849
+ | type | string | yes | |
1846
1850
 
1847
1851
  ---
1848
1852
 
@@ -1853,8 +1857,8 @@ Returns a success response
1853
1857
 
1854
1858
  | Properties | Type | Nullable | Description |
1855
1859
  | ---------- | ---- | -------- | ----------- |
1856
- | page | [Page](#Page) | no | |
1857
1860
  | items | [[CompanyBrandSerializer](#CompanyBrandSerializer)] | no | |
1861
+ | page | [Page](#Page) | no | |
1858
1862
 
1859
1863
  ---
1860
1864
 
@@ -1865,9 +1869,9 @@ Returns a success response
1865
1869
 
1866
1870
  | Properties | Type | Nullable | Description |
1867
1871
  | ---------- | ---- | -------- | ----------- |
1868
- | uid | number | no | |
1869
1872
  | company | number | yes | |
1870
1873
  | brands | [number] | yes | |
1874
+ | uid | number | no | |
1871
1875
 
1872
1876
  ---
1873
1877
 
@@ -1878,44 +1882,58 @@ Returns a success response
1878
1882
 
1879
1883
  | Properties | Type | Nullable | Description |
1880
1884
  | ---------- | ---- | -------- | ----------- |
1881
- | uid | number | no | |
1882
- | name | string | no | |
1883
- | verified_by | [UserSerializer](#UserSerializer) | no | |
1884
1885
  | business_type | string | no | |
1886
+ | modified_by | [UserSerializer](#UserSerializer) | no | |
1885
1887
  | created_by | [UserSerializer](#UserSerializer) | no | |
1886
1888
  | stage | string | no | |
1887
- | modified_on | string | no | |
1888
- | created_on | string | no | |
1889
- | modified_by | [UserSerializer](#UserSerializer) | no | |
1889
+ | addresses | [[GetAddressSerializer](#GetAddressSerializer)] | no | |
1890
+ | verified_by | [UserSerializer](#UserSerializer) | no | |
1891
+ | name | string | no | |
1890
1892
  | company_type | string | no | |
1891
1893
  | reject_reason | string | no | |
1894
+ | uid | number | no | |
1892
1895
  | verified_on | string | no | |
1893
- | addresses | [[GetAddressSerializer](#GetAddressSerializer)] | no | |
1896
+ | created_on | string | no | |
1897
+ | modified_on | string | no | |
1894
1898
 
1895
1899
  ---
1896
1900
 
1897
1901
 
1898
1902
 
1899
1903
 
1900
- #### [InvoiceCredSerializer](#InvoiceCredSerializer)
1904
+ #### [LocationManagerSerializer](#LocationManagerSerializer)
1901
1905
 
1902
1906
  | Properties | Type | Nullable | Description |
1903
1907
  | ---------- | ---- | -------- | ----------- |
1904
- | password | string | no | |
1905
- | username | string | no | |
1906
- | enabled | boolean | no | |
1908
+ | email | string | no | |
1909
+ | mobile_no | [SellerPhoneNumber](#SellerPhoneNumber) | yes | |
1910
+ | name | string | no | |
1907
1911
 
1908
1912
  ---
1909
1913
 
1910
1914
 
1911
1915
 
1912
1916
 
1913
- #### [InvoiceDetailsSerializer](#InvoiceDetailsSerializer)
1917
+ #### [LocationTimingSerializer](#LocationTimingSerializer)
1914
1918
 
1915
1919
  | Properties | Type | Nullable | Description |
1916
1920
  | ---------- | ---- | -------- | ----------- |
1917
- | e_waybill | [InvoiceCredSerializer](#InvoiceCredSerializer) | no | |
1918
- | e_invoice | [InvoiceCredSerializer](#InvoiceCredSerializer) | no | |
1921
+ | hour | number | yes | |
1922
+ | minute | number | yes | |
1923
+
1924
+ ---
1925
+
1926
+
1927
+
1928
+
1929
+ #### [LocationDayWiseSerializer](#LocationDayWiseSerializer)
1930
+
1931
+ | Properties | Type | Nullable | Description |
1932
+ | ---------- | ---- | -------- | ----------- |
1933
+ | open | boolean | yes | |
1934
+ | opening | [LocationTimingSerializer](#LocationTimingSerializer) | no | |
1935
+ | weekday | string | yes | |
1936
+ | closing | [LocationTimingSerializer](#LocationTimingSerializer) | no | |
1919
1937
 
1920
1938
  ---
1921
1939
 
@@ -1934,39 +1952,50 @@ Returns a success response
1934
1952
 
1935
1953
 
1936
1954
 
1937
- #### [LocationManagerSerializer](#LocationManagerSerializer)
1955
+ #### [HolidayDateSerializer](#HolidayDateSerializer)
1938
1956
 
1939
1957
  | Properties | Type | Nullable | Description |
1940
1958
  | ---------- | ---- | -------- | ----------- |
1941
- | name | string | no | |
1942
- | mobile_no | [SellerPhoneNumber](#SellerPhoneNumber) | yes | |
1943
- | email | string | no | |
1959
+ | start_date | string | yes | |
1960
+ | end_date | string | yes | |
1944
1961
 
1945
1962
  ---
1946
1963
 
1947
1964
 
1948
1965
 
1949
1966
 
1950
- #### [LocationTimingSerializer](#LocationTimingSerializer)
1967
+ #### [HolidaySchemaSerializer](#HolidaySchemaSerializer)
1951
1968
 
1952
1969
  | Properties | Type | Nullable | Description |
1953
1970
  | ---------- | ---- | -------- | ----------- |
1954
- | minute | number | yes | |
1955
- | hour | number | yes | |
1971
+ | holiday_type | string | yes | |
1972
+ | title | string | yes | |
1973
+ | date | [HolidayDateSerializer](#HolidayDateSerializer) | yes | |
1956
1974
 
1957
1975
  ---
1958
1976
 
1959
1977
 
1960
1978
 
1961
1979
 
1962
- #### [LocationDayWiseSerializer](#LocationDayWiseSerializer)
1980
+ #### [InvoiceCredSerializer](#InvoiceCredSerializer)
1963
1981
 
1964
1982
  | Properties | Type | Nullable | Description |
1965
1983
  | ---------- | ---- | -------- | ----------- |
1966
- | closing | [LocationTimingSerializer](#LocationTimingSerializer) | no | |
1967
- | weekday | string | yes | |
1968
- | opening | [LocationTimingSerializer](#LocationTimingSerializer) | no | |
1969
- | open | boolean | yes | |
1984
+ | password | string | no | |
1985
+ | enabled | boolean | no | |
1986
+ | username | string | no | |
1987
+
1988
+ ---
1989
+
1990
+
1991
+
1992
+
1993
+ #### [InvoiceDetailsSerializer](#InvoiceDetailsSerializer)
1994
+
1995
+ | Properties | Type | Nullable | Description |
1996
+ | ---------- | ---- | -------- | ----------- |
1997
+ | e_waybill | [InvoiceCredSerializer](#InvoiceCredSerializer) | no | |
1998
+ | e_invoice | [InvoiceCredSerializer](#InvoiceCredSerializer) | no | |
1970
1999
 
1971
2000
  ---
1972
2001
 
@@ -1977,30 +2006,31 @@ Returns a success response
1977
2006
 
1978
2007
  | Properties | Type | Nullable | Description |
1979
2008
  | ---------- | ---- | -------- | ----------- |
1980
- | uid | number | no | |
1981
- | address | [GetAddressSerializer](#GetAddressSerializer) | yes | |
1982
- | warnings | string | no | |
2009
+ | documents | [[Document](#Document)] | no | |
2010
+ | verified_by | [UserSerializer](#UserSerializer) | no | |
1983
2011
  | name | string | yes | |
1984
- | stage | string | no | |
1985
2012
  | company | [GetCompanySerializer](#GetCompanySerializer) | no | |
1986
- | created_by | [UserSerializer](#UserSerializer) | no | |
1987
2013
  | store_type | string | no | |
1988
2014
  | contact_numbers | [[SellerPhoneNumber](#SellerPhoneNumber)] | no | |
1989
- | gst_credentials | [InvoiceDetailsSerializer](#InvoiceDetailsSerializer) | no | |
1990
- | code | string | yes | |
1991
- | verified_by | [UserSerializer](#UserSerializer) | no | |
1992
- | product_return_config | [ProductReturnConfigSerializer](#ProductReturnConfigSerializer) | no | |
1993
- | modified_on | string | no | |
2015
+ | modified_by | [UserSerializer](#UserSerializer) | no | |
1994
2016
  | manager | [LocationManagerSerializer](#LocationManagerSerializer) | no | |
1995
2017
  | display_name | string | yes | |
1996
- | created_on | string | no | |
1997
- | documents | [[Document](#Document)] | no | |
2018
+ | timing | [[LocationDayWiseSerializer](#LocationDayWiseSerializer)] | no | |
2019
+ | product_return_config | [ProductReturnConfigSerializer](#ProductReturnConfigSerializer) | no | |
2020
+ | warnings | string | no | |
2021
+ | holiday | [[HolidaySchemaSerializer](#HolidaySchemaSerializer)] | no | |
1998
2022
  | notification_emails | [string] | no | |
1999
- | _custom_json | string | no | |
2000
- | modified_by | [UserSerializer](#UserSerializer) | no | |
2001
- | phone_number | string | yes | |
2023
+ | uid | number | no | |
2002
2024
  | verified_on | string | no | |
2003
- | timing | [[LocationDayWiseSerializer](#LocationDayWiseSerializer)] | no | |
2025
+ | modified_on | string | no | |
2026
+ | code | string | yes | |
2027
+ | created_by | [UserSerializer](#UserSerializer) | no | |
2028
+ | gst_credentials | [InvoiceDetailsSerializer](#InvoiceDetailsSerializer) | no | |
2029
+ | phone_number | string | no | |
2030
+ | _custom_json | string | no | |
2031
+ | stage | string | no | |
2032
+ | address | [GetAddressSerializer](#GetAddressSerializer) | yes | |
2033
+ | created_on | string | no | |
2004
2034
 
2005
2035
  ---
2006
2036
 
@@ -2011,8 +2041,29 @@ Returns a success response
2011
2041
 
2012
2042
  | Properties | Type | Nullable | Description |
2013
2043
  | ---------- | ---- | -------- | ----------- |
2014
- | page | [Page](#Page) | no | |
2015
2044
  | items | [[GetLocationSerializer](#GetLocationSerializer)] | no | |
2045
+ | page | [Page](#Page) | no | |
2046
+
2047
+ ---
2048
+
2049
+
2050
+
2051
+
2052
+ #### [AddressSerializer](#AddressSerializer)
2053
+
2054
+ | Properties | Type | Nullable | Description |
2055
+ | ---------- | ---- | -------- | ----------- |
2056
+ | address_type | string | no | |
2057
+ | latitude | number | yes | |
2058
+ | address1 | string | no | |
2059
+ | landmark | string | no | |
2060
+ | longitude | number | yes | |
2061
+ | city | string | no | |
2062
+ | pincode | number | no | |
2063
+ | state | string | no | |
2064
+ | country | string | no | |
2065
+ | address2 | string | no | |
2066
+ | country_code | string | no | |
2016
2067
 
2017
2068
  ---
2018
2069
 
@@ -2023,22 +2074,23 @@ Returns a success response
2023
2074
 
2024
2075
  | Properties | Type | Nullable | Description |
2025
2076
  | ---------- | ---- | -------- | ----------- |
2026
- | uid | number | no | |
2077
+ | documents | [[Document](#Document)] | no | |
2078
+ | gst_credentials | [InvoiceDetailsSerializer](#InvoiceDetailsSerializer) | no | |
2079
+ | manager | [LocationManagerSerializer](#LocationManagerSerializer) | no | |
2080
+ | stage | string | no | |
2081
+ | display_name | string | yes | |
2082
+ | timing | [[LocationDayWiseSerializer](#LocationDayWiseSerializer)] | no | |
2083
+ | product_return_config | [ProductReturnConfigSerializer](#ProductReturnConfigSerializer) | no | |
2084
+ | warnings | string | no | |
2027
2085
  | name | string | yes | |
2028
2086
  | company | number | yes | |
2029
- | stage | string | no | |
2030
- | documents | [[Document](#Document)] | no | |
2031
- | address | [GetAddressSerializer](#GetAddressSerializer) | yes | |
2087
+ | holiday | [[HolidaySchemaSerializer](#HolidaySchemaSerializer)] | no | |
2032
2088
  | notification_emails | [string] | no | |
2033
- | store_type | string | no | |
2034
2089
  | _custom_json | string | no | |
2035
- | product_return_config | [ProductReturnConfigSerializer](#ProductReturnConfigSerializer) | no | |
2090
+ | uid | number | no | |
2091
+ | address | [AddressSerializer](#AddressSerializer) | yes | |
2092
+ | store_type | string | no | |
2036
2093
  | contact_numbers | [[SellerPhoneNumber](#SellerPhoneNumber)] | no | |
2037
- | warnings | string | no | |
2038
- | manager | [LocationManagerSerializer](#LocationManagerSerializer) | no | |
2039
- | timing | [[LocationDayWiseSerializer](#LocationDayWiseSerializer)] | no | |
2040
- | display_name | string | yes | |
2041
- | gst_credentials | [InvoiceDetailsSerializer](#InvoiceDetailsSerializer) | no | |
2042
2094
  | code | string | yes | |
2043
2095
 
2044
2096
  ---
@@ -2057,25 +2109,25 @@ Returns a success response
2057
2109
 
2058
2110
 
2059
2111
 
2060
- #### [_ArticleQuery](#_ArticleQuery)
2112
+ #### [_ArticleAssignment](#_ArticleAssignment)
2061
2113
 
2062
2114
  | Properties | Type | Nullable | Description |
2063
2115
  | ---------- | ---- | -------- | ----------- |
2064
- | ignored_stores | [number] | no | |
2065
- | item_id | number | no | |
2066
- | size | string | no | |
2116
+ | strategy | string | no | |
2117
+ | level | string | no | |
2067
2118
 
2068
2119
  ---
2069
2120
 
2070
2121
 
2071
2122
 
2072
2123
 
2073
- #### [_ArticleAssignment](#_ArticleAssignment)
2124
+ #### [_ArticleQuery](#_ArticleQuery)
2074
2125
 
2075
2126
  | Properties | Type | Nullable | Description |
2076
2127
  | ---------- | ---- | -------- | ----------- |
2077
- | level | string | no | |
2078
- | strategy | string | no | |
2128
+ | item_id | number | no | |
2129
+ | size | string | no | |
2130
+ | ignored_stores | [number] | no | |
2079
2131
 
2080
2132
  ---
2081
2133
 
@@ -2086,11 +2138,11 @@ Returns a success response
2086
2138
 
2087
2139
  | Properties | Type | Nullable | Description |
2088
2140
  | ---------- | ---- | -------- | ----------- |
2089
- | query | [_ArticleQuery](#_ArticleQuery) | no | |
2090
- | article_assignment | [_ArticleAssignment](#_ArticleAssignment) | no | |
2091
2141
  | quantity | number | no | |
2142
+ | article_assignment | [_ArticleAssignment](#_ArticleAssignment) | no | |
2092
2143
  | meta | string | no | |
2093
2144
  | group_id | string | no | |
2145
+ | query | [_ArticleQuery](#_ArticleQuery) | no | |
2094
2146
 
2095
2147
  ---
2096
2148
 
@@ -2101,13 +2153,13 @@ Returns a success response
2101
2153
 
2102
2154
  | Properties | Type | Nullable | Description |
2103
2155
  | ---------- | ---- | -------- | ----------- |
2104
- | store_ids | [number] | no | |
2105
- | company_id | number | no | |
2106
- | channel_identifier | string | no | |
2107
- | app_id | string | no | |
2108
2156
  | articles | [[_AssignStoreArticle](#_AssignStoreArticle)] | no | |
2157
+ | company_id | number | no | |
2109
2158
  | channel_type | string | no | |
2159
+ | store_ids | [number] | no | |
2110
2160
  | pincode | string | no | |
2161
+ | app_id | string | no | |
2162
+ | channel_identifier | string | no | |
2111
2163
 
2112
2164
  ---
2113
2165
 
@@ -2118,21 +2170,21 @@ Returns a success response
2118
2170
 
2119
2171
  | Properties | Type | Nullable | Description |
2120
2172
  | ---------- | ---- | -------- | ----------- |
2121
- | price_marked | number | no | |
2122
- | uid | string | no | |
2123
2173
  | article_assignment | [_ArticleAssignment](#_ArticleAssignment) | no | |
2124
- | size | string | no | |
2174
+ | store_id | number | no | |
2175
+ | quantity | number | no | |
2176
+ | price_marked | number | no | |
2177
+ | store_pincode | string | no | |
2125
2178
  | company_id | number | no | |
2126
2179
  | _id | string | no | |
2127
- | store_pincode | string | no | |
2128
- | preice_effective | number | no | |
2129
- | quantity | number | no | |
2180
+ | s_city | string | no | |
2181
+ | size | string | no | |
2182
+ | index | number | no | |
2130
2183
  | meta | string | no | |
2131
2184
  | item_id | number | no | |
2132
- | s_city | string | no | |
2133
- | store_id | number | no | |
2185
+ | uid | string | no | |
2134
2186
  | status | boolean | no | |
2135
- | index | number | no | |
2187
+ | preice_effective | number | no | |
2136
2188
 
2137
2189
  ---
2138
2190