yellowgrid-api-ts 3.2.220 → 3.2.221-dev.0

package/dist/models/ReportEnum.d.ts

@@ -0,0 +1,53 @@
+export declare const ReportEnum: {
+    readonly STOCK: {
+        readonly name: "STOCK";
+        readonly value: 1;
+        readonly publicValue: "Stock";
+    };
+    readonly POS: {
+        readonly name: "POS";
+        readonly value: 2;
+        readonly publicValue: "POS";
+    };
+    readonly CUSTOMER_SPEND: {
+        readonly name: "CUSTOMER_SPEND";
+        readonly value: 3;
+        readonly publicValue: "Customer Spend";
+    };
+    readonly MONTHLY_SALES: {
+        readonly name: "MONTHLY_SALES";
+        readonly value: 4;
+        readonly publicValue: "Monthly Sales";
+    };
+    readonly CUSTOMER_ANNUAL_COMPARISON: {
+        readonly name: "CUSTOMER_ANNUAL_COMPARISON";
+        readonly value: 5;
+        readonly publicValue: "Customer Annual Comparison";
+    };
+    readonly LOW_STOCK: {
+        readonly name: "LOW_STOCK";
+        readonly value: 6;
+        readonly publicValue: "Low Stock";
+    };
+    readonly LEAGUE_TABLE: {
+        readonly name: "LEAGUE_TABLE";
+        readonly value: 7;
+        readonly publicValue: "League Table";
+    };
+    readonly REVENUE: {
+        readonly name: "REVENUE";
+        readonly value: 8;
+        readonly publicValue: "Revenue";
+    };
+    readonly EXPENDITURE: {
+        readonly name: "EXPENDITURE";
+        readonly value: 9;
+        readonly publicValue: "Expenditure";
+    };
+    readonly TECH_SUPPORT_CUSTOMERS: {
+        readonly name: "TECH_SUPPORT_CUSTOMERS";
+        readonly value: 10;
+        readonly publicValue: "Tech Support Customers";
+    };
+};
+export type ReportEnum = typeof ReportEnum;

package/dist/models/ReportEnum.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReportEnum = void 0;
+exports.ReportEnum = {
+    "STOCK": {
+        "name": "STOCK",
+        "value": 1,
+        "publicValue": "Stock"
+    },
+    "POS": {
+        "name": "POS",
+        "value": 2,
+        "publicValue": "POS"
+    },
+    "CUSTOMER_SPEND": {
+        "name": "CUSTOMER_SPEND",
+        "value": 3,
+        "publicValue": "Customer Spend"
+    },
+    "MONTHLY_SALES": {
+        "name": "MONTHLY_SALES",
+        "value": 4,
+        "publicValue": "Monthly Sales"
+    },
+    "CUSTOMER_ANNUAL_COMPARISON": {
+        "name": "CUSTOMER_ANNUAL_COMPARISON",
+        "value": 5,
+        "publicValue": "Customer Annual Comparison"
+    },
+    "LOW_STOCK": {
+        "name": "LOW_STOCK",
+        "value": 6,
+        "publicValue": "Low Stock"
+    },
+    "LEAGUE_TABLE": {
+        "name": "LEAGUE_TABLE",
+        "value": 7,
+        "publicValue": "League Table"
+    },
+    "REVENUE": {
+        "name": "REVENUE",
+        "value": 8,
+        "publicValue": "Revenue"
+    },
+    "EXPENDITURE": {
+        "name": "EXPENDITURE",
+        "value": 9,
+        "publicValue": "Expenditure"
+    },
+    "TECH_SUPPORT_CUSTOMERS": {
+        "name": "TECH_SUPPORT_CUSTOMERS",
+        "value": 10,
+        "publicValue": "Tech Support Customers"
+    }
+};

package/docs/AbstractItemDiscountModel.md

