npm - yellowgrid-api-ts - Versions diffs - 3.2.89-dev.0 → 3.2.91-dev.0 - Mend

yellowgrid-api-ts 3.2.89-dev.0 → 3.2.91-dev.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (44) hide show

package/.openapi-generator/FILES +3 -0
package/README.md +8 -1
package/api.ts +292 -1
package/base.ts +2 -2
package/common.ts +1 -1
package/configuration.ts +1 -1
package/dist/api.d.ts +210 -1
package/dist/api.js +190 -4
package/dist/base.d.ts +1 -1
package/dist/base.js +2 -2
package/dist/common.d.ts +1 -1
package/dist/common.js +1 -1
package/dist/configuration.d.ts +1 -1
package/dist/configuration.js +1 -1
package/dist/index.d.ts +1 -1
package/dist/index.js +1 -1
package/docs/AccountsApi.md +1 -1
package/docs/CRMApi.md +1 -1
package/docs/Class3CXApi.md +1 -1
package/docs/Class3CXInstallationWizardApi.md +1 -1
package/docs/Class3CXInstallationsApi.md +1 -1
package/docs/Class3CXIntegrationsApi.md +1 -1
package/docs/Class3CXMultiTenantApi.md +1 -1
package/docs/CreditNoteItemModel.md +29 -0
package/docs/CreditNoteModel.md +2 -0
package/docs/MyPBXToolsApi.md +1 -1
package/docs/NumberPortingApi.md +1 -1
package/docs/OAuth20Api.md +4 -4
package/docs/OrdersApi.md +59 -1
package/docs/PricingApi.md +1 -1
package/docs/ProductsApi.md +1 -1
package/docs/ProvisioningApi.md +1 -1
package/docs/SIPTrunksApi.md +1 -1
package/docs/SMSApi.md +57 -1
package/docs/ServicesApi.md +1 -1
package/docs/ShippingApi.md +1 -1
package/docs/SmsAccountDTO.md +31 -0
package/docs/SmsAccountRequestDTO.md +29 -0
package/docs/StockManagementApi.md +1 -1
package/docs/SystemApi.md +1 -1
package/docs/TicketsApi.md +1 -1
package/docs/WebhooksApi.md +1 -1
package/index.ts +1 -1
package/package.json +1 -1

package/dist/api.d.ts CHANGED Viewed

@@ -1,6 +1,6 @@
 /**
  * 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:    `https://api.yellowgrid.local`                  For questions or technical support, please contact support@yellowgrid.co.uk.
+ * 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:    `https://api.local.yellowgrid.co.uk`                  For questions or technical support, please contact support@yellowgrid.co.uk.
  *
  * The version of the OpenAPI document: 0
  *
@@ -2124,6 +2124,43 @@ export interface CreditNoteItemEntity {
      */
     'amount'?: number;
 }
+/**
+ * Credit Note Item
+ * @export
+ * @interface CreditNoteItemModel
+ */
+export interface CreditNoteItemModel {
+    /**
+     * id
+     * @type {number}
+     * @memberof CreditNoteItemModel
+     */
+    'id'?: number;
+    /**
+     * creditNoteId
+     * @type {number}
+     * @memberof CreditNoteItemModel
+     */
+    'creditNoteId'?: number;
+    /**
+     * orderId
+     * @type {number}
+     * @memberof CreditNoteItemModel
+     */
+    'orderId'?: number;
+    /**
+     * itemId
+     * @type {number}
+     * @memberof CreditNoteItemModel
+     */
+    'itemId'?: number;
+    /**
+     * amount
+     * @type {number}
+     * @memberof CreditNoteItemModel
+     */
+    'amount'?: number;
+}
 /**
  * Credit Note Model
  * @export
@@ -2160,6 +2197,12 @@ export interface CreditNoteModel {
      * @memberof CreditNoteModel
      */
     'timestamp'?: string;
+    /**
+     * Credit Note Items
+     * @type {Array<CreditNoteItemModel>}
+     * @memberof CreditNoteModel
+     */
+    'items'?: Array<CreditNoteItemModel>;
 }
 /**
  * CRM Contact
@@ -7552,6 +7595,49 @@ export interface SipTrunksResponseModel {
      */
     'totalResults'?: number;
 }
