yellowgrid-api-ts 3.2.144-dev.0 → 3.2.145-dev.0

package/.openapi-generator/FILES

@@ -10,10 +10,13 @@ docs/AccountContactEntity.md
 docs/AccountContactModel.md
 docs/AccountContactRequestModel.md
 docs/AccountDetailedSummaryDTO.md
+docs/AccountFinanceDTO.md
+docs/AccountPageDetailsDTO.md
 docs/AccountRequestModel.md
 docs/AccountSummaryDTO.md
 docs/AccountsApi.md
 docs/AccountsResponseModel.md
+docs/AddressDTO.md
 docs/AddressModel.md
 docs/AddressRequestModel.md
 docs/AdminNumberPortDTO.md
@@ -44,6 +47,7 @@ docs/CompanyContractModel.md
 docs/ContactInfoModel.md
 docs/ConversationModel.md
 docs/CourierPriceEntity.md
+docs/CreateCrmNoteBody.md
 docs/CreditAccountEntity.md
 docs/CreditNoteDTO.md
 docs/CreditNoteEntity.md
@@ -51,7 +55,12 @@ docs/CreditNoteItemDTO.md
 docs/CreditNoteItemEntity.md
 docs/CreditNoteItemModel.md
 docs/CreditNoteModel.md
+docs/CrmActivitiesResponseDTO.md
+docs/CrmActivityDTO.md
 docs/CrmContactDTO.md
+docs/CrmDateActivitiesDTO.md
+docs/CrmNoteEntity.md
+docs/CrmNoteModel.md
 docs/CustomerInformationModel.md
 docs/CustomerItemRequestDTO.md
 docs/CustomerOrderRequestDTO.md
@@ -101,6 +110,7 @@ docs/MonthlyUsageModel.md
 docs/MultiTenantChangeResponseModel.md
 docs/MyPBXToolsApi.md
 docs/NavigationModel.md
+docs/NumberPortAdminNoteBody.md
 docs/NumberPortDTO.md
 docs/NumberPortNoteDTO.md
 docs/NumberPortRangeDTO.md
@@ -109,27 +119,34 @@ docs/NumberPortingApi.md
 docs/NumberPortsModel.md
 docs/OAuth20Api.md
 docs/OfflineInstancesEntity.md
-docs/OrderDTO.md
 docs/OrderDetailsDTO.md
 docs/OrderEntity.md
 docs/OrderItemDTO.md
 docs/OrderRequestModel.md
-docs/OrderResponseDTO.md
 docs/OrderSummariesModel.md
 docs/OrderSummaryDTO.md
 docs/OrderTotalModel.md
 docs/OrderedItemEntity.md
 docs/OrderedItemModel.md
 docs/OrdersApi.md
-docs/PatchSetTcxWizardCnameRequest.md
+docs/PartnerDTO.md
+docs/PatchUpdateAccountCnameRequest.md
+docs/PatchUpdateAccountCompanyNumberRequest.md
 docs/PatchUpdateAccountContactPasswordRequest.md
+docs/PatchUpdateAccountPhoneRequest.md
+docs/PatchUpdateAccountVatNumberRequest.md
+docs/PatchUpdateCreditLimitRequest.md
+docs/PatchUpdatePriceListRequest.md
+docs/PatchUpdateSipChannelCostRequest.md
+docs/PatchUpdateTcxHostingPriceListRequest.md
+docs/PatchUpdateTcxPartnerIdRequest.md
 docs/PortalAccountModel.md
 docs/PortalLoginModel.md
-docs/PostAddAdminNoteRequest.md
 docs/PostAddOrderNoteRequest.md
 docs/PostAddWebhook200Response.md
 docs/PostGetClientCredentialsRequest.md
 docs/PostGetProductForCustomerRequest.md
+docs/PostSendWelcomeEmailRequest.md
 docs/PostSplitOrderRequest.md
 docs/PriceListItemModel.md
 docs/PricingApi.md
@@ -158,7 +175,6 @@ docs/RootAccessModel.md
 docs/S3BucketEntity.md
 docs/SIPTrunksApi.md
 docs/SMSApi.md