@@ -0,0 +1,21 @@
+# AbstractItemDiscountModel
+
+Item Discount
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**description** | **string** | Description | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AbstractItemDiscountModel } from 'yellowgrid-api-ts';
+
+const instance: AbstractItemDiscountModel = {
+    description,
+};
+```
+
+[[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/AbstractOrderRequestDTO.md

@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 **items** | [**Array<CustomerItemRequestDTO>**](CustomerItemRequestDTO.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) | Shipping Address | [optional] [default to undefined]
+**shippingAddress** | [**AddressModel**](AddressModel.md) |  | [optional] [default to undefined]
 **partShip** | **boolean** | Part Ship Order | [optional] [default to undefined]
 **quote** | **boolean** | Quote | [optional] [default to undefined]
 

package/docs/AccountsApi.md

@@ -1,6 +1,6 @@
 # AccountsApi
 
-All URIs are relative to *https://bitbucket.org*
+All URIs are relative to *https://api.local.yellowgrid.co.uk*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
@@ -17,8 +17,10 @@ All URIs are relative to *https://bitbucket.org*
 |[**getGetClientCredentials**](#getgetclientcredentials) | **GET** /accounts/me/contacts/credentials | Get user\'s client credentials|
 |[**getGetCustomerAccountsList**](#getgetcustomeraccountslist) | **GET** /admin/accounts/customers/list | |
 |[**getGetCustomerKeys**](#getgetcustomerkeys) | **GET** /accounts/me/tcx/keys | Get 3CX Keys|
+|[**getGetCustomerMap**](#getgetcustomermap) | **GET** /admin/accounts/customer/map | |
 |[**getGetFinanceSettings**](#getgetfinancesettings) | **GET** /admin/accounts/{id}/finance | |
 |[**getGetLastAccount**](#getgetlastaccount) | **GET** /admin/accounts/last | Get Last Account|
+|[**getGetNewPriceList**](#getgetnewpricelist) | **GET** /admin/accounts/priceList/new | Download New Price List|
 |[**getGetTcxPartnerDetails**](#getgettcxpartnerdetails) | **GET** /admin/accounts/{id}/tcx/partner | |
 |[**getVerifyEmailAddress**](#getverifyemailaddress) | **GET** /accounts/contacts/verify | Verify account email address|
 |[**patchSetAccountStatus**](#patchsetaccountstatus) | **PATCH** /admin/accounts/{id}/status/{state} | |
@@ -737,6 +739,53 @@ 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)
 
+# **getGetCustomerMap**
+> Array<CustomerCoordinatesDTO> getGetCustomerMap()
+
+Get Customer Map
+
+### Example
+
+```typescript
+import {
+    AccountsApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new AccountsApi(configuration);
+
+const { status, data } = await apiInstance.getGetCustomerMap();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**Array<CustomerCoordinatesDTO>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Customer Coordinates |  -  |
+|**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)
+
 # **getGetFinanceSettings**
 > AccountFinanceDTO getGetFinanceSettings()
 
@@ -838,6 +887,60 @@ 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)
 
+# **getGetNewPriceList**
+> string getGetNewPriceList()
+
+Download New Price List
+
+### 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.getGetNewPriceList(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | Xero ID | defaults to undefined|
+
+
+### Return type
+
+**string**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: text/csv
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Price List |  -  |
+|**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)
+
 # **getGetTcxPartnerDetails**
 > PartnerDTO getGetTcxPartnerDetails()
 

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) | Shipping Address | [optional] [default to undefined]
+**shippingAddress** | [**AddressModel**](AddressModel.md) |  | [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]

package/docs/AxisDataDTO.md

@@ -0,0 +1,25 @@
+# AxisDataDTO
+
+Graph Axis Data
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **string** | Type | [optional] [default to undefined]
+**data** | **Array<string>** | Data | [optional] [default to undefined]
+**name** | **string** | Name | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AxisDataDTO } from 'yellowgrid-api-ts';
+
+const instance: AxisDataDTO = {
+    type,
+    data,
+    name,
+};
+```
+
+[[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/BaseService.md

@@ -0,0 +1,36 @@
+# BaseService
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**createdDate** | **string** |  | [optional] [default to undefined]
+**id** | **number** |  | [optional] [default to undefined]
+**serviceCode** | **string** |  | [optional] [default to undefined]
+**dataType** | **string** |  | [default to undefined]
+**originalDescription** | **string** |  | [default to undefined]
+**cost** | **number** |  | [optional] [default to undefined]
+**startDate** | **string** |  | [optional] [default to undefined]
+**endDate** | **string** |  | [optional] [default to undefined]
+**filePeriod** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { BaseService } from 'yellowgrid-api-ts';
+
+const instance: BaseService = {
+    createdDate,
+    id,
+    serviceCode,
+    dataType,
+    originalDescription,
+    cost,
+    startDate,
+    endDate,
+    filePeriod,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)