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

package/docs/AccountsApi.md

@@ -1,6 +1,6 @@
 # AccountsApi
 
-All URIs are relative to *https://localhost*
+All URIs are relative to *https://bitbucket.org*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
@@ -9,30 +9,20 @@ All URIs are relative to *https://localhost*
 |[**getGetAccount**](#getgetaccount) | **GET** /accounts/me | Get Account|
 |[**getGetAccountContacts**](#getgetaccountcontacts) | **GET** /accounts/me/contacts | Get Account Contacts|
 |[**getGetAccountDetailedSummary**](#getgetaccountdetailedsummary) | **GET** /accounts/{id}/summary | Get Account Detailed Summary|
-|[**getGetAccountPageInfo**](#getgetaccountpageinfo) | **GET** /admin/accounts/{id} | |
 |[**getGetAccounts**](#getgetaccounts) | **GET** /accounts | Get Accounts|
 |[**getGetClientCredentials**](#getgetclientcredentials) | **GET** /accounts/me/contacts/credentials | Get user\'s client credentials|
 |[**getGetCustomerKeys**](#getgetcustomerkeys) | **GET** /accounts/me/tcx/keys | Get 3CX Keys|
 |[**getVerifyEmailAddress**](#getverifyemailaddress) | **GET** /accounts/contacts/verify | Verify account email address|
-|[**patchSetPortalAccess**](#patchsetportalaccess) | **PATCH** /admin/accounts/{id}/portal/access/{state} | |
-|[**patchSetPrizePromo**](#patchsetprizepromo) | **PATCH** /admin/accounts/{id}/prizes/{state} | |
 |[**patchSetTcxWizardCname**](#patchsettcxwizardcname) | **PATCH** /accounts/me/cname | |
-|[**patchUpdateAccountCname**](#patchupdateaccountcname) | **PATCH** /admin/accounts/{id}/cname | |
-|[**patchUpdateAccountCompanyNumber**](#patchupdateaccountcompanynumber) | **PATCH** /admin/accounts/{id}/companyNumber | |
 |[**patchUpdateAccountContactPassword**](#patchupdateaccountcontactpassword) | **PATCH** /accounts/contacts/password | Update Account Password|
-|[**patchUpdateAccountPhone**](#patchupdateaccountphone) | **PATCH** /admin/accounts/{id}/phone | |
-|[**patchUpdateAccountVatNumber**](#patchupdateaccountvatnumber) | **PATCH** /admin/accounts/{id}/vatNumber | |
 |[**postGetAccountContacts**](#postgetaccountcontacts) | **POST** /accounts/me/contacts | Add Account Contact|
 |[**postGetAccounts**](#postgetaccounts) | **POST** /accounts | Create a new customer account|
 |[**postGetAdminAccount**](#postgetadminaccount) | **POST** /admin/me | Get Admin Account|
 |[**postGetClientCredentials**](#postgetclientcredentials) | **POST** /accounts/me/contacts/credentials | Create client credentials|
 |[**postSendEmailVerificationEmail**](#postsendemailverificationemail) | **POST** /accounts/contacts/verify/{email} | Send email verification email|
 |[**postSendPasswordReset**](#postsendpasswordreset) | **POST** /accounts/contacts/password/reset | Send password reset email|
-|[**postSendWelcomeEmail**](#postsendwelcomeemail) | **POST** /admin/accounts/{id}/email/welcome | |
 |[**postSubmitResellerApplication**](#postsubmitresellerapplication) | **POST** /accounts/reseller | Submit reseller application|
 |[**putUpdateAccountContact**](#putupdateaccountcontact) | **PUT** /accounts/me/contacts/{email} | Update Account Contact|
-|[**putUpdateBillingAddress**](#putupdatebillingaddress) | **PUT** /admin/accounts/{id}/billing/address | |
-|[**putUpdateShippingAddress**](#putupdateshippingaddress) | **PUT** /admin/accounts/{id}/shipping/address | |
 
 # **deleteDeleteClientCredentials**
 > deleteDeleteClientCredentials()
@@ -297,60 +287,6 @@ No authorization required
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
-# **getGetAccountPageInfo**
-> AccountPageDetailsDTO getGetAccountPageInfo()
-
-Get Account Page Details
-
-### Example
-
-```typescript
-import {
-    AccountsApi,
-    Configuration
-} from 'yellowgrid-api-ts';
-
-const configuration = new Configuration();
-const apiInstance = new AccountsApi(configuration);
-
-let id: string; //Xero ID (default to undefined)
-
-const { status, data } = await apiInstance.getGetAccountPageInfo(
-    id
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **id** | [**string**] | Xero ID | defaults to undefined|
-
-
-### Return type
-
-**AccountPageDetailsDTO**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | Accounts Page Details |  -  |
-|**400** | Bad Request |  -  |
-|**401** | Unauthorised |  -  |
-|**403** | Access Denied |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-
 # **getGetAccounts**
 > AccountsResponseModel getGetAccounts()
 
@@ -562,120 +498,6 @@ No authorization required
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
-# **patchSetPortalAccess**
-> patchSetPortalAccess()
-
-Set Account Portal Access
-
-### Example
-
-```typescript
-import {
-    AccountsApi,
-    Configuration
-} from 'yellowgrid-api-ts';
-
-const configuration = new Configuration();
-const apiInstance = new AccountsApi(configuration);
-
-let id: string; //Xero ID (default to undefined)
-let state: 'enable' | 'disable'; //Portal Access State (default to undefined)
-
-const { status, data } = await apiInstance.patchSetPortalAccess(
-    id,
-    state
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **id** | [**string**] | Xero ID | defaults to undefined|
-| **state** | [**&#39;enable&#39; | &#39;disable&#39;**]**Array<&#39;enable&#39; &#124; &#39;disable&#39;>** | Portal Access State | defaults to undefined|
-
-
-### Return type
-
-void (empty response body)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: Not defined
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**204** | No Response |  -  |
-|**400** | Bad Request |  -  |
-|**401** | Unauthorised |  -  |
-|**403** | Access Denied |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-
-# **patchSetPrizePromo**
-> patchSetPrizePromo()
-
-Set Account Prize Promo
-
-### Example
-
-```typescript
-import {
-    AccountsApi,
-    Configuration
-} from 'yellowgrid-api-ts';
-
-const configuration = new Configuration();
-const apiInstance = new AccountsApi(configuration);
-
-let id: string; //Xero ID (default to undefined)
-let state: 'enable' | 'disable'; //Prize Promo State (default to undefined)
-
-const { status, data } = await apiInstance.patchSetPrizePromo(
-    id,
-    state
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **id** | [**string**] | Xero ID | defaults to undefined|
-| **state** | [**&#39;enable&#39; | &#39;disable&#39;**]**Array<&#39;enable&#39; &#124; &#39;disable&#39;>** | Prize Promo State | defaults to undefined|
-
-
-### Return type
-
-void (empty response body)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: Not defined
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**204** | No Response |  -  |
-|**400** | Bad Request |  -  |
-|**401** | Unauthorised |  -  |
-|**403** | Access Denied |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-
 # **patchSetTcxWizardCname**
 > patchSetTcxWizardCname()
 
@@ -687,16 +509,16 @@ Set 3CX Wizard CNAME
 import {
     AccountsApi,
     Configuration,
-    PatchUpdateAccountCnameRequest
+    PatchSetTcxWizardCnameRequest
 } from 'yellowgrid-api-ts';
 
 const configuration = new Configuration();
 const apiInstance = new AccountsApi(configuration);
 
-let patchUpdateAccountCnameRequest: PatchUpdateAccountCnameRequest; //CNAME Request (optional)
+let patchSetTcxWizardCnameRequest: PatchSetTcxWizardCnameRequest; //CNAME Request (optional)
 
 const { status, data } = await apiInstance.patchSetTcxWizardCname(
-    patchUpdateAccountCnameRequest
+    patchSetTcxWizardCnameRequest
 );
 ```
 
@@ -704,7 +526,7 @@ const { status, data } = await apiInstance.patchSetTcxWizardCname(
 
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
-| **patchUpdateAccountCnameRequest** | **PatchUpdateAccountCnameRequest**| CNAME Request | |
+| **patchSetTcxWizardCnameRequest** | **PatchSetTcxWizardCnameRequest**| CNAME Request | |
 
 
 ### Return type
@@ -731,122 +553,6 @@ No authorization required
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
-# **patchUpdateAccountCname**
-> patchUpdateAccountCname()
-
-Set Account CNAME
-
-### Example
-
-```typescript
-import {
-    AccountsApi,
-    Configuration,
-    PatchUpdateAccountCnameRequest
-} from 'yellowgrid-api-ts';
-
-const configuration = new Configuration();
-const apiInstance = new AccountsApi(configuration);
-
-let id: string; //Xero ID (default to undefined)
-let patchUpdateAccountCnameRequest: PatchUpdateAccountCnameRequest; //CNAME Request (optional)
-
-const { status, data } = await apiInstance.patchUpdateAccountCname(
-    id,
-    patchUpdateAccountCnameRequest
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **patchUpdateAccountCnameRequest** | **PatchUpdateAccountCnameRequest**| CNAME Request | |
-| **id** | [**string**] | Xero ID | defaults to undefined|
-
-
-### Return type
-
-void (empty response body)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: Not defined
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**204** | No Response |  -  |
-|**400** | Bad Request |  -  |
-|**401** | Unauthorised |  -  |
-|**403** | Access Denied |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-
-# **patchUpdateAccountCompanyNumber**
-> patchUpdateAccountCompanyNumber()
-
-Set Account Company Number
-
-### Example
-
-```typescript
-import {
-    AccountsApi,
-    Configuration,
-    PatchUpdateAccountCompanyNumberRequest
-} from 'yellowgrid-api-ts';
-
-const configuration = new Configuration();
-const apiInstance = new AccountsApi(configuration);
-
-let id: string; //Xero ID (default to undefined)
-let patchUpdateAccountCompanyNumberRequest: PatchUpdateAccountCompanyNumberRequest; //Account Company Number Request (optional)
-
-const { status, data } = await apiInstance.patchUpdateAccountCompanyNumber(
-    id,
-    patchUpdateAccountCompanyNumberRequest
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **patchUpdateAccountCompanyNumberRequest** | **PatchUpdateAccountCompanyNumberRequest**| Account Company Number Request | |
-| **id** | [**string**] | Xero ID | defaults to undefined|
-
-
-### Return type
-
-void (empty response body)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: Not defined
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**204** | No Response |  -  |
-|**400** | Bad Request |  -  |
-|**401** | Unauthorised |  -  |
-|**403** | Access Denied |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-
 # **patchUpdateAccountContactPassword**
 > patchUpdateAccountContactPassword()
 
@@ -905,122 +611,6 @@ No authorization required
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
-# **patchUpdateAccountPhone**
-> patchUpdateAccountPhone()
-
-Set Account Phone
-
-### Example
-
-```typescript
-import {
-    AccountsApi,
-    Configuration,
-    PatchUpdateAccountPhoneRequest
-} from 'yellowgrid-api-ts';
-
-const configuration = new Configuration();
-const apiInstance = new AccountsApi(configuration);
-
-let id: string; //Xero ID (default to undefined)
-let patchUpdateAccountPhoneRequest: PatchUpdateAccountPhoneRequest; //Telephone Request (optional)
-
-const { status, data } = await apiInstance.patchUpdateAccountPhone(
-    id,
-    patchUpdateAccountPhoneRequest
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **patchUpdateAccountPhoneRequest** | **PatchUpdateAccountPhoneRequest**| Telephone Request | |
-| **id** | [**string**] | Xero ID | defaults to undefined|
-
-
-### Return type
-
-void (empty response body)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: Not defined
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**204** | No Response |  -  |
-|**400** | Bad Request |  -  |
-|**401** | Unauthorised |  -  |
-|**403** | Access Denied |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-
-# **patchUpdateAccountVatNumber**
-> patchUpdateAccountVatNumber()
-
-Set Account VAT Number
-
-### Example
-
-```typescript
-import {
-    AccountsApi,
-    Configuration,
-    PatchUpdateAccountVatNumberRequest
-} from 'yellowgrid-api-ts';
-
-const configuration = new Configuration();
-const apiInstance = new AccountsApi(configuration);
-
-let id: string; //Xero ID (default to undefined)
-let patchUpdateAccountVatNumberRequest: PatchUpdateAccountVatNumberRequest; //VAT Number Request (optional)
-
-const { status, data } = await apiInstance.patchUpdateAccountVatNumber(
-    id,
-    patchUpdateAccountVatNumberRequest
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **patchUpdateAccountVatNumberRequest** | **PatchUpdateAccountVatNumberRequest**| VAT Number Request | |
-| **id** | [**string**] | Xero ID | defaults to undefined|
-
-
-### Return type
-
-void (empty response body)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: Not defined
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**204** | No Response |  -  |
-|**400** | Bad Request |  -  |
-|**401** | Unauthorised |  -  |
-|**403** | Access Denied |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-
 # **postGetAccountContacts**
 > postGetAccountContacts()
 
@@ -1331,64 +921,6 @@ No authorization required
  - **Accept**: Not defined
 
 
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | No Response |  -  |
-|**400** | Bad Request |  -  |
-|**401** | Unauthorised |  -  |
-|**403** | Access Denied |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-
-# **postSendWelcomeEmail**
-> postSendWelcomeEmail()
-
-Send Account Welcome Email
-
-### Example
-
-```typescript
-import {
-    AccountsApi,
-    Configuration,
-    PostSendWelcomeEmailRequest
-} from 'yellowgrid-api-ts';
-
-const configuration = new Configuration();
-const apiInstance = new AccountsApi(configuration);
-
-let id: string; //Xero ID (default to undefined)
-let postSendWelcomeEmailRequest: PostSendWelcomeEmailRequest; //Email Request (optional)
-
-const { status, data } = await apiInstance.postSendWelcomeEmail(
-    id,
-    postSendWelcomeEmailRequest
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **postSendWelcomeEmailRequest** | **PostSendWelcomeEmailRequest**| Email Request | |
-| **id** | [**string**] | Xero ID | defaults to undefined|
-
-
-### Return type
-
-void (empty response body)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: Not defined
-
-
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
@@ -1517,119 +1049,3 @@ No authorization required
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
-# **putUpdateBillingAddress**
-> putUpdateBillingAddress()
-
-Update Account Billing Address
-
-### Example
-
-```typescript
-import {
-    AccountsApi,
-    Configuration,
-    AddressDTO
-} from 'yellowgrid-api-ts';
-
-const configuration = new Configuration();
-const apiInstance = new AccountsApi(configuration);
-
-let id: string; //Xero ID (default to undefined)
-let addressDTO: AddressDTO; //Updated Billing Address (optional)
-
-const { status, data } = await apiInstance.putUpdateBillingAddress(
-    id,
-    addressDTO
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **addressDTO** | **AddressDTO**| Updated Billing Address | |
-| **id** | [**string**] | Xero ID | defaults to undefined|
-
-
-### Return type
-
-void (empty response body)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: Not defined
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**204** | No Response |  -  |
-|**400** | Bad Request |  -  |
-|**401** | Unauthorised |  -  |
-|**403** | Access Denied |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-
-# **putUpdateShippingAddress**
-> putUpdateShippingAddress()
-
-Update Account Shipping Address
-
-### Example
-
-```typescript
-import {
-    AccountsApi,
-    Configuration,
-    AddressDTO
-} from 'yellowgrid-api-ts';
-
-const configuration = new Configuration();
-const apiInstance = new AccountsApi(configuration);
-
-let id: string; //Xero ID (default to undefined)
-let addressDTO: AddressDTO; //Updated Shipping Address (optional)
-
-const { status, data } = await apiInstance.putUpdateShippingAddress(
-    id,
-    addressDTO
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **addressDTO** | **AddressDTO**| Updated Shipping Address | |
-| **id** | [**string**] | Xero ID | defaults to undefined|
-
-
-### Return type
-
-void (empty response body)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: application/json
- - **Accept**: Not defined
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**204** | No Response |  -  |
-|**400** | Bad Request |  -  |
-|**401** | Unauthorised |  -  |
-|**403** | Access Denied |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
-

package/docs/AdminOrderRequestDTO.md

@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 **items** | [**Array<DetailedItemRequestDTO>**](DetailedItemRequestDTO.md) | Items | [optional] [default to undefined]
 **shippingService** | [**ShippingServiceDTO**](ShippingServiceDTO.md) |  | [optional] [default to undefined]
 **provisioningUrl** | **string** | Provisioning URL | [optional] [default to undefined]
-**shippingAddress** | [**AddressModel**](AddressModel.md) |  | [optional] [default to undefined]
+**shippingAddress** | [**AddressModel**](AddressModel.md) | Shipping Address | [optional] [default to undefined]
 **partShip** | **boolean** | Part Ship Order | [optional] [default to undefined]
 **quote** | **boolean** | Quote | [optional] [default to undefined]
 **customerId** | **number** | Customer ID | [optional] [default to undefined]
@@ -20,6 +20,7 @@ Name | Type | Description | Notes
 **includeNfrPromos** | **boolean** | Include NFR Promos | [optional] [default to false]
 **carriageCharge** | **number** | Carriage Charge | [optional] [default to undefined]
 **sendOrderEmail** | **boolean** | Send Order Email | [optional] [default to undefined]
+**paymentMethod** | **string** | Payment Method | [optional] [default to undefined]
 
 ## Example
 
@@ -41,6 +42,7 @@ const instance: AdminOrderRequestDTO = {
     includeNfrPromos,
     carriageCharge,
     sendOrderEmail,
+    paymentMethod,
 };
 ```