yellowgrid-api-ts 3.2.39-dev.0 → 3.2.40-dev.0

package/.openapi-generator/FILES

@@ -1,5 +1,6 @@
 .gitignore
 .npmignore
+.openapi-generator-ignore
 README.md
 api.ts
 base.ts

package/api.ts

@@ -2264,12 +2264,6 @@ export interface EdTechProSchoolModel {
      * @memberof EdTechProSchoolModel
      */
     'creationDate'?: string;
-    /**
-     * Template URL
-     * @type {string}
-     * @memberof EdTechProSchoolModel
-     */
-    ''?: string;
     /**
      * School Annual Price
      * @type {number}
@@ -5545,7 +5539,7 @@ export interface ServiceStatusDTO {
     'name'?: string;
     /**
      * Service Status
-     * @type {number}
+     * @type {string}
      * @memberof ServiceStatusDTO
      */
     'status'?: ServiceStatusDTOStatusEnum;
@@ -5558,9 +5552,9 @@ export interface ServiceStatusDTO {
 }
 
 export const ServiceStatusDTOStatusEnum = {
-    NUMBER_0: 0,
-    NUMBER_1: 1,
-    NUMBER_2: 2
+    _0: '0',
+    _1: '1',
+    _2: '2'
 } as const;
 
 export type ServiceStatusDTOStatusEnum = typeof ServiceStatusDTOStatusEnum[keyof typeof ServiceStatusDTOStatusEnum];

package/dist/api.d.ts

@@ -2248,12 +2248,6 @@ export interface EdTechProSchoolModel {
      * @memberof EdTechProSchoolModel
      */
     'creationDate'?: string;
-    /**
-     * Template URL
-     * @type {string}
-     * @memberof EdTechProSchoolModel
-     */
-    ''?: string;
     /**
      * School Annual Price
      * @type {number}
@@ -5504,7 +5498,7 @@ export interface ServiceStatusDTO {
     'name'?: string;
     /**
      * Service Status
-     * @type {number}
+     * @type {string}
      * @memberof ServiceStatusDTO
      */
     'status'?: ServiceStatusDTOStatusEnum;
@@ -5516,9 +5510,9 @@ export interface ServiceStatusDTO {
     'events'?: Array<EventDTO>;
 }
 export declare const ServiceStatusDTOStatusEnum: {
-    readonly NUMBER_0: 0;
-    readonly NUMBER_1: 1;
-    readonly NUMBER_2: 2;
+    readonly _0: "0";
+    readonly _1: "1";
+    readonly _2: "2";
 };
 export type ServiceStatusDTOStatusEnum = typeof ServiceStatusDTOStatusEnum[keyof typeof ServiceStatusDTOStatusEnum];
 /**

package/dist/api.js

@@ -192,9 +192,9 @@ exports.ServiceHealthDTOGlobalStatusEnum = {
     NUMBER_2: 2
 };
 exports.ServiceStatusDTOStatusEnum = {
-    NUMBER_0: 0,
-    NUMBER_1: 1,
-    NUMBER_2: 2
+    _0: '0',
+    _1: '1',
+    _2: '2'
 };
 exports.ShippingServiceDTOCourierEnum = {
     Dpd: 'DPD',

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

@@ -0,0 +1,258 @@
+/**
+ * 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 { AccountContactModel, AccountContactRequestModel, AccountDetailedSummaryDTO, AccountRequestModel, AccountsResponseModel, AdminUserModel, ClientModel, PatchSetTcxWizardCnameRequest, PatchUpdateAccountContactPasswordRequest, PortalAccountModel, PostGetClientCredentialsRequest, TcxKeySummaryDTO } from '../models/index';
+export interface DeleteDeleteClientCredentialsRequest {
+    id: string;
+}
+export interface DeleteUpdateAccountContactRequest {
+    email: string;
+}
+export interface GetGetAccountContactsRequest {
+    email?: string;
+}
+export interface GetGetAccountDetailedSummaryRequest {
+    id: number;
+}
+export interface GetGetAccountsRequest {
+    pageSize?: number;
+    page?: number;
+    search?: string;
+    active?: boolean;
+}
+export interface GetVerifyEmailAddressRequest {
+    token: string;
+}
+export interface PatchSetTcxWizardCnameOperationRequest {
+    patchSetTcxWizardCnameRequest?: PatchSetTcxWizardCnameRequest;
+}
+export interface PatchUpdateAccountContactPasswordOperationRequest {
+    token: string;
+    patchUpdateAccountContactPasswordRequest?: PatchUpdateAccountContactPasswordRequest;
+}
+export interface PostGetAccountContactsRequest {
+    accountContactRequestModel?: AccountContactRequestModel;
+}
+export interface PostGetAccountsRequest {
+    accountRequestModel?: AccountRequestModel;
+}
+export interface PostGetClientCredentialsOperationRequest {
+    postGetClientCredentialsRequest?: PostGetClientCredentialsRequest;
+}
+export interface PostSendEmailVerificationEmailRequest {
+    email: string;
+}
+export interface PostSendPasswordResetRequest {
+    email: string;
+}
+export interface PostSubmitResellerApplicationRequest {
+    creditRequired?: number;
+    companyNumber?: string;
+    vatNumber?: string;
+}
+export interface PutUpdateAccountContactRequest {
+    email: string;
+    accountContactRequestModel?: AccountContactRequestModel;
+}
+/**
+ *
+ */
+export declare class AccountsApi extends runtime.BaseAPI {
+    /**
+     * Delete client credentials
+     * Delete client credentials
+     */
+    deleteDeleteClientCredentialsRaw(requestParameters: DeleteDeleteClientCredentialsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Delete client credentials
+     * Delete client credentials
+     */
+    deleteDeleteClientCredentials(requestParameters: DeleteDeleteClientCredentialsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Delete Account Contacts
+     * Delete Account Contact
+     */
+    deleteUpdateAccountContactRaw(requestParameters: DeleteUpdateAccountContactRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Delete Account Contacts
+     * Delete Account Contact
+     */
+    deleteUpdateAccountContact(requestParameters: DeleteUpdateAccountContactRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Get Account
+     * Get Account
+     */
+    getGetAccountRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PortalAccountModel>>;
+    /**
+     * Get Account
+     * Get Account
+     */
+    getGetAccount(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PortalAccountModel>;
+    /**
+     * Get Account Contacts
+     * Get Account Contacts
+     */
+    getGetAccountContactsRaw(requestParameters: GetGetAccountContactsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<AccountContactModel>>>;
+    /**
+     * Get Account Contacts
+     * Get Account Contacts
+     */
+    getGetAccountContacts(requestParameters?: GetGetAccountContactsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<AccountContactModel>>;
+    /**
+     * Get Account Detailed Summary
+     * Get Account Detailed Summary
+     */
+    getGetAccountDetailedSummaryRaw(requestParameters: GetGetAccountDetailedSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AccountDetailedSummaryDTO>>;
+    /**
+     * Get Account Detailed Summary
+     * Get Account Detailed Summary
+     */
+    getGetAccountDetailedSummary(requestParameters: GetGetAccountDetailedSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AccountDetailedSummaryDTO>;
+    /**
+     * Get Accounts
+     * Get Accounts
+     */
+    getGetAccountsRaw(requestParameters: GetGetAccountsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AccountsResponseModel>>;
+    /**
+     * Get Accounts
+     * Get Accounts
+     */
+    getGetAccounts(requestParameters?: GetGetAccountsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AccountsResponseModel>;
+    /**
+     * Get user\'s client credentials
+     * Get user\'s client credentials
+     */
+    getGetClientCredentialsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ClientModel>>>;
+    /**
+     * Get user\'s client credentials
+     * Get user\'s client credentials
+     */
+    getGetClientCredentials(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ClientModel>>;
+    /**
+     * Get 3CX Keys
+     * Get 3CX Keys
+     */
+    getGetCustomerKeysRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<TcxKeySummaryDTO>>>;
+    /**
+     * Get 3CX Keys
+     * Get 3CX Keys
+     */
+    getGetCustomerKeys(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<TcxKeySummaryDTO>>;
+    /**
+     * Verify account email address
+     * Verify account email address
+     */
+    getVerifyEmailAddressRaw(requestParameters: GetVerifyEmailAddressRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Verify account email address
+     * Verify account email address
+     */
+    getVerifyEmailAddress(requestParameters: GetVerifyEmailAddressRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Set 3CX Wizard CNAME
+     */
+    patchSetTcxWizardCnameRaw(requestParameters: PatchSetTcxWizardCnameOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Set 3CX Wizard CNAME
+     */
+    patchSetTcxWizardCname(requestParameters?: PatchSetTcxWizardCnameOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Update Account Password
+     * Update Account Password
+     */
+    patchUpdateAccountContactPasswordRaw(requestParameters: PatchUpdateAccountContactPasswordOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Update Account Password
+     * Update Account Password
+     */
+    patchUpdateAccountContactPassword(requestParameters: PatchUpdateAccountContactPasswordOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Add Account Contacts
+     * Add Account Contact
+     */
+    postGetAccountContactsRaw(requestParameters: PostGetAccountContactsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Add Account Contacts
+     * Add Account Contact
+     */
+    postGetAccountContacts(requestParameters?: PostGetAccountContactsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Create new customer account
+     * Create a new customer account
+     */
+    postGetAccountsRaw(requestParameters: PostGetAccountsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PortalAccountModel>>;
+    /**
+     * Create new customer account
+     * Create a new customer account
+     */
+    postGetAccounts(requestParameters?: PostGetAccountsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PortalAccountModel>;
+    /**
+     * Get Admin Account
+     * Get Admin Account
+     */
+    postGetAdminAccountRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminUserModel>>;
+    /**
+     * Get Admin Account
+     * Get Admin Account
+     */
+    postGetAdminAccount(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminUserModel>;
+    /**
+     * Create client credentials
+     * Create client credentials
+     */
+    postGetClientCredentialsRaw(requestParameters: PostGetClientCredentialsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ClientModel>>;
+    /**
+     * Create client credentials
+     * Create client credentials
+     */
+    postGetClientCredentials(requestParameters?: PostGetClientCredentialsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ClientModel>;
+    /**
+     * Send email verification email
+     * Send email verification email
+     */
+    postSendEmailVerificationEmailRaw(requestParameters: PostSendEmailVerificationEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Send email verification email
+     * Send email verification email
+     */
+    postSendEmailVerificationEmail(requestParameters: PostSendEmailVerificationEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Send password reset email
+     * Send password reset email
+     */
+    postSendPasswordResetRaw(requestParameters: PostSendPasswordResetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Send password reset email
+     * Send password reset email
+     */
+    postSendPasswordReset(requestParameters: PostSendPasswordResetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Submit reseller application
+     * Submit reseller application
+     */
+    postSubmitResellerApplicationRaw(requestParameters: PostSubmitResellerApplicationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Submit reseller application
+     * Submit reseller application
+     */
+    postSubmitResellerApplication(requestParameters?: PostSubmitResellerApplicationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Update Account Contacts
+     * Update Account Contact
+     */
+    putUpdateAccountContactRaw(requestParameters: PutUpdateAccountContactRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Update Account Contacts
+     * Update Account Contact
+     */
+    putUpdateAccountContact(requestParameters: PutUpdateAccountContactRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+}