yellowgrid-api-ts 3.2.156-dev.0 → 3.2.156

package/README.md

@@ -47,32 +47,59 @@ 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://bitbucket.org*
 
 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* | [**getGetAccountAddresses**](docs/AccountsApi.md#getgetaccountaddresses) | **GET** /admin/accounts/{id}/addresses | 
 *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* | [**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* | [**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* | [**getGetFinanceSettings**](docs/AccountsApi.md#getgetfinancesettings) | **GET** /admin/accounts/{id}/finance | 
+*AccountsApi* | [**getGetLastAccount**](docs/AccountsApi.md#getgetlastaccount) | **GET** /admin/accounts/last | Get Last Account
+*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 | 
 *BillingApi* | [**getGetAllCustomer**](docs/BillingApi.md#getgetallcustomer) | **GET** /billing/admin/customerList | Get Billing Customers
+*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* | [**getGetTcxExpiringKeys**](docs/Class3CXApi.md#getgettcxexpiringkeys) | **GET** /tcx/admin/keys/expiring/csv | Get 3CX Expiring Keys
 *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
 *Class3CXInstallationWizardApi* | [**deleteAddNumbers**](docs/Class3CXInstallationWizardApi.md#deleteaddnumbers) | **DELETE** /tcx/wizards/numbers | Delete 3CX Installation Wizard Numbers
@@ -110,6 +137,7 @@ Class | Method | HTTP request | Description
 *Class3CXInstallationWizardApi* | [**postUploadBackup**](docs/Class3CXInstallationWizardApi.md#postuploadbackup) | **POST** /tcx/wizards/backup | 
 *Class3CXInstallationsApi* | [**getGetDetails**](docs/Class3CXInstallationsApi.md#getgetdetails) | **GET** /tcx/installations/{wizard_id}/details | Get 3CX Installation Details
 *Class3CXInstallationsApi* | [**getGetInstallations**](docs/Class3CXInstallationsApi.md#getgetinstallations) | **GET** /tcx/installations | Get 3CX Installations
+*Class3CXInstallationsApi* | [**getGetRecordingBackupStorage**](docs/Class3CXInstallationsApi.md#getgetrecordingbackupstorage) | **GET** /tcx/installations/{instance_id}/recordings/backup | Get Recording Backup Storage
 *Class3CXInstallationsApi* | [**patchChangeInstanceOwner**](docs/Class3CXInstallationsApi.md#patchchangeinstanceowner) | **PATCH** /tcx/installations/{instance_id}/owner | Change instance owner
 *Class3CXInstallationsApi* | [**patchUpdateAutoFailover**](docs/Class3CXInstallationsApi.md#patchupdateautofailover) | **PATCH** /tcx/installations/{instance_id}/failover/auto | Update 3CX Instance Auto Failover
 *Class3CXInstallationsApi* | [**postAddDisk**](docs/Class3CXInstallationsApi.md#postadddisk) | **POST** /tcx/installations/{instance_id}/disk | Add additional disk on 3CX Instance
@@ -159,6 +187,7 @@ Class | Method | HTTP request | Description
 *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* | [**postLogout**](docs/OAuth20Api.md#postlogout) | **POST** /oauth2/logout | 
 *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)
@@ -285,13 +314,16 @@ Class | Method | HTTP request | Description
 ### Documentation For Models
 
  - [AbstractOrderRequestDTO](docs/AbstractOrderRequestDTO.md)
+ - [AccountAddressesDTO](docs/AccountAddressesDTO.md)
  - [AccountContactEntity](docs/AccountContactEntity.md)
  - [AccountContactModel](docs/AccountContactModel.md)
  - [AccountContactRequestModel](docs/AccountContactRequestModel.md)
  - [AccountDetailedSummaryDTO](docs/AccountDetailedSummaryDTO.md)
+ - [AccountFinanceDTO](docs/AccountFinanceDTO.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)
@@ -316,6 +348,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)
@@ -323,9 +356,15 @@ 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)
+ - [CustomerListAccountDTO](docs/CustomerListAccountDTO.md)
  - [CustomerOrderRequestDTO](docs/CustomerOrderRequestDTO.md)
  - [CustomerPriceListEnum](docs/CustomerPriceListEnum.md)
  - [CustomerSummaryReportDTO](docs/CustomerSummaryReportDTO.md)
@@ -372,6 +411,7 @@ 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)
@@ -389,15 +429,24 @@ Class | Method | HTTP request | Description
  - [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)
@@ -478,6 +527,7 @@ Class | Method | HTTP request | Description
  - [SupplierItemModel](docs/SupplierItemModel.md)
  - [SupplierModel](docs/SupplierModel.md)
  - [SupportTicketModel](docs/SupportTicketModel.md)
+ - [TableHistoryEntity](docs/TableHistoryEntity.md)
  - [TcxBackupEntity](docs/TcxBackupEntity.md)
  - [TcxBackupModel](docs/TcxBackupModel.md)
  - [TcxBillingEntity](docs/TcxBillingEntity.md)