yellowgrid-api-ts 3.2.129-dev.0 → 3.2.131-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.local.yellowgrid.co.uk*
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
@@ -56,33 +56,21 @@ Class | Method | HTTP request | Description
 *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* | [**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* | [**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* | [**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
@@ -213,6 +201,10 @@ Class | Method | HTTP request | Description
 *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
+*ProspectsApi* | [**getGetProspect**](docs/ProspectsApi.md#getgetprospect) | **GET** /accounts/prospects/{xero_id} | Get Prospect
+*ProspectsApi* | [**getGetProspects**](docs/ProspectsApi.md#getgetprospects) | **GET** /accounts/prospects | Get Prospects
+*ProspectsApi* | [**getRemoveFromProspects**](docs/ProspectsApi.md#getremovefromprospects) | **GET** /accounts/prospects/{xero_id}/remove | Remove From Prospects
+*ProspectsApi* | [**getSetCallback**](docs/ProspectsApi.md#getsetcallback) | **GET** /accounts/prospects/{xero_id}/callback | Set Call Back Date
 *ProvisioningApi* | [**deleteAddFanvilMac**](docs/ProvisioningApi.md#deleteaddfanvilmac) | **DELETE** /provisioning/fanvil/groups/{id}/macs/{mac} | Remove MAC address from DB and FDPS group
 *ProvisioningApi* | [**deleteDeleteFanvilGroup**](docs/ProvisioningApi.md#deletedeletefanvilgroup) | **DELETE** /provisioning/fanvil/groups/{id} | Delete group from DB and FDPS
 *ProvisioningApi* | [**getGetFanvilEncryptionKey**](docs/ProvisioningApi.md#getgetfanvilencryptionkey) | **GET** /provisioning/fanvil/groups/{id}/macs/{mac}/key | Get group Fanvil encryption key
@@ -295,11 +287,9 @@ Class | Method | HTTP request | Description
  - [AccountContactModel](docs/AccountContactModel.md)
  - [AccountContactRequestModel](docs/AccountContactRequestModel.md)
  - [AccountDetailedSummaryDTO](docs/AccountDetailedSummaryDTO.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)
@@ -324,7 +314,6 @@ 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)
@@ -332,12 +321,7 @@ 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)
@@ -386,7 +370,6 @@ 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)
@@ -402,19 +385,16 @@ Class | Method | HTTP request | Description
  - [OrderTotalModel](docs/OrderTotalModel.md)
  - [OrderedItemEntity](docs/OrderedItemEntity.md)
  - [OrderedItemModel](docs/OrderedItemModel.md)
- - [PatchUpdateAccountCnameRequest](docs/PatchUpdateAccountCnameRequest.md)
- - [PatchUpdateAccountCompanyNumberRequest](docs/PatchUpdateAccountCompanyNumberRequest.md)
+ - [PatchSetTcxWizardCnameRequest](docs/PatchSetTcxWizardCnameRequest.md)
  - [PatchUpdateAccountContactPasswordRequest](docs/PatchUpdateAccountContactPasswordRequest.md)
- - [PatchUpdateAccountPhoneRequest](docs/PatchUpdateAccountPhoneRequest.md)
- - [PatchUpdateAccountVatNumberRequest](docs/PatchUpdateAccountVatNumberRequest.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)
- - [PostSendWelcomeEmailRequest](docs/PostSendWelcomeEmailRequest.md)
  - [PostSplitOrderRequest](docs/PostSplitOrderRequest.md)
  - [PriceListItemModel](docs/PriceListItemModel.md)
  - [PrinterEntity](docs/PrinterEntity.md)
@@ -425,6 +405,8 @@ Class | Method | HTTP request | Description
  - [ProductSummaryDTO](docs/ProductSummaryDTO.md)
  - [PromoCodesEntity](docs/PromoCodesEntity.md)
  - [PromoItemsEntity](docs/PromoItemsEntity.md)
+ - [ProspectDTO](docs/ProspectDTO.md)
+ - [ProspectEntity](docs/ProspectEntity.md)
  - [ProvisioningModel](docs/ProvisioningModel.md)
  - [ProvisioningRequestEntity](docs/ProvisioningRequestEntity.md)
  - [PutAllocateItemsRequest](docs/PutAllocateItemsRequest.md)