yellowgrid-api-ts 3.2.98-dev.0 → 3.2.100-dev.0

package/README.md

@@ -47,7 +47,7 @@ npm install PATH_TO_GENERATED_PACKAGE --save
 
 ### Documentation for API Endpoints
 
-All URIs are relative to *https://api.local.yellowgrid.co.uk*
+All URIs are relative to *https://localhost*
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
@@ -140,7 +140,6 @@ Class | Method | HTTP request | Description
 *NumberPortingApi* | [**getGetAdminNumberPort**](docs/NumberPortingApi.md#getgetadminnumberport) | **GET** /admin/sip/numbers/ports/{id} | 
 *NumberPortingApi* | [**getGetAdminNumberPorts**](docs/NumberPortingApi.md#getgetadminnumberports) | **GET** /admin/sip/numbers/ports | 
 *NumberPortingApi* | [**getUpdateNumberPort**](docs/NumberPortingApi.md#getupdatenumberport) | **GET** /sip/numbers/ports/{id} | 
-*NumberPortingApi* | [**patchCancelAdminNumberPort**](docs/NumberPortingApi.md#patchcanceladminnumberport) | **PATCH** /admin/sip/numbers/ports/{id}/cancel | 
 *NumberPortingApi* | [**patchCloseAdminNumberPort**](docs/NumberPortingApi.md#patchcloseadminnumberport) | **PATCH** /admin/sip/numbers/ports/{id}/close | 
 *NumberPortingApi* | [**postAddAdminNote**](docs/NumberPortingApi.md#postaddadminnote) | **POST** /admin/sip/numbers/ports/{id}/notes | 
 *NumberPortingApi* | [**postCreateNumberPort**](docs/NumberPortingApi.md#postcreatenumberport) | **POST** /sip/numbers/ports | 
@@ -153,34 +152,14 @@ Class | Method | HTTP request | Description
 *OAuth20Api* | [**postAuthorise**](docs/OAuth20Api.md#postauthorise) | **POST** /oauth2/authorise | Get OAuth2.0 Auth Code
 *OAuth20Api* | [**postGetIdentity**](docs/OAuth20Api.md#postgetidentity) | **POST** /oauth2/me | Get Token Identity
 *OAuth20Api* | [**postPortalLogin**](docs/OAuth20Api.md#postportallogin) | **POST** /oauth2/portal/login | Portal Login
-*OrdersApi* | [**deleteDeleteBatch**](docs/OrdersApi.md#deletedeletebatch) | **DELETE** /admin/orders/{id}/batches/{batch_id} | 
 *OrdersApi* | [**deleteUpdateOrder**](docs/OrdersApi.md#deleteupdateorder) | **DELETE** /orders/{id} | Delete Orders (Beta)
-*OrdersApi* | [**deleteUpdateShipment**](docs/OrdersApi.md#deleteupdateshipment) | **DELETE** /admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id} | Delete Shipment (Admin)
 *OrdersApi* | [**getGetAdminEditableOrder**](docs/OrdersApi.md#getgetadmineditableorder) | **GET** /admin/orders/{id}/views/editable | Get Editable Order (Admin)
-*OrdersApi* | [**getGetAdminOrderDetails**](docs/OrdersApi.md#getgetadminorderdetails) | **GET** /admin/orders/{id}/details | Get Order Details (Admin)
 *OrdersApi* | [**getGetEditableOrder**](docs/OrdersApi.md#getgeteditableorder) | **GET** /orders/{id}/views/editable | Get Editable Order (Beta)
-*OrdersApi* | [**getGetItemSerialInfo**](docs/OrdersApi.md#getgetitemserialinfo) | **GET** /admin/orders/{id}/items/{item_id}/info | Get Item Serial Info (Admin)
-*OrdersApi* | [**getGetOrderPdf**](docs/OrdersApi.md#getgetorderpdf) | **GET** /orders/{id}/pdf | Download Order PDF
-*OrdersApi* | [**getGetOrderSummary**](docs/OrdersApi.md#getgetordersummary) | **GET** /admin/orders/{id}/summary | Get Order Summary (Admin)
 *OrdersApi* | [**getGetOrders**](docs/OrdersApi.md#getgetorders) | **GET** /orders | Get Orders (Beta)
-*OrdersApi* | [**patchCompleteOrder**](docs/OrdersApi.md#patchcompleteorder) | **PATCH** /admin/orders/{id}/complete | Mark Order As Complete (Admin)
-*OrdersApi* | [**postAddOrderNote**](docs/OrdersApi.md#postaddordernote) | **POST** /admin/orders/{id}/notes | Add Order Note
 *OrdersApi* | [**postCreateAdminOrder**](docs/OrdersApi.md#postcreateadminorder) | **POST** /admin/orders | Create An Order (Admin)
-*OrdersApi* | [**postCreateConsignment**](docs/OrdersApi.md#postcreateconsignment) | **POST** /admin/orders/{id}/shipments/{shipment_id}/consignment | Create Shipping Consignment
-*OrdersApi* | [**postCreateShipment**](docs/OrdersApi.md#postcreateshipment) | **POST** /admin/orders/{id}/batches/{batch_id}/shipments | Create Shipment (Admin)
 *OrdersApi* | [**postGetOrders**](docs/OrdersApi.md#postgetorders) | **POST** /orders | Create An Order (Beta)
-*OrdersApi* | [**postIssueCredit**](docs/OrdersApi.md#postissuecredit) | **POST** /admin/orders/{id}/credit | Issue Credit (Admin)
-*OrdersApi* | [**postPrintShippingLabel**](docs/OrdersApi.md#postprintshippinglabel) | **POST** /admin/orders/{id}/shipments/{shipment_id}/label/print | Print Shipment Label
-*OrdersApi* | [**postSendOrderEmail**](docs/OrdersApi.md#postsendorderemail) | **POST** /admin/orders/{id}/email/send | Send Order Email
-*OrdersApi* | [**postSendShipmentEmail**](docs/OrdersApi.md#postsendshipmentemail) | **POST** /admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id}/send/email | Send Shipment Email (Admin)
-*OrdersApi* | [**postSendSupplierEmail**](docs/OrdersApi.md#postsendsupplieremail) | **POST** /admin/orders/{id}/batches/{batch_id}/email/send | Send Supplier Email
-*OrdersApi* | [**postSplitOrder**](docs/OrdersApi.md#postsplitorder) | **POST** /admin/orders/{id}/split | Split Order
-*OrdersApi* | [**putAllocateItems**](docs/OrdersApi.md#putallocateitems) | **PUT** /admin/orders/{id}/items/allocate | Allocate Items To Supplier
 *OrdersApi* | [**putUpdateAdminOrder**](docs/OrdersApi.md#putupdateadminorder) | **PUT** /admin/orders/{id} | Update An Order (Admin)
-*OrdersApi* | [**putUpdateBatchItem**](docs/OrdersApi.md#putupdatebatchitem) | **PUT** /admin/orders/{id}/batches/{batch_id}/items/{item_id} | Update Batch Item (Admin)
 *OrdersApi* | [**putUpdateOrder**](docs/OrdersApi.md#putupdateorder) | **PUT** /orders/{id} | Update An Order (Beta)
-*OrdersApi* | [**putUpdatePaymentStatus**](docs/OrdersApi.md#putupdatepaymentstatus) | **PUT** /admin/orders/{id}/paid | Change Payment Status (Admin)
-*OrdersApi* | [**putUpdateShipment**](docs/OrdersApi.md#putupdateshipment) | **PUT** /admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id} | Update Shipment (Admin)
 *PricingApi* | [**getGetPriceList**](docs/PricingApi.md#getgetpricelist) | **GET** /finance/pricing/lists | Get Price List
 *PricingApi* | [**postSendPriceList**](docs/PricingApi.md#postsendpricelist) | **POST** /finance/pricing/lists/send | Send Price List
 *ProductsApi* | [**getGetAttributeSets**](docs/ProductsApi.md#getgetattributesets) | **GET** /products/attributes | Get Attribute Sets
@@ -190,7 +169,6 @@ Class | Method | HTTP request | Description
 *ProductsApi* | [**getGetStockList**](docs/ProductsApi.md#getgetstocklist) | **GET** /products/stock | Get Current Stock & Pricing
 *ProductsApi* | [**getGetTcxTemplates**](docs/ProductsApi.md#getgettcxtemplates) | **GET** /products/attributes/tcx/templates | Get 3CX Templates
 *ProductsApi* | [**getSearchProducts**](docs/ProductsApi.md#getsearchproducts) | **GET** /products/search | Search Products
-*ProductsApi* | [**patchAddQuantityToStock**](docs/ProductsApi.md#patchaddquantitytostock) | **PATCH** /products/{sku}/stock/add | Add Item Quantity To Stock
 *ProductsApi* | [**postGetProduct**](docs/ProductsApi.md#postgetproduct) | **POST** /products/{sku} | Get Product
 *ProductsApi* | [**postGetProductForCustomer**](docs/ProductsApi.md#postgetproductforcustomer) | **POST** /admin/products/{sku} | Get Product For Customer
 *ProvisioningApi* | [**deleteAddFanvilMac**](docs/ProvisioningApi.md#deleteaddfanvilmac) | **DELETE** /provisioning/fanvil/groups/{id}/macs/{mac} | Remove MAC address from DB and FDPS group
@@ -223,7 +201,6 @@ Class | Method | HTTP request | Description
 *SIPTrunksApi* | [**postTrackChange**](docs/SIPTrunksApi.md#posttrackchange) | **POST** /sip/trunks/changes/track | Track SIP Trunk Change Request
 *SIPTrunksApi* | [**putGetAddress**](docs/SIPTrunksApi.md#putgetaddress) | **PUT** /sip/trunks/{id}/address | Update SIP Trunk Address
 *SIPTrunksApi* | [**putGetDiverts**](docs/SIPTrunksApi.md#putgetdiverts) | **PUT** /sip/trunks/{id}/diverts | Update SIP Trunk Diverts
-*SMSApi* | [**postCreateSmsAccount**](docs/SMSApi.md#postcreatesmsaccount) | **POST** /messaging/sms/account | Create SMS Account
 *SMSApi* | [**postSendSms**](docs/SMSApi.md#postsendsms) | **POST** /messaging/sms/send | 
 *ServicesApi* | [**deleteUnsubscribe**](docs/ServicesApi.md#deleteunsubscribe) | **DELETE** /services/events/unsubscribe | 
 *ServicesApi* | [**getGetServiceHealth**](docs/ServicesApi.md#getgetservicehealth) | **GET** /services/health | 
@@ -293,7 +270,6 @@ Class | Method | HTTP request | Description
  - [AuthCodeResponseModel](docs/AuthCodeResponseModel.md)
  - [BasicItemDTO](docs/BasicItemDTO.md)
  - [BasicProductDTO](docs/BasicProductDTO.md)
- - [BatchDTO](docs/BatchDTO.md)
  - [BatchEntity](docs/BatchEntity.md)
  - [CallBarringModel](docs/CallBarringModel.md)
  - [ClientDetailsModel](docs/ClientDetailsModel.md)
@@ -303,12 +279,6 @@ Class | Method | HTTP request | Description
  - [ConversationModel](docs/ConversationModel.md)
  - [CourierPriceEntity](docs/CourierPriceEntity.md)
  - [CreditAccountEntity](docs/CreditAccountEntity.md)
- - [CreditNoteDTO](docs/CreditNoteDTO.md)
- - [CreditNoteEntity](docs/CreditNoteEntity.md)
- - [CreditNoteItemDTO](docs/CreditNoteItemDTO.md)
- - [CreditNoteItemEntity](docs/CreditNoteItemEntity.md)
- - [CreditNoteItemModel](docs/CreditNoteItemModel.md)
- - [CreditNoteModel](docs/CreditNoteModel.md)
  - [CrmContactDTO](docs/CrmContactDTO.md)
  - [CustomerInformationModel](docs/CustomerInformationModel.md)
  - [CustomerItemRequestDTO](docs/CustomerItemRequestDTO.md)
@@ -363,28 +333,21 @@ Class | Method | HTTP request | Description
  - [NumberPortRangeRequestDTO](docs/NumberPortRangeRequestDTO.md)
  - [NumberPortsModel](docs/NumberPortsModel.md)
  - [OfflineInstancesEntity](docs/OfflineInstancesEntity.md)
- - [OrderDetailsDTO](docs/OrderDetailsDTO.md)
  - [OrderEntity](docs/OrderEntity.md)
- - [OrderItemDTO](docs/OrderItemDTO.md)
  - [OrderRequestModel](docs/OrderRequestModel.md)
  - [OrderSummariesModel](docs/OrderSummariesModel.md)
  - [OrderSummaryDTO](docs/OrderSummaryDTO.md)
  - [OrderTotalModel](docs/OrderTotalModel.md)
  - [OrderedItemEntity](docs/OrderedItemEntity.md)
- - [OrderedItemModel](docs/OrderedItemModel.md)
  - [PatchSetTcxWizardCnameRequest](docs/PatchSetTcxWizardCnameRequest.md)
  - [PatchUpdateAccountContactPasswordRequest](docs/PatchUpdateAccountContactPasswordRequest.md)
  - [PortalAccountModel](docs/PortalAccountModel.md)
  - [PortalLoginModel](docs/PortalLoginModel.md)
- - [PostAddAdminNoteRequest](docs/PostAddAdminNoteRequest.md)
- - [PostAddOrderNoteRequest](docs/PostAddOrderNoteRequest.md)
  - [PostAddWebhook200Response](docs/PostAddWebhook200Response.md)
  - [PostGetClientCredentialsRequest](docs/PostGetClientCredentialsRequest.md)
  - [PostGetProductForCustomerRequest](docs/PostGetProductForCustomerRequest.md)
  - [PostGetProductRequest](docs/PostGetProductRequest.md)
- - [PostSplitOrderRequest](docs/PostSplitOrderRequest.md)
  - [PriceListItemModel](docs/PriceListItemModel.md)
- - [PrinterEntity](docs/PrinterEntity.md)
  - [PrizesEntity](docs/PrizesEntity.md)
  - [ProductPriceListItemModel](docs/ProductPriceListItemModel.md)
  - [ProductSearchResultsModel](docs/ProductSearchResultsModel.md)
@@ -394,8 +357,6 @@ Class | Method | HTTP request | Description
  - [PromoItemsEntity](docs/PromoItemsEntity.md)
  - [ProvisioningModel](docs/ProvisioningModel.md)
  - [ProvisioningRequestEntity](docs/ProvisioningRequestEntity.md)
- - [PutAllocateItemsRequest](docs/PutAllocateItemsRequest.md)
- - [PutAllocateItemsRequestItemsInner](docs/PutAllocateItemsRequestItemsInner.md)
  - [RecordingBackupAzureModel](docs/RecordingBackupAzureModel.md)
  - [RecordingsBackupInfoDTO](docs/RecordingsBackupInfoDTO.md)
  - [ResourceNotReadyException](docs/ResourceNotReadyException.md)
@@ -406,16 +367,10 @@ Class | Method | HTTP request | Description
  - [ServiceHealthDTO](docs/ServiceHealthDTO.md)
  - [ServiceStatusDTO](docs/ServiceStatusDTO.md)
  - [ShipmentAddressEntity](docs/ShipmentAddressEntity.md)
- - [ShipmentDTO](docs/ShipmentDTO.md)
  - [ShipmentEntity](docs/ShipmentEntity.md)
- - [ShipmentItemDTO](docs/ShipmentItemDTO.md)
  - [ShipmentItemEntity](docs/ShipmentItemEntity.md)
- - [ShipmentItemModel](docs/ShipmentItemModel.md)
- - [ShipmentModel](docs/ShipmentModel.md)
- - [ShipmentRequestDTO](docs/ShipmentRequestDTO.md)
  - [ShippingConsignmentModel](docs/ShippingConsignmentModel.md)
  - [ShippingInformationDTO](docs/ShippingInformationDTO.md)
- - [ShippingRequestDTO](docs/ShippingRequestDTO.md)
  - [ShippingServiceDTO](docs/ShippingServiceDTO.md)
  - [ShippingServiceModel](docs/ShippingServiceModel.md)
  - [ShippingServicesModel](docs/ShippingServicesModel.md)
@@ -423,9 +378,7 @@ Class | Method | HTTP request | Description
  - [SipTrunkCreationRequestModel](docs/SipTrunkCreationRequestModel.md)
  - [SipTrunkEntity](docs/SipTrunkEntity.md)
  - [SipTrunksResponseModel](docs/SipTrunksResponseModel.md)
- - [SmsAccountDTO](docs/SmsAccountDTO.md)
  - [SmsAccountEntity](docs/SmsAccountEntity.md)
- - [SmsAccountRequestDTO](docs/SmsAccountRequestDTO.md)
  - [SmsDataModel](docs/SmsDataModel.md)
  - [SmsMessageModel](docs/SmsMessageModel.md)
  - [SmsNumbersEntity](docs/SmsNumbersEntity.md)
@@ -454,8 +407,6 @@ Class | Method | HTTP request | Description
  - [StockTransactionsEntity](docs/StockTransactionsEntity.md)
  - [SupplierEntity](docs/SupplierEntity.md)
  - [SupplierItemEntity](docs/SupplierItemEntity.md)
- - [SupplierItemModel](docs/SupplierItemModel.md)
- - [SupplierModel](docs/SupplierModel.md)
  - [SupportTicketModel](docs/SupportTicketModel.md)
  - [TcxBackupEntity](docs/TcxBackupEntity.md)
  - [TcxBackupModel](docs/TcxBackupModel.md)
@@ -527,8 +478,6 @@ Authentication schemes defined for the API:
  - **products.read**: Products (Read)
  - **provisioning.read**: Provisioning (Read)
  - **provisioning.write**: Provisioning (Write)
- - **sms.read**: Sms (Read)
- - **sms.write**: Sms (Write)
  - **trunks.read**: Trunks (Read)
  - **trunks.write**: Trunks (Write)
  - **tcx_integrations.read**: 3CX Integrations (Read)