yellowgrid-api-ts 3.2.277 → 3.2.279

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 (321) hide show
  1. package/.openapi-generator/FILES +32 -0
  2. package/.openapi-generator/VERSION +1 -1
  3. package/README.md +66 -0
  4. package/api.ts +5123 -1849
  5. package/common.ts +2 -2
  6. package/dist/api.d.ts +10229 -8273
  7. package/dist/api.js +3208 -319
  8. package/dist/models/ReasonEnum.d.ts +18 -0
  9. package/dist/models/ReasonEnum.js +20 -0
  10. package/dist/models/ResolutionEnum.d.ts +18 -0
  11. package/dist/models/ResolutionEnum.js +20 -0
  12. package/dist/models/RmaItemCreditTypeEnum.d.ts +13 -0
  13. package/dist/models/RmaItemCreditTypeEnum.js +15 -0
  14. package/dist/models/RmaItemResolutionEnum.d.ts +28 -0
  15. package/dist/models/RmaItemResolutionEnum.js +30 -0
  16. package/dist/models/RmaItemStatusEnum.d.ts +18 -0
  17. package/dist/models/RmaItemStatusEnum.js +20 -0
  18. package/dist/models/RmaStatusEnum.d.ts +33 -0
  19. package/dist/models/RmaStatusEnum.js +35 -0
  20. package/docs/AbstractOrderRequestDTO.md +4 -4
  21. package/docs/AccountAddressesDTO.md +3 -3
  22. package/docs/AccountContactEntity.md +13 -13
  23. package/docs/AccountContactModel.md +13 -13
  24. package/docs/AccountContactRequestModel.md +9 -9
  25. package/docs/AccountDetailedSummaryDTO.md +10 -10
  26. package/docs/AccountFinanceDTO.md +10 -10
  27. package/docs/AccountRequestModel.md +11 -11
  28. package/docs/AccountSummaryDTO.md +3 -3
  29. package/docs/AccountsApi.md +48 -0
  30. package/docs/AccountsResponseModel.md +4 -4
  31. package/docs/AddressDTO.md +12 -6
  32. package/docs/AddressModel.md +5 -5
  33. package/docs/AddressRequestModel.md +4 -4
  34. package/docs/AdminCustomerRmasModel.md +27 -0
  35. package/docs/AdminNumberPortDTO.md +7 -7
  36. package/docs/AdminOrderRequestDTO.md +4 -4
  37. package/docs/AdminRmaDTO.md +67 -0
  38. package/docs/AdminRmaItemDTO.md +51 -0
  39. package/docs/AdminRmaNoteDTO.md +27 -0
  40. package/docs/AdminRmaSummaryDTO.md +39 -0
  41. package/docs/AdminUserModel.md +5 -5
  42. package/docs/AgentHoursGraphModel.md +4 -4
  43. package/docs/AgentHoursGraphMonthModel.md +2 -2
  44. package/docs/ApiLogEntity.md +12 -12
  45. package/docs/AreaCodeModel.md +2 -2
  46. package/docs/AttachmentModel.md +5 -5
  47. package/docs/AttributeSetEnum.md +2 -2
  48. package/docs/AuditLogEntity.md +9 -9
  49. package/docs/AuthCodeResponseModel.md +1 -1
  50. package/docs/AxisDataDTO.md +1 -1
  51. package/docs/BasicItemDTO.md +2 -2
  52. package/docs/BasicProductDTO.md +2 -2
  53. package/docs/BatchDTO.md +17 -17
  54. package/docs/BatchEntity.md +17 -17
  55. package/docs/BrandedVideoSummaryDTO.md +10 -10
  56. package/docs/BrandedVideosSummariesModel.md +4 -4
  57. package/docs/CallBarringModel.md +5 -5
  58. package/docs/ClientDetailsModel.md +7 -7
  59. package/docs/ClientModel.md +4 -4
  60. package/docs/CollectionDateDTO.md +27 -0
  61. package/docs/CollectionDatesRequestDTO.md +23 -0
  62. package/docs/CompanyContractModel.md +5 -5
  63. package/docs/ContactInfoModel.md +5 -5
  64. package/docs/ConversationModel.md +8 -8
  65. package/docs/CourierPriceEntity.md +10 -10
  66. package/docs/CreditAccountEntity.md +23 -23
  67. package/docs/CreditNoteDTO.md +5 -1
  68. package/docs/CreditNoteEntity.md +5 -5
  69. package/docs/CreditNoteItemDTO.md +3 -1
  70. package/docs/CreditNoteItemEntity.md +7 -5
  71. package/docs/CreditNoteItemModel.md +7 -5
  72. package/docs/CreditNoteModel.md +5 -5
  73. package/docs/CrmActivitiesResponseDTO.md +2 -2
  74. package/docs/CrmActivityDTO.md +3 -3
  75. package/docs/CrmContactDTO.md +7 -7
  76. package/docs/CrmDateActivitiesDTO.md +1 -1
  77. package/docs/CrmNoteEntity.md +10 -10
  78. package/docs/CrmNoteModel.md +10 -10
  79. package/docs/CustomerCoordinatesDTO.md +5 -5
  80. package/docs/CustomerInformationModel.md +4 -4
  81. package/docs/CustomerItemRequestDTO.md +2 -2
  82. package/docs/CustomerListAccountDTO.md +13 -13
  83. package/docs/CustomerOrderRequestDTO.md +4 -4
  84. package/docs/CustomerPriceListEnum.md +2 -2
  85. package/docs/CustomerRmasModel.md +27 -0
  86. package/docs/CustomerSummaryReportDTO.md +6 -6
  87. package/docs/DdiRangeRequestModel.md +3 -3
  88. package/docs/DdiRangesRequestModel.md +1 -1
  89. package/docs/DetailedItemRequestDTO.md +2 -2
  90. package/docs/DetailedOrderRequestDTO.md +4 -4
  91. package/docs/DivertRequestModel.md +1 -1
  92. package/docs/DivertResponseModel.md +2 -2
  93. package/docs/EdTechProClientEntity.md +4 -4
  94. package/docs/EdTechProSchoolModel.md +11 -11
  95. package/docs/EdTechProSchoolsModel.md +4 -4
  96. package/docs/EdTechProSetupModel.md +5 -5
  97. package/docs/EmailRequestModel.md +21 -0
  98. package/docs/EventDTO.md +8 -8
  99. package/docs/EventRequestDTO.md +3 -3
  100. package/docs/EventSubscriptionModel.md +2 -2
  101. package/docs/EventUpdateDTO.md +4 -4
  102. package/docs/EventUpdateEntity.md +5 -5
  103. package/docs/EventUpdateRequestDTO.md +3 -3
  104. package/docs/ExpiringKeyDTO.md +5 -5
  105. package/docs/FraudManagementModel.md +2 -2
  106. package/docs/FreshdeskCompanyTicketsModel.md +4 -4
  107. package/docs/FreshdeskTicketEntity.md +6 -6
  108. package/docs/FtpAccountsEntity.md +5 -5
  109. package/docs/GenericFileModel.md +3 -3
  110. package/docs/GraphDTO.md +6 -6
  111. package/docs/HostingChangeResponseModel.md +5 -5
  112. package/docs/HostingRegionDTO.md +3 -3
  113. package/docs/InstallationDetailsDTO.md +3 -3
  114. package/docs/InstanceAutoFailoverEntity.md +5 -5
  115. package/docs/InstanceDeletionScheduleEntity.md +4 -4
  116. package/docs/InstanceEntity.md +21 -21
  117. package/docs/InstanceFailoverEntity.md +11 -11
  118. package/docs/InstanceMonitoringEntity.md +3 -3
  119. package/docs/InstanceMonitoringLogEntity.md +6 -6
  120. package/docs/InstanceScheduledTasksEntity.md +6 -6
  121. package/docs/InstanceTcxDetailsEntity.md +10 -10
  122. package/docs/InstanceUserCredentialsEntity.md +5 -5
  123. package/docs/ItemDTO.md +2 -2
  124. package/docs/ItemDiscountEntity.md +6 -6
  125. package/docs/ItemEntity.md +21 -21
  126. package/docs/ItemResolutionRequestModel.md +21 -0
  127. package/docs/LinkedOrderEntity.md +2 -2
  128. package/docs/MFARequiredModel.md +2 -2
  129. package/docs/MacAddressDTO.md +2 -2
  130. package/docs/MacAddressRequestModel.md +21 -0
  131. package/docs/MonthlyUsageModel.md +2 -2
  132. package/docs/MultiTenantChangeResponseModel.md +4 -4
  133. package/docs/NameRequestModel.md +21 -0
  134. package/docs/NavigationModel.md +4 -4
  135. package/docs/NoteRequestModel.md +21 -0
  136. package/docs/NumberPortDTO.md +7 -7
  137. package/docs/NumberPortNoteDTO.md +5 -5
  138. package/docs/NumberPortRangeDTO.md +2 -2
  139. package/docs/NumberPortingApi.md +21 -21
  140. package/docs/NumberPortsModel.md +4 -4
  141. package/docs/OAuth20Api.md +3 -3
  142. package/docs/OfflineInstancesEntity.md +5 -5
  143. package/docs/OrderDTO.md +3 -3
  144. package/docs/OrderDetailsDTO.md +10 -10
  145. package/docs/OrderEntity.md +56 -56
  146. package/docs/OrderItemDTO.md +2 -2
  147. package/docs/OrderRequestModel.md +6 -6
  148. package/docs/OrderSummariesModel.md +4 -4
  149. package/docs/OrderSummaryDTO.md +10 -10
  150. package/docs/OrderTotalModel.md +7 -7
  151. package/docs/OrderedItemEntity.md +14 -14
  152. package/docs/OrderedItemModel.md +14 -14
  153. package/docs/OrdersApi.md +55 -0
  154. package/docs/PartnerDTO.md +10 -10
  155. package/docs/PasswordSenderDTO.md +2 -2
  156. package/docs/PasswordSenderEntity.md +7 -7
  157. package/docs/PortalAccountModel.md +23 -23
  158. package/docs/PortalLoginModel.md +7 -7
  159. package/docs/PostGenerateReport200Response.md +8 -8
  160. package/docs/PriceListItemModel.md +2 -2
  161. package/docs/PrinterEntity.md +5 -5
  162. package/docs/PrizesEntity.md +6 -6
  163. package/docs/ProductDetailedSummaryDTO.md +2 -2
  164. package/docs/ProductPriceListItemModel.md +2 -2
  165. package/docs/ProductSearchResultsModel.md +1 -1
  166. package/docs/ProductSerialInfoDTO.md +27 -0
  167. package/docs/ProductSerialInfoModel.md +3 -3
  168. package/docs/ProductSummaryDTO.md +2 -2
  169. package/docs/PromoCodesEntity.md +8 -8
  170. package/docs/PromoItemModel.md +8 -8
  171. package/docs/PromoItemsEntity.md +8 -8
  172. package/docs/PromoModel.md +8 -8
  173. package/docs/PromoSummariesModel.md +4 -4
  174. package/docs/PromoSummaryDTO.md +3 -3
  175. package/docs/ProspectDTO.md +7 -7
  176. package/docs/ProspectEntity.md +11 -11
  177. package/docs/ProvisioningModel.md +3 -3
  178. package/docs/ProvisioningRequestEntity.md +3 -3
  179. package/docs/RMAApi.md +1749 -0
  180. package/docs/ReasonRequestModel.md +21 -0
  181. package/docs/RecordingBackupAzureModel.md +4 -4
  182. package/docs/RemoteStorageDTO.md +4 -4
  183. package/docs/ReportRequestDTO.md +1 -1
  184. package/docs/ResolutionRequestModel.md +21 -0
  185. package/docs/ResourceNotReadyException.md +3 -3
  186. package/docs/RmaCollectionDTO.md +27 -0
  187. package/docs/RmaCreditItemRequestDTO.md +25 -0
  188. package/docs/RmaDTO.md +47 -0
  189. package/docs/RmaItemDTO.md +35 -0
  190. package/docs/RmaItemRequestDTO.md +25 -0
  191. package/docs/RmaOrderDTO.md +33 -0
  192. package/docs/RmaOrderItemDTO.md +37 -0
  193. package/docs/RmaOrderSummaryDTO.md +25 -0
  194. package/docs/RmaReplacementOrderItemDTO.md +23 -0
  195. package/docs/RmaReplacementOrderRequestDTO.md +21 -0
  196. package/docs/RmaRequestDTO.md +36 -0
  197. package/docs/RmaReturnDTO.md +31 -0
  198. package/docs/RmaSummaryDTO.md +31 -0
  199. package/docs/RmaSummaryItemDTO.md +23 -0
  200. package/docs/RootAccessModel.md +3 -3
  201. package/docs/S3BucketEntity.md +4 -4
  202. package/docs/ScannedItemModel.md +1 -1
  203. package/docs/ScopeModel.md +2 -2
  204. package/docs/SerialNumberRequestModel.md +21 -0
  205. package/docs/SeriesDTO.md +3 -3
  206. package/docs/ServiceHealthDTO.md +2 -2
  207. package/docs/ServiceStatusDTO.md +4 -4
  208. package/docs/ShipmentAddressEntity.md +11 -11
  209. package/docs/ShipmentDTO.md +4 -4
  210. package/docs/ShipmentEntity.md +12 -12
  211. package/docs/ShipmentItemDTO.md +2 -2
  212. package/docs/ShipmentItemEntity.md +5 -5
  213. package/docs/ShipmentItemModel.md +5 -5
  214. package/docs/ShipmentModel.md +12 -12
  215. package/docs/ShipmentRequestDTO.md +4 -4
  216. package/docs/ShippingApi.md +56 -0
  217. package/docs/ShippingConsignmentModel.md +4 -4
  218. package/docs/ShippingInformationDTO.md +3 -3
  219. package/docs/ShippingRequestDTO.md +3 -3
  220. package/docs/ShippingServiceDTO.md +2 -2
  221. package/docs/ShippingServiceModel.md +4 -4
  222. package/docs/ShippingServicesModel.md +1 -1
  223. package/docs/SipTrunkChangeResponseModel.md +5 -5
  224. package/docs/SipTrunkCreationRequestModel.md +6 -6
  225. package/docs/SipTrunkEntity.md +12 -12
  226. package/docs/SipTrunksResponseModel.md +4 -4
  227. package/docs/SmsAccountDTO.md +6 -6
  228. package/docs/SmsAccountEntity.md +6 -6
  229. package/docs/SmsAccountRequestDTO.md +5 -5
  230. package/docs/SmsDataModel.md +1 -1
  231. package/docs/SmsMessageModel.md +3 -3
  232. package/docs/SmsNumbersEntity.md +2 -2
  233. package/docs/SmsPayloadModel.md +3 -3
  234. package/docs/SmsPhoneNumberModel.md +1 -1
  235. package/docs/SmsResponseModel.md +3 -3
  236. package/docs/SmsWhitelistEntity.md +2 -2
  237. package/docs/StockOrderCourierEntity.md +4 -4
  238. package/docs/StockOrderDeductionModel.md +4 -4
  239. package/docs/StockOrderDeductionRequestModel.md +2 -2
  240. package/docs/StockOrderDeductionsEntity.md +4 -4
  241. package/docs/StockOrderEntity.md +22 -22
  242. package/docs/StockOrderItemEntity.md +7 -7
  243. package/docs/StockOrderItemModel.md +7 -7
  244. package/docs/StockOrderItemRequestModel.md +4 -4
  245. package/docs/StockOrderModel.md +14 -14
  246. package/docs/StockOrderProductEntity.md +6 -6
  247. package/docs/StockOrderRequestModel.md +3 -3
  248. package/docs/StockOrderSupplierEntity.md +9 -9
  249. package/docs/StockOrderSupplierModel.md +9 -9
  250. package/docs/StockOrdersModel.md +4 -4
  251. package/docs/StockProductModel.md +6 -6
  252. package/docs/StockProductPriceModel.md +1 -1
  253. package/docs/StockProductSummariesModel.md +4 -4
  254. package/docs/StockProductSummaryModel.md +6 -6
  255. package/docs/StockReportItemModel.md +6 -6
  256. package/docs/StockReportModel.md +5 -5
  257. package/docs/StockTransactionsEntity.md +8 -8
  258. package/docs/SupplierEntity.md +9 -9
  259. package/docs/SupplierItemEntity.md +8 -8
  260. package/docs/SupplierItemModel.md +8 -8
  261. package/docs/SupplierItemsResultsDTO.md +1 -1
  262. package/docs/SupplierModel.md +9 -9
  263. package/docs/SupplierProductModel.md +3 -3
  264. package/docs/SupplierProductResultsModel.md +4 -4
  265. package/docs/SupportTicketModel.md +10 -10
  266. package/docs/TableDTO.md +3 -3
  267. package/docs/TableDataDTO.md +1 -1
  268. package/docs/TableHistoryEntity.md +8 -8
  269. package/docs/TableRowDTO.md +1 -1
  270. package/docs/TcxBackupEntity.md +9 -9
  271. package/docs/TcxBackupModel.md +9 -9
  272. package/docs/TcxBillingEntity.md +10 -10
  273. package/docs/TcxBulkLicenceDetailsModel.md +2 -2
  274. package/docs/TcxDeadLicenceEntity.md +3 -3
  275. package/docs/TcxExtsEntity.md +8 -8
  276. package/docs/TcxInstallationModel.md +17 -17
  277. package/docs/TcxInstallationsModel.md +4 -4
  278. package/docs/TcxKeySummaryDTO.md +3 -3
  279. package/docs/TcxKeysEntity.md +6 -6
  280. package/docs/TcxLicenceDetailsErrorModel.md +4 -4
  281. package/docs/TcxLicenceDetailsModel.md +11 -11
  282. package/docs/TcxMacsEntity.md +3 -3
  283. package/docs/TcxMultiTenantModel.md +7 -7
  284. package/docs/TcxMultiTenantUserModel.md +3 -3
  285. package/docs/TcxMultiTenantsModel.md +4 -4
  286. package/docs/TcxNumbersEntity.md +3 -3
  287. package/docs/TcxOfficeHoursEntity.md +15 -15
  288. package/docs/TcxPhoneModel.md +6 -6
  289. package/docs/TcxPhonesEntity.md +6 -6
  290. package/docs/TcxRemoteStorageModel.md +4 -4
  291. package/docs/TcxSbcDTO.md +7 -7
  292. package/docs/TcxSbcEntity.md +16 -16
  293. package/docs/TcxSbcModel.md +16 -16
  294. package/docs/TcxSbcResponseDTO.md +2 -2
  295. package/docs/TcxSetupEntity.md +25 -25
  296. package/docs/TcxSetupsModel.md +4 -4
  297. package/docs/TcxSipTrunksEntity.md +13 -13
  298. package/docs/TcxTemplateXmlEnum.md +2 -2
  299. package/docs/TcxUsersEntity.md +6 -6
  300. package/docs/TcxWizardConfigModel.md +2 -2
  301. package/docs/TcxWizardModel.md +9 -9
  302. package/docs/TechSupportCompanySummaryDTO.md +5 -5
  303. package/docs/ThumbnailDTO.md +3 -3
  304. package/docs/TicketSummaryModel.md +6 -6
  305. package/docs/TicketTimeDTO.md +9 -9
  306. package/docs/TicketsApi.md +10 -10
  307. package/docs/TokenResponseModel.md +3 -3
  308. package/docs/UpgradeOrderResponseModel.md +2 -2
  309. package/docs/UpgradeRequestModel.md +4 -4
  310. package/docs/UserEntity.md +10 -10
  311. package/docs/VideoRequestEntity.md +13 -13
  312. package/docs/XeroLogEntity.md +10 -10
  313. package/git_push.sh +14 -17
  314. package/models/ReasonEnum.ts +19 -0
  315. package/models/ResolutionEnum.ts +19 -0
  316. package/models/RmaItemCreditTypeEnum.ts +14 -0
  317. package/models/RmaItemResolutionEnum.ts +29 -0
  318. package/models/RmaItemStatusEnum.ts +19 -0
  319. package/models/RmaStatusEnum.ts +34 -0
  320. package/openapitools.json +1 -1
  321. package/package.json +1 -1
