yellowgrid-api-ts 3.2.222-dev.0 → 3.2.223-dev.0

package/dist/base.d.ts

@@ -12,42 +12,22 @@
 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);
@@ -58,9 +38,5 @@ interface ServerMap {
         description: string;
     }[];
 }
-/**
- *
- * @export
- */
 export declare const operationServerMap: ServerMap;
 export {};

package/dist/base.js

@@ -31,21 +31,12 @@ 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; }
@@ -62,12 +53,6 @@ var BaseAPI = /** @class */ (function () {
 }());
 exports.BaseAPI = BaseAPI;
 ;
-/**
- *
- * @export
- * @class RequiredError
- * @extends {Error}
- */
 var RequiredError = /** @class */ (function (_super) {
     __extends(RequiredError, _super);
     function RequiredError(field, msg) {
@@ -79,8 +64,4 @@ var RequiredError = /** @class */ (function (_super) {
     return RequiredError;
 }(Error));
 exports.RequiredError = RequiredError;
-/**
- *
- * @export
- */
 exports.operationServerMap = {};

package/dist/common.d.ts

@@ -12,54 +12,23 @@
 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;
 /**
- *
- * @export
+ * 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 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,17 +60,12 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     }
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createRequestFunction = exports.toPathString = exports.serializeDataIfNeeded = 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.replaceWithSerializableTypeIfNeeded = 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) {
@@ -78,10 +73,6 @@ 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;
@@ -108,20 +99,12 @@ 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;
@@ -148,10 +131,6 @@ 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;
@@ -183,7 +162,7 @@ function setFlattenedQueryParams(urlSearchParams, parameter, key) {
     if (parameter == null)
         return;
     if (typeof parameter === "object") {
-        if (Array.isArray(parameter)) {
+        if (Array.isArray(parameter) || parameter instanceof Set) {
             parameter.forEach(function (item) { return setFlattenedQueryParams(urlSearchParams, item, key); });
         }
         else {
@@ -201,10 +180,6 @@ function setFlattenedQueryParams(urlSearchParams, parameter, key) {
         }
     }
 }
-/**
- *
- * @export
- */
 var setSearchParams = function (url) {
     var objects = [];
     for (var _i = 1; _i < arguments.length; _i++) {
@@ -216,31 +191,34 @@ var setSearchParams = function (url) {
 };
 exports.setSearchParams = setSearchParams;
 /**
- *
- * @export
+ * 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.
  */
+// @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 : {})
+        ? JSON.stringify(value !== undefined ? value : {}, exports.replaceWithSerializableTypeIfNeeded)
         : (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,11 +9,23 @@
  * 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;
@@ -23,49 +35,43 @@ 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
-     * @memberof Configuration
      */
     accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
     /**
-     * override base path
-     *
-     * @type {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;
+    /**
+     * override base path
+     */
     basePath?: string;
     /**
      * override server index
-     *
-     * @type {number}
-     * @memberof Configuration
      */
     serverIndex?: number;
     /**
      * base options for axios calls
-     *
-     * @type {any}
-     * @memberof Configuration
      */
     baseOptions?: any;
     /**
@@ -89,3 +95,4 @@ export declare class Configuration {
      */
     isJsonMime(mime: string): boolean;
 }
+export {};

package/dist/configuration.js

@@ -1,6 +1,5 @@
 "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.
@@ -33,6 +32,7 @@ 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 = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i');
-        return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json');
+        var jsonMime = /^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$/i;
+        return mime !== null && jsonMime.test(mime);
     };
     return Configuration;
 }());

package/dist/models/ConnectionTypeEnum.d.ts

@@ -0,0 +1,63 @@
+export declare const ConnectionTypeEnum: {
+    readonly SIP_TRUNK: {
+        readonly name: "SIP_TRUNK";
+        readonly value: "SIP Trunks";
+        readonly publicValue: "SIP Trunks";
+    };
+    readonly BROADBAND: {
+        readonly name: "BROADBAND";
+        readonly value: "Broadband";
+        readonly publicValue: "Broadband";
+    };
+    readonly ETHERNET: {
+        readonly name: "ETHERNET";
+        readonly value: "Ethernet";
+        readonly publicValue: "Ethernet";
+    };
+    readonly MOBILE: {
+        readonly name: "MOBILE";
+        readonly value: "Mobile";
+        readonly publicValue: "Mobile";
+    };
+    readonly WLR: {
+        readonly name: "WLR";
+        readonly value: "WLR";
+        readonly publicValue: "WLR";
+    };
+    readonly HZN: {
+        readonly name: "HZN";
+        readonly value: "Horizon";
+        readonly publicValue: "Horizon";
+    };
+    readonly NTS: {
+        readonly name: "NTS";
+        readonly value: "NTS";
+        readonly publicValue: "NTS";
+    };
+    readonly HOSTING: {
+        readonly name: "HOSTING";
+        readonly value: "Hosting";
+        readonly publicValue: "Hosting";
+    };
+    readonly CRM: {
+        readonly name: "CRM";
+        readonly value: "CRM";
+        readonly publicValue: "CRM";
+    };
+    readonly TCX_MULTITENANT: {
+        readonly name: "TCX_MULTITENANT";
+        readonly value: "Starter Bundle";
+        readonly publicValue: "Starter Bundle";
+    };
+    readonly OTHER: {
+        readonly name: "OTHER";
+        readonly value: "Other";
+        readonly publicValue: "Other";
+    };
+    readonly RECURRING_CHARGES: {
+        readonly name: "RECURRING_CHARGES";
+        readonly value: "Recurring Charges";
+        readonly publicValue: "Recurring Charges";
+    };
+};
+export type ConnectionTypeEnum = typeof ConnectionTypeEnum;

package/dist/models/ConnectionTypeEnum.js

@@ -0,0 +1,65 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConnectionTypeEnum = void 0;
+exports.ConnectionTypeEnum = {
+    "SIP_TRUNK": {
+        "name": "SIP_TRUNK",
+        "value": "SIP Trunks",
+        "publicValue": "SIP Trunks"
+    },
+    "BROADBAND": {
+        "name": "BROADBAND",
+        "value": "Broadband",
+        "publicValue": "Broadband"
+    },
+    "ETHERNET": {
+        "name": "ETHERNET",
+        "value": "Ethernet",
+        "publicValue": "Ethernet"
+    },
+    "MOBILE": {
+        "name": "MOBILE",
+        "value": "Mobile",
+        "publicValue": "Mobile"
+    },
+    "WLR": {
+        "name": "WLR",
+        "value": "WLR",
+        "publicValue": "WLR"
+    },
+    "HZN": {
+        "name": "HZN",
+        "value": "Horizon",
+        "publicValue": "Horizon"
+    },
+    "NTS": {
+        "name": "NTS",
+        "value": "NTS",
+        "publicValue": "NTS"
+    },
+    "HOSTING": {
+        "name": "HOSTING",
+        "value": "Hosting",
+        "publicValue": "Hosting"
+    },
+    "CRM": {
+        "name": "CRM",
+        "value": "CRM",
+        "publicValue": "CRM"
+    },
+    "TCX_MULTITENANT": {
+        "name": "TCX_MULTITENANT",
+        "value": "Starter Bundle",
+        "publicValue": "Starter Bundle"
+    },
+    "OTHER": {
+        "name": "OTHER",
+        "value": "Other",
+        "publicValue": "Other"
+    },
+    "RECURRING_CHARGES": {
+        "name": "RECURRING_CHARGES",
+        "value": "Recurring Charges",
+        "publicValue": "Recurring Charges"
+    }
+};

package/dist/models/ReasonEnum.d.ts

@@ -0,0 +1,23 @@
+export declare const ReasonEnum: {
+    readonly DOA: {
+        readonly name: "DOA";
+        readonly value: 1;
+        readonly publicValue: "Doa";
+    };
+    readonly FAULTY: {
+        readonly name: "FAULTY";
+        readonly value: 2;
+        readonly publicValue: "Faulty";
+    };
+    readonly WORKING_GOOD_CONDITION: {
+        readonly name: "WORKING_GOOD_CONDITION";
+        readonly value: 3;
+        readonly publicValue: "Working Good Condition";
+    };
+    readonly WORKING_BAD_CONDITION: {
+        readonly name: "WORKING_BAD_CONDITION";
+        readonly value: 4;
+        readonly publicValue: "Working Bad Condition";
+    };
+};
+export type ReasonEnum = typeof ReasonEnum;

package/dist/models/ReasonEnum.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReasonEnum = void 0;
+exports.ReasonEnum = {
+    "DOA": {
+        "name": "DOA",
+        "value": 1,
+        "publicValue": "Doa"
+    },
+    "FAULTY": {
+        "name": "FAULTY",
+        "value": 2,
+        "publicValue": "Faulty"
+    },
+    "WORKING_GOOD_CONDITION": {
+        "name": "WORKING_GOOD_CONDITION",
+        "value": 3,
+        "publicValue": "Working Good Condition"
+    },
+    "WORKING_BAD_CONDITION": {
+        "name": "WORKING_BAD_CONDITION",
+        "value": 4,
+        "publicValue": "Working Bad Condition"
+    }
+};

package/dist/models/ResolutionEnum.d.ts

@@ -0,0 +1,18 @@
+export declare const ResolutionEnum: {
+    readonly REPLACEMENT: {
+        readonly name: "REPLACEMENT";
+        readonly value: 1;
+        readonly publicValue: "Replacement";
+    };
+    readonly CREDIT: {
+        readonly name: "CREDIT";
+        readonly value: 2;
+        readonly publicValue: "Credit";
+    };
+    readonly ADVANCE_REPLACEMENT: {
+        readonly name: "ADVANCE_REPLACEMENT";
+        readonly value: 3;
+        readonly publicValue: "Advance Replacement";
+    };
+};
+export type ResolutionEnum = typeof ResolutionEnum;

package/dist/models/ResolutionEnum.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ResolutionEnum = void 0;
+exports.ResolutionEnum = {
+    "REPLACEMENT": {
+        "name": "REPLACEMENT",
+        "value": 1,
+        "publicValue": "Replacement"
+    },
+    "CREDIT": {
+        "name": "CREDIT",
+        "value": 2,
+        "publicValue": "Credit"
+    },
+    "ADVANCE_REPLACEMENT": {
+        "name": "ADVANCE_REPLACEMENT",
+        "value": 3,
+        "publicValue": "Advance Replacement"
+    }
+};

package/dist/models/RmaItemCreditTypeEnum.d.ts

@@ -0,0 +1,13 @@
+export declare const RmaItemCreditTypeEnum: {
+    readonly FULL: {
+        readonly name: "FULL";
+        readonly value: 100;
+        readonly publicValue: "Full";
+    };
+    readonly RESTOCKING_FEE: {
+        readonly name: "RESTOCKING_FEE";
+        readonly value: 85;
+        readonly publicValue: "Restocking Fee";
+    };
+};
+export type RmaItemCreditTypeEnum = typeof RmaItemCreditTypeEnum;

package/dist/models/RmaItemCreditTypeEnum.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RmaItemCreditTypeEnum = void 0;
+exports.RmaItemCreditTypeEnum = {
+    "FULL": {
+        "name": "FULL",
+        "value": 100,
+        "publicValue": "Full"
+    },
+    "RESTOCKING_FEE": {
+        "name": "RESTOCKING_FEE",
+        "value": 85,
+        "publicValue": "Restocking Fee"
+    }
+};

package/dist/models/RmaItemResolutionEnum.d.ts

@@ -0,0 +1,28 @@
+export declare const RmaItemResolutionEnum: {
+    readonly UNRESOLVED: {
+        readonly name: "UNRESOLVED";
+        readonly value: 1;
+        readonly publicValue: "Unresolved";
+    };
+    readonly REPLACED: {
+        readonly name: "REPLACED";
+        readonly value: 2;
+        readonly publicValue: "Replaced";
+    };
+    readonly CREDITED: {
+        readonly name: "CREDITED";
+        readonly value: 3;
+        readonly publicValue: "Credited";
+    };
+    readonly RETURNED: {
+        readonly name: "RETURNED";
+        readonly value: 4;
+        readonly publicValue: "Returned";
+    };
+    readonly BINNED: {
+        readonly name: "BINNED";
+        readonly value: 5;
+        readonly publicValue: "Binned";
+    };
+};
+export type RmaItemResolutionEnum = typeof RmaItemResolutionEnum;