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

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
  *
@@ -279,6 +279,10 @@ export interface AccountFinanceDTO {
      * Overdue Amount
      */
     'overdue'?: number;
+    /**
+     * On Hold
+     */
+    'onHold'?: boolean;
     'priceList'?: CustomerPriceListEnum;
     /**
      * SIP Trunk Channel Cost
@@ -1639,6 +1643,23 @@ export interface CreditNoteModel {
      */
     'items'?: Array<CreditNoteItemModel>;
 }
+/**
+ * 3CX Credit Status
+ */
+export interface CreditStatusDTO {
+    /**
+     * Currency Code
+     */
+    'CurrencyCode'?: string | null;
+    /**
+     * Credit Limit
+     */
+    'CreditLimit'?: number | null;
+    /**
+     * Credit
+     */
+    'Credit'?: number | null;
+}
 /**
  * CRM Activities Response
  */
@@ -4299,6 +4320,10 @@ export interface PartnerDTO {
      * 3CX Installation URL
      */
     'installationUrl'?: string;
+    /**
+     * Aligned
+     */
+    'aligned'?: boolean;
 }
 export interface PatchUpdateAccountCnameRequest {
     /**
@@ -4991,6 +5016,12 @@ export interface PutAllocateItemsRequestItemsInner {
      */
     'quantity'?: number;
 }
+export interface PutTransferConnectionRequest {
+    /**
+     * Customer ID
+     */
+    'customerId'?: number;
+}
 /**
  * Azure Recordings Backup
  */
