yellowgrid-api-ts 3.0.79

package/docs/AccountContactEntity.md

@@ -0,0 +1,45 @@
+# AccountContactEntity
+
+AccountContactsEntity
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | ID | [optional] [default to undefined]
+**xeroId** | **string** | Account ID | [optional] [default to undefined]
+**firstName** | **string** | First Name | [optional] [default to undefined]
+**lastName** | **string** | Last Name | [optional] [default to undefined]
+**emailAddress** | **string** | Email Address | [optional] [default to undefined]
+**telephone** | **string** | Telephone | [optional] [default to undefined]
+**accountsEmails** | **boolean** | Receives Accounts Emails | [optional] [default to undefined]
+**marketingEmails** | **boolean** | Receives Marketing Emails | [optional] [default to undefined]
+**licenceEmails** | **boolean** | Receives 3CX Licence Emails | [optional] [default to undefined]
+**telephonyEmails** | **boolean** | Receives Telephony Emails | [optional] [default to undefined]
+**despatchEmails** | **boolean** | Receives Despatch Emails | [optional] [default to undefined]
+**mainContact** | **boolean** | mainContact | [optional] [default to undefined]
+**verified** | **boolean** | Email Verified | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AccountContactEntity } from 'yellowgrid-api-ts';
+
+const instance: AccountContactEntity = {
+    id,
+    xeroId,
+    firstName,
+    lastName,
+    emailAddress,
+    telephone,
+    accountsEmails,
+    marketingEmails,
+    licenceEmails,
+    telephonyEmails,
+    despatchEmails,
+    mainContact,
+    verified,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/AccountContactModel.md

@@ -0,0 +1,45 @@
+# AccountContactModel
+
+Account Contact Model
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | ID | [optional] [default to undefined]
+**xeroId** | **string** | Account ID | [optional] [default to undefined]
+**firstName** | **string** | First Name | [optional] [default to undefined]
+**lastName** | **string** | Last Name | [optional] [default to undefined]
+**emailAddress** | **string** | Email Address | [optional] [default to undefined]
+**telephone** | **string** | Telephone | [optional] [default to undefined]
+**accountsEmails** | **boolean** | Receives Accounts Emails | [optional] [default to undefined]
+**marketingEmails** | **boolean** | Receives Marketing Emails | [optional] [default to undefined]
+**licenceEmails** | **boolean** | Receives 3CX Licence Emails | [optional] [default to undefined]
+**telephonyEmails** | **boolean** | Receives Telephony Emails | [optional] [default to undefined]
+**despatchEmails** | **boolean** | Receives Despatch Emails | [optional] [default to undefined]
+**mainContact** | **boolean** | mainContact | [optional] [default to undefined]
+**verified** | **boolean** | Email Verified | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AccountContactModel } from 'yellowgrid-api-ts';
+
+const instance: AccountContactModel = {
+    id,
+    xeroId,
+    firstName,
+    lastName,
+    emailAddress,
+    telephone,
+    accountsEmails,
+    marketingEmails,
+    licenceEmails,
+    telephonyEmails,
+    despatchEmails,
+    mainContact,
+    verified,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/AccountContactRequestModel.md

@@ -0,0 +1,37 @@
+# AccountContactRequestModel
+
+New Account Contact Request
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**firstName** | **string** | First Name | [optional] [default to undefined]
+**lastName** | **string** | Last Name | [optional] [default to undefined]
+**emailAddress** | **string** | Email Address | [optional] [default to undefined]
+**telephone** | **string** | Telephone Number | [optional] [default to undefined]
+**accountsEmails** | **boolean** | Receive Accounts Emails | [optional] [default to undefined]
+**marketingEmails** | **boolean** | Receive Marketing Emails | [optional] [default to undefined]
+**licenceEmails** | **boolean** | Receive 3CX Licence Emails | [optional] [default to undefined]
+**telephonyEmails** | **boolean** | Receive SIP Trunk Emails | [optional] [default to undefined]
+**despatchEmails** | **boolean** | Receive Despatch Emails | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AccountContactRequestModel } from 'yellowgrid-api-ts';
+
+const instance: AccountContactRequestModel = {
+    firstName,
+    lastName,
+    emailAddress,
+    telephone,
+    accountsEmails,
+    marketingEmails,
+    licenceEmails,
+    telephonyEmails,
+    despatchEmails,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/AccountRequestModel.md

@@ -0,0 +1,53 @@
+# AccountRequestModel
+
+New Account Request
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**companyName** | **string** | Company Name | [optional] [default to undefined]
+**firstName** | **string** | First Name | [optional] [default to undefined]
+**lastName** | **string** | Last Name | [optional] [default to undefined]
+**telephone** | **string** | Telephone | [optional] [default to undefined]
+**addressLine1** | **string** | Address Line 1 | [optional] [default to undefined]
+**addressLine2** | **string** | Address Line 2 | [optional] [default to undefined]
+**town** | **string** | Town/City | [optional] [default to undefined]
+**postCode** | **string** | Post Code | [optional] [default to undefined]
+**country** | **string** | Country ISO | [optional] [default to undefined]
+**companyNumber** | **string** | Company Registration Number | [optional] [default to undefined]
+**preferredPbx** | **string** | Preferred PBX | [optional] [default to undefined]
+**vatNumber** | **string** | VAT Number | [optional] [default to undefined]
+**email** | **string** | Email Address | [optional] [default to undefined]
+**source** | **string** | Source | [optional] [default to undefined]
+**creditRequired** | **number** | Credit Limit Required | [optional] [default to undefined]
+**marketing** | **boolean** | Marketing Opt-In | [optional] [default to false]
+**reseller** | **boolean** | Reseller | [optional] [default to false]
+
+## Example
+
+```typescript
+import { AccountRequestModel } from 'yellowgrid-api-ts';
+
+const instance: AccountRequestModel = {
+    companyName,
+    firstName,
+    lastName,
+    telephone,
+    addressLine1,
+    addressLine2,
+    town,
+    postCode,
+    country,
+    companyNumber,
+    preferredPbx,
+    vatNumber,
+    email,
+    source,
+    creditRequired,
+    marketing,
+    reseller,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/AccountSummaryDTO.md

@@ -0,0 +1,25 @@
+# AccountSummaryDTO
+
+Account Summary
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | ID | [optional] [default to undefined]
+**company** | **string** | Company | [optional] [default to undefined]
+**xeroId** | **string** | Xero ID | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AccountSummaryDTO } from 'yellowgrid-api-ts';
+
+const instance: AccountSummaryDTO = {
+    id,
+    company,
+    xeroId,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)