package/docs/ProductDetailedSummaryDTO.md CHANGED
@@ -6,8 +6,8 @@ Product Detailed Summary
6
6
 
7
7
  Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
- **sku** | **string** | SKU | [optional] [default to undefined]
10
- **title** | **string** | Title | [optional] [default to undefined]
9
+ **sku** | **string** | SKU | [default to undefined]
10
+ **title** | **string** | Title | [default to undefined]
11
11
  **quantity** | **number** | Stock Quantity | [optional] [default to undefined]
12
12
  **stockProduct** | **boolean** | Stock Product | [optional] [default to undefined]
13
13
  **price** | **number** | Price | [optional] [default to undefined]
package/docs/ProductPriceListItemModel.md CHANGED
@@ -6,9 +6,9 @@ Product Price List Item
6
6
 
7
7
  Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
- **title** | **string** | Title | [optional] [default to undefined]
9
+ **title** | **string** | Title | [default to undefined]
10
10
  **sku** | **string** | SKU | [optional] [default to undefined]
11
- **price** | **number** | Price | [optional] [default to undefined]
11
+ **price** | **number** | Price | [default to undefined]
12
12
  **rrp** | **number** | RRP | [optional] [default to undefined]
13
13
  **stock** | **number** | Stock | [optional] [default to undefined]