+/**
+ * SMS Account
+ * @export
+ * @interface SmsAccountDTO
+ */
+export interface SmsAccountDTO {
+    /**
+     * Send URL
+     * @type {string}
+     * @memberof SmsAccountDTO
+     */
+    'sendUrl'?: string;
+    /**
+     * Webhook URL
+     * @type {string}
+     * @memberof SmsAccountDTO
+     */
+    'webhookUrl'?: string;
+    /**
+     * API Key
+     * @type {string}
+     * @memberof SmsAccountDTO
+     */
+    'apiKey'?: string;
+    /**
+     * Numbers
+     * @type {Array<SmsNumbersEntity>}
+     * @memberof SmsAccountDTO
+     */
+    'numbers'?: Array<SmsNumbersEntity>;
+    /**
+     * Name
+     * @type {string}
+     * @memberof SmsAccountDTO
+     */
+    'name'?: string;
+    /**
+     * Sender Whitelist
+     * @type {Array<SmsWhitelistEntity>}
+     * @memberof SmsAccountDTO
+     */
+    'whitelist'?: Array<SmsWhitelistEntity>;
+}
 /**
  * SmsEntity
  * @export
@@ -7601,6 +7687,55 @@ export interface SmsAccountEntity {
      */
     'name'?: string;
 }
