yellowgrid-api-ts 3.2.257-dev.0 → 3.2.258-dev.0

package/dist/base.d.ts

@@ -12,22 +12,42 @@
 import type { Configuration } from './configuration';
 import type { AxiosInstance, RawAxiosRequestConfig } from 'axios';
 export declare const BASE_PATH: string;
+/**
+ *
+ * @export
+ */
 export declare const COLLECTION_FORMATS: {
     csv: string;
     ssv: string;
     tsv: string;
     pipes: string;
 };
+/**
+ *
+ * @export
+ * @interface RequestArgs
+ */
 export interface RequestArgs {
     url: string;
     options: RawAxiosRequestConfig;
 }
+/**
+ *
+ * @export
+ * @class BaseAPI
+ */
 export declare class BaseAPI {
     protected basePath: string;
     protected axios: AxiosInstance;
     protected configuration: Configuration | undefined;
     constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
 }
+/**
+ *
+ * @export
+ * @class RequiredError
+ * @extends {Error}
+ */
 export declare class RequiredError extends Error {
     field: string;
     constructor(field: string, msg?: string);
@@ -38,5 +58,9 @@ interface ServerMap {
         description: string;
     }[];
 }
+/**
+ *
+ * @export
+ */
 export declare const operationServerMap: ServerMap;
 export {};

package/dist/base.js

@@ -31,12 +31,21 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.operationServerMap = exports.RequiredError = exports.BaseAPI = exports.COLLECTION_FORMATS = exports.BASE_PATH = void 0;
 var axios_1 = require("axios");
 exports.BASE_PATH = "https://api.local.yellowgrid.co.uk".replace(/\/+$/, "");
+/**
+ *
+ * @export
+ */
 exports.COLLECTION_FORMATS = {
     csv: ",",
     ssv: " ",
     tsv: "\t",
     pipes: "|",
 };
