yellowgrid-api-ts 3.2.52-dev.0 → 3.2.53-dev.0

package/base.ts

@@ -21,6 +21,10 @@ import globalAxios from 'axios';
 
 export const BASE_PATH = "http://api.yellowgrid.local".replace(/\/+$/, "");
 
+/**
+ *
+ * @export
+ */
 export const COLLECTION_FORMATS = {
     csv: ",",
     ssv: " ",
@@ -28,11 +32,21 @@ export const COLLECTION_FORMATS = {
     pipes: "|",
 };
 
+/**
+ *
+ * @export
+ * @interface RequestArgs
+ */
 export interface RequestArgs {
     url: string;
     options: RawAxiosRequestConfig;
 }
 
+/**
+ *
+ * @export
+ * @class BaseAPI
+ */
 export class BaseAPI {
     protected configuration: Configuration | undefined;
 
@@ -44,6 +58,12 @@ export class BaseAPI {
     }
 };
 
+/**
+ *
+ * @export
+ * @class RequiredError
+ * @extends {Error}
+ */
 export class RequiredError extends Error {
     constructor(public field: string, msg?: string) {
         super(msg);
@@ -58,5 +78,9 @@ interface ServerMap {
     }[];
 }
 
+/**
+ *
+ * @export
+ */
 export const operationServerMap: ServerMap = {
 }

package/common.ts

@@ -12,16 +12,22 @@
  * Do not edit the class manually.
  */
 
+
 import type { Configuration } from "./configuration";
 import type { RequestArgs } from "./base";
 import type { AxiosInstance, AxiosResponse } from 'axios';
 import { RequiredError } from "./base";
 
+/**
+ *
+ * @export
+ */
 export const DUMMY_BASE_URL = 'https://example.com'
 
 /**
  *
  * @throws {RequiredError}
+ * @export
  */
 export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) {
     if (paramValue === null || paramValue === undefined) {
@@ -29,6 +35,10 @@ export const assertParamExists = function (functionName: string, paramName: stri
     }
 }
 
+/**
+ *
+ * @export
+ */
 export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) {
     if (configuration && configuration.apiKey) {
         const localVarApiKeyValue = typeof configuration.apiKey === 'function'
@@ -38,12 +48,20 @@ export const setApiKeyToObject = async function (object: any, keyParamName: stri
     }
 }
 
+/**
+ *
+ * @export
+ */
 export const setBasicAuthToObject = function (object: any, configuration?: Configuration) {
     if (configuration && (configuration.username || configuration.password)) {
         object["auth"] = { username: configuration.username, password: configuration.password };
     }
 }
 
+/**
+ *
+ * @export
+ */
 export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) {
     if (configuration && configuration.accessToken) {
         const accessToken = typeof configuration.accessToken === 'function'
@@ -53,6 +71,10 @@ export const setBearerAuthToObject = async function (object: any, configuration?
     }
 }
 
+/**
+ *
+ * @export
+ */
 export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) {
     if (configuration && configuration.accessToken) {
         const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
@@ -62,11 +84,10 @@ export const setOAuthToObject = async function (object: any, name: string, scope
     }
 }
 
-
 function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void {
     if (parameter == null) return;
     if (typeof parameter === "object") {
-        if (Array.isArray(parameter) || parameter instanceof Set) {
+        if (Array.isArray(parameter)) {
             (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key));
         }
         else {
@@ -85,6 +106,10 @@ function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: an
     }
 }
 
+/**
+ *
+ * @export
+ */
 export const setSearchParams = function (url: URL, ...objects: any[]) {
     const searchParams = new URLSearchParams(url.search);
     setFlattenedQueryParams(searchParams, objects);
@@ -92,32 +117,31 @@ export const setSearchParams = function (url: URL, ...objects: any[]) {
 }
 
 /**
- * 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 const replaceWithSerializableTypeIfNeeded = function(key: any, value: any) {
-    if (value instanceof Set) {
-        return Array.from(value);
-    } else {
-        return value;
-    }
-}
-
 export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) {
     const nonString = typeof value !== 'string';
     const needsSerialization = nonString && configuration && configuration.isJsonMime
         ? configuration.isJsonMime(requestOptions.headers['Content-Type'])
         : nonString;
     return needsSerialization
-        ? JSON.stringify(value !== undefined ? value : {}, replaceWithSerializableTypeIfNeeded)
+        ? JSON.stringify(value !== undefined ? value : {})
         : (value || "");
 }
 
+/**
+ *
+ * @export
+ */
 export const toPathString = function (url: URL) {
     return url.pathname + url.search + url.hash
 }
 
+/**
+ *
+ * @export
+ */
 export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) {
     return <T = unknown, R = AxiosResponse<T>>(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
         const axiosRequestArgs = {...axiosArgs.options, url: (axios.defaults.baseURL ? '' : configuration?.basePath ?? basePath) + axiosArgs.url};

package/configuration.ts

@@ -1,4 +1,5 @@
 /* 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.
@@ -11,24 +12,12 @@
  * 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;
@@ -39,43 +28,49 @@ export 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;
     /**
@@ -92,7 +87,6 @@ export class Configuration {
         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 = {