+/**
+ * SMS Account Request
+ * @export
+ * @interface SmsAccountRequestDTO
+ */
+export interface SmsAccountRequestDTO {
+    /**
+     * SMS Provider
+     * @type {number}
+     * @memberof SmsAccountRequestDTO
+     */
+    'provider'?: SmsAccountRequestDTOProviderEnum;
+    /**
+     * Customer Name
+     * @type {string}
+     * @memberof SmsAccountRequestDTO
+     */
+    'name'?: string;
+    /**
+     * SMS Webhook
+     * @type {string}
+     * @memberof SmsAccountRequestDTO
+     */
+    'webhookUrl'?: string;
+    /**
+     * Number Country
+     * @type {string}
+     * @memberof SmsAccountRequestDTO
+     */
+    'iso'?: string;
+    /**
+     * Number Type
+     * @type {string}
+     * @memberof SmsAccountRequestDTO
+     */
+    'type'?: SmsAccountRequestDTOTypeEnum;
+}
+export declare const SmsAccountRequestDTOProviderEnum: {
+    readonly NUMBER_1: 1;
+};
+export type SmsAccountRequestDTOProviderEnum = typeof SmsAccountRequestDTOProviderEnum[keyof typeof SmsAccountRequestDTOProviderEnum];
+export declare const SmsAccountRequestDTOTypeEnum: {
+    readonly Local: "local";
+    readonly TollFree: "toll_free";
+    readonly Mobile: "mobile";
+    readonly National: "national";
+    readonly SharedCost: "shared_cost";
+};
+export type SmsAccountRequestDTOTypeEnum = typeof SmsAccountRequestDTOTypeEnum[keyof typeof SmsAccountRequestDTOTypeEnum];
 /**
  * SMS Data Model
  * @export
@@ -15455,6 +15590,8 @@ export declare const PostAccessTokenScopeEnum: {
     readonly ProductsRead: "products.read";
     readonly ProvisioningRead: "provisioning.read";
     readonly ProvisioningWrite: "provisioning.write";
+    readonly SmsRead: "sms.read";
+    readonly SmsWrite: "sms.write";
     readonly TrunksRead: "trunks.read";
     readonly TrunksWrite: "trunks.write";
     readonly TcxIntegrationsRead: "tcx_integrations.read";
@@ -15495,6 +15632,8 @@ export declare const PostAuthoriseScopeEnum: {
     readonly ProductsRead: "products.read";
     readonly ProvisioningRead: "provisioning.read";
     readonly ProvisioningWrite: "provisioning.write";
+    readonly SmsRead: "sms.read";
+    readonly SmsWrite: "sms.write";
     readonly TrunksRead: "trunks.read";
     readonly TrunksWrite: "trunks.write";
     readonly TcxIntegrationsRead: "tcx_integrations.read";
@@ -15602,6 +15741,15 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
      * @throws {RequiredError}
      */
     getGetOrders: (pageSize?: number, page?: number, search?: string, fulfillable?: boolean | null, status?: GetGetOrdersStatusEnum, filter?: GetGetOrdersFilterEnum, customerId?: number | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Change Payment Status (Admin)
+     * @summary Change Payment Status (Admin)
+     * @param {number} id Order ID
+     * @param {boolean} id2 Paid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getUpdatePaymentStatus: (id: number, id2: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Add Order Note
      * @summary Add Order Note
@@ -15842,6 +15990,15 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getGetOrders(pageSize?: number, page?: number, search?: string, fulfillable?: boolean | null, status?: GetGetOrdersStatusEnum, filter?: GetGetOrdersFilterEnum, customerId?: number | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrderSummariesModel>>;
+    /**
+     * Change Payment Status (Admin)
+     * @summary Change Payment Status (Admin)
+     * @param {number} id Order ID
+     * @param {boolean} id2 Paid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getUpdatePaymentStatus(id: number, id2: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrderDetailsDTO>>;
     /**
      * Add Order Note
      * @summary Add Order Note
@@ -16082,6 +16239,15 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
      * @throws {RequiredError}
      */
     getGetOrders(pageSize?: number, page?: number, search?: string, fulfillable?: boolean | null, status?: GetGetOrdersStatusEnum, filter?: GetGetOrdersFilterEnum, customerId?: number | null, options?: RawAxiosRequestConfig): AxiosPromise<OrderSummariesModel>;
+    /**
+     * Change Payment Status (Admin)
+     * @summary Change Payment Status (Admin)
+     * @param {number} id Order ID
+     * @param {boolean} id2 Paid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getUpdatePaymentStatus(id: number, id2: boolean, options?: RawAxiosRequestConfig): AxiosPromise<OrderDetailsDTO>;
     /**
      * Add Order Note
      * @summary Add Order Note
@@ -16334,6 +16500,16 @@ export declare class OrdersApi extends BaseAPI {
      * @memberof OrdersApi
      */
     getGetOrders(pageSize?: number, page?: number, search?: string, fulfillable?: boolean | null, status?: GetGetOrdersStatusEnum, filter?: GetGetOrdersFilterEnum, customerId?: number | null, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderSummariesModel, any, {}>>;
+    /**
+     * Change Payment Status (Admin)
+     * @summary Change Payment Status (Admin)
+     * @param {number} id Order ID
+     * @param {boolean} id2 Paid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrdersApi
+     */
+    getUpdatePaymentStatus(id: number, id2: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderDetailsDTO, any, {}>>;
     /**
      * Add Order Note
      * @summary Add Order Note
@@ -18190,6 +18366,14 @@ export declare class SIPTrunksApi extends BaseAPI {
  * @export
  */
 export declare const SMSApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Create SMS Account
+     * @summary Create SMS Account
+     * @param {SmsAccountRequestDTO} [smsAccountRequestDTO] SMS Account Request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postCreateSmsAccount: (smsAccountRequestDTO?: SmsAccountRequestDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Send SMS
      * @param {string} authorization Bearer Token
@@ -18204,6 +18388,14 @@ export declare const SMSApiAxiosParamCreator: (configuration?: Configuration) =>
  * @export
  */
 export declare const SMSApiFp: (configuration?: Configuration) => {
+    /**
+     * Create SMS Account
+     * @summary Create SMS Account
+     * @param {SmsAccountRequestDTO} [smsAccountRequestDTO] SMS Account Request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postCreateSmsAccount(smsAccountRequestDTO?: SmsAccountRequestDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SmsAccountDTO>>;
     /**
      * Send SMS
      * @param {string} authorization Bearer Token
@@ -18218,6 +18410,14 @@ export declare const SMSApiFp: (configuration?: Configuration) => {
  * @export
  */
 export declare const SMSApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Create SMS Account
+     * @summary Create SMS Account
+     * @param {SmsAccountRequestDTO} [smsAccountRequestDTO] SMS Account Request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postCreateSmsAccount(smsAccountRequestDTO?: SmsAccountRequestDTO, options?: RawAxiosRequestConfig): AxiosPromise<SmsAccountDTO>;
     /**
      * Send SMS
      * @param {string} authorization Bearer Token
@@ -18234,6 +18434,15 @@ export declare const SMSApiFactory: (configuration?: Configuration, basePath?: s
  * @extends {BaseAPI}
  */
 export declare class SMSApi extends BaseAPI {
+    /**
+     * Create SMS Account
+     * @summary Create SMS Account
+     * @param {SmsAccountRequestDTO} [smsAccountRequestDTO] SMS Account Request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SMSApi
+     */
+    postCreateSmsAccount(smsAccountRequestDTO?: SmsAccountRequestDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SmsAccountDTO, any, {}>>;
     /**
      * Send SMS
      * @param {string} authorization Bearer Token

package/dist/api.js CHANGED Viewed

@@ -3,7 +3,7 @@
 /* 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:    `https://api.yellowgrid.local`                  For questions or technical support, please contact support@yellowgrid.co.uk.
+ * 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:    `https://api.local.yellowgrid.co.uk`                  For questions or technical support, please contact support@yellowgrid.co.uk.
  *
  * The version of the OpenAPI document: 0
  *
@@ -84,9 +84,9 @@ var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
     return to.concat(ar || Array.prototype.slice.call(from));
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Class3CXInstallationsApiFp = exports.Class3CXInstallationsApiAxiosParamCreator = exports.Class3CXInstallationWizardApi = exports.Class3CXInstallationWizardApiFactory = exports.Class3CXInstallationWizardApiFp = exports.Class3CXInstallationWizardApiAxiosParamCreator = exports.Class3CXApi = exports.Class3CXApiFactory = exports.Class3CXApiFp = exports.Class3CXApiAxiosParamCreator = exports.CRMApi = exports.CRMApiFactory = exports.CRMApiFp = exports.CRMApiAxiosParamCreator = exports.AccountsApi = exports.AccountsApiFactory = exports.AccountsApiFp = exports.AccountsApiAxiosParamCreator = exports.UpgradeRequestModelSchoolTypeEnum = exports.UpgradeRequestModelLicenceTypeEnum = exports.TcxWizardModelInstallationStatusEnum = exports.TcxWizardModelInstallTypeEnum = exports.TcxSetupEntityRegionEnum = exports.TcxSetupEntityInstallTypeEnum = exports.TcxMultiTenantModelPackageEnum = exports.StockOrderModelPaidEnum = exports.StockOrderModelDeliveryMethodEnum = exports.SmsResponseModelEventTypeEnum = exports.SmsPhoneNumberModelStatusEnum = exports.SipTrunkChangeResponseModelTypeEnum = exports.ShippingServiceModelCourierEnum = exports.ShippingServiceDTOCourierEnum = exports.ShippingRequestDTOPrinterEnum = exports.ShippingRequestDTOCourierEnum = exports.ShipmentRequestDTOCourierEnum = exports.ShipmentDTOCourierEnum = exports.ServiceStatusDTOStatusEnum = exports.ServiceHealthDTOGlobalStatusEnum = exports.OrderTotalModelCurrencyEnum = exports.OrderRequestModelSchoolTypeEnum = exports.OrderRequestModelLicenceTypeEnum = exports.MultiTenantChangeResponseModelTypeEnum = exports.ItemDiscountEntityTypeEnum = exports.HostingRegionDTOCodeEnum = exports.HostingChangeResponseModelTypeEnum = exports.EventDTOStatusEnum = exports.DivertResponseModelStatusEnum = exports.AuditLogEntityTypeEnum = exports.AuditLogEntityActionEnum = exports.AdminUserModelRoleEnum = void 0;
-exports.PostSendPriceListFormatEnum = exports.PostSendPriceListTypeEnum = exports.GetGetPriceListCategoryEnum = exports.GetGetPriceListFormatEnum = exports.GetGetPriceListTypeEnum = exports.PricingApi = exports.PricingApiFactory = exports.PricingApiFp = exports.PricingApiAxiosParamCreator = exports.PostPrintShippingLabelPrinterEnum = exports.GetGetOrdersFilterEnum = exports.GetGetOrdersStatusEnum = exports.OrdersApi = exports.OrdersApiFactory = exports.OrdersApiFp = exports.OrdersApiAxiosParamCreator = exports.PostAuthoriseScopeEnum = exports.PostAccessTokenTokenExchangeTypeEnum = exports.PostAccessTokenScopeEnum = exports.PostAccessTokenGrantTypeEnum = exports.OAuth20Api = exports.OAuth20ApiFactory = exports.OAuth20ApiFp = exports.OAuth20ApiAxiosParamCreator = exports.NumberPortingApi = exports.NumberPortingApiFactory = exports.NumberPortingApiFp = exports.NumberPortingApiAxiosParamCreator = exports.MyPBXToolsApi = exports.MyPBXToolsApiFactory = exports.MyPBXToolsApiFp = exports.MyPBXToolsApiAxiosParamCreator = exports.GetGetTenantsStatusEnum = exports.Class3CXMultiTenantApi = exports.Class3CXMultiTenantApiFactory = exports.Class3CXMultiTenantApiFp = exports.Class3CXMultiTenantApiAxiosParamCreator = exports.GetGetPriceSchoolTypeEnum = exports.GetGetPriceLicenceTypeEnum = exports.Class3CXIntegrationsApi = exports.Class3CXIntegrationsApiFactory = exports.Class3CXIntegrationsApiFp = exports.Class3CXIntegrationsApiAxiosParamCreator = exports.PostResizeInstanceSizeEnum = exports.PostFailoverInstanceTypeEnum = exports.GetGetInstallationsInstallTypeEnum = exports.GetGetInstallationsHostingEnum = exports.GetGetInstallationsStatusEnum = exports.Class3CXInstallationsApi = exports.Class3CXInstallationsApiFactory = void 0;
-exports.PostAddWebhookWebhookUriEnum = exports.WebhooksApi = exports.WebhooksApiFactory = exports.WebhooksApiFp = exports.WebhooksApiAxiosParamCreator = exports.TicketsApi = exports.TicketsApiFactory = exports.TicketsApiFp = exports.TicketsApiAxiosParamCreator = exports.SystemApi = exports.SystemApiFactory = exports.SystemApiFp = exports.SystemApiAxiosParamCreator = exports.StockManagementApi = exports.StockManagementApiFactory = exports.StockManagementApiFp = exports.StockManagementApiAxiosParamCreator = exports.ShippingApi = exports.ShippingApiFactory = exports.ShippingApiFp = exports.ShippingApiAxiosParamCreator = exports.ServicesApi = exports.ServicesApiFactory = exports.ServicesApiFp = exports.ServicesApiAxiosParamCreator = exports.SMSApi = exports.SMSApiFactory = exports.SMSApiFp = exports.SMSApiAxiosParamCreator = exports.SIPTrunksApi = exports.SIPTrunksApiFactory = exports.SIPTrunksApiFp = exports.SIPTrunksApiAxiosParamCreator = exports.ProvisioningApi = exports.ProvisioningApiFactory = exports.ProvisioningApiFp = exports.ProvisioningApiAxiosParamCreator = exports.GetGetLegacyStockListFormatEnum = exports.ProductsApi = exports.ProductsApiFactory = exports.ProductsApiFp = exports.ProductsApiAxiosParamCreator = exports.PostSendPriceListCategoryEnum = void 0;
+exports.Class3CXInstallationWizardApi = exports.Class3CXInstallationWizardApiFactory = exports.Class3CXInstallationWizardApiFp = exports.Class3CXInstallationWizardApiAxiosParamCreator = exports.Class3CXApi = exports.Class3CXApiFactory = exports.Class3CXApiFp = exports.Class3CXApiAxiosParamCreator = exports.CRMApi = exports.CRMApiFactory = exports.CRMApiFp = exports.CRMApiAxiosParamCreator = exports.AccountsApi = exports.AccountsApiFactory = exports.AccountsApiFp = exports.AccountsApiAxiosParamCreator = exports.UpgradeRequestModelSchoolTypeEnum = exports.UpgradeRequestModelLicenceTypeEnum = exports.TcxWizardModelInstallationStatusEnum = exports.TcxWizardModelInstallTypeEnum = exports.TcxSetupEntityRegionEnum = exports.TcxSetupEntityInstallTypeEnum = exports.TcxMultiTenantModelPackageEnum = exports.StockOrderModelPaidEnum = exports.StockOrderModelDeliveryMethodEnum = exports.SmsResponseModelEventTypeEnum = exports.SmsPhoneNumberModelStatusEnum = exports.SmsAccountRequestDTOTypeEnum = exports.SmsAccountRequestDTOProviderEnum = exports.SipTrunkChangeResponseModelTypeEnum = exports.ShippingServiceModelCourierEnum = exports.ShippingServiceDTOCourierEnum = exports.ShippingRequestDTOPrinterEnum = exports.ShippingRequestDTOCourierEnum = exports.ShipmentRequestDTOCourierEnum = exports.ShipmentDTOCourierEnum = exports.ServiceStatusDTOStatusEnum = exports.ServiceHealthDTOGlobalStatusEnum = exports.OrderTotalModelCurrencyEnum = exports.OrderRequestModelSchoolTypeEnum = exports.OrderRequestModelLicenceTypeEnum = exports.MultiTenantChangeResponseModelTypeEnum = exports.ItemDiscountEntityTypeEnum = exports.HostingRegionDTOCodeEnum = exports.HostingChangeResponseModelTypeEnum = exports.EventDTOStatusEnum = exports.DivertResponseModelStatusEnum = exports.AuditLogEntityTypeEnum = exports.AuditLogEntityActionEnum = exports.AdminUserModelRoleEnum = void 0;
+exports.GetGetPriceListCategoryEnum = exports.GetGetPriceListFormatEnum = exports.GetGetPriceListTypeEnum = exports.PricingApi = exports.PricingApiFactory = exports.PricingApiFp = exports.PricingApiAxiosParamCreator = exports.PostPrintShippingLabelPrinterEnum = exports.GetGetOrdersFilterEnum = exports.GetGetOrdersStatusEnum = exports.OrdersApi = exports.OrdersApiFactory = exports.OrdersApiFp = exports.OrdersApiAxiosParamCreator = exports.PostAuthoriseScopeEnum = exports.PostAccessTokenTokenExchangeTypeEnum = exports.PostAccessTokenScopeEnum = exports.PostAccessTokenGrantTypeEnum = exports.OAuth20Api = exports.OAuth20ApiFactory = exports.OAuth20ApiFp = exports.OAuth20ApiAxiosParamCreator = exports.NumberPortingApi = exports.NumberPortingApiFactory = exports.NumberPortingApiFp = exports.NumberPortingApiAxiosParamCreator = exports.MyPBXToolsApi = exports.MyPBXToolsApiFactory = exports.MyPBXToolsApiFp = exports.MyPBXToolsApiAxiosParamCreator = exports.GetGetTenantsStatusEnum = exports.Class3CXMultiTenantApi = exports.Class3CXMultiTenantApiFactory = exports.Class3CXMultiTenantApiFp = exports.Class3CXMultiTenantApiAxiosParamCreator = exports.GetGetPriceSchoolTypeEnum = exports.GetGetPriceLicenceTypeEnum = exports.Class3CXIntegrationsApi = exports.Class3CXIntegrationsApiFactory = exports.Class3CXIntegrationsApiFp = exports.Class3CXIntegrationsApiAxiosParamCreator = exports.PostResizeInstanceSizeEnum = exports.PostFailoverInstanceTypeEnum = exports.GetGetInstallationsInstallTypeEnum = exports.GetGetInstallationsHostingEnum = exports.GetGetInstallationsStatusEnum = exports.Class3CXInstallationsApi = exports.Class3CXInstallationsApiFactory = exports.Class3CXInstallationsApiFp = exports.Class3CXInstallationsApiAxiosParamCreator = void 0;
+exports.PostAddWebhookWebhookUriEnum = exports.WebhooksApi = exports.WebhooksApiFactory = exports.WebhooksApiFp = exports.WebhooksApiAxiosParamCreator = exports.TicketsApi = exports.TicketsApiFactory = exports.TicketsApiFp = exports.TicketsApiAxiosParamCreator = exports.SystemApi = exports.SystemApiFactory = exports.SystemApiFp = exports.SystemApiAxiosParamCreator = exports.StockManagementApi = exports.StockManagementApiFactory = exports.StockManagementApiFp = exports.StockManagementApiAxiosParamCreator = exports.ShippingApi = exports.ShippingApiFactory = exports.ShippingApiFp = exports.ShippingApiAxiosParamCreator = exports.ServicesApi = exports.ServicesApiFactory = exports.ServicesApiFp = exports.ServicesApiAxiosParamCreator = exports.SMSApi = exports.SMSApiFactory = exports.SMSApiFp = exports.SMSApiAxiosParamCreator = exports.SIPTrunksApi = exports.SIPTrunksApiFactory = exports.SIPTrunksApiFp = exports.SIPTrunksApiAxiosParamCreator = exports.ProvisioningApi = exports.ProvisioningApiFactory = exports.ProvisioningApiFp = exports.ProvisioningApiAxiosParamCreator = exports.GetGetLegacyStockListFormatEnum = exports.ProductsApi = exports.ProductsApiFactory = exports.ProductsApiFp = exports.ProductsApiAxiosParamCreator = exports.PostSendPriceListCategoryEnum = exports.PostSendPriceListFormatEnum = exports.PostSendPriceListTypeEnum = void 0;
 var axios_1 = require("axios");
 // Some imports not used depending on template conditions
 // @ts-ignore
@@ -326,6 +326,16 @@ exports.SipTrunkChangeResponseModelTypeEnum = {
     Fraud: 'Fraud',
     CallBarring: 'Call Barring'
 };
+exports.SmsAccountRequestDTOProviderEnum = {
+    NUMBER_1: 1
+};
+exports.SmsAccountRequestDTOTypeEnum = {
+    Local: 'local',
+    TollFree: 'toll_free',
+    Mobile: 'mobile',
+    National: 'national',
+    SharedCost: 'shared_cost'
+};
 exports.SmsPhoneNumberModelStatusEnum = {
     Queued: 'queued',
     Sending: 'sending',
@@ -9798,6 +9808,8 @@ exports.PostAccessTokenScopeEnum = {
     ProductsRead: 'products.read',
     ProvisioningRead: 'provisioning.read',
     ProvisioningWrite: 'provisioning.write',
+    SmsRead: 'sms.read',
+    SmsWrite: 'sms.write',
     TrunksRead: 'trunks.read',
     TrunksWrite: 'trunks.write',
     TcxIntegrationsRead: 'tcx_integrations.read',
@@ -9836,6 +9848,8 @@ exports.PostAuthoriseScopeEnum = {
     ProductsRead: 'products.read',
     ProvisioningRead: 'provisioning.read',
     ProvisioningWrite: 'provisioning.write',
+    SmsRead: 'sms.read',
+    SmsWrite: 'sms.write',
     TrunksRead: 'trunks.read',
     TrunksWrite: 'trunks.write',
     TcxIntegrationsRead: 'tcx_integrations.read',
@@ -10264,6 +10278,49 @@ var OrdersApiAxiosParamCreator = function (configuration) {
                 });
             });
         },
+        /**
+         * Change Payment Status (Admin)
+         * @summary Change Payment Status (Admin)
+         * @param {number} id Order ID
+         * @param {boolean} id2 Paid
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getUpdatePaymentStatus: function (id_1, id2_1) {
+            var args_1 = [];
+            for (var _i = 2; _i < arguments.length; _i++) {
+                args_1[_i - 2] = arguments[_i];
+            }
+            return __awaiter(_this, __spreadArray([id_1, id2_1], args_1, true), void 0, function (id, id2, options) {
+                var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
+                if (options === void 0) { options = {}; }
+                return __generator(this, function (_a) {
+                    // verify required parameter 'id' is not null or undefined
+                    (0, common_1.assertParamExists)('getUpdatePaymentStatus', 'id', id);
+                    // verify required parameter 'id2' is not null or undefined
+                    (0, common_1.assertParamExists)('getUpdatePaymentStatus', 'id2', id2);
+                    localVarPath = "/admin/orders/{id}/paid"
+                        .replace("{".concat("id", "}"), encodeURIComponent(String(id)));
+                    localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
+                    if (configuration) {
+                        baseOptions = configuration.baseOptions;
+                    }
+                    localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
+                    localVarHeaderParameter = {};
+                    localVarQueryParameter = {};
+                    if (id2 !== undefined) {
+                        localVarQueryParameter['id'] = id2;
+                    }
+                    (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+                    headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+                    localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+                    return [2 /*return*/, {
+                            url: (0, common_1.toPathString)(localVarUrlObj),
+                            options: localVarRequestOptions,
+                        }];
+                });
+            });
+        },
         /**
          * Add Order Note
          * @summary Add Order Note
@@ -11165,6 +11222,30 @@ var OrdersApiFp = function (configuration) {
                 });
             });
         },
+        /**
+         * Change Payment Status (Admin)
+         * @summary Change Payment Status (Admin)
+         * @param {number} id Order ID
+         * @param {boolean} id2 Paid
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getUpdatePaymentStatus: function (id, id2, options) {
+            return __awaiter(this, void 0, void 0, function () {
+                var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
+                var _a, _b, _c;
+                return __generator(this, function (_d) {
+                    switch (_d.label) {
+                        case 0: return [4 /*yield*/, localVarAxiosParamCreator.getUpdatePaymentStatus(id, id2, options)];
+                        case 1:
+                            localVarAxiosArgs = _d.sent();
+                            localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                            localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['OrdersApi.getUpdatePaymentStatus']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                            return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
+                    }
+                });
+            });
+        },
         /**
          * Add Order Note
          * @summary Add Order Note
@@ -11654,6 +11735,17 @@ var OrdersApiFactory = function (configuration, basePath, axios) {
         getGetOrders: function (pageSize, page, search, fulfillable, status, filter, customerId, options) {
             return localVarFp.getGetOrders(pageSize, page, search, fulfillable, status, filter, customerId, options).then(function (request) { return request(axios, basePath); });
         },
+        /**
+         * Change Payment Status (Admin)
+         * @summary Change Payment Status (Admin)
+         * @param {number} id Order ID
+         * @param {boolean} id2 Paid
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getUpdatePaymentStatus: function (id, id2, options) {
+            return localVarFp.getUpdatePaymentStatus(id, id2, options).then(function (request) { return request(axios, basePath); });
+        },
         /**
          * Add Order Note
          * @summary Add Order Note
@@ -11972,6 +12064,19 @@ var OrdersApi = /** @class */ (function (_super) {
         var _this = this;
         return (0, exports.OrdersApiFp)(this.configuration).getGetOrders(pageSize, page, search, fulfillable, status, filter, customerId, options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
+    /**
+     * Change Payment Status (Admin)
+     * @summary Change Payment Status (Admin)
+     * @param {number} id Order ID
+     * @param {boolean} id2 Paid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrdersApi
+     */
+    OrdersApi.prototype.getUpdatePaymentStatus = function (id, id2, options) {
+        var _this = this;
+        return (0, exports.OrdersApiFp)(this.configuration).getUpdatePaymentStatus(id, id2, options).then(function (request) { return request(_this.axios, _this.basePath); });
+    };
     /**
      * Add Order Note
      * @summary Add Order Note
@@ -16042,6 +16147,42 @@ exports.SIPTrunksApi = SIPTrunksApi;
 var SMSApiAxiosParamCreator = function (configuration) {
     var _this = this;
     return {
+        /**
+         * Create SMS Account
+         * @summary Create SMS Account
+         * @param {SmsAccountRequestDTO} [smsAccountRequestDTO] SMS Account Request
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        postCreateSmsAccount: function (smsAccountRequestDTO_1) {
+            var args_1 = [];
+            for (var _i = 1; _i < arguments.length; _i++) {
+                args_1[_i - 1] = arguments[_i];
+            }
+            return __awaiter(_this, __spreadArray([smsAccountRequestDTO_1], args_1, true), void 0, function (smsAccountRequestDTO, options) {
+                var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
+                if (options === void 0) { options = {}; }
+                return __generator(this, function (_a) {
+                    localVarPath = "/messaging/sms/account";
+                    localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
+                    if (configuration) {
+                        baseOptions = configuration.baseOptions;
+                    }
+                    localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
+                    localVarHeaderParameter = {};
+                    localVarQueryParameter = {};
+                    localVarHeaderParameter['Content-Type'] = 'application/json';
+                    (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+                    headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+                    localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+                    localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(smsAccountRequestDTO, localVarRequestOptions, configuration);
+                    return [2 /*return*/, {
+                            url: (0, common_1.toPathString)(localVarUrlObj),
+                            options: localVarRequestOptions,
+                        }];
+                });
+            });
+        },
         /**
          * Send SMS
          * @param {string} authorization Bearer Token
@@ -16093,6 +16234,29 @@ exports.SMSApiAxiosParamCreator = SMSApiAxiosParamCreator;
 var SMSApiFp = function (configuration) {
     var localVarAxiosParamCreator = (0, exports.SMSApiAxiosParamCreator)(configuration);
     return {
+        /**
+         * Create SMS Account
+         * @summary Create SMS Account
+         * @param {SmsAccountRequestDTO} [smsAccountRequestDTO] SMS Account Request
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        postCreateSmsAccount: function (smsAccountRequestDTO, options) {
+            return __awaiter(this, void 0, void 0, function () {
+                var localVarAxiosArgs, localVarOperationServerIndex, localVarOperationServerBasePath;
+                var _a, _b, _c;
+                return __generator(this, function (_d) {
+                    switch (_d.label) {
+                        case 0: return [4 /*yield*/, localVarAxiosParamCreator.postCreateSmsAccount(smsAccountRequestDTO, options)];
+                        case 1:
+                            localVarAxiosArgs = _d.sent();
+                            localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                            localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['SMSApi.postCreateSmsAccount']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                            return [2 /*return*/, function (axios, basePath) { return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); }];
+                    }
+                });
+            });
+        },
         /**
          * Send SMS
          * @param {string} authorization Bearer Token
@@ -16126,6 +16290,16 @@ exports.SMSApiFp = SMSApiFp;
 var SMSApiFactory = function (configuration, basePath, axios) {
     var localVarFp = (0, exports.SMSApiFp)(configuration);
     return {
+        /**
+         * Create SMS Account
+         * @summary Create SMS Account
+         * @param {SmsAccountRequestDTO} [smsAccountRequestDTO] SMS Account Request
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        postCreateSmsAccount: function (smsAccountRequestDTO, options) {
+            return localVarFp.postCreateSmsAccount(smsAccountRequestDTO, options).then(function (request) { return request(axios, basePath); });
+        },
         /**
          * Send SMS
          * @param {string} authorization Bearer Token
@@ -16150,6 +16324,18 @@ var SMSApi = /** @class */ (function (_super) {
     function SMSApi() {
         return _super !== null && _super.apply(this, arguments) || this;
     }
+    /**
+     * Create SMS Account
+     * @summary Create SMS Account
+     * @param {SmsAccountRequestDTO} [smsAccountRequestDTO] SMS Account Request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SMSApi
+     */
+    SMSApi.prototype.postCreateSmsAccount = function (smsAccountRequestDTO, options) {
+        var _this = this;
+        return (0, exports.SMSApiFp)(this.configuration).postCreateSmsAccount(smsAccountRequestDTO, options).then(function (request) { return request(_this.axios, _this.basePath); });
+    };
     /**
      * Send SMS
      * @param {string} authorization Bearer Token

package/dist/base.d.ts CHANGED Viewed

@@ -1,6 +1,6 @@
 /**
  * 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:    `https://api.yellowgrid.local`                  For questions or technical support, please contact support@yellowgrid.co.uk.
+ * 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:    `https://api.local.yellowgrid.co.uk`                  For questions or technical support, please contact support@yellowgrid.co.uk.
  *
  * The version of the OpenAPI document: 0
  *

package/dist/base.js CHANGED Viewed

@@ -3,7 +3,7 @@
 /* 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:    `https://api.yellowgrid.local`                  For questions or technical support, please contact support@yellowgrid.co.uk.
+ * 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:    `https://api.local.yellowgrid.co.uk`                  For questions or technical support, please contact support@yellowgrid.co.uk.
  *
  * The version of the OpenAPI document: 0
  *
@@ -30,7 +30,7 @@ var __extends = (this && this.__extends) || (function () {
 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 = "https://api.yellowgrid.local".replace(/\/+$/, "");
+exports.BASE_PATH = "https://api.local.yellowgrid.co.uk".replace(/\/+$/, "");
 /**
  *
  * @export

package/dist/common.d.ts CHANGED Viewed

@@ -1,6 +1,6 @@
 /**
  * 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:    `https://api.yellowgrid.local`                  For questions or technical support, please contact support@yellowgrid.co.uk.
+ * 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:    `https://api.local.yellowgrid.co.uk`                  For questions or technical support, please contact support@yellowgrid.co.uk.
  *
  * The version of the OpenAPI document: 0
  *