@@ -5319,6 +5350,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];
 /**
@@ -5523,6 +5555,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];
 /**
@@ -5617,6 +5650,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: {
@@ -5642,6 +5676,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];
 /**
@@ -5677,6 +5712,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 {
@@ -8615,6 +8651,14 @@ export declare const AccountsApiAxiosParamCreator: (configuration?: Configuratio
      * @throws {RequiredError}
      */
     patchSetAccountStatus: (id: string, state: PatchSetAccountStatusStateEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Set Account On Hold
+     * @param {string} id Xero ID
+     * @param {PatchSetOnHoldStateEnum} state On Hold State
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchSetOnHold: (id: string, state: PatchSetOnHoldStateEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Set Account Portal Access
      * @param {string} id Xero ID
@@ -8967,6 +9011,14 @@ export declare const AccountsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     patchSetAccountStatus(id: string, state: PatchSetAccountStatusStateEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Set Account On Hold
+     * @param {string} id Xero ID
+     * @param {PatchSetOnHoldStateEnum} state On Hold State
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchSetOnHold(id: string, state: PatchSetOnHoldStateEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountFinanceDTO>>;
     /**
      * Set Account Portal Access
      * @param {string} id Xero ID
@@ -9319,6 +9371,14 @@ export declare const AccountsApiFactory: (configuration?: Configuration, basePat
      * @throws {RequiredError}
      */
     patchSetAccountStatus(id: string, state: PatchSetAccountStatusStateEnum, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * Set Account On Hold
+     * @param {string} id Xero ID
+     * @param {PatchSetOnHoldStateEnum} state On Hold State
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchSetOnHold(id: string, state: PatchSetOnHoldStateEnum, options?: RawAxiosRequestConfig): AxiosPromise<AccountFinanceDTO>;
     /**
      * Set Account Portal Access
      * @param {string} id Xero ID
@@ -9671,6 +9731,14 @@ export declare class AccountsApi extends BaseAPI {
      * @throws {RequiredError}
      */
     patchSetAccountStatus(id: string, state: PatchSetAccountStatusStateEnum, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     * Set Account On Hold
+     * @param {string} id Xero ID
+     * @param {PatchSetOnHoldStateEnum} state On Hold State
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchSetOnHold(id: string, state: PatchSetOnHoldStateEnum, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountFinanceDTO, any, {}>>;
     /**
      * Set Account Portal Access
      * @param {string} id Xero ID
@@ -9888,6 +9956,11 @@ export declare const PatchSetAccountStatusStateEnum: {
     readonly Disable: "disable";
 };
 export type PatchSetAccountStatusStateEnum = typeof PatchSetAccountStatusStateEnum[keyof typeof PatchSetAccountStatusStateEnum];
+export declare const PatchSetOnHoldStateEnum: {
+    readonly Enable: "enable";
+    readonly Disable: "disable";
+};
+export type PatchSetOnHoldStateEnum = typeof PatchSetOnHoldStateEnum[keyof typeof PatchSetOnHoldStateEnum];
 export declare const PatchSetPortalAccessStateEnum: {
     readonly Enable: "enable";
     readonly Disable: "disable";
@@ -9909,6 +9982,16 @@ export declare const BillingApiAxiosParamCreator: (configuration?: Configuration
      * @throws {RequiredError}
      */
     getGetAllCustomer: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Transfer Billing Connection
+     * @param {PutTransferConnectionRequest} putTransferConnectionRequest Transfer Request
+     * @param {number} [id] Connection ID
+     * @param {string} [cli] CLI
+     * @param {boolean} [skipDDis] Skip DDIs
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    putTransferConnection: (putTransferConnectionRequest: PutTransferConnectionRequest, id?: number, cli?: string, skipDDis?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * BillingApi - functional programming interface
@@ -9925,6 +10008,16 @@ export declare const BillingApiFp: (configuration?: Configuration) => {
             [key: string]: string;
         };
     }>>;
+    /**
+     * Transfer Billing Connection
+     * @param {PutTransferConnectionRequest} putTransferConnectionRequest Transfer Request
+     * @param {number} [id] Connection ID
+     * @param {string} [cli] CLI
+     * @param {boolean} [skipDDis] Skip DDIs
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    putTransferConnection(putTransferConnectionRequest: PutTransferConnectionRequest, id?: number, cli?: string, skipDDis?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
 };
 /**
  * BillingApi - factory interface
@@ -9941,6 +10034,16 @@ export declare const BillingApiFactory: (configuration?: Configuration, basePath
             [key: string]: string;
         };
     }>;
+    /**
+     * Transfer Billing Connection
+     * @param {PutTransferConnectionRequest} putTransferConnectionRequest Transfer Request
+     * @param {number} [id] Connection ID
+     * @param {string} [cli] CLI
+     * @param {boolean} [skipDDis] Skip DDIs
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    putTransferConnection(putTransferConnectionRequest: PutTransferConnectionRequest, id?: number, cli?: string, skipDDis?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<object>;
 };
 /**
  * BillingApi - object-oriented interface
@@ -9957,6 +10060,16 @@ export declare class BillingApi extends BaseAPI {
             [key: string]: string;
         };
     }, any, {}>>;
+    /**
+     * Transfer Billing Connection
+     * @param {PutTransferConnectionRequest} putTransferConnectionRequest Transfer Request
+     * @param {number} [id] Connection ID
+     * @param {string} [cli] CLI
+     * @param {boolean} [skipDDis] Skip DDIs
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    putTransferConnection(putTransferConnectionRequest: PutTransferConnectionRequest, id?: number, cli?: string, skipDDis?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any, {}>>;
 }
 /**
  * CRMApi - axios parameter creator
@@ -10092,6 +10205,13 @@ export declare const Class3CXApiAxiosParamCreator: (configuration?: Configuratio
      * @throws {RequiredError}
      */
     getGetLicenceDetails: (key: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get 3CX Credit Status
+     * @summary Get 3CX Credit Status
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetTcxCreditStatus: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Get 3CX Expiring Keys
      * @summary Get 3CX Expiring Keys
@@ -10120,6 +10240,13 @@ export declare const Class3CXApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getGetLicenceDetails(key: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TcxLicenceDetailsModel>>;
+    /**
+     * Get 3CX Credit Status
+     * @summary Get 3CX Credit Status
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetTcxCreditStatus(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreditStatusDTO>>;
     /**
      * Get 3CX Expiring Keys
      * @summary Get 3CX Expiring Keys
@@ -10148,6 +10275,13 @@ export declare const Class3CXApiFactory: (configuration?: Configuration, basePat
      * @throws {RequiredError}
      */
     getGetLicenceDetails(key: string, options?: RawAxiosRequestConfig): AxiosPromise<TcxLicenceDetailsModel>;
+    /**
+     * Get 3CX Credit Status
+     * @summary Get 3CX Credit Status
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetTcxCreditStatus(options?: RawAxiosRequestConfig): AxiosPromise<CreditStatusDTO>;
     /**
      * Get 3CX Expiring Keys
      * @summary Get 3CX Expiring Keys
@@ -10176,6 +10310,13 @@ export declare class Class3CXApi extends BaseAPI {
      * @throws {RequiredError}
      */
     getGetLicenceDetails(key: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TcxLicenceDetailsModel, any, {}>>;
+    /**
+     * Get 3CX Credit Status
+     * @summary Get 3CX Credit Status
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetTcxCreditStatus(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreditStatusDTO, any, {}>>;
     /**
      * Get 3CX Expiring Keys
      * @summary Get 3CX Expiring Keys