yellowgrid-api-ts 3.2.48 → 3.2.49-dev.0

package/dist/src/apis/PricingApi.js

@@ -0,0 +1,308 @@
+"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.
+ *
+ * The version of the OpenAPI document: 0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PostSendPriceListCategoryEnum = exports.PostSendPriceListFormatEnum = exports.PostSendPriceListTypeEnum = exports.GetGetPriceListCategoryEnum = exports.GetGetPriceListFormatEnum = exports.GetGetPriceListTypeEnum = exports.PricingApi = void 0;
+var runtime = require("../runtime");
+/**
+ *
+ */
+var PricingApi = /** @class */ (function (_super) {
+    __extends(PricingApi, _super);
+    function PricingApi() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    /**
+     * Get Price List
+     * Get Price List
+     */
+    PricingApi.prototype.getGetPriceListRaw = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, urlPath, response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (requestParameters['type'] == null) {
+                            throw new runtime.RequiredError('type', 'Required parameter "type" was null or undefined when calling getGetPriceList().');
+                        }
+                        if (requestParameters['format'] == null) {
+                            throw new runtime.RequiredError('format', 'Required parameter "format" was null or undefined when calling getGetPriceList().');
+                        }
+                        queryParameters = {};
+                        if (requestParameters['type'] != null) {
+                            queryParameters['type'] = requestParameters['type'];
+                        }
+                        if (requestParameters['format'] != null) {
+                            queryParameters['format'] = requestParameters['format'];
+                        }
+                        if (requestParameters['category'] != null) {
+                            queryParameters['category'] = requestParameters['category'];
+                        }
+                        if (requestParameters['customerId'] != null) {
+                            queryParameters['customerId'] = requestParameters['customerId'];
+                        }
+                        headerParameters = {};
+                        urlPath = "/finance/pricing/lists";
+                        return [4 /*yield*/, this.request({
+                                path: urlPath,
+                                method: 'GET',
+                                headers: headerParameters,
+                                query: queryParameters,
+                            }, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [2 /*return*/, new runtime.BlobApiResponse(response)];
+                }
+            });
+        });
+    };
+    /**
+     * Get Price List
+     * Get Price List
+     */
+    PricingApi.prototype.getGetPriceList = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.getGetPriceListRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
+    /**
+     * Send Price List
+     * Send Price List
+     */
+    PricingApi.prototype.postSendPriceListRaw = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, urlPath, response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (requestParameters['email'] == null) {
+                            throw new runtime.RequiredError('email', 'Required parameter "email" was null or undefined when calling postSendPriceList().');
+                        }
+                        if (requestParameters['customerId'] == null) {
+                            throw new runtime.RequiredError('customerId', 'Required parameter "customerId" was null or undefined when calling postSendPriceList().');
+                        }
+                        if (requestParameters['type'] == null) {
+                            throw new runtime.RequiredError('type', 'Required parameter "type" was null or undefined when calling postSendPriceList().');
+                        }
+                        if (requestParameters['format'] == null) {
+                            throw new runtime.RequiredError('format', 'Required parameter "format" was null or undefined when calling postSendPriceList().');
+                        }
+                        queryParameters = {};
+                        if (requestParameters['email'] != null) {
+                            queryParameters['email'] = requestParameters['email'];
+                        }
+                        if (requestParameters['customerId'] != null) {
+                            queryParameters['customerId'] = requestParameters['customerId'];
+                        }
+                        if (requestParameters['type'] != null) {
+                            queryParameters['type'] = requestParameters['type'];
+                        }
+                        if (requestParameters['format'] != null) {
+                            queryParameters['format'] = requestParameters['format'];
+                        }
+                        if (requestParameters['category'] != null) {
+                            queryParameters['category'] = requestParameters['category'];
+                        }
+                        headerParameters = {};
+                        urlPath = "/finance/pricing/lists/send";
+                        return [4 /*yield*/, this.request({
+                                path: urlPath,
+                                method: 'POST',
+                                headers: headerParameters,
+                                query: queryParameters,
+                            }, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [2 /*return*/, new runtime.VoidApiResponse(response)];
+                }
+            });
+        });
+    };
+    /**
+     * Send Price List
+     * Send Price List
+     */
+    PricingApi.prototype.postSendPriceList = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.postSendPriceListRaw(requestParameters, initOverrides)];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    return PricingApi;
+}(runtime.BaseAPI));
+exports.PricingApi = PricingApi;
+/**
+ * @export
+ */
+exports.GetGetPriceListTypeEnum = {
+    Products: 'Products',
+    StockProducts: 'Stock Products',
+    _3CxLicences: '3CX Licences',
+    HostedByYellowgrid: 'Hosted By Yellowgrid',
+    _3CxStarterBundle: '3CX Starter Bundle',
+    EdTechPro: 'EdTechPro',
+    Sms: 'SMS',
+    SipTrunks: 'SIP Trunks',
+    CrmIntegrations: 'CRM Integrations'
+};
+/**
+ * @export
+ */
+exports.GetGetPriceListFormatEnum = {
+    Pdf: 'pdf',
+    Json: 'json',
+    Csv: 'csv',
+    Xml: 'xml',
+    Html: 'html'
+};
+/**
+ * @export
+ */
+exports.GetGetPriceListCategoryEnum = {
+    Yealink: 'Yealink',
+    Mairdi: 'Mairdi',
+    Jabra: 'Jabra',
+    _3Cx: '3CX',
+    Fanvil: 'Fanvil',
+    Vt: 'VT',
+    Netgear: 'Netgear',
+    Algo: 'Algo',
+    YealinkHeadsets: 'Yealink Headsets',
+    YealinkDectHandsets: 'Yealink DECT Handsets',
+    YealinkDectHeadsets: 'Yealink DECT Headsets',
+    YealinkBtHeadsets: 'Yealink BT Headsets',
+    YealinkUsbWiredHeadsets: 'Yealink USB Wired Headsets',
+    YealinkMeetingRooms: 'Yealink Meeting Rooms',
+    FanvilPhones: 'Fanvil Phones',
+    FanvilHeadsets: 'Fanvil Headsets',
+    FanvilWirelessPhones: 'Fanvil Wireless Phones',
+    FanvilSecurityProducts: 'Fanvil Security Products',
+    FanvilAccessories: 'Fanvil Accessories',
+    FanvilHotelPhones: 'Fanvil Hotel Phones'
+};
+/**
+ * @export
+ */
+exports.PostSendPriceListTypeEnum = {
+    Products: 'Products',
+    StockProducts: 'Stock Products',
+    _3CxLicences: '3CX Licences',
+    HostedByYellowgrid: 'Hosted By Yellowgrid',
+    _3CxStarterBundle: '3CX Starter Bundle',
+    EdTechPro: 'EdTechPro',
+    Sms: 'SMS',
+    SipTrunks: 'SIP Trunks',
+    CrmIntegrations: 'CRM Integrations'
+};
+/**
+ * @export
+ */
+exports.PostSendPriceListFormatEnum = {
+    Pdf: 'pdf',
+    Json: 'json',
+    Csv: 'csv',
+    Xml: 'xml',
+    Html: 'html'
+};
+/**
+ * @export
+ */
+exports.PostSendPriceListCategoryEnum = {
+    Yealink: 'Yealink',
+    Mairdi: 'Mairdi',
+    Jabra: 'Jabra',
+    _3Cx: '3CX',
+    Fanvil: 'Fanvil',
+    Vt: 'VT',
+    Netgear: 'Netgear',
+    Algo: 'Algo',
+    YealinkHeadsets: 'Yealink Headsets',
+    YealinkDectHandsets: 'Yealink DECT Handsets',
+    YealinkDectHeadsets: 'Yealink DECT Headsets',
+    YealinkBtHeadsets: 'Yealink BT Headsets',
+    YealinkUsbWiredHeadsets: 'Yealink USB Wired Headsets',
+    YealinkMeetingRooms: 'Yealink Meeting Rooms',
+    FanvilPhones: 'Fanvil Phones',
+    FanvilHeadsets: 'Fanvil Headsets',
+    FanvilWirelessPhones: 'Fanvil Wireless Phones',
+    FanvilSecurityProducts: 'Fanvil Security Products',
+    FanvilAccessories: 'Fanvil Accessories',
+    FanvilHotelPhones: 'Fanvil Hotel Phones'
+};

