yellowgrid-api-ts 3.2.60-dev.0 → 3.2.61-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://localhost*
+All URIs are relative to *https://api.yellowgrid.local*
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
@@ -127,7 +127,6 @@ Class | Method | HTTP request | Description
 *Class3CXIntegrationsApi* | [**postOrderEdTechPro**](docs/Class3CXIntegrationsApi.md#postorderedtechpro) | **POST** /tcx/integrations/edtechpro/orders | 
 *Class3CXIntegrationsApi* | [**postUpgradeEdTechPro**](docs/Class3CXIntegrationsApi.md#postupgradeedtechpro) | **POST** /tcx/integrations/edtechpro/upgrades | 
 *Class3CXMultiTenantApi* | [**deleteGetTenant**](docs/Class3CXMultiTenantApi.md#deletegettenant) | **DELETE** /tcx/mt/tenants/{reference} | Delete 3CX MT Tenant
-*Class3CXMultiTenantApi* | [**getGetAdminTenants**](docs/Class3CXMultiTenantApi.md#getgetadmintenants) | **GET** /tcx/mt/admin/tenants | Get 3CX MT Tenants
 *Class3CXMultiTenantApi* | [**getGetTenant**](docs/Class3CXMultiTenantApi.md#getgettenant) | **GET** /tcx/mt/tenants/{reference} | Get 3CX MT Tenant
 *Class3CXMultiTenantApi* | [**getGetTenants**](docs/Class3CXMultiTenantApi.md#getgettenants) | **GET** /tcx/mt/tenants | Get 3CX MT Tenants
 *Class3CXMultiTenantApi* | [**postAddMtDdi**](docs/Class3CXMultiTenantApi.md#postaddmtddi) | **POST** /tcx/mt/ddis | Add 3CX MT DDI
@@ -135,28 +134,32 @@ Class | Method | HTTP request | Description
 *Class3CXMultiTenantApi* | [**postGetTenants**](docs/Class3CXMultiTenantApi.md#postgettenants) | **POST** /tcx/mt/tenants | Add 3CX MT Tenant
 *Class3CXMultiTenantApi* | [**postTrackMtChange**](docs/Class3CXMultiTenantApi.md#posttrackmtchange) | **POST** /tcx/mt/changes/track | Track 3CX MT Change
 *MyPBXToolsApi* | [**getGetRecording**](docs/MyPBXToolsApi.md#getgetrecording) | **GET** /mypbxtools/recordings | Fetch recording from a 3CX instance
-*NumberPortingApi* | [**deleteGetAdminNumberPort**](docs/NumberPortingApi.md#deletegetadminnumberport) | **DELETE** /admin/sip/numbers/ports/{id} | 
-*NumberPortingApi* | [**getCreateNumberPort**](docs/NumberPortingApi.md#getcreatenumberport) | **GET** /sip/numbers/ports | 
-*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* | [**patchCloseAdminNumberPort**](docs/NumberPortingApi.md#patchcloseadminnumberport) | **PATCH** /admin/sip/numbers/ports/{id}/close | 
-*NumberPortingApi* | [**postCreateNumberPort**](docs/NumberPortingApi.md#postcreatenumberport) | **POST** /sip/numbers/ports | 
-*NumberPortingApi* | [**postSubmitNumberPort**](docs/NumberPortingApi.md#postsubmitnumberport) | **POST** /sip/numbers/ports/{id}/submit | 
-*NumberPortingApi* | [**postUpdateNumberPort**](docs/NumberPortingApi.md#postupdatenumberport) | **POST** /sip/numbers/ports/{id} | 
-*NumberPortingApi* | [**putGetAdminNumberPort**](docs/NumberPortingApi.md#putgetadminnumberport) | **PUT** /admin/sip/numbers/ports/{id} | 
 *OAuth20Api* | [**getGetMfaQrCode**](docs/OAuth20Api.md#getgetmfaqrcode) | **GET** /oauth2/qr/code | Get MFA QR Code
 *OAuth20Api* | [**getGetScopes**](docs/OAuth20Api.md#getgetscopes) | **GET** /oauth2/scopes | Get Scopes
 *OAuth20Api* | [**postAccessToken**](docs/OAuth20Api.md#postaccesstoken) | **POST** /oauth2/access_token | Validates client credentials and returns access token
 *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* | [**deleteCreateShipment**](docs/OrdersApi.md#deletecreateshipment) | **DELETE** /admin/orders/{id}/batches/{batch_id}/shipments | Delete Shipment (Admin)
+*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* | [**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* | [**getGetOrderPdf**](docs/OrdersApi.md#getgetorderpdf) | **GET** /orders/{id}/pdf | Download Order PDF
 *OrdersApi* | [**getGetOrders**](docs/OrdersApi.md#getgetorders) | **GET** /orders | Get Orders (Beta)
+*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* | [**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* | [**putCreateShipment**](docs/OrdersApi.md#putcreateshipment) | **PUT** /admin/orders/{id}/batches/{batch_id}/shipments | Update Shipment (Admin)
 *OrdersApi* | [**putUpdateAdminOrder**](docs/OrdersApi.md#putupdateadminorder) | **PUT** /admin/orders/{id} | Update An Order (Admin)
 *OrdersApi* | [**putUpdateOrder**](docs/OrdersApi.md#putupdateorder) | **PUT** /orders/{id} | Update An Order (Beta)
 *PricingApi* | [**getGetPriceList**](docs/PricingApi.md#getgetpricelist) | **GET** /finance/pricing/lists | Get Price List
@@ -180,7 +183,6 @@ Class | Method | HTTP request | Description
 *SIPTrunksApi* | [**deleteGetSipTrunk**](docs/SIPTrunksApi.md#deletegetsiptrunk) | **DELETE** /sip/trunks/{id} | Delete SIP Trunk
 *SIPTrunksApi* | [**getCanDivert**](docs/SIPTrunksApi.md#getcandivert) | **GET** /sip/trunks/{id}/diverts/allowed | SIP Trunk Diverts Allowed
 *SIPTrunksApi* | [**getGetAddress**](docs/SIPTrunksApi.md#getgetaddress) | **GET** /sip/trunks/{id}/address | Get SIP Trunk Address
-*SIPTrunksApi* | [**getGetAdminSipTrunks**](docs/SIPTrunksApi.md#getgetadminsiptrunks) | **GET** /sip/trunks/admin | 
 *SIPTrunksApi* | [**getGetAreaCodes**](docs/SIPTrunksApi.md#getgetareacodes) | **GET** /sip/trunks/area/codes | Get UK National Area Codes
 *SIPTrunksApi* | [**getGetCliFlexibility**](docs/SIPTrunksApi.md#getgetcliflexibility) | **GET** /sip/trunks/{id}/cli/flexibility | Get SIP Trunk CLI Flexibility Status
 *SIPTrunksApi* | [**getGetDdis**](docs/SIPTrunksApi.md#getgetddis) | **GET** /sip/trunks/{id}/ddis | Get SIP Trunk DDIs
@@ -268,6 +270,7 @@ 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)
@@ -277,6 +280,11 @@ 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)
+ - [CreditNoteModel](docs/CreditNoteModel.md)
  - [CrmContactDTO](docs/CrmContactDTO.md)
  - [CustomerInformationModel](docs/CustomerInformationModel.md)
  - [CustomerItemRequestDTO](docs/CustomerItemRequestDTO.md)
@@ -325,27 +333,28 @@ Class | Method | HTTP request | Description
  - [MonthlyUsageModel](docs/MonthlyUsageModel.md)
  - [MultiTenantChangeResponseModel](docs/MultiTenantChangeResponseModel.md)
  - [NavigationModel](docs/NavigationModel.md)
- - [NumberPortDTO](docs/NumberPortDTO.md)
- - [NumberPortModel](docs/NumberPortModel.md)
- - [NumberPortRangeDTO](docs/NumberPortRangeDTO.md)
- - [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)
+ - [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)
@@ -355,6 +364,8 @@ 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)
@@ -365,10 +376,16 @@ 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)
@@ -405,7 +422,7 @@ Class | Method | HTTP request | Description
  - [StockTransactionsEntity](docs/StockTransactionsEntity.md)
  - [SupplierEntity](docs/SupplierEntity.md)
  - [SupplierItemEntity](docs/SupplierItemEntity.md)
- - [SupportTicketModel](docs/SupportTicketModel.md)
+ - [SupplierModel](docs/SupplierModel.md)
  - [TcxBackupEntity](docs/TcxBackupEntity.md)
  - [TcxBackupModel](docs/TcxBackupModel.md)
  - [TcxBillingEntity](docs/TcxBillingEntity.md)
@@ -440,6 +457,7 @@ Class | Method | HTTP request | Description
  - [TcxWizardConfigModel](docs/TcxWizardConfigModel.md)
  - [TcxWizardModel](docs/TcxWizardModel.md)
  - [TechSupportCompanySummaryDTO](docs/TechSupportCompanySummaryDTO.md)
+ - [TelephonySupportTicketModel](docs/TelephonySupportTicketModel.md)
  - [TicketSummaryModel](docs/TicketSummaryModel.md)
  - [TicketTimeDTO](docs/TicketTimeDTO.md)
  - [TokenResponseModel](docs/TokenResponseModel.md)
@@ -468,8 +486,6 @@ Authentication schemes defined for the API:
  - **tcx_wizard**: 3CX Installation Wizard
  - **accounts.read**: Accounts (Read)
  - **accounts.write**: Accounts (Write)
- - **number_porting.read**: Number Porting (Read)
- - **number_porting.write**: Number Porting (Write)
  - **pricing.read**: Pricing (Read)
  - **orders.read**: Orders (Read)
  - **orders.write**: Orders (Write)