yellowgrid-api-ts 3.2.72-dev.0 → 3.2.73

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
  *
@@ -511,9 +511,13 @@ export interface AdminNumberPortDTO {
      */
     'notes'?: Array<NumberPortNoteDTO>;
     /**
-     * CLOAs
+     * Attachments
+     */
+    'cloas'?: Array<AttachmentModel>;
+    /**
+     * Created At
      */
-    'cloas'?: Array<string>;
+    'createdAt'?: string;
 }
 /**
  * Admin Order Request
@@ -3447,6 +3451,12 @@ export interface PortalLoginModel {
      */
     'redirect_uri'?: string;
 }
+export interface PostAddAdminNoteRequest {
+    /**
+     * Note
+     */
+    'note'?: string;
+}
 export interface PostAddWebhook200Response {
     'url'?: string;
 }
@@ -4281,6 +4291,35 @@ export interface SipTrunksResponseModel {
      */
     'totalResults'?: number;
 }
+/**
+ * SMS Account
+ */
+export interface SmsAccountDTO {
+    /**
+     * Send URL
+     */
+    'sendUrl'?: string;
+    /**
+     * Webhook URL
+     */
+    'webhookUrl'?: string;
+    /**
+     * API Key
+     */
+    'apiKey'?: string;
+    /**
+     * Numbers
+     */
+    'numbers'?: Array<SmsNumbersEntity>;
+    /**
+     * Name
+     */
+    'name'?: string;
+    /**
+     * Sender Whitelist
+     */
+    'whitelist'?: Array<SmsWhitelistEntity>;
+}
 /**
  * SmsEntity
  */
@@ -4314,6 +4353,43 @@ export interface SmsAccountEntity {
      */
     'name'?: string;
 }
+/**
+ * SMS Account Request
+ */
+export interface SmsAccountRequestDTO {
+    /**
+     * SMS Provider
+     */
+    'provider'?: SmsAccountRequestDTOProviderEnum;
+    /**
+     * Customer Name
+     */
+    'name'?: string;
+    /**
+     * SMS Webhook
+     */
+    'webhookUrl'?: string;
+    /**
+     * Number Country
+     */
+    'iso'?: string;
+    /**
+     * Number Type
+     */
+    '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
  */
@@ -9824,6 +9900,13 @@ export declare const NumberPortingApiAxiosParamCreator: (configuration?: Configu
      * @throws {RequiredError}
      */
     getUpdateNumberPort: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @param {number} id Number Port ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchCancelAdminNumberPort: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @param {number} id Number Port ID
@@ -9834,11 +9917,11 @@ export declare const NumberPortingApiAxiosParamCreator: (configuration?: Configu
     /**
      *
      * @param {number} id Number Port ID
-     * @param {string} body
+     * @param {PostAddAdminNoteRequest} postAddAdminNoteRequest
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    postAddAdminNote: (id: number, body: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    postAddAdminNote: (id: number, postAddAdminNoteRequest: PostAddAdminNoteRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @param {string | null} [companyName] Company Name
@@ -9947,6 +10030,13 @@ export declare const NumberPortingApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getUpdateNumberPort(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NumberPortDTO>>;
+    /**
+     *
+     * @param {number} id Number Port ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchCancelAdminNumberPort(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminNumberPortDTO>>;
     /**
      *
      * @param {number} id Number Port ID
@@ -9957,11 +10047,11 @@ export declare const NumberPortingApiFp: (configuration?: Configuration) => {
     /**
      *
      * @param {number} id Number Port ID
-     * @param {string} body
+     * @param {PostAddAdminNoteRequest} postAddAdminNoteRequest
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    postAddAdminNote(id: number, body: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminNumberPortDTO>>;
+    postAddAdminNote(id: number, postAddAdminNoteRequest: PostAddAdminNoteRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AdminNumberPortDTO>>;
     /**
      *
      * @param {string | null} [companyName] Company Name
@@ -10070,6 +10160,13 @@ export declare const NumberPortingApiFactory: (configuration?: Configuration, ba
      * @throws {RequiredError}
      */
     getUpdateNumberPort(id: number, options?: RawAxiosRequestConfig): AxiosPromise<NumberPortDTO>;
+    /**
+     *
+     * @param {number} id Number Port ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchCancelAdminNumberPort(id: number, options?: RawAxiosRequestConfig): AxiosPromise<AdminNumberPortDTO>;
     /**
      *
      * @param {number} id Number Port ID
@@ -10080,11 +10177,11 @@ export declare const NumberPortingApiFactory: (configuration?: Configuration, ba
     /**
      *
      * @param {number} id Number Port ID
-     * @param {string} body
+     * @param {PostAddAdminNoteRequest} postAddAdminNoteRequest
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    postAddAdminNote(id: number, body: string, options?: RawAxiosRequestConfig): AxiosPromise<AdminNumberPortDTO>;
+    postAddAdminNote(id: number, postAddAdminNoteRequest: PostAddAdminNoteRequest, options?: RawAxiosRequestConfig): AxiosPromise<AdminNumberPortDTO>;
     /**
      *
      * @param {string | null} [companyName] Company Name
@@ -10193,6 +10290,13 @@ export declare class NumberPortingApi extends BaseAPI {
      * @throws {RequiredError}
      */
     getUpdateNumberPort(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<NumberPortDTO, any, {}>>;
+    /**
+     *
+     * @param {number} id Number Port ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchCancelAdminNumberPort(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminNumberPortDTO, any, {}>>;
     /**
      *
      * @param {number} id Number Port ID
@@ -10203,11 +10307,11 @@ export declare class NumberPortingApi extends BaseAPI {
     /**
      *
      * @param {number} id Number Port ID
-     * @param {string} body
+     * @param {PostAddAdminNoteRequest} postAddAdminNoteRequest
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    postAddAdminNote(id: number, body: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminNumberPortDTO, any, {}>>;
+    postAddAdminNote(id: number, postAddAdminNoteRequest: PostAddAdminNoteRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AdminNumberPortDTO, any, {}>>;
     /**
      *
      * @param {string | null} [companyName] Company Name
@@ -10567,6 +10671,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";
@@ -10601,6 +10707,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";
@@ -12531,6 +12639,14 @@ export declare class SIPTrunksApi extends BaseAPI {
  * SMSApi - axios parameter creator
  */
 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
@@ -12544,6 +12660,14 @@ export declare const SMSApiAxiosParamCreator: (configuration?: Configuration) =>
  * SMSApi - functional programming interface
  */
 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
@@ -12557,6 +12681,14 @@ export declare const SMSApiFp: (configuration?: Configuration) => {
  * SMSApi - factory interface
  */
 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
@@ -12570,6 +12702,14 @@ export declare const SMSApiFactory: (configuration?: Configuration, basePath?: s
  * SMSApi - object-oriented interface
  */
 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}
+     */
+    postCreateSmsAccount(smsAccountRequestDTO?: SmsAccountRequestDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SmsAccountDTO, any, {}>>;
     /**
      * Send SMS
      * @param {string} authorization Bearer Token