yellowgrid-api-ts 3.2.30-dev.0 → 3.2.31-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 = "http://api.yellowgrid.local".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,17 +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;
+/**
+ *
+ * @export
+ */
 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

@@ -62,10 +62,15 @@ 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;
 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;
@@ -180,6 +201,10 @@ function setFlattenedQueryParams(urlSearchParams, parameter, key) {
         }
     }
 }
+/**
+ *
+ * @export
+ */
 var setSearchParams = function (url) {
     var objects = [];
     for (var _i = 1; _i < arguments.length; _i++) {
@@ -190,6 +215,10 @@ var setSearchParams = function (url) {
     url.search = searchParams.toString();
 };
 exports.setSearchParams = setSearchParams;
+/**
+ *
+ * @export
+ */
 var serializeDataIfNeeded = function (value, requestOptions, configuration) {
     var nonString = typeof value !== 'string';
     var needsSerialization = nonString && configuration && configuration.isJsonMime
@@ -200,10 +229,18 @@ var serializeDataIfNeeded = function (value, requestOptions, configuration) {
         : (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:    `http://api.yellowgrid.local`                  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) });

package/docs/ServicesApi.md

@@ -234,7 +234,7 @@ import {
 const configuration = new Configuration();
 const apiInstance = new ServicesApi(configuration);
 
-let id: string; //Group ID (default to undefined)
+let id: number; //Group ID (default to undefined)
 let eventUpdateRequestDTO: EventUpdateRequestDTO; // (optional)
 
 const { status, data } = await apiInstance.postCreateEventUpdate(
@@ -248,7 +248,7 @@ const { status, data } = await apiInstance.postCreateEventUpdate(
 |Name | Type | Description  | Notes|
 |------------- | ------------- | ------------- | -------------|
 | **eventUpdateRequestDTO** | **EventUpdateRequestDTO**|  | |
-| **id** | [**string**] | Group ID | defaults to undefined|
+| **id** | [**number**] | Group ID | defaults to undefined|
 
 
 ### Return type

package/openapitools.json

@@ -2,6 +2,6 @@
   "$schema": "./node_modules/@openapitools/openapi-generator-cli/config.schema.json",
   "spaces": 2,
   "generator-cli": {
-    "version": "7.17.0"
+    "version": "7.14.0"
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "yellowgrid-api-ts",
-  "version": "3.2.30-dev.0",
+  "version": "3.2.31-dev.0",
   "description": "OpenAPI client for yellowgrid-api-ts",
   "author": "OpenAPI-Generator Contributors",
   "repository": {

package/docs/IncidentDTO.md

@@ -1,35 +0,0 @@
-# IncidentDTO
-
-Incident DTO
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**title** | **string** | Incident Title | [optional] [default to undefined]
-**severity** | **number** | Incident Severity | [optional] [default to undefined]
-**service** | **number** | Service Impacted | [optional] [default to undefined]
-**statusName** | **string** | Incident Status Description | [optional] [default to undefined]
-**severityName** | **string** | Incident Severity Description | [optional] [default to undefined]
-**id** | **number** | Incident ID | [optional] [default to undefined]
-**status** | **number** | Incident Status | [optional] [default to undefined]
-**updates** | [**Array<IncidentUpdateDTO>**](IncidentUpdateDTO.md) | Incident Updates | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { IncidentDTO } from 'yellowgrid-api-ts';
-
-const instance: IncidentDTO = {
-    title,
-    severity,
-    service,
-    statusName,
-    severityName,
-    id,
-    status,
-    updates,
-};
-```
-
-[[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/IncidentRequestDTO.md

@@ -1,25 +0,0 @@
-# IncidentRequestDTO
-
-Incident Request DTO
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**title** | **string** | Incident Title | [optional] [default to undefined]
-**severity** | **number** | Incident Severity | [optional] [default to undefined]
-**service** | **number** | Service Impacted | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { IncidentRequestDTO } from 'yellowgrid-api-ts';
-
-const instance: IncidentRequestDTO = {
-    title,
-    severity,
-    service,
-};
-```
-
-[[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/IncidentSubscriptionModel.md

@@ -1,23 +0,0 @@
-# IncidentSubscriptionModel
-
-Incident Subscribption Model
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **string** | id | [optional] [default to undefined]
-**email** | **string** | email | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { IncidentSubscriptionModel } from 'yellowgrid-api-ts';
-
-const instance: IncidentSubscriptionModel = {
-    id,
-    email,
-};
-```
-
-[[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/IncidentUpdateDTO.md

@@ -1,27 +0,0 @@
-# IncidentUpdateDTO
-
-Incident Update DTO
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**message** | **string** | Incident Update Message | [optional] [default to undefined]
-**type** | **number** | Incident Update Type | [optional] [default to undefined]
-**typeName** | **string** | Incident Update Type Description | [optional] [default to undefined]
-**createdAt** | **string** | Date Time | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { IncidentUpdateDTO } from 'yellowgrid-api-ts';
-
-const instance: IncidentUpdateDTO = {
-    message,
-    type,
-    typeName,
-    createdAt,
-};
-```
-
-[[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/IncidentUpdateEntity.md

@@ -1,29 +0,0 @@
-# IncidentUpdateEntity
-
-IncidentUpdatesEntity
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **number** | id | [optional] [default to undefined]
-**incidentId** | **number** | incidentId | [optional] [default to undefined]
-**message** | **string** | message | [optional] [default to undefined]
-**type** | **number** | type | [optional] [default to undefined]
-**createdAt** | **string** | createdAt | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { IncidentUpdateEntity } from 'yellowgrid-api-ts';
-
-const instance: IncidentUpdateEntity = {
-    id,
-    incidentId,
-    message,
-    type,
-    createdAt,
-};
-```
-
-[[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/IncidentUpdateRequestDTO.md

@@ -1,23 +0,0 @@
-# IncidentUpdateRequestDTO
-
-Incident Update Request DTO
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**message** | **string** | Incident Update Message | [optional] [default to undefined]
-**type** | **number** | Incident Update Type | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { IncidentUpdateRequestDTO } from 'yellowgrid-api-ts';
-
-const instance: IncidentUpdateRequestDTO = {
-    message,
-    type,
-};
-```
-
-[[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/NumberPortDTO.md

@@ -1,51 +0,0 @@
-# NumberPortDTO
-
-Number Port Response
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**companyName** | **string** | Company Name | [optional] [default to undefined]
-**addressLine1** | **string** | Address Line 1 | [optional] [default to undefined]
-**addressLine2** | **string** | Address Line 2 | [optional] [default to undefined]
-**city** | **string** | City | [optional] [default to undefined]
-**postCode** | **string** | Post Code | [optional] [default to undefined]
-**trunkId** | **number** | Trunk ID | [optional] [default to undefined]
-**tenantId** | **string** | Starter Bundle ID | [optional] [default to undefined]
-**requestedPortDate** | **string** | Requested Port Date | [optional] [default to undefined]
-**asap** | **boolean** | Port Date ASAP | [optional] [default to undefined]
-**comment** | **string** | Comment | [optional] [default to undefined]
-**id** | **number** | Number Port ID | [optional] [default to undefined]
-**customerName** | **string** | Customer Name | [optional] [default to undefined]
-**portDate** | **string** | Porting Date | [optional] [default to undefined]
-**numberRanges** | [**Array<NumberPortRangeDTO>**](NumberPortRangeDTO.md) | Number Ranges | [optional] [default to undefined]
-**status** | **number** | Status | [optional] [default to undefined]
-**ticketId** | **number** | Ticket ID | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { NumberPortDTO } from 'yellowgrid-api-ts';
-
-const instance: NumberPortDTO = {
-    companyName,
-    addressLine1,
-    addressLine2,
-    city,
-    postCode,
-    trunkId,
-    tenantId,
-    requestedPortDate,
-    asap,
-    comment,
-    id,
-    customerName,
-    portDate,
-    numberRanges,
-    status,
-    ticketId,
-};
-```
-
-[[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/NumberPortEntity.md

@@ -1,47 +0,0 @@
-# NumberPortEntity
-
-NumberPortsEntity
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **number** | Number Port ID | [optional] [default to undefined]
-**customerId** | **number** | Customer ID | [optional] [default to undefined]
-**endUser** | **string** | End User | [optional] [default to undefined]
-**addressLine1** | **string** | Address Line 1 | [optional] [default to undefined]
-**addressLine2** | **string** | Address Line 2 | [optional] [default to undefined]
-**city** | **string** | City | [optional] [default to undefined]
-**postCode** | **string** | Post Code | [optional] [default to undefined]
-**trunkId** | **string** | Trunk ID | [optional] [default to undefined]
-**tenantId** | **string** | Tenant ID | [optional] [default to undefined]
-**requestedPortDate** | **string** | Requested Port Date | [optional] [default to undefined]
-**portDate** | **string** | Port Date | [optional] [default to undefined]
-**comment** | **string** | Comment | [optional] [default to undefined]
-**status** | **number** | Status | [optional] [default to undefined]
-**ticketId** | **number** | Ticket ID | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { NumberPortEntity } from 'yellowgrid-api-ts';
-
-const instance: NumberPortEntity = {
-    id,
-    customerId,
-    endUser,
-    addressLine1,
-    addressLine2,
-    city,
-    postCode,
-    trunkId,
-    tenantId,
-    requestedPortDate,
-    portDate,
-    comment,
-    status,
-    ticketId,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)