-docs/SbcDTO.md
 docs/ScannedItemModel.md
 docs/ScopeModel.md
 docs/ServiceHealthDTO.md
@@ -172,7 +188,6 @@ docs/ShipmentItemEntity.md
 docs/ShipmentItemModel.md
 docs/ShipmentModel.md
 docs/ShipmentRequestDTO.md
-docs/ShippingAddressDTO.md
 docs/ShippingApi.md
 docs/ShippingConsignmentModel.md
 docs/ShippingInformationDTO.md

package/.openapi-generator/VERSION

@@ -1 +1 @@
-7.14.0
+7.20.0

package/README.md

@@ -47,30 +47,54 @@ 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
 ------------ | ------------- | ------------- | -------------
+*AccountsApi* | [**deleteAdminUpdateAccountContact**](docs/AccountsApi.md#deleteadminupdateaccountcontact) | **DELETE** /admin/accounts/{id}/contacts/{contact_id} | 
+*AccountsApi* | [**deleteArchiveAccount**](docs/AccountsApi.md#deletearchiveaccount) | **DELETE** /admin/accounts/{id}/archive | 
 *AccountsApi* | [**deleteDeleteClientCredentials**](docs/AccountsApi.md#deletedeleteclientcredentials) | **DELETE** /accounts/me/contacts/credentials/{id} | Delete client credentials
 *AccountsApi* | [**deleteUpdateAccountContact**](docs/AccountsApi.md#deleteupdateaccountcontact) | **DELETE** /accounts/me/contacts/{email} | Delete Account Contact
+*AccountsApi* | [**getAdminCreateAccountContact**](docs/AccountsApi.md#getadmincreateaccountcontact) | **GET** /admin/accounts/{id}/contacts | 
 *AccountsApi* | [**getGetAccount**](docs/AccountsApi.md#getgetaccount) | **GET** /accounts/me | Get Account
 *AccountsApi* | [**getGetAccountContacts**](docs/AccountsApi.md#getgetaccountcontacts) | **GET** /accounts/me/contacts | Get Account Contacts
 *AccountsApi* | [**getGetAccountDetailedSummary**](docs/AccountsApi.md#getgetaccountdetailedsummary) | **GET** /accounts/{id}/summary | Get Account Detailed Summary
+*AccountsApi* | [**getGetAccountPageInfo**](docs/AccountsApi.md#getgetaccountpageinfo) | **GET** /admin/accounts/{id} | 
 *AccountsApi* | [**getGetAccounts**](docs/AccountsApi.md#getgetaccounts) | **GET** /accounts | Get Accounts
 *AccountsApi* | [**getGetClientCredentials**](docs/AccountsApi.md#getgetclientcredentials) | **GET** /accounts/me/contacts/credentials | Get user\'s client credentials
 *AccountsApi* | [**getGetCustomerKeys**](docs/AccountsApi.md#getgetcustomerkeys) | **GET** /accounts/me/tcx/keys | Get 3CX Keys
+*AccountsApi* | [**getGetFinanceSettings**](docs/AccountsApi.md#getgetfinancesettings) | **GET** /admin/accounts/{id}/finance | 
+*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* | [**patchSetPortalAccess**](docs/AccountsApi.md#patchsetportalaccess) | **PATCH** /admin/accounts/{id}/portal/access/{state} | 
+*AccountsApi* | [**patchSetPrizePromo**](docs/AccountsApi.md#patchsetprizepromo) | **PATCH** /admin/accounts/{id}/prizes/{state} | 
 *AccountsApi* | [**patchSetTcxWizardCname**](docs/AccountsApi.md#patchsettcxwizardcname) | **PATCH** /accounts/me/cname | 
+*AccountsApi* | [**patchUpdateAccountCname**](docs/AccountsApi.md#patchupdateaccountcname) | **PATCH** /admin/accounts/{id}/cname | 
+*AccountsApi* | [**patchUpdateAccountCompanyNumber**](docs/AccountsApi.md#patchupdateaccountcompanynumber) | **PATCH** /admin/accounts/{id}/companyNumber | 
 *AccountsApi* | [**patchUpdateAccountContactPassword**](docs/AccountsApi.md#patchupdateaccountcontactpassword) | **PATCH** /accounts/contacts/password | Update Account Password
+*AccountsApi* | [**patchUpdateAccountPhone**](docs/AccountsApi.md#patchupdateaccountphone) | **PATCH** /admin/accounts/{id}/phone | 
+*AccountsApi* | [**patchUpdateAccountVatNumber**](docs/AccountsApi.md#patchupdateaccountvatnumber) | **PATCH** /admin/accounts/{id}/vatNumber | 
+*AccountsApi* | [**patchUpdateCreditLimit**](docs/AccountsApi.md#patchupdatecreditlimit) | **PATCH** /admin/accounts/{id}/creditLimit | 
+*AccountsApi* | [**patchUpdatePriceList**](docs/AccountsApi.md#patchupdatepricelist) | **PATCH** /admin/accounts/{id}/priceList | 
+*AccountsApi* | [**patchUpdateSipChannelCost**](docs/AccountsApi.md#patchupdatesipchannelcost) | **PATCH** /admin/accounts/{id}/channelCost | 
+*AccountsApi* | [**patchUpdateTcxHostingPriceList**](docs/AccountsApi.md#patchupdatetcxhostingpricelist) | **PATCH** /admin/accounts/{id}/tcx/hosting/priceList | 
+*AccountsApi* | [**patchUpdateTcxPartnerId**](docs/AccountsApi.md#patchupdatetcxpartnerid) | **PATCH** /admin/accounts{id}/tcx/partner/id | 
+*AccountsApi* | [**postAdminCreateAccountContact**](docs/AccountsApi.md#postadmincreateaccountcontact) | **POST** /admin/accounts/{id}/contacts | 
 *AccountsApi* | [**postGetAccountContacts**](docs/AccountsApi.md#postgetaccountcontacts) | **POST** /accounts/me/contacts | Add Account Contact
 *AccountsApi* | [**postGetAccounts**](docs/AccountsApi.md#postgetaccounts) | **POST** /accounts | Create a new customer account
 *AccountsApi* | [**postGetAdminAccount**](docs/AccountsApi.md#postgetadminaccount) | **POST** /admin/me | Get Admin Account
 *AccountsApi* | [**postGetClientCredentials**](docs/AccountsApi.md#postgetclientcredentials) | **POST** /accounts/me/contacts/credentials | Create client credentials
 *AccountsApi* | [**postSendEmailVerificationEmail**](docs/AccountsApi.md#postsendemailverificationemail) | **POST** /accounts/contacts/verify/{email} | Send email verification email
 *AccountsApi* | [**postSendPasswordReset**](docs/AccountsApi.md#postsendpasswordreset) | **POST** /accounts/contacts/password/reset | Send password reset email
+*AccountsApi* | [**postSendWelcomeEmail**](docs/AccountsApi.md#postsendwelcomeemail) | **POST** /admin/accounts/{id}/email/welcome | 
 *AccountsApi* | [**postSubmitResellerApplication**](docs/AccountsApi.md#postsubmitresellerapplication) | **POST** /accounts/reseller | Submit reseller application
+*AccountsApi* | [**putAdminUpdateAccountContact**](docs/AccountsApi.md#putadminupdateaccountcontact) | **PUT** /admin/accounts/{id}/contacts/{contact_id} | 
 *AccountsApi* | [**putUpdateAccountContact**](docs/AccountsApi.md#putupdateaccountcontact) | **PUT** /accounts/me/contacts/{email} | Update Account Contact
+*AccountsApi* | [**putUpdateBillingAddress**](docs/AccountsApi.md#putupdatebillingaddress) | **PUT** /admin/accounts/{id}/billing/address | 
+*AccountsApi* | [**putUpdateShippingAddress**](docs/AccountsApi.md#putupdateshippingaddress) | **PUT** /admin/accounts/{id}/shipping/address | 
+*CRMApi* | [**getGetCrmActivities**](docs/CRMApi.md#getgetcrmactivities) | **GET** /admin/crm/{id}/activities | 
 *CRMApi* | [**getSearchByPhone**](docs/CRMApi.md#getsearchbyphone) | **GET** /crm/contact/search | 
+*CRMApi* | [**postCreateCrmNote**](docs/CRMApi.md#postcreatecrmnote) | **POST** /admin/crm/{id}/activities/note | 
 *Class3CXApi* | [**getGetLicenceDetails**](docs/Class3CXApi.md#getgetlicencedetails) | **GET** /tcx/licences/details | Get 3CX Licence Details
 *Class3CXApi* | [**postGetBulkLicenceDetails**](docs/Class3CXApi.md#postgetbulklicencedetails) | **POST** /tcx/licences/bulk/details | Get bulk 3CX Licence Details
 *Class3CXInstallationWizardApi* | [**deleteAddExtensions**](docs/Class3CXInstallationWizardApi.md#deleteaddextensions) | **DELETE** /tcx/wizards/extensions | Delete 3CX Installation Wizard Extensions
@@ -162,7 +186,6 @@ Class | Method | HTTP request | Description
 *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* | [**getCreatePortalOrderLegacy**](docs/OrdersApi.md#getcreateportalorderlegacy) | **GET** /orders/portal/legacy | Create an order via the legacy portal
 *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* | [**getGetCommercialInvoice**](docs/OrdersApi.md#getgetcommercialinvoice) | **GET** /admin/orders/{id}/batches/{batch_id}/shipments/{shipment_id}/pdf | Get Commercial Invoice PDF
@@ -288,9 +311,12 @@ Class | Method | HTTP request | Description
  - [AccountContactModel](docs/AccountContactModel.md)
  - [AccountContactRequestModel](docs/AccountContactRequestModel.md)
  - [AccountDetailedSummaryDTO](docs/AccountDetailedSummaryDTO.md)
+ - [AccountFinanceDTO](docs/AccountFinanceDTO.md)
+ - [AccountPageDetailsDTO](docs/AccountPageDetailsDTO.md)
  - [AccountRequestModel](docs/AccountRequestModel.md)
  - [AccountSummaryDTO](docs/AccountSummaryDTO.md)
  - [AccountsResponseModel](docs/AccountsResponseModel.md)
+ - [AddressDTO](docs/AddressDTO.md)
  - [AddressModel](docs/AddressModel.md)
  - [AddressRequestModel](docs/AddressRequestModel.md)
  - [AdminNumberPortDTO](docs/AdminNumberPortDTO.md)
@@ -315,6 +341,7 @@ Class | Method | HTTP request | Description
  - [ContactInfoModel](docs/ContactInfoModel.md)
  - [ConversationModel](docs/ConversationModel.md)
  - [CourierPriceEntity](docs/CourierPriceEntity.md)
+ - [CreateCrmNoteBody](docs/CreateCrmNoteBody.md)
  - [CreditAccountEntity](docs/CreditAccountEntity.md)
  - [CreditNoteDTO](docs/CreditNoteDTO.md)
  - [CreditNoteEntity](docs/CreditNoteEntity.md)
@@ -322,7 +349,12 @@ Class | Method | HTTP request | Description
  - [CreditNoteItemEntity](docs/CreditNoteItemEntity.md)
  - [CreditNoteItemModel](docs/CreditNoteItemModel.md)
  - [CreditNoteModel](docs/CreditNoteModel.md)
+ - [CrmActivitiesResponseDTO](docs/CrmActivitiesResponseDTO.md)
+ - [CrmActivityDTO](docs/CrmActivityDTO.md)
  - [CrmContactDTO](docs/CrmContactDTO.md)
+ - [CrmDateActivitiesDTO](docs/CrmDateActivitiesDTO.md)
+ - [CrmNoteEntity](docs/CrmNoteEntity.md)
+ - [CrmNoteModel](docs/CrmNoteModel.md)
  - [CustomerInformationModel](docs/CustomerInformationModel.md)
  - [CustomerItemRequestDTO](docs/CustomerItemRequestDTO.md)
  - [CustomerOrderRequestDTO](docs/CustomerOrderRequestDTO.md)
@@ -371,32 +403,40 @@ Class | Method | HTTP request | Description
  - [MonthlyUsageModel](docs/MonthlyUsageModel.md)
  - [MultiTenantChangeResponseModel](docs/MultiTenantChangeResponseModel.md)
  - [NavigationModel](docs/NavigationModel.md)
+ - [NumberPortAdminNoteBody](docs/NumberPortAdminNoteBody.md)
  - [NumberPortDTO](docs/NumberPortDTO.md)
  - [NumberPortNoteDTO](docs/NumberPortNoteDTO.md)
  - [NumberPortRangeDTO](docs/NumberPortRangeDTO.md)
  - [NumberPortRangeRequestDTO](docs/NumberPortRangeRequestDTO.md)
  - [NumberPortsModel](docs/NumberPortsModel.md)
  - [OfflineInstancesEntity](docs/OfflineInstancesEntity.md)
- - [OrderDTO](docs/OrderDTO.md)
  - [OrderDetailsDTO](docs/OrderDetailsDTO.md)
  - [OrderEntity](docs/OrderEntity.md)
  - [OrderItemDTO](docs/OrderItemDTO.md)
  - [OrderRequestModel](docs/OrderRequestModel.md)
- - [OrderResponseDTO](docs/OrderResponseDTO.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)
+ - [PartnerDTO](docs/PartnerDTO.md)
+ - [PatchUpdateAccountCnameRequest](docs/PatchUpdateAccountCnameRequest.md)
+ - [PatchUpdateAccountCompanyNumberRequest](docs/PatchUpdateAccountCompanyNumberRequest.md)
  - [PatchUpdateAccountContactPasswordRequest](docs/PatchUpdateAccountContactPasswordRequest.md)
+ - [PatchUpdateAccountPhoneRequest](docs/PatchUpdateAccountPhoneRequest.md)
+ - [PatchUpdateAccountVatNumberRequest](docs/PatchUpdateAccountVatNumberRequest.md)
+ - [PatchUpdateCreditLimitRequest](docs/PatchUpdateCreditLimitRequest.md)
+ - [PatchUpdatePriceListRequest](docs/PatchUpdatePriceListRequest.md)
+ - [PatchUpdateSipChannelCostRequest](docs/PatchUpdateSipChannelCostRequest.md)
+ - [PatchUpdateTcxHostingPriceListRequest](docs/PatchUpdateTcxHostingPriceListRequest.md)
+ - [PatchUpdateTcxPartnerIdRequest](docs/PatchUpdateTcxPartnerIdRequest.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)
+ - [PostSendWelcomeEmailRequest](docs/PostSendWelcomeEmailRequest.md)
  - [PostSplitOrderRequest](docs/PostSplitOrderRequest.md)
  - [PriceListItemModel](docs/PriceListItemModel.md)
  - [PrinterEntity](docs/PrinterEntity.md)
@@ -419,7 +459,6 @@ Class | Method | HTTP request | Description
  - [ResourceNotReadyException](docs/ResourceNotReadyException.md)
  - [RootAccessModel](docs/RootAccessModel.md)
  - [S3BucketEntity](docs/S3BucketEntity.md)
- - [SbcDTO](docs/SbcDTO.md)
  - [ScannedItemModel](docs/ScannedItemModel.md)
  - [ScopeModel](docs/ScopeModel.md)
  - [ServiceHealthDTO](docs/ServiceHealthDTO.md)
@@ -432,7 +471,6 @@ Class | Method | HTTP request | Description
  - [ShipmentItemModel](docs/ShipmentItemModel.md)
  - [ShipmentModel](docs/ShipmentModel.md)
  - [ShipmentRequestDTO](docs/ShipmentRequestDTO.md)
- - [ShippingAddressDTO](docs/ShippingAddressDTO.md)
  - [ShippingConsignmentModel](docs/ShippingConsignmentModel.md)
  - [ShippingInformationDTO](docs/ShippingInformationDTO.md)
  - [ShippingRequestDTO](docs/ShippingRequestDTO.md)