14
14
  **brand** | **string** | Brand | [optional] [default to undefined]
package/docs/ProductSearchResultsModel.md CHANGED
@@ -6,7 +6,7 @@ Product Search Results
6
6
 
7
7
  Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
- **results** | [**Array<ProductSummaryDTO>**](ProductSummaryDTO.md) | Results | [optional] [default to undefined]
9
+ **results** | [**Array<ProductSummaryDTO>**](ProductSummaryDTO.md) | Results | [default to undefined]
10
10
 
11
11
  ## Example
12
12
 
package/docs/ProductSerialInfoDTO.md ADDED
@@ -0,0 +1,27 @@
1
+ # ProductSerialInfoDTO
2
+
3
+ Product Serial Info Response
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **sku** | **string** | SKU | [default to undefined]
10
+ **title** | **string** | Product Title | [default to undefined]
11
+ **mac** | **boolean** | Has MAC Address | [default to undefined]
12
+ **serialPrefixes** | **Array<string>** | Serial Prefix | [default to undefined]
13
+
14
+ ## Example
15
+
16
+ ```typescript
17
+ import { ProductSerialInfoDTO } from 'yellowgrid-api-ts';
18
+
19
+ const instance: ProductSerialInfoDTO = {
20
+ sku,
21
+ title,
22
+ mac,
23
+ serialPrefixes,
24
+ };
25
+ ```
26
+
27
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
package/docs/ProductSerialInfoModel.md CHANGED
@@ -6,9 +6,9 @@ Product Serial Info
6
6
 