+/**
+ *
+ * @export
+ * @class BaseAPI
+ */
 var BaseAPI = /** @class */ (function () {
     function BaseAPI(configuration, basePath, axios) {
         if (basePath === void 0) { basePath = exports.BASE_PATH; }
@@ -53,6 +62,12 @@ var BaseAPI = /** @class */ (function () {
 }());
 exports.BaseAPI = BaseAPI;
 ;
+/**
+ *
+ * @export
+ * @class RequiredError
+ * @extends {Error}
+ */
 var RequiredError = /** @class */ (function (_super) {
     __extends(RequiredError, _super);
     function RequiredError(field, msg) {
@@ -64,4 +79,8 @@ var RequiredError = /** @class */ (function (_super) {
     return RequiredError;
 }(Error));
 exports.RequiredError = RequiredError;
+/**
+ *
+ * @export
+ */
 exports.operationServerMap = {};

package/dist/common.d.ts

@@ -12,23 +12,54 @@
 import type { Configuration } from "./configuration";
 import type { RequestArgs } from "./base";
 import type { AxiosInstance, AxiosResponse } from 'axios';
+/**
+ *
+ * @export
+ */
 export declare const DUMMY_BASE_URL = "https://example.com";
 /**
  *
  * @throws {RequiredError}
+ * @export
  */
 export declare const assertParamExists: (functionName: string, paramName: string, paramValue: unknown) => void;
+/**
+ *
+ * @export
+ */
 export declare const setApiKeyToObject: (object: any, keyParamName: string, configuration?: Configuration) => Promise<void>;
+/**
+ *
+ * @export
+ */
 export declare const setBasicAuthToObject: (object: any, configuration?: Configuration) => void;
+/**
+ *
+ * @export
+ */
 export declare const setBearerAuthToObject: (object: any, configuration?: Configuration) => Promise<void>;
+/**
+ *
+ * @export
+ */
 export declare const setOAuthToObject: (object: any, name: string, scopes: string[], configuration?: Configuration) => Promise<void>;
+/**
+ *
+ * @export
+ */
 export declare const setSearchParams: (url: URL, ...objects: any[]) => void;
 /**
- * JSON serialization helper function which replaces instances of unserializable types with serializable ones.
- * This function will run for every key-value pair encountered by JSON.stringify while traversing an object.
- * Converting a set to a string will return an empty object, so an intermediate conversion to an array is required.
+ *
+ * @export
  */
-export declare const replaceWithSerializableTypeIfNeeded: (key: string, value: any) => any;
 export declare const serializeDataIfNeeded: (value: any, requestOptions: any, configuration?: Configuration) => any;
+/**
+ *
+ * @export
+ */
 export declare const toPathString: (url: URL) => string;
+/**
+ *
+ * @export
+ */
 export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;

package/dist/common.js

@@ -60,12 +60,17 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     }
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createRequestFunction = exports.toPathString = exports.serializeDataIfNeeded = exports.replaceWithSerializableTypeIfNeeded = exports.setSearchParams = exports.setOAuthToObject = exports.setBearerAuthToObject = exports.setBasicAuthToObject = exports.setApiKeyToObject = exports.assertParamExists = exports.DUMMY_BASE_URL = void 0;
+exports.createRequestFunction = exports.toPathString = exports.serializeDataIfNeeded = exports.setSearchParams = exports.setOAuthToObject = exports.setBearerAuthToObject = exports.setBasicAuthToObject = exports.setApiKeyToObject = exports.assertParamExists = exports.DUMMY_BASE_URL = void 0;
 var base_1 = require("./base");
+/**
+ *
+ * @export
+ */
 exports.DUMMY_BASE_URL = 'https://example.com';
 /**
  *
  * @throws {RequiredError}
+ * @export
  */
 var assertParamExists = function (functionName, paramName, paramValue) {
     if (paramValue === null || paramValue === undefined) {
@@ -73,6 +78,10 @@ var assertParamExists = function (functionName, paramName, paramValue) {
     }
 };
 exports.assertParamExists = assertParamExists;
+/**
+ *
+ * @export
+ */
 var setApiKeyToObject = function (object, keyParamName, configuration) {
     return __awaiter(this, void 0, void 0, function () {
         var localVarApiKeyValue, _a;
@@ -99,12 +108,20 @@ var setApiKeyToObject = function (object, keyParamName, configuration) {
     });
 };
 exports.setApiKeyToObject = setApiKeyToObject;
+/**
+ *
+ * @export
+ */
 var setBasicAuthToObject = function (object, configuration) {
     if (configuration && (configuration.username || configuration.password)) {
         object["auth"] = { username: configuration.username, password: configuration.password };
     }
 };
 exports.setBasicAuthToObject = setBasicAuthToObject;
+/**
+ *
+ * @export
+ */
 var setBearerAuthToObject = function (object, configuration) {
     return __awaiter(this, void 0, void 0, function () {
         var accessToken, _a;
@@ -131,6 +148,10 @@ var setBearerAuthToObject = function (object, configuration) {
     });
 };
 exports.setBearerAuthToObject = setBearerAuthToObject;
+/**
+ *
+ * @export
+ */
 var setOAuthToObject = function (object, name, scopes, configuration) {
     return __awaiter(this, void 0, void 0, function () {
         var localVarAccessTokenValue, _a;
@@ -162,7 +183,7 @@ function setFlattenedQueryParams(urlSearchParams, parameter, key) {
     if (parameter == null)
         return;
     if (typeof parameter === "object") {
-        if (Array.isArray(parameter) || parameter instanceof Set) {
+        if (Array.isArray(parameter)) {
             parameter.forEach(function (item) { return setFlattenedQueryParams(urlSearchParams, item, key); });
         }
         else {
@@ -180,6 +201,10 @@ function setFlattenedQueryParams(urlSearchParams, parameter, key) {
         }
     }
 }
+/**
+ *
+ * @export
+ */
 var setSearchParams = function (url) {
     var objects = [];
     for (var _i = 1; _i < arguments.length; _i++) {
@@ -191,34 +216,31 @@ var setSearchParams = function (url) {
 };
 exports.setSearchParams = setSearchParams;
 /**
- * JSON serialization helper function which replaces instances of unserializable types with serializable ones.
- * This function will run for every key-value pair encountered by JSON.stringify while traversing an object.
- * Converting a set to a string will return an empty object, so an intermediate conversion to an array is required.
+ *
+ * @export
  */
-// @ts-ignore
-var replaceWithSerializableTypeIfNeeded = function (key, value) {
-    if (value instanceof Set) {
-        return Array.from(value);
-    }
-    else {
-        return value;
-    }
-};
-exports.replaceWithSerializableTypeIfNeeded = replaceWithSerializableTypeIfNeeded;
 var serializeDataIfNeeded = function (value, requestOptions, configuration) {
     var nonString = typeof value !== 'string';
     var needsSerialization = nonString && configuration && configuration.isJsonMime
         ? configuration.isJsonMime(requestOptions.headers['Content-Type'])
         : nonString;
     return needsSerialization
-        ? JSON.stringify(value !== undefined ? value : {}, exports.replaceWithSerializableTypeIfNeeded)
+        ? JSON.stringify(value !== undefined ? value : {})
         : (value || "");
 };
 exports.serializeDataIfNeeded = serializeDataIfNeeded;
+/**
+ *
+ * @export
+ */
 var toPathString = function (url) {
     return url.pathname + url.search + url.hash;
 };
 exports.toPathString = toPathString;
+/**
+ *
+ * @export
+ */
 var createRequestFunction = function (axiosArgs, globalAxios, BASE_PATH, configuration) {
     return function (axios, basePath) {
         var _a;

package/dist/configuration.d.ts

@@ -9,23 +9,11 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-interface AWSv4Configuration {
-    options?: {
-        region?: string;
-        service?: string;
-    };
-    credentials?: {
-        accessKeyId?: string;
-        secretAccessKey?: string;
-        sessionToken?: string;
-    };
-}
 export interface ConfigurationParameters {
     apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
     username?: string;
     password?: string;
     accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
-    awsv4?: AWSv4Configuration;
     basePath?: string;
     serverIndex?: number;
     baseOptions?: any;
@@ -35,43 +23,49 @@ export declare class Configuration {
     /**
      * parameter for apiKey security
      * @param name security name
+     * @memberof Configuration
      */
     apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
     /**
      * parameter for basic security
+     *
+     * @type {string}
+     * @memberof Configuration
      */
     username?: string;
     /**
      * parameter for basic security
+     *
+     * @type {string}
+     * @memberof Configuration
      */
     password?: string;
     /**
      * parameter for oauth2 security
      * @param name security name
      * @param scopes oauth2 scope
-     */
-    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
-    /**
-     * parameter for aws4 signature security
-     * @param {Object} AWS4Signature - AWS4 Signature security
-     * @param {string} options.region - aws region
-     * @param {string} options.service - name of the service.
-     * @param {string} credentials.accessKeyId - aws access key id
-     * @param {string} credentials.secretAccessKey - aws access key
-     * @param {string} credentials.sessionToken - aws session token
      * @memberof Configuration
      */
-    awsv4?: AWSv4Configuration;
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
     /**
      * override base path
+     *
+     * @type {string}
+     * @memberof Configuration
      */
     basePath?: string;
     /**
      * override server index
+     *
+     * @type {number}
+     * @memberof Configuration
      */
     serverIndex?: number;
     /**
      * base options for axios calls
+     *
+     * @type {any}
+     * @memberof Configuration
      */
     baseOptions?: any;
     /**
@@ -95,4 +89,3 @@ export declare class Configuration {
      */
     isJsonMime(mime: string): boolean;
 }
-export {};

package/dist/configuration.js

@@ -1,5 +1,6 @@
 "use strict";
 /* tslint:disable */
+/* eslint-disable */
 /**
  * Yellowgrid
  * Welcome to the Yellowgrid API documentation.      This API provides secure and comprehensive access to the Yellowgrid platform, enabling developers and integrators to manage accounts, contacts, SIP trunks, SMS messaging, 3CX integrations, and provisioning services.      ## Key Features:    - **Accounts**: View and manage account details, contacts, client credentials, and verification.    - **Provisioning**: Automate setup and configuration of devices and groups.    - **SIP Trunks**: Manage trunk creation, changes, DDIs, diverts, and configuration.    - **Messaging**: Send SMS messages securely via the messaging gateway.    - **3CX Integrations**: Automate licence handling, installation, and multi-tenant setup.      ## Authentication:    The API supports OAuth 2.0 for authentication and authorization. Ensure you use a valid bearer token for all authenticated endpoints.            ## Base URL:    `https://api.local.yellowgrid.co.uk`                  For questions or technical support, please contact support@yellowgrid.co.uk.
@@ -32,7 +33,6 @@ var Configuration = /** @class */ (function () {
         this.username = param.username;
         this.password = param.password;
         this.accessToken = param.accessToken;
-        this.awsv4 = param.awsv4;
         this.basePath = param.basePath;
         this.serverIndex = param.serverIndex;
         this.baseOptions = __assign(__assign({}, param.baseOptions), { headers: __assign({}, (_a = param.baseOptions) === null || _a === void 0 ? void 0 : _a.headers) });
@@ -49,8 +49,8 @@ var Configuration = /** @class */ (function () {
      * @return True if the given MIME is JSON, false otherwise.
      */
     Configuration.prototype.isJsonMime = function (mime) {
-        var jsonMime = /^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$/i;
-        return mime !== null && jsonMime.test(mime);
+        var jsonMime = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i');
+        return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json');
     };
     return Configuration;
 }());

package/dist/models/GroupEnum.d.ts

@@ -0,0 +1,43 @@
+export declare const GroupEnum: {
+    readonly ACCOUNTS: {
+        readonly name: "ACCOUNTS";
+        readonly value: "Accounts";
+        readonly publicValue: "Accounts";
+    };
+    readonly ALL: {
+        readonly name: "ALL";
+        readonly value: "All";
+        readonly publicValue: "All";
+    };
+    readonly BOARD: {
+        readonly name: "BOARD";
+        readonly value: "Board";
+        readonly publicValue: "Board";
+    };
+    readonly DEVELOPMENT: {
+        readonly name: "DEVELOPMENT";
+        readonly value: "Development";
+        readonly publicValue: "Development";
+    };
+    readonly SALES_MARKETING: {
+        readonly name: "SALES_MARKETING";
+        readonly value: "SalesMarketing";
+        readonly publicValue: "SalesMarketing";
+    };
+    readonly TELEPHONY: {
+        readonly name: "TELEPHONY";
+        readonly value: "Telephony";
+        readonly publicValue: "Telephony";
+    };
+    readonly TELESALES: {
+        readonly name: "TELESALES";
+        readonly value: "Telesales";
+        readonly publicValue: "Telesales";
+    };
+    readonly TECH: {
+        readonly name: "TECH";
+        readonly value: "Tech";
+        readonly publicValue: "Tech";
+    };
+};
+export type GroupEnum = typeof GroupEnum;

package/dist/models/GroupEnum.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GroupEnum = void 0;
+exports.GroupEnum = {
+    "ACCOUNTS": {
+        "name": "ACCOUNTS",
+        "value": "Accounts",
+        "publicValue": "Accounts"
+    },
+    "ALL": {
+        "name": "ALL",
+        "value": "All",
+        "publicValue": "All"
+    },
+    "BOARD": {
+        "name": "BOARD",
+        "value": "Board",
+        "publicValue": "Board"
+    },
+    "DEVELOPMENT": {
+        "name": "DEVELOPMENT",
+        "value": "Development",
+        "publicValue": "Development"
+    },
+    "SALES_MARKETING": {
+        "name": "SALES_MARKETING",
+        "value": "SalesMarketing",
+        "publicValue": "SalesMarketing"
+    },
+    "TELEPHONY": {
+        "name": "TELEPHONY",
+        "value": "Telephony",
+        "publicValue": "Telephony"
+    },
+    "TELESALES": {
+        "name": "TELESALES",
+        "value": "Telesales",
+        "publicValue": "Telesales"
+    },
+    "TECH": {
+        "name": "TECH",
+        "value": "Tech",
+        "publicValue": "Tech"
+    }
+};

package/dist/models/ReportEnum.d.ts

@@ -7,7 +7,7 @@ export declare const ReportEnum: {
     readonly POS: {
         readonly name: "POS";
         readonly value: 2;
-        readonly publicValue: "POS";
+        readonly publicValue: "Fanvil POS";
     };
     readonly CUSTOMER_SPEND: {
         readonly name: "CUSTOMER_SPEND";
@@ -64,5 +64,10 @@ export declare const ReportEnum: {
         readonly value: 13;
         readonly publicValue: "Billing - Unconnected Services";
     };
+    readonly TCX_VALUE_ADD: {
+        readonly name: "TCX_VALUE_ADD";
+        readonly value: 14;
+        readonly publicValue: "3CX Value Add";
+    };
 };
 export type ReportEnum = typeof ReportEnum;

package/dist/models/ReportEnum.js

@@ -10,7 +10,7 @@ exports.ReportEnum = {
     "POS": {
         "name": "POS",
         "value": 2,
-        "publicValue": "POS"
+        "publicValue": "Fanvil POS"
     },
     "CUSTOMER_SPEND": {
         "name": "CUSTOMER_SPEND",
@@ -66,5 +66,10 @@ exports.ReportEnum = {
         "name": "BILLING_UNCONNECTED_SERVICES",
         "value": 13,
         "publicValue": "Billing - Unconnected Services"
+    },
+    "TCX_VALUE_ADD": {
+        "name": "TCX_VALUE_ADD",
+        "value": 14,
+        "publicValue": "3CX Value Add"
     }
 };

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 | [default to undefined]
 **shippingService** | [**ShippingServiceDTO**](ShippingServiceDTO.md) |  | [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 | [default to undefined]
 **quote** | **boolean** | Quote | [default to undefined]
 

package/docs/AdminOrderRequestDTO.md

@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 **items** | [**Array<DetailedItemRequestDTO>**](DetailedItemRequestDTO.md) | Items | [default to undefined]
 **shippingService** | [**ShippingServiceDTO**](ShippingServiceDTO.md) |  | [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 | [default to undefined]
 **quote** | **boolean** | Quote | [default to undefined]
 **customerId** | **number** | Customer ID | [optional] [default to undefined]

package/docs/BrandedVideoSummaryDTO.md

@@ -15,8 +15,8 @@ Name | Type | Description | Notes
 **website** | **string** | Website | [default to undefined]
 **telephone** | **string** | Telephone | [default to undefined]
 **invoiceNumber** | **string** | Invoice Number | [optional] [default to undefined]
-**requestDate** | **string** | Request Date | [optional] [default to undefined]
-**dueDate** | **string** | Due Date | [optional] [default to undefined]
+**requestDate** | **string** | Date Time | [optional] [default to undefined]
+**dueDate** | **string** | Date Time | [optional] [default to undefined]
 **oneDriveId** | **string** | OneDrive ID | [optional] [default to undefined]
 **status** | **string** | Status | [default to undefined]
 **notes** | **string** | Notes | [default to undefined]

package/docs/CRMApi.md

@@ -7,6 +7,7 @@ All URIs are relative to *https://api.local.yellowgrid.co.uk*
 |[**getGetCrmActivities**](#getgetcrmactivities) | **GET** /admin/crm/{id}/activities | |
 |[**getSearchByPhone**](#getsearchbyphone) | **GET** /crm/contact/search | |
 |[**postCreateCrmNote**](#postcreatecrmnote) | **POST** /admin/crm/{id}/activities/note | |
+|[**postJournalCall**](#postjournalcall) | **POST** /crm/contact/{id}/journal | |
 
 # **getGetCrmActivities**
 > CrmActivitiesResponseDTO getGetCrmActivities()
@@ -173,3 +174,61 @@ 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)
 
+# **postJournalCall**
+> CrmActivityDTO postJournalCall()
+
+Journal a phone call
+
+### Example
+
+```typescript
+import {
+    CRMApi,
+    Configuration,
+    CallJournalRequestModel
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new CRMApi(configuration);
+
+let id: number; //Contact ID (default to undefined)
+let callJournalRequestModel: CallJournalRequestModel; //Journal Call Request (optional)
+
+const { status, data } = await apiInstance.postJournalCall(
+    id,
+    callJournalRequestModel
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **callJournalRequestModel** | **CallJournalRequestModel**| Journal Call Request | |
+| **id** | [**number**] | Contact ID | defaults to undefined|
+
+
+### Return type
+
+**CrmActivityDTO**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | CRM Contact |  -  |
+|**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)
+