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

package/dist/src/models/index.js

@@ -0,0 +1,214 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/* tslint:disable */
+/* eslint-disable */
+__exportStar(require("./AbstractOrderRequestDTO"), exports);
+__exportStar(require("./AccountContactEntity"), exports);
+__exportStar(require("./AccountContactModel"), exports);
+__exportStar(require("./AccountContactRequestModel"), exports);
+__exportStar(require("./AccountDetailedSummaryDTO"), exports);
+__exportStar(require("./AccountRequestModel"), exports);
+__exportStar(require("./AccountSummaryDTO"), exports);
+__exportStar(require("./AccountsResponseModel"), exports);
+__exportStar(require("./AddressModel"), exports);
+__exportStar(require("./AddressRequestModel"), exports);
+__exportStar(require("./AdminOrderRequestDTO"), exports);
+__exportStar(require("./AdminUserModel"), exports);
+__exportStar(require("./AgentHoursGraphModel"), exports);
+__exportStar(require("./AgentHoursGraphMonthModel"), exports);
+__exportStar(require("./ApiLogEntity"), exports);
+__exportStar(require("./AreaCodeModel"), exports);
+__exportStar(require("./AttachmentModel"), exports);
+__exportStar(require("./AttributeSetEnum"), exports);
+__exportStar(require("./AuditLogEntity"), exports);
+__exportStar(require("./AuthCodeResponseModel"), exports);
+__exportStar(require("./BasicItemDTO"), exports);
+__exportStar(require("./BasicProductDTO"), exports);
+__exportStar(require("./BatchEntity"), exports);
+__exportStar(require("./CallBarringModel"), exports);
+__exportStar(require("./ClientDetailsModel"), exports);
+__exportStar(require("./ClientModel"), exports);
+__exportStar(require("./CompanyContractModel"), exports);
+__exportStar(require("./ContactInfoModel"), exports);
+__exportStar(require("./ConversationModel"), exports);
+__exportStar(require("./CourierPriceEntity"), exports);
+__exportStar(require("./CreditAccountEntity"), exports);
+__exportStar(require("./CrmContactDTO"), exports);
+__exportStar(require("./CustomerInformationModel"), exports);
+__exportStar(require("./CustomerItemRequestDTO"), exports);
+__exportStar(require("./CustomerOrderRequestDTO"), exports);
+__exportStar(require("./CustomerPriceListEnum"), exports);
+__exportStar(require("./CustomerSummaryReportDTO"), exports);
+__exportStar(require("./DdiRangeRequestModel"), exports);
+__exportStar(require("./DdiRangesRequestModel"), exports);
+__exportStar(require("./DetailedItemRequestDTO"), exports);
+__exportStar(require("./DetailedOrderRequestDTO"), exports);
+__exportStar(require("./DivertRequestModel"), exports);
+__exportStar(require("./DivertResponseModel"), exports);
+__exportStar(require("./EdTechProClientEntity"), exports);
+__exportStar(require("./EdTechProSchoolModel"), exports);
+__exportStar(require("./EdTechProSchoolsModel"), exports);
+__exportStar(require("./EdTechProSetupModel"), exports);
+__exportStar(require("./EventDTO"), exports);
+__exportStar(require("./EventRequestDTO"), exports);
+__exportStar(require("./EventSubscriptionModel"), exports);
+__exportStar(require("./EventUpdateDTO"), exports);
+__exportStar(require("./EventUpdateEntity"), exports);
+__exportStar(require("./EventUpdateRequestDTO"), exports);
+__exportStar(require("./FraudManagementModel"), exports);
+__exportStar(require("./FreshdeskCompanyTicketsModel"), exports);
+__exportStar(require("./FreshdeskTicketEntity"), exports);
+__exportStar(require("./FtpAccountsEntity"), exports);
+__exportStar(require("./GenericFileModel"), exports);
+__exportStar(require("./GetGetPrice200Response"), exports);
+__exportStar(require("./GetGetRecording200Response"), exports);
+__exportStar(require("./HostingChangeResponseModel"), exports);
+__exportStar(require("./HostingRegionDTO"), exports);
+__exportStar(require("./InstanceAutoFailoverEntity"), exports);
+__exportStar(require("./InstanceDeletionScheduleEntity"), exports);
+__exportStar(require("./InstanceEntity"), exports);
+__exportStar(require("./InstanceFailoverEntity"), exports);
+__exportStar(require("./InstanceMonitoringEntity"), exports);
+__exportStar(require("./InstanceMonitoringLogEntity"), exports);
+__exportStar(require("./InstanceScheduledTasksEntity"), exports);
+__exportStar(require("./InstanceTcxDetailsEntity"), exports);
+__exportStar(require("./InstanceUserCredentialsEntity"), exports);
+__exportStar(require("./ItemDTO"), exports);
+__exportStar(require("./ItemDiscountEntity"), exports);
+__exportStar(require("./ItemEntity"), exports);
+__exportStar(require("./LinkedOrderEntity"), exports);
+__exportStar(require("./MFARequiredModel"), exports);
+__exportStar(require("./MonthlyUsageModel"), exports);
+__exportStar(require("./MultiTenantChangeResponseModel"), exports);
+__exportStar(require("./NavigationModel"), exports);
+__exportStar(require("./OfflineInstancesEntity"), exports);
+__exportStar(require("./OrderEntity"), exports);
+__exportStar(require("./OrderRequestModel"), exports);
+__exportStar(require("./OrderSummariesModel"), exports);
+__exportStar(require("./OrderSummaryDTO"), exports);
+__exportStar(require("./OrderTotalModel"), exports);
+__exportStar(require("./OrderedItemEntity"), exports);
+__exportStar(require("./PatchSetTcxWizardCnameRequest"), exports);
+__exportStar(require("./PatchUpdateAccountContactPasswordRequest"), exports);
+__exportStar(require("./PortalAccountModel"), exports);
+__exportStar(require("./PortalLoginModel"), exports);
+__exportStar(require("./PostAddWebhook200Response"), exports);
+__exportStar(require("./PostGetClientCredentialsRequest"), exports);
+__exportStar(require("./PostGetProductForCustomerRequest"), exports);
+__exportStar(require("./PostGetProductRequest"), exports);
+__exportStar(require("./PriceListItemModel"), exports);
+__exportStar(require("./PrizesEntity"), exports);
+__exportStar(require("./ProductPriceListItemModel"), exports);
+__exportStar(require("./ProductSearchResultsModel"), exports);
+__exportStar(require("./ProductSerialInfoModel"), exports);
+__exportStar(require("./ProductSummaryDTO"), exports);
+__exportStar(require("./PromoCodesEntity"), exports);
+__exportStar(require("./PromoItemsEntity"), exports);
+__exportStar(require("./ProvisioningModel"), exports);
+__exportStar(require("./ProvisioningRequestEntity"), exports);
+__exportStar(require("./RecordingBackupAzureModel"), exports);
+__exportStar(require("./RecordingsBackupInfoDTO"), exports);
+__exportStar(require("./ResourceNotReadyException"), exports);
+__exportStar(require("./RootAccessModel"), exports);
+__exportStar(require("./S3BucketEntity"), exports);
+__exportStar(require("./ScannedItemModel"), exports);
+__exportStar(require("./ScopeModel"), exports);
+__exportStar(require("./ServiceHealthDTO"), exports);
+__exportStar(require("./ServiceStatusDTO"), exports);
+__exportStar(require("./ShipmentAddressEntity"), exports);
+__exportStar(require("./ShipmentEntity"), exports);
+__exportStar(require("./ShipmentItemEntity"), exports);
+__exportStar(require("./ShippingConsignmentModel"), exports);
+__exportStar(require("./ShippingInformationDTO"), exports);
+__exportStar(require("./ShippingServiceDTO"), exports);
+__exportStar(require("./ShippingServiceModel"), exports);
+__exportStar(require("./ShippingServicesModel"), exports);
+__exportStar(require("./SipTrunkChangeResponseModel"), exports);
+__exportStar(require("./SipTrunkCreationRequestModel"), exports);
+__exportStar(require("./SipTrunkEntity"), exports);
+__exportStar(require("./SipTrunksResponseModel"), exports);
+__exportStar(require("./SmsAccountEntity"), exports);
+__exportStar(require("./SmsDataModel"), exports);
+__exportStar(require("./SmsMessageModel"), exports);
+__exportStar(require("./SmsNumbersEntity"), exports);
+__exportStar(require("./SmsPayloadModel"), exports);
+__exportStar(require("./SmsPhoneNumberModel"), exports);
+__exportStar(require("./SmsResponseModel"), exports);
+__exportStar(require("./SmsWhitelistEntity"), exports);
+__exportStar(require("./StockOrderCourierEntity"), exports);
+__exportStar(require("./StockOrderDeductionModel"), exports);
+__exportStar(require("./StockOrderDeductionRequestModel"), exports);
+__exportStar(require("./StockOrderDeductionsEntity"), exports);
+__exportStar(require("./StockOrderEntity"), exports);
+__exportStar(require("./StockOrderItemEntity"), exports);
+__exportStar(require("./StockOrderItemModel"), exports);
+__exportStar(require("./StockOrderItemRequestModel"), exports);
+__exportStar(require("./StockOrderModel"), exports);
+__exportStar(require("./StockOrderProductEntity"), exports);
+__exportStar(require("./StockOrderRequestModel"), exports);
+__exportStar(require("./StockOrderSupplierEntity"), exports);
+__exportStar(require("./StockOrderSupplierModel"), exports);
+__exportStar(require("./StockOrdersModel"), exports);
+__exportStar(require("./StockProductModel"), exports);
+__exportStar(require("./StockProductPriceModel"), exports);
+__exportStar(require("./StockProductSummariesModel"), exports);
+__exportStar(require("./StockProductSummaryModel"), exports);
+__exportStar(require("./StockTransactionsEntity"), exports);
+__exportStar(require("./SupplierEntity"), exports);
+__exportStar(require("./SupplierItemEntity"), exports);
+__exportStar(require("./TcxBackupEntity"), exports);
+__exportStar(require("./TcxBackupModel"), exports);
+__exportStar(require("./TcxBillingEntity"), exports);
+__exportStar(require("./TcxBulkLicenceDetailsModel"), exports);
+__exportStar(require("./TcxDeadLicenceEntity"), exports);
+__exportStar(require("./TcxExtsEntity"), exports);
+__exportStar(require("./TcxHostingPricingEntity"), exports);
+__exportStar(require("./TcxInstallationDetailsModel"), exports);
+__exportStar(require("./TcxInstallationModel"), exports);
+__exportStar(require("./TcxInstallationsModel"), exports);
+__exportStar(require("./TcxKeySummaryDTO"), exports);
+__exportStar(require("./TcxKeysEntity"), exports);
+__exportStar(require("./TcxLicenceDetailsErrorModel"), exports);
+__exportStar(require("./TcxLicenceDetailsModel"), exports);
+__exportStar(require("./TcxMacsEntity"), exports);
+__exportStar(require("./TcxMultiTenantModel"), exports);
+__exportStar(require("./TcxMultiTenantUserModel"), exports);
+__exportStar(require("./TcxMultiTenantsModel"), exports);
+__exportStar(require("./TcxNumbersEntity"), exports);
+__exportStar(require("./TcxOfficeHoursEntity"), exports);
+__exportStar(require("./TcxPhoneModel"), exports);
+__exportStar(require("./TcxPhonesEntity"), exports);
+__exportStar(require("./TcxRemoteStorageModel"), exports);
+__exportStar(require("./TcxSbcDTO"), exports);
+__exportStar(require("./TcxSbcEntity"), exports);
+__exportStar(require("./TcxSbcModel"), exports);
+__exportStar(require("./TcxSetupEntity"), exports);
+__exportStar(require("./TcxSetupsModel"), exports);
+__exportStar(require("./TcxSipTrunksEntity"), exports);
+__exportStar(require("./TcxTemplateXmlEnum"), exports);
+__exportStar(require("./TcxUsersEntity"), exports);
+__exportStar(require("./TcxWizardConfigModel"), exports);
+__exportStar(require("./TcxWizardModel"), exports);
+__exportStar(require("./TechSupportCompanySummaryDTO"), exports);
+__exportStar(require("./TelephonySupportTicketModel"), exports);
+__exportStar(require("./TicketSummaryModel"), exports);
+__exportStar(require("./TicketTimeDTO"), exports);
+__exportStar(require("./TokenResponseModel"), exports);
+__exportStar(require("./UpgradeOrderResponseModel"), exports);
+__exportStar(require("./UpgradeRequestModel"), exports);
+__exportStar(require("./UserEntity"), exports);
+__exportStar(require("./XeroLogEntity"), exports);