7
7
  Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
- **sku** | **string** | SKU | [optional] [default to undefined]
10
- **title** | **string** | Product Title | [optional] [default to undefined]
11
- **mac** | **boolean** | Has MAC Address | [optional] [default to undefined]
9
+ **sku** | **string** | SKU | [default to undefined]
10
+ **title** | **string** | Product Title | [default to undefined]
11
+ **mac** | **boolean** | Has MAC Address | [default to undefined]
12
12
  **serial_prefixes** | **Array<string>** | Serial Prefix | [optional] [default to undefined]
13
13
 
14
14
  ## Example
package/docs/ProductSummaryDTO.md CHANGED
@@ -6,8 +6,8 @@ Product Summary
6
6
 
7
7
  Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
- **sku** | **string** | SKU | [optional] [default to undefined]
10
- **title** | **string** | Title | [optional] [default to undefined]
9
+ **sku** | **string** | SKU | [default to undefined]
10
+ **title** | **string** | Title | [default to undefined]
11
11
  **quantity** | **number** | Stock Quantity | [optional] [default to undefined]
12
12
  **stockProduct** | **boolean** | Stock Product | [optional] [default to undefined]
13
13
  **price** | **number** | Price | [optional] [default to undefined]
package/docs/PromoCodesEntity.md CHANGED
@@ -7,16 +7,16 @@ PromoCodesEntity
7
7
  Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