package/dist/src/apis/ProductsApi.d.ts

@@ -0,0 +1,135 @@
+/**
+ * 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.
+ *
+ * The version of the OpenAPI document: 0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime';
+import type { AttributeSetEnum, BasicProductDTO, CustomerPriceListEnum, PostGetProductForCustomerRequest, PostGetProductRequest, ProductPriceListItemModel, ProductSearchResultsModel, ProductSummaryDTO, TcxTemplateXmlEnum } from '../models/index';
+export interface GetGetLegacyStockListRequest {
+    format: GetGetLegacyStockListFormatEnum;
+}
+export interface GetSearchProductsRequest {
+    pageSize?: number;
+    page?: number;
+    search?: string;
+}
+export interface PostGetProductOperationRequest {
+    sku: string;
+    postGetProductRequest: PostGetProductRequest;
+}
+export interface PostGetProductForCustomerOperationRequest {
+    customerId: number;
+    sku: string;
+    postGetProductForCustomerRequest: PostGetProductForCustomerRequest;
+}
+/**
+ *
+ */
+export declare class ProductsApi extends runtime.BaseAPI {
+    /**
+     * Get Attribute Sets
+     * Get Attribute Sets
+     */
+    getGetAttributeSetsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<AttributeSetEnum>>>;
+    /**
+     * Get Attribute Sets
+     * Get Attribute Sets
+     */
+    getGetAttributeSets(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<AttributeSetEnum>>;
+    /**
+     * Get Customer Price Lists
+     * Get Customer Price Lists
+     */
+    getGetCustomerPriceListsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<CustomerPriceListEnum>>>;
+    /**
+     * Get Customer Price Lists
+     * Get Customer Price Lists
+     */
+    getGetCustomerPriceLists(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<CustomerPriceListEnum>>;
+    /**
+     * Get Current Stock & Pricing
+     * Get Current Stock & Pricing
+     * @deprecated
+     */
+    getGetLegacyStockListRaw(requestParameters: GetGetLegacyStockListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
+    /**
+     * Get Current Stock & Pricing
+     * Get Current Stock & Pricing
+     * @deprecated
+     */
+    getGetLegacyStockList(requestParameters: GetGetLegacyStockListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
+    /**
+     * Get Products
+     * Get Products
+     */
+    getGetProductsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<BasicProductDTO>>>;
+    /**
+     * Get Products
+     * Get Products
+     */
+    getGetProducts(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<BasicProductDTO>>;
+    /**
+     * Get Current Stock & Pricing
+     * Get Current Stock & Pricing
+     */
+    getGetStockListRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ProductPriceListItemModel>>>;
+    /**
+     * Get Current Stock & Pricing
+     * Get Current Stock & Pricing
+     */
+    getGetStockList(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ProductPriceListItemModel>>;
+    /**
+     * Get 3CX Templates
+     * Get 3CX Templates
+     */
+    getGetTcxTemplatesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<TcxTemplateXmlEnum>>>;
+    /**
+     * Get 3CX Templates
+     * Get 3CX Templates
+     */
+    getGetTcxTemplates(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<TcxTemplateXmlEnum>>;
+    /**
+     * Search Products
+     * Search Products
+     */
+    getSearchProductsRaw(requestParameters: GetSearchProductsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProductSearchResultsModel>>;
+    /**
+     * Search Products
+     * Search Products
+     */
+    getSearchProducts(requestParameters?: GetSearchProductsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProductSearchResultsModel>;
+    /**
+     * Get Product
+     * Get Product
+     */
+    postGetProductRaw(requestParameters: PostGetProductOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProductSummaryDTO>>;
+    /**
+     * Get Product
+     * Get Product
+     */
+    postGetProduct(requestParameters: PostGetProductOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProductSummaryDTO>;
+    /**
+     * Get Product For Customer
+     * Get Product For Customer
+     */
+    postGetProductForCustomerRaw(requestParameters: PostGetProductForCustomerOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProductSummaryDTO>>;
+    /**
+     * Get Product For Customer
+     * Get Product For Customer
+     */
+    postGetProductForCustomer(requestParameters: PostGetProductForCustomerOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProductSummaryDTO>;
+}
+/**
+ * @export
+ */
+export declare const GetGetLegacyStockListFormatEnum: {
+    readonly Xml: "XML";
+    readonly Csv: "CSV";
+};
+export type GetGetLegacyStockListFormatEnum = typeof GetGetLegacyStockListFormatEnum[keyof typeof GetGetLegacyStockListFormatEnum];