yellowgrid-api-ts 3.2.161-dev.0 → 3.2.161

package/base.ts

@@ -2,7 +2,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://localhost`                  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://bitbucket.org`               For questions or technical support, please contact support@yellowgrid.co.uk.
  *
  * The version of the OpenAPI document: 0
  * 
@@ -19,7 +19,7 @@ import type { Configuration } from './configuration';
 import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
 import globalAxios from 'axios';
 
-export const BASE_PATH = "https://localhost".replace(/\/+$/, "");
+export const BASE_PATH = "https://bitbucket.org".replace(/\/+$/, "");
 
 export const COLLECTION_FORMATS = {
     csv: ",",

package/common.ts

@@ -2,7 +2,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://localhost`                  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://bitbucket.org`               For questions or technical support, please contact support@yellowgrid.co.uk.
  *
  * The version of the OpenAPI document: 0
  * 

package/config.json

@@ -1,3 +1,3 @@
-{
-  "npmName": "yellowgrid-api-ts"
-}
+{
+  "npmName": "yellowgrid-api-ts"
+}

package/configuration.ts

@@ -1,7 +1,7 @@
 /* tslint: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://localhost`                  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://bitbucket.org`               For questions or technical support, please contact support@yellowgrid.co.uk.
  *
  * The version of the OpenAPI document: 0
  * 
@@ -115,7 +115,7 @@ export class Configuration {
      * @return True if the given MIME is JSON, false otherwise.
      */
     public isJsonMime(mime: string): boolean {
-        const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i');
-        return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json');
+        const jsonMime: RegExp = /^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$/i;
+        return mime !== null && jsonMime.test(mime);
     }
 }

package/dist/api.d.ts

@@ -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://localhost`                  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://bitbucket.org`               For questions or technical support, please contact support@yellowgrid.co.uk.
  *
  * The version of the OpenAPI document: 0
  *