9
  **id** | **number** | id | [optional] [default to undefined]
10
- **code** | **string** | code | [optional] [default to undefined]
11
- **description** | **string** | description | [optional] [default to undefined]
10
+ **code** | **string** | code | [default to undefined]
11
+ **description** | **string** | description | [default to undefined]
12
12
  **startDate** | **string** | start | [optional] [default to undefined]
13
13
  **endDate** | **string** | expiry | [optional] [default to undefined]
14
- **customerLimit** | **number** | customerLimit | [optional] [default to undefined]
15
- **globalLimit** | **number** | globalLimit | [optional] [default to undefined]
16
- **orderRestrictions** | **Array<string>** | orderRestrictions | [optional] [default to undefined]
17
- **includeDistribution** | **boolean** | includeDistribution | [optional] [default to undefined]
18
- **distributionOnly** | **boolean** | distributionOnly | [optional] [default to undefined]
19
- **nfr** | **boolean** | nfr | [optional] [default to undefined]
14
+ **customerLimit** | **number** | customerLimit | [default to undefined]
15
+ **globalLimit** | **number** | globalLimit | [default to undefined]
16
+ **orderRestrictions** | **Array<string>** | orderRestrictions | [default to undefined]
17
+ **includeDistribution** | **boolean** | includeDistribution | [default to undefined]
18
+ **distributionOnly** | **boolean** | distributionOnly | [default to undefined]
19
+ **nfr** | **boolean** | nfr | [default to undefined]
20
20
  **note** | **string** | note | [optional] [default to undefined]