package/dist/src/runtime.d.ts

@@ -0,0 +1,184 @@
+/**
+ * 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.
+ */
+export declare const BASE_PATH: string;
+export interface ConfigurationParameters {
+    basePath?: string;
+    fetchApi?: FetchAPI;
+    middleware?: Middleware[];
+    queryParamsStringify?: (params: HTTPQuery) => string;
+    username?: string;
+    password?: string;
+    apiKey?: string | Promise<string> | ((name: string) => string | Promise<string>);
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string | Promise<string>);
+    headers?: HTTPHeaders;
+    credentials?: RequestCredentials;
+}
+export declare class Configuration {
+    private configuration;
+    constructor(configuration?: ConfigurationParameters);
+    set config(configuration: Configuration);
+    get basePath(): string;
+    get fetchApi(): FetchAPI | undefined;
+    get middleware(): Middleware[];
+    get queryParamsStringify(): (params: HTTPQuery) => string;
+    get username(): string | undefined;
+    get password(): string | undefined;
+    get apiKey(): ((name: string) => string | Promise<string>) | undefined;
+    get accessToken(): ((name?: string, scopes?: string[]) => string | Promise<string>) | undefined;
+    get headers(): HTTPHeaders | undefined;
+    get credentials(): RequestCredentials | undefined;
+}
+export declare const DefaultConfig: Configuration;
+/**
+ * This is the base class for all generated API classes.
+ */
+export declare class BaseAPI {
+    protected configuration: Configuration;
+    private static readonly jsonRegex;
+    private middleware;
+    constructor(configuration?: Configuration);
+    withMiddleware<T extends BaseAPI>(this: T, ...middlewares: Middleware[]): T;
+    withPreMiddleware<T extends BaseAPI>(this: T, ...preMiddlewares: Array<Middleware['pre']>): T;
+    withPostMiddleware<T extends BaseAPI>(this: T, ...postMiddlewares: Array<Middleware['post']>): T;
+    /**
+     * Check if the given MIME is a JSON MIME.
+     * JSON MIME examples:
+     *   application/json
+     *   application/json; charset=UTF8
+     *   APPLICATION/JSON
+     *   application/vnd.company+json
+     * @param mime - MIME (Multipurpose Internet Mail Extensions)
+     * @return True if the given MIME is JSON, false otherwise.
+     */
+    protected isJsonMime(mime: string | null | undefined): boolean;
+    protected request(context: RequestOpts, initOverrides?: RequestInit | InitOverrideFunction): Promise<Response>;
+    private createFetchParams;
+    private fetchApi;
+    /**
+     * Create a shallow clone of `this` by constructing a new instance
+     * and then shallow cloning data members.
+     */
+    private clone;
+}
+export declare class ResponseError extends Error {
+    response: Response;
+    name: "ResponseError";
+    constructor(response: Response, msg?: string);
+}
+export declare class FetchError extends Error {
+    cause: Error;
+    name: "FetchError";
+    constructor(cause: Error, msg?: string);
+}
+export declare class RequiredError extends Error {
+    field: string;
+    name: "RequiredError";
+    constructor(field: string, msg?: string);
+}
+export declare const COLLECTION_FORMATS: {
+    csv: string;
+    ssv: string;
+    tsv: string;
+    pipes: string;
+};
+export type FetchAPI = WindowOrWorkerGlobalScope['fetch'];
+export type Json = any;
+export type HTTPMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD';
+export type HTTPHeaders = {
+    [key: string]: string;
+};
+export type HTTPQuery = {
+    [key: string]: string | number | null | boolean | Array<string | number | null | boolean> | Set<string | number | null | boolean> | HTTPQuery;
+};
+export type HTTPBody = Json | FormData | URLSearchParams;
+export type HTTPRequestInit = {
+    headers?: HTTPHeaders;
+    method: HTTPMethod;
+    credentials?: RequestCredentials;
+    body?: HTTPBody;
+};
+export type ModelPropertyNaming = 'camelCase' | 'snake_case' | 'PascalCase' | 'original';
+export type InitOverrideFunction = (requestContext: {
+    init: HTTPRequestInit;
+    context: RequestOpts;
+}) => Promise<RequestInit>;
+export interface FetchParams {
+    url: string;
+    init: RequestInit;
+}
+export interface RequestOpts {
+    path: string;
+    method: HTTPMethod;
+    headers: HTTPHeaders;
+    query?: HTTPQuery;
+    body?: HTTPBody;
+}
+export declare function querystring(params: HTTPQuery, prefix?: string): string;
+export declare function exists(json: any, key: string): boolean;
+export declare function mapValues(data: any, fn: (item: any) => any): {
+    [key: string]: any;
+};
+export declare function canConsumeForm(consumes: Consume[]): boolean;
+export interface Consume {
+    contentType: string;
+}
+export interface RequestContext {
+    fetch: FetchAPI;
+    url: string;
+    init: RequestInit;
+}
+export interface ResponseContext {
+    fetch: FetchAPI;
+    url: string;
+    init: RequestInit;
+    response: Response;
+}
+export interface ErrorContext {
+    fetch: FetchAPI;
+    url: string;
+    init: RequestInit;
+    error: unknown;
+    response?: Response;
+}
+export interface Middleware {
+    pre?(context: RequestContext): Promise<FetchParams | void>;
+    post?(context: ResponseContext): Promise<Response | void>;
+    onError?(context: ErrorContext): Promise<Response | void>;
+}
+export interface ApiResponse<T> {
+    raw: Response;
+    value(): Promise<T>;
+}
+export interface ResponseTransformer<T> {
+    (json: any): T;
+}
+export declare class JSONApiResponse<T> {
+    raw: Response;
+    private transformer;
+    constructor(raw: Response, transformer?: ResponseTransformer<T>);
+    value(): Promise<T>;
+}
+export declare class VoidApiResponse {
+    raw: Response;
+    constructor(raw: Response);
+    value(): Promise<void>;
+}
+export declare class BlobApiResponse {
+    raw: Response;
+    constructor(raw: Response);
+    value(): Promise<Blob>;
+}
+export declare class TextApiResponse {
+    raw: Response;
+    constructor(raw: Response);
+    value(): Promise<string>;
+}