yellowgrid-api-ts 3.2.217 → 3.2.218-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://bitbucket.org*
+All URIs are relative to *https://api.local.yellowgrid.co.uk*
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
@@ -64,8 +64,10 @@ Class | Method | HTTP request | Description
 *AccountsApi* | [**getGetClientCredentials**](docs/AccountsApi.md#getgetclientcredentials) | **GET** /accounts/me/contacts/credentials | Get user\'s client credentials
 *AccountsApi* | [**getGetCustomerAccountsList**](docs/AccountsApi.md#getgetcustomeraccountslist) | **GET** /admin/accounts/customers/list | 
 *AccountsApi* | [**getGetCustomerKeys**](docs/AccountsApi.md#getgetcustomerkeys) | **GET** /accounts/me/tcx/keys | Get 3CX Keys
+*AccountsApi* | [**getGetCustomerMap**](docs/AccountsApi.md#getgetcustomermap) | **GET** /admin/accounts/customer/map | 
 *AccountsApi* | [**getGetFinanceSettings**](docs/AccountsApi.md#getgetfinancesettings) | **GET** /admin/accounts/{id}/finance | 
 *AccountsApi* | [**getGetLastAccount**](docs/AccountsApi.md#getgetlastaccount) | **GET** /admin/accounts/last | Get Last Account
+*AccountsApi* | [**getGetNewPriceList**](docs/AccountsApi.md#getgetnewpricelist) | **GET** /admin/accounts/priceList/new | Download New Price List
 *AccountsApi* | [**getGetTcxPartnerDetails**](docs/AccountsApi.md#getgettcxpartnerdetails) | **GET** /admin/accounts/{id}/tcx/partner | 
 *AccountsApi* | [**getVerifyEmailAddress**](docs/AccountsApi.md#getverifyemailaddress) | **GET** /accounts/contacts/verify | Verify account email address
 *AccountsApi* | [**patchSetAccountStatus**](docs/AccountsApi.md#patchsetaccountstatus) | **PATCH** /admin/accounts/{id}/status/{state} | 
@@ -176,6 +178,7 @@ Class | Method | HTTP request | Description
 *Class3CXMultiTenantApi* | [**postGetMtNewDdis**](docs/Class3CXMultiTenantApi.md#postgetmtnewddis) | **POST** /tcx/mt/changes/ddis | Get 3CX MT New DDIs
 *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
+*MiscApi* | [**postSendPassword**](docs/MiscApi.md#postsendpassword) | **POST** /admin/password/send | 
 *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 | 
@@ -253,6 +256,34 @@ Class | Method | HTTP request | Description
 *ProvisioningApi* | [**postAddFanvilGroup**](docs/ProvisioningApi.md#postaddfanvilgroup) | **POST** /provisioning/fanvil/groups | Add group to DB and FDPS
 *ProvisioningApi* | [**postAddFanvilMac**](docs/ProvisioningApi.md#postaddfanvilmac) | **POST** /provisioning/fanvil/groups/{id}/macs/{mac} | Add MAC address to DB and FDPS group
 *ProvisioningApi* | [**postCreateMac**](docs/ProvisioningApi.md#postcreatemac) | **POST** /admin/provisioning/fanvil/macs | 
+*RMAApi* | [**deleteDeleteRmaItem**](docs/RMAApi.md#deletedeletermaitem) | **DELETE** /admin/rma/{id}/items/{item_id} | 
+*RMAApi* | [**deleteGetAdminRma**](docs/RMAApi.md#deletegetadminrma) | **DELETE** /admin/rma/{id} | 
+*RMAApi* | [**getCreateRma**](docs/RMAApi.md#getcreaterma) | **GET** /rma | 
+*RMAApi* | [**getGetAdminRma**](docs/RMAApi.md#getgetadminrma) | **GET** /admin/rma/{id} | 
+*RMAApi* | [**getGetAdminRmas**](docs/RMAApi.md#getgetadminrmas) | **GET** /admin/rma | 
+*RMAApi* | [**getGetRma**](docs/RMAApi.md#getgetrma) | **GET** /rma/{id} | 
+*RMAApi* | [**patchApproveRma**](docs/RMAApi.md#patchapproverma) | **PATCH** /admin/rma/{id}/approve | 
+*RMAApi* | [**patchMarkRmaItemAsBinned**](docs/RMAApi.md#patchmarkrmaitemasbinned) | **PATCH** /admin/rma/{id}/items/{item_id}/bin | 
+*RMAApi* | [**patchMarkRmaItemAsReceived**](docs/RMAApi.md#patchmarkrmaitemasreceived) | **PATCH** /admin/rma/{id}/items/{item_id}/received | 
+*RMAApi* | [**patchMarkRmaItemAsUnresolved**](docs/RMAApi.md#patchmarkrmaitemasunresolved) | **PATCH** /admin/rma/{id}/items/{item_id}/unresolved | 
+*RMAApi* | [**patchRejectRma**](docs/RMAApi.md#patchrejectrma) | **PATCH** /admin/rma/{id}/reject | 
+*RMAApi* | [**patchResolveRma**](docs/RMAApi.md#patchresolverma) | **PATCH** /admin/rma/{id}/resolve | 
+*RMAApi* | [**patchUpdateRmaContactEmail**](docs/RMAApi.md#patchupdatermacontactemail) | **PATCH** /admin/rma/{id}/contactEmail | 
+*RMAApi* | [**patchUpdateRmaContactName**](docs/RMAApi.md#patchupdatermacontactname) | **PATCH** /admin/rma/{id}/contactName | 
+*RMAApi* | [**patchUpdateRmaItemMacAddress**](docs/RMAApi.md#patchupdatermaitemmacaddress) | **PATCH** /admin/rma/{id}/items/{item_id}/mac | 
+*RMAApi* | [**patchUpdateRmaItemNote**](docs/RMAApi.md#patchupdatermaitemnote) | **PATCH** /admin/rma/{id}/items/{item_id}/note | 
+*RMAApi* | [**patchUpdateRmaItemSerialNumber**](docs/RMAApi.md#patchupdatermaitemserialnumber) | **PATCH** /admin/rma/{id}/items/{item_id}/serial | 
+*RMAApi* | [**patchUpdateRmaReason**](docs/RMAApi.md#patchupdatermareason) | **PATCH** /admin/rma/{id}/reason | 
+*RMAApi* | [**patchUpdateRmaResolution**](docs/RMAApi.md#patchupdatermaresolution) | **PATCH** /admin/rma/{id}/resolution | 
+*RMAApi* | [**patchUpdateRmaReturnAddress**](docs/RMAApi.md#patchupdatermareturnaddress) | **PATCH** /admin/rma/{id}/address | 
+*RMAApi* | [**postCreateReplacementOrder**](docs/RMAApi.md#postcreatereplacementorder) | **POST** /admin/rma/{id}/replacement_order | 
+*RMAApi* | [**postCreateRma**](docs/RMAApi.md#postcreaterma) | **POST** /rma | 
+*RMAApi* | [**postCreateRmaCollection**](docs/RMAApi.md#postcreatermacollection) | **POST** /admin/rma/{id}/collection | 
+*RMAApi* | [**postCreateRmaCreditNote**](docs/RMAApi.md#postcreatermacreditnote) | **POST** /admin/rma/{id}/credit | 
+*RMAApi* | [**postCreateRmaNote**](docs/RMAApi.md#postcreatermanote) | **POST** /admin/rma/{id}/notes | 
+*RMAApi* | [**postCreateRmaReturn**](docs/RMAApi.md#postcreatermareturn) | **POST** /admin/rma/{id}/return | 
+*ReportsApi* | [**getGetStockReport**](docs/ReportsApi.md#getgetstockreport) | **GET** /reports/stock | 
+*ReportsApi* | [**postGenerateReport**](docs/ReportsApi.md#postgeneratereport) | **POST** /reports | Generate Reports
 *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
@@ -311,6 +342,10 @@ Class | Method | HTTP request | Description
 *StockManagementApi* | [**postUploadStockOrderInvoice**](docs/StockManagementApi.md#postuploadstockorderinvoice) | **POST** /stock/orders/{id}/invoice | Upload Stock Order Supplier Invoice
 *StockManagementApi* | [**putGetStockProduct**](docs/StockManagementApi.md#putgetstockproduct) | **PUT** /stock/products/{id} | Update Stock Product
 *StockManagementApi* | [**putReceiveStockOrderItem**](docs/StockManagementApi.md#putreceivestockorderitem) | **PUT** /stock/orders/{order_id}/items/{item_id}/receive | Receive Stock Order Item
+*SuppliersApi* | [**getGetSupplierItem**](docs/SuppliersApi.md#getgetsupplieritem) | **GET** /suppliers/items/{id} | Get Supplier Item
+*SuppliersApi* | [**getGetSupplierItems**](docs/SuppliersApi.md#getgetsupplieritems) | **GET** /suppliers/items | Get Supplier Items
+*SuppliersApi* | [**getGetSuppliers**](docs/SuppliersApi.md#getgetsuppliers) | **GET** /suppliers | Get Suppliers
+*SuppliersApi* | [**putGetSupplierItem**](docs/SuppliersApi.md#putgetsupplieritem) | **PUT** /suppliers/items/{id} | Update Supplier Product
 *SystemApi* | [**getLogSearch**](docs/SystemApi.md#getlogsearch) | **GET** /system/logs/api/search | Search for logs
 *TicketsApi* | [**getCreateTicket**](docs/TicketsApi.md#getcreateticket) | **GET** /tickets/support | 
 *TicketsApi* | [**getGetTicket**](docs/TicketsApi.md#getgetticket) | **GET** /tickets/support/{id} | 
@@ -336,8 +371,13 @@ Class | Method | HTTP request | Description
  - [AddressDTO](docs/AddressDTO.md)
  - [AddressModel](docs/AddressModel.md)
  - [AddressRequestModel](docs/AddressRequestModel.md)
+ - [AdminCustomerRmasModel](docs/AdminCustomerRmasModel.md)
  - [AdminNumberPortDTO](docs/AdminNumberPortDTO.md)
  - [AdminOrderRequestDTO](docs/AdminOrderRequestDTO.md)
+ - [AdminRmaDTO](docs/AdminRmaDTO.md)
+ - [AdminRmaItemDTO](docs/AdminRmaItemDTO.md)
+ - [AdminRmaNoteDTO](docs/AdminRmaNoteDTO.md)
+ - [AdminRmaSummaryDTO](docs/AdminRmaSummaryDTO.md)
  - [AdminUserModel](docs/AdminUserModel.md)
  - [AgentHoursGraphModel](docs/AgentHoursGraphModel.md)
  - [AgentHoursGraphMonthModel](docs/AgentHoursGraphMonthModel.md)
@@ -347,6 +387,7 @@ Class | Method | HTTP request | Description
  - [AttributeSetEnum](docs/AttributeSetEnum.md)
  - [AuditLogEntity](docs/AuditLogEntity.md)
  - [AuthCodeResponseModel](docs/AuthCodeResponseModel.md)
+ - [AxisDataDTO](docs/AxisDataDTO.md)
  - [BasicItemDTO](docs/BasicItemDTO.md)
  - [BasicProductDTO](docs/BasicProductDTO.md)
  - [BatchDTO](docs/BatchDTO.md)
@@ -373,11 +414,13 @@ Class | Method | HTTP request | Description
  - [CrmDateActivitiesDTO](docs/CrmDateActivitiesDTO.md)
  - [CrmNoteEntity](docs/CrmNoteEntity.md)
  - [CrmNoteModel](docs/CrmNoteModel.md)
+ - [CustomerCoordinatesDTO](docs/CustomerCoordinatesDTO.md)
  - [CustomerInformationModel](docs/CustomerInformationModel.md)
  - [CustomerItemRequestDTO](docs/CustomerItemRequestDTO.md)
  - [CustomerListAccountDTO](docs/CustomerListAccountDTO.md)
  - [CustomerOrderRequestDTO](docs/CustomerOrderRequestDTO.md)
  - [CustomerPriceListEnum](docs/CustomerPriceListEnum.md)
+ - [CustomerRmasModel](docs/CustomerRmasModel.md)
  - [CustomerSummaryReportDTO](docs/CustomerSummaryReportDTO.md)
  - [DdiRangeRequestModel](docs/DdiRangeRequestModel.md)
  - [DdiRangesRequestModel](docs/DdiRangesRequestModel.md)
@@ -389,6 +432,7 @@ Class | Method | HTTP request | Description
  - [EdTechProSchoolModel](docs/EdTechProSchoolModel.md)
  - [EdTechProSchoolsModel](docs/EdTechProSchoolsModel.md)
  - [EdTechProSetupModel](docs/EdTechProSetupModel.md)
+ - [EmailRequestModel](docs/EmailRequestModel.md)
  - [EventDTO](docs/EventDTO.md)
  - [EventRequestDTO](docs/EventRequestDTO.md)
  - [EventSubscriptionModel](docs/EventSubscriptionModel.md)
@@ -404,6 +448,7 @@ Class | Method | HTTP request | Description
  - [GetCheckMacExists200Response](docs/GetCheckMacExists200Response.md)
  - [GetGetPrice200Response](docs/GetGetPrice200Response.md)
  - [GetGetRecording200Response](docs/GetGetRecording200Response.md)
+ - [GraphDTO](docs/GraphDTO.md)
  - [HostingChangeResponseModel](docs/HostingChangeResponseModel.md)
  - [HostingRegionDTO](docs/HostingRegionDTO.md)
  - [InstallationDetailsDTO](docs/InstallationDetailsDTO.md)
@@ -419,12 +464,16 @@ Class | Method | HTTP request | Description
  - [ItemDTO](docs/ItemDTO.md)
  - [ItemDiscountEntity](docs/ItemDiscountEntity.md)
  - [ItemEntity](docs/ItemEntity.md)
+ - [ItemResolutionRequestModel](docs/ItemResolutionRequestModel.md)
  - [LinkedOrderEntity](docs/LinkedOrderEntity.md)
  - [MFARequiredModel](docs/MFARequiredModel.md)
  - [MacAddressDTO](docs/MacAddressDTO.md)
+ - [MacAddressRequestModel](docs/MacAddressRequestModel.md)
  - [MonthlyUsageModel](docs/MonthlyUsageModel.md)
  - [MultiTenantChangeResponseModel](docs/MultiTenantChangeResponseModel.md)
+ - [NameRequestModel](docs/NameRequestModel.md)
  - [NavigationModel](docs/NavigationModel.md)
+ - [NoteRequestModel](docs/NoteRequestModel.md)
  - [NumberPortAdminNoteBody](docs/NumberPortAdminNoteBody.md)
  - [NumberPortDTO](docs/NumberPortDTO.md)
  - [NumberPortNoteDTO](docs/NumberPortNoteDTO.md)
@@ -445,6 +494,8 @@ Class | Method | HTTP request | Description
  - [OrderedItemEntity](docs/OrderedItemEntity.md)
  - [OrderedItemModel](docs/OrderedItemModel.md)
  - [PartnerDTO](docs/PartnerDTO.md)
+ - [PasswordSenderDTO](docs/PasswordSenderDTO.md)
+ - [PasswordSenderEntity](docs/PasswordSenderEntity.md)
  - [PatchUpdateAccountCnameRequest](docs/PatchUpdateAccountCnameRequest.md)
  - [PatchUpdateAccountCompanyNumberRequest](docs/PatchUpdateAccountCompanyNumberRequest.md)
  - [PatchUpdateAccountContactPasswordRequest](docs/PatchUpdateAccountContactPasswordRequest.md)
@@ -460,6 +511,7 @@ Class | Method | HTTP request | Description
  - [PortalLoginModel](docs/PortalLoginModel.md)
  - [PostAddOrderNoteRequest](docs/PostAddOrderNoteRequest.md)
  - [PostAddWebhook200Response](docs/PostAddWebhook200Response.md)
+ - [PostGenerateReport200Response](docs/PostGenerateReport200Response.md)
  - [PostGetClientCredentialsRequest](docs/PostGetClientCredentialsRequest.md)
  - [PostGetProductForCustomerRequest](docs/PostGetProductForCustomerRequest.md)
  - [PostSendWelcomeEmailRequest](docs/PostSendWelcomeEmailRequest.md)
@@ -481,15 +533,31 @@ Class | Method | HTTP request | Description
  - [PutAllocateItemsRequest](docs/PutAllocateItemsRequest.md)
  - [PutAllocateItemsRequestItemsInner](docs/PutAllocateItemsRequestItemsInner.md)
  - [PutTransferConnectionRequest](docs/PutTransferConnectionRequest.md)
+ - [ReasonRequestModel](docs/ReasonRequestModel.md)
  - [RecordingBackupAzureModel](docs/RecordingBackupAzureModel.md)
  - [RecordingsBackupInfoDTO](docs/RecordingsBackupInfoDTO.md)
  - [RemoteStorageDTO](docs/RemoteStorageDTO.md)
+ - [ReportRequestDTO](docs/ReportRequestDTO.md)
+ - [ResolutionRequestModel](docs/ResolutionRequestModel.md)
  - [ResourceNotReadyException](docs/ResourceNotReadyException.md)
+ - [RmaCollectionDTO](docs/RmaCollectionDTO.md)
+ - [RmaCreditItemRequestDTO](docs/RmaCreditItemRequestDTO.md)
+ - [RmaDTO](docs/RmaDTO.md)
+ - [RmaItemDTO](docs/RmaItemDTO.md)
+ - [RmaItemRequestDTO](docs/RmaItemRequestDTO.md)
+ - [RmaReplacementOrderItemDTO](docs/RmaReplacementOrderItemDTO.md)
+ - [RmaReplacementOrderRequestDTO](docs/RmaReplacementOrderRequestDTO.md)
+ - [RmaRequestDTO](docs/RmaRequestDTO.md)
+ - [RmaReturnDTO](docs/RmaReturnDTO.md)
+ - [RmaSummaryDTO](docs/RmaSummaryDTO.md)
+ - [RmaSummaryItemDTO](docs/RmaSummaryItemDTO.md)
  - [RootAccessModel](docs/RootAccessModel.md)
  - [S3BucketEntity](docs/S3BucketEntity.md)
  - [SbcDTO](docs/SbcDTO.md)
  - [ScannedItemModel](docs/ScannedItemModel.md)
  - [ScopeModel](docs/ScopeModel.md)
+ - [SerialNumberRequestModel](docs/SerialNumberRequestModel.md)
+ - [SeriesDTO](docs/SeriesDTO.md)
  - [ServiceHealthDTO](docs/ServiceHealthDTO.md)
  - [ServiceStatusDTO](docs/ServiceStatusDTO.md)
  - [ShipmentAddressEntity](docs/ShipmentAddressEntity.md)
@@ -539,13 +607,21 @@ Class | Method | HTTP request | Description
  - [StockProductPriceModel](docs/StockProductPriceModel.md)
  - [StockProductSummariesModel](docs/StockProductSummariesModel.md)
  - [StockProductSummaryModel](docs/StockProductSummaryModel.md)
+ - [StockReportItemModel](docs/StockReportItemModel.md)
+ - [StockReportModel](docs/StockReportModel.md)
  - [StockTransactionsEntity](docs/StockTransactionsEntity.md)
  - [SupplierEntity](docs/SupplierEntity.md)
  - [SupplierItemEntity](docs/SupplierItemEntity.md)
  - [SupplierItemModel](docs/SupplierItemModel.md)
+ - [SupplierItemsResultsDTO](docs/SupplierItemsResultsDTO.md)
  - [SupplierModel](docs/SupplierModel.md)
+ - [SupplierProductModel](docs/SupplierProductModel.md)
+ - [SupplierProductResultsModel](docs/SupplierProductResultsModel.md)
  - [SupportTicketModel](docs/SupportTicketModel.md)
+ - [TableDTO](docs/TableDTO.md)
+ - [TableDataDTO](docs/TableDataDTO.md)
  - [TableHistoryEntity](docs/TableHistoryEntity.md)
+ - [TableRowDTO](docs/TableRowDTO.md)
  - [TcxBackupEntity](docs/TcxBackupEntity.md)
  - [TcxBackupModel](docs/TcxBackupModel.md)
  - [TcxBillingEntity](docs/TcxBillingEntity.md)
@@ -615,6 +691,8 @@ Authentication schemes defined for the API:
  - **products.read**: Products (Read)
  - **provisioning.read**: Provisioning (Read)
  - **provisioning.write**: Provisioning (Write)
+ - **rma.read**: Rma (Read)
+ - **rma.write**: Rma (Write)
  - **sms.read**: Sms (Read)
  - **sms.write**: Sms (Write)
  - **trunks.read**: Trunks (Read)