21
21
 
22
22
  ## Example
package/docs/PromoItemModel.md CHANGED
@@ -6,14 +6,14 @@ Promo Item
6
6
 
7
7
  Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
- **id** | **number** | id | [optional] [default to undefined]
10
- **promoId** | **number** | promoId | [optional] [default to undefined]
11
- **price** | **number** | price | [optional] [default to undefined]
12
- **discount** | **number** | discount | [optional] [default to undefined]
13
- **sku** | **string** | sku | [optional] [default to undefined]
14
- **quantity** | **number** | quantity | [optional] [default to undefined]
15
- **bulkQuantity** | **number** | bulkQuantity | [optional] [default to undefined]
16
- **bulkAdd** | **number** | bulkAdd | [optional] [default to undefined]
9
+ **id** | **number** | id | [default to undefined]
10
+ **promoId** | **number** | promoId | [default to undefined]
11
+ **price** | **number** | price | [default to undefined]
12
+ **discount** | **number** | discount | [default to undefined]
13
+ **sku** | **string** | sku | [default to undefined]
14
+ **quantity** | **number** | quantity | [default to undefined]
15
+ **bulkQuantity** | **number** | bulkQuantity | [default to undefined]
16
+ **bulkAdd** | **number** | bulkAdd | [default to undefined]
17
17
 
18
18
  ## Example
19
19
 
package/docs/PromoItemsEntity.md CHANGED
@@ -6,14 +6,14 @@ PromoItemsEntity
6
6
 
7
7
  Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