@@ -30,6 +30,9 @@ export interface AbstractOrderRequestDTO {
      * Provisioning URL
      */
     'provisioningUrl'?: string | null;
+    /**
+     * Shipping Address
+     */
     'shippingAddress'?: AddressModel | null;
     /**
      * Part Ship Order
@@ -614,6 +617,9 @@ export interface AdminOrderRequestDTO {
      * Provisioning URL
      */
     'provisioningUrl'?: string | null;
+    /**
+     * Shipping Address
+     */
     'shippingAddress'?: AddressModel | null;
     /**
      * Part Ship Order
@@ -720,6 +726,7 @@ export declare const AdminUserModelPermissionsEnum: {
     readonly Technical: "Technical";
     readonly Privileged: "Privileged";
     readonly Development: "Development";
+    readonly Finance: "Finance";
 };
 export type AdminUserModelPermissionsEnum = typeof AdminUserModelPermissionsEnum[keyof typeof AdminUserModelPermissionsEnum];
 /**
@@ -1409,10 +1416,6 @@ export interface CreateCrmNoteBody {
  * Credit Account
  */
 export interface CreditAccountEntity {
-    /**
-     * Contact Email Domains
-     */
-    'domains'?: Array<string>;
     /**
      * ID
      */
@@ -1658,7 +1661,7 @@ export interface CrmActivityDTO {
      */
     'type'?: string;
     /**
-     * Date Time
+     * Activity Timestamp
      */
     'timestamp'?: string | null;
     /**
@@ -1720,7 +1723,7 @@ export interface CrmContactDTO {
  */
 export interface CrmDateActivitiesDTO {
     /**
-     * Date Time
+     * Date
      */
     'date'?: string | null;
     /**
@@ -1896,6 +1899,63 @@ export interface CustomerItemRequestDTO {
      */
     'readOnly'?: boolean;
 }
+/**
+ * Customer List Account
+ */
+export interface CustomerListAccountDTO {
+    /**
+     * ID
+     */
+    'id'?: number;
+    /**
+     * Xero ID
+     */
+    'xeroId'?: string;
+    /**
+     * Account Number
+     */
+    'accountNumber'?: string;
+    /**
+     * Company Name
+     */
+    'company'?: string;
+    /**
+     * Associated Email Domains
+     */
+    'domains'?: Array<string>;
+    /**
+     * Telephone
+     */
+    'telephone'?: string;
+    /**
+     * VAT Number
+     */
+    'vatNumber'?: string;
+    /**
+     * Company Number
+     */
+    'companyNumber'?: string;
+    /**
+     * Wizard CNAME
+     */
+    'cname'?: string;
+    /**
+     * 3CX Reseller ID
+     */
+    'partnerId'?: string;
+    /**
+     * Account Status
+     */
+    'status'?: boolean;
+    /**
+     * Portal Access
+     */
+    'portalAccess'?: boolean;
+    /**
+     * Prize Promo
+     */
+    'prizePromo'?: boolean;
+}
 /**
  * Order Request
  */
@@ -1913,6 +1973,9 @@ export interface CustomerOrderRequestDTO {
      * Provisioning URL
      */
     'provisioningUrl'?: string | null;
+    /**
+     * Shipping Address
+     */
     'shippingAddress'?: AddressModel | null;
     /**
      * Part Ship Order
@@ -2062,6 +2125,9 @@ export interface DetailedOrderRequestDTO {
      * Provisioning URL
      */
     'provisioningUrl'?: string | null;
+    /**
+     * Shipping Address
+     */
     'shippingAddress'?: AddressModel | null;
     /**
      * Part Ship Order
@@ -4316,10 +4382,6 @@ export interface PatchUpdateTcxPartnerIdRequest {
  * Customer Account
  */
 export interface PortalAccountModel {
-    /**
-     * Contact Email Domains
-     */
-    'domains'?: Array<string>;
     /**
      * ID
      */
@@ -4662,7 +4724,7 @@ export interface ProductSummaryDTO {
      */
     'stockProduct'?: boolean;
     /**
-     * Date Time
+     * Due Date
      */
     'dueDate'?: string | null;
     /**
@@ -4677,6 +4739,9 @@ export interface ProductSummaryDTO {
      * RRP Price
      */
     'rrp'?: number | null;
+    /**
+     * 3CX Licence Details
+     */
     'licenceDetails'?: TcxLicenceDetailsModel | null;
     /**
      * 3CX Hosting
@@ -4786,11 +4851,11 @@ export interface ProspectDTO {
      */
     'telephone'?: string | null;
     /**
-     * Date Time
+     * Last Order Date
      */
     'lastOrderDate'?: string | null;
     /**
-     * Date Time
+     * Call Back Date
      */
     'callbackDate'?: string | null;
     /**
@@ -4942,6 +5007,10 @@ export interface RecordingBackupAzureModel {
      * Storage Account Connection String
      */
     'connection_string'?: string;
+    /**
+     * SAS Url
+     */
+    'sasUrl'?: string;
     /**
      * Recordings Path
      */
@@ -4951,7 +5020,13 @@ export interface RecordingBackupAzureModel {
  * Recordings Backup Info
  */
 export interface RecordingsBackupInfoDTO {
+    /**
+     * Azure Backup Storage
+     */
     'backup'?: RecordingBackupAzureModel | null;
+    /**
+     * 3CX Remote Storage
+     */
     'storage'?: TcxRemoteStorageModel | null;
 }
 /**
@@ -5244,6 +5319,7 @@ export declare const ShipmentDTOCourierEnum: {
     readonly Dpd: "DPD";
     readonly ChorltonPallet: "Chorlton Pallet";
     readonly Pops: "POPS";
+    readonly Interparcel: "Interparcel";
 };
 export type ShipmentDTOCourierEnum = typeof ShipmentDTOCourierEnum[keyof typeof ShipmentDTOCourierEnum];
 /**
@@ -5423,6 +5499,9 @@ export interface ShipmentRequestDTO {
      * Courier
      */
     'courier'?: ShipmentRequestDTOCourierEnum;
+    /**
+     * Address
+     */
     'address'?: AddressModel | null;
     /**
      * Scanned Lines
@@ -5433,7 +5512,7 @@ export interface ShipmentRequestDTO {
      */
     'service'?: string;
     /**
-     * Date Time
+     * Ship Date
      */
     'shipDate'?: string | null;
     /**
@@ -5445,6 +5524,7 @@ export declare const ShipmentRequestDTOCourierEnum: {
     readonly Dpd: "DPD";
     readonly ChorltonPallet: "Chorlton Pallet";
     readonly Pops: "POPS";
+    readonly Interparcel: "Interparcel";
 };
 export type ShipmentRequestDTOCourierEnum = typeof ShipmentRequestDTOCourierEnum[keyof typeof ShipmentRequestDTOCourierEnum];
 /**
@@ -5539,6 +5619,7 @@ export declare const ShippingRequestDTOCourierEnum: {
     readonly Dpd: "DPD";
     readonly ChorltonPallet: "Chorlton Pallet";
     readonly Pops: "POPS";
+    readonly Interparcel: "Interparcel";
 };
 export type ShippingRequestDTOCourierEnum = typeof ShippingRequestDTOCourierEnum[keyof typeof ShippingRequestDTOCourierEnum];
 export declare const ShippingRequestDTOPrinterEnum: {
@@ -5564,6 +5645,7 @@ export declare const ShippingServiceDTOCourierEnum: {
     readonly Dpd: "DPD";
     readonly ChorltonPallet: "Chorlton Pallet";
     readonly Pops: "POPS";
+    readonly Interparcel: "Interparcel";
 };
 export type ShippingServiceDTOCourierEnum = typeof ShippingServiceDTOCourierEnum[keyof typeof ShippingServiceDTOCourierEnum];
 /**
@@ -5599,6 +5681,7 @@ export declare const ShippingServiceModelCourierEnum: {
     readonly Dpd: "DPD";
     readonly ChorltonPallet: "Chorlton Pallet";
     readonly Pops: "POPS";
+    readonly Interparcel: "Interparcel";
 };
 export type ShippingServiceModelCourierEnum = typeof ShippingServiceModelCourierEnum[keyof typeof ShippingServiceModelCourierEnum];
 export interface ShippingServicesModel {
@@ -7254,7 +7337,7 @@ export interface TcxKeySummaryDTO {
      */
     'edition'?: string;
     /**
-     * Date Time
+     * Expiry Date
      */
     'expiry'?: string | null;
 }
@@ -8487,6 +8570,12 @@ export declare const AccountsApiAxiosParamCreator: (configuration?: Configuratio
      * @throws {RequiredError}
      */
     getGetClientCredentials: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get Customer Accounts List
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetCustomerAccountsList: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Get 3CX Keys
      * @summary Get 3CX Keys
@@ -8825,6 +8914,12 @@ export declare const AccountsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getGetClientCredentials(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ClientModel>>>;
+    /**
+     * Get Customer Accounts List
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetCustomerAccountsList(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<CustomerListAccountDTO>>>;
     /**
      * Get 3CX Keys
      * @summary Get 3CX Keys
@@ -9163,6 +9258,12 @@ export declare const AccountsApiFactory: (configuration?: Configuration, basePat
      * @throws {RequiredError}
      */
     getGetClientCredentials(options?: RawAxiosRequestConfig): AxiosPromise<Array<ClientModel>>;
+    /**
+     * Get Customer Accounts List
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetCustomerAccountsList(options?: RawAxiosRequestConfig): AxiosPromise<Array<CustomerListAccountDTO>>;
     /**
      * Get 3CX Keys
      * @summary Get 3CX Keys
@@ -9501,6 +9602,12 @@ export declare class AccountsApi extends BaseAPI {
      * @throws {RequiredError}
      */
     getGetClientCredentials(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ClientModel[], any, {}>>;
+    /**
+     * Get Customer Accounts List
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetCustomerAccountsList(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CustomerListAccountDTO[], any, {}>>;
     /**
      * Get 3CX Keys
      * @summary Get 3CX Keys