- **id** | **number** | id | [optional] [default to undefined]
10
- **promoId** | **number** | promoId | [optional] [default to undefined]
11
- **price** | **number** | price | [optional] [default to undefined]
12
- **discount** | **number** | discount | [optional] [default to undefined]
13
- **sku** | **string** | sku | [optional] [default to undefined]
14
- **quantity** | **number** | quantity | [optional] [default to undefined]
15
- **bulkQuantity** | **number** | bulkQuantity | [optional] [default to undefined]
16
- **bulkAdd** | **number** | bulkAdd | [optional] [default to undefined]
9
+ **id** | **number** | id | [default to undefined]
10
+ **promoId** | **number** | promoId | [default to undefined]
11
+ **price** | **number** | price | [default to undefined]
12
+ **discount** | **number** | discount | [default to undefined]
13
+ **sku** | **string** | sku | [default to undefined]
14
+ **quantity** | **number** | quantity | [default to undefined]
15
+ **bulkQuantity** | **number** | bulkQuantity | [default to undefined]
16
+ **bulkAdd** | **number** | bulkAdd | [default to undefined]
17
17
 
18
18
  ## Example
19
19
 
package/docs/PromoModel.md CHANGED
@@ -7,16 +7,16 @@ Promotion
7
7
  Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
9
  **id** | **number** | id | [optional] [default to undefined]
10
- **code** | **string** | code | [optional] [default to undefined]
11
- **description** | **string** | description | [optional] [default to undefined]
10
+ **code** | **string** | code | [default to undefined]
11
+ **description** | **string** | description | [default to undefined]
12
12
  **startDate** | **string** | start | [optional] [default to undefined]
13
13
  **endDate** | **string** | expiry | [optional] [default to undefined]
14
- **customerLimit** | **number** | customerLimit | [optional] [default to undefined]
15
- **globalLimit** | **number** | globalLimit | [optional] [default to undefined]
16
- **orderRestrictions** | **Array<string>** | orderRestrictions | [optional] [default to undefined]
17
- **includeDistribution** | **boolean** | includeDistribution | [optional] [default to undefined]
18
- **distributionOnly** | **boolean** | distributionOnly | [optional] [default to undefined]
19
- **nfr** | **boolean** | nfr | [optional] [default to undefined]
14
+ **customerLimit** | **number** | customerLimit | [default to undefined]
15
+ **globalLimit** | **number** | globalLimit | [default to undefined]
16
+ **orderRestrictions** | **Array<string>** | orderRestrictions | [default to undefined]
17
+ **includeDistribution** | **boolean** | includeDistribution | [default to undefined]
18
+ **distributionOnly** | **boolean** | distributionOnly | [default to undefined]
19
+ **nfr** | **boolean** | nfr | [default to undefined]
20
20
  **note** | **string** | note | [optional] [default to undefined]
21
21
  **items** | [**Array<PromoItemModel>**](PromoItemModel.md) | Items | [optional] [default to undefined]
22
22
 
package/docs/PromoSummariesModel.md CHANGED
@@ -6,10 +6,10 @@ Promotions
6
6
 
7
7
  Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
- **results** | [**Array<PromoSummaryDTO>**](PromoSummaryDTO.md) | Results | [optional] [default to undefined]
10
- **page** | **number** | Page | [optional] [default to undefined]
11
- **perPage** | **number** | Per Page | [optional] [default to undefined]
12
- **totalResults** | **number** | Total Results | [optional] [default to undefined]
9
+ **results** | [**Array<PromoSummaryDTO>**](PromoSummaryDTO.md) | Results | [default to undefined]
10
+ **page** | **number** | Page | [default to undefined]
11
+ **perPage** | **number** | Per Page | [default to undefined]
12
+ **totalResults** | **number** | Total Results | [default to undefined]
13
13
 
14
14
  ## Example
15
15
 
package/docs/PromoSummaryDTO.md CHANGED
@@ -7,11 +7,11 @@ Promo Summary
7
7
  Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
9
  **id** | **number** | ID | [optional] [default to undefined]
10
- **description** | **string** | Description | [optional] [default to undefined]
11
- **code** | **string** | Promo Code | [optional] [default to undefined]
10
+ **description** | **string** | Description | [default to undefined]
11
+ **code** | **string** | Promo Code | [default to undefined]
12
12
  **startDate** | **string** | Start Date | [optional] [default to undefined]
13
13
  **endDate** | **string** | End Date | [optional] [default to undefined]
14
- **orders** | **number** | Orders | [optional] [default to undefined]
14
+ **orders** | **number** | Orders | [default to undefined]
15
15
 
16
16
  ## Example
17
17
 
package/docs/ProspectDTO.md CHANGED
@@ -6,16 +6,16 @@ Prospect
6
6
 
7
7
  Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
- **companyName** | **string** | Company Name | [optional] [default to undefined]
9
+ **companyName** | **string** | Company Name | [default to undefined]
10
10
  **telephone** | **string** | Telephone | [optional] [default to undefined]
11
11
  **lastOrderDate** | **string** | Last Order Date | [optional] [default to undefined]
12
12
  **callbackDate** | **string** | Call Back Date | [optional] [default to undefined]
13
- **xeroId** | **string** | Xero ID | [optional] [default to undefined]
14
- **removed** | **boolean** | Removed From Prospects | [optional] [default to undefined]
15
- **status** | **string** | Status | [optional] [default to undefined]
16
- **orderCount** | **number** | Order Count | [optional] [default to undefined]
17
- **tcxOrderCount** | **number** | 3CX Order Count | [optional] [default to undefined]
18
- **videoCount** | **number** | Branded Video Count | [optional] [default to undefined]
13
+ **xeroId** | **string** | Xero ID | [default to undefined]
14
+ **removed** | **boolean** | Removed From Prospects | [default to undefined]
15
+ **status** | **string** | Status | [default to undefined]
16
+ **orderCount** | **number** | Order Count | [default to undefined]
17
+ **tcxOrderCount** | **number** | 3CX Order Count | [default to undefined]
18
+ **videoCount** | **number** | Branded Video Count | [default to undefined]
19
19
 
20
20
  ## Example
21
21
 
package/docs/ProspectEntity.md CHANGED
@@ -6,17 +6,17 @@ ProspectEntity
6
6
 
7
7
  Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
- **id** | **number** | id | [optional] [default to undefined]
10
- **status** | **number** | status | [optional] [default to undefined]
11
- **customerId** | **number** | customerId | [optional] [default to undefined]
12
- **companyName** | **string** | companyName | [optional] [default to undefined]
13
- **contactName** | **string** | contactName | [optional] [default to undefined]
14
- **telephone** | **string** | telephone | [optional] [default to undefined]
15
- **email** | **string** | email | [optional] [default to undefined]
16
- **reason** | **string** | reason | [optional] [default to undefined]
17
- **lastOrderDate** | **string** | lastOrderDate | [optional] [default to undefined]
18
- **followUpDate** | **string** | followUpDate | [optional] [default to undefined]
19
- **notes** | **string** | notes | [optional] [default to undefined]
9
+ **id** | **number** | id | [default to undefined]
10
+ **status** | **number** | status | [default to undefined]
11
+ **customerId** | **number** | customerId | [default to undefined]
12
+ **companyName** | **string** | companyName | [default to undefined]
13
+ **contactName** | **string** | contactName | [default to undefined]
14
+ **telephone** | **string** | telephone | [default to undefined]
15
+ **email** | **string** | email | [default to undefined]
16
+ **reason** | **string** | reason | [default to undefined]
17
+ **lastOrderDate** | **string** | lastOrderDate | [default to undefined]
18
+ **followUpDate** | **string** | followUpDate | [default to undefined]
19
+ **notes** | **string** | notes | [default to undefined]
20
20
 
21
21
  ## Example
22
22
 
package/docs/ProvisioningModel.md CHANGED
@@ -6,9 +6,9 @@ Provisioning Group
6
6
 
7
7
  Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
- **groupName** | **string** | Provisioning Group Name | [optional] [default to undefined]
10
- **provisioningUrl** | **string** | Provisioning URL (Static Provisioning Server) | [optional] [default to undefined]
11
- **auth** | **string** | Additional Authentication Secret | [optional] [default to undefined]
9
+ **groupName** | **string** | Provisioning Group Name | [default to undefined]
10
+ **provisioningUrl** | **string** | Provisioning URL (Static Provisioning Server) | [default to undefined]
11
+ **auth** | **string** | Additional Authentication Secret | [default to undefined]
12
12
  **id** | **number** | Provisioning Group ID | [optional] [default to undefined]
13
13
  **customerId** | **number** | Owner ID | [optional] [default to undefined]
14
14
 
package/docs/ProvisioningRequestEntity.md CHANGED
@@ -6,9 +6,9 @@ Provisioning Group Request
6
6
 
7
7
  Name | Type | Description | Notes
8
8
  ------------ | ------------- | ------------- | -------------
9
- **groupName** | **string** | Provisioning Group Name | [optional] [default to undefined]
10
- **provisioningUrl** | **string** | Provisioning URL (Static Provisioning Server) | [optional] [default to undefined]
11
- **auth** | **string** | Additional Authentication Secret | [optional] [default to undefined]
9
+ **groupName** | **string** | Provisioning Group Name | [default to undefined]
10
+ **provisioningUrl** | **string** | Provisioning URL (Static Provisioning Server) | [default to undefined]
11
+ **auth** | **string** | Additional Authentication Secret | [default to undefined]
12
12
 
13
13
  ## Example
14
14