yellowgrid-api-ts 3.2.177-dev.0 → 3.2.178-dev.0

package/dist/api.d.ts

@@ -2459,6 +2459,28 @@ export interface EventUpdateRequestDTO {
      */
     'createdAt'?: string;
 }
+/**
+ * 3CX Expiring Key
+ */
+export interface ExpiringKeyDTO {
+    /**
+     * Date Time
+     */
+    'expiryDate'?: string;
+    /**
+     * Licence Key
+     */
+    'licenceKey'?: string;
+    /**
+     * Edition
+     */
+    'edition'?: string;
+    /**
+     * Type
+     */
+    'type'?: string;
+    'partner'?: PartnerDTO;
+}
 /**
  * Fraud Management
  */
@@ -3521,6 +3543,31 @@ export interface OfflineInstancesEntity {
      */
     'alerted'?: number;
 }
+/**
+ * Opayo Redirect
+ */
+export interface OpayoRedirectDTO {
+    /**
+     * acsUrl
+     */
+    'acsUrl'?: string | null;
+    /**
+     * paReq
+     */
+    'paReq'?: string | null;
+    /**
+     * Transaction ID
+     */
+    'transactionId'?: string | null;
+    /**
+     * dsTranId
+     */
+    'dsTranId'?: string | null;
+    /**
+     * cReq
+     */
+    'cReq'?: string | null;
+}
 /**
  * Legacy Portal Order
  */
@@ -10248,6 +10295,13 @@ export declare const Class3CXApiAxiosParamCreator: (configuration?: Configuratio
      * @throws {RequiredError}
      */
     getGetTcxExpiringKeys: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get 3CX Expiring Keys
+     * @summary Get 3CX Expiring Keys
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetTcxExpiringKeysCsv: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Get 3CX Partners
      * @summary Get 3CX Partners
@@ -10289,7 +10343,14 @@ export declare const Class3CXApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getGetTcxExpiringKeys(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
+    getGetTcxExpiringKeys(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ExpiringKeyDTO>>>;
+    /**
+     * Get 3CX Expiring Keys
+     * @summary Get 3CX Expiring Keys
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetTcxExpiringKeysCsv(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
     /**
      * Get 3CX Partners
      * @summary Get 3CX Partners
@@ -10331,7 +10392,14 @@ export declare const Class3CXApiFactory: (configuration?: Configuration, basePat
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getGetTcxExpiringKeys(options?: RawAxiosRequestConfig): AxiosPromise<string>;
+    getGetTcxExpiringKeys(options?: RawAxiosRequestConfig): AxiosPromise<Array<ExpiringKeyDTO>>;
+    /**
+     * Get 3CX Expiring Keys
+     * @summary Get 3CX Expiring Keys
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetTcxExpiringKeysCsv(options?: RawAxiosRequestConfig): AxiosPromise<string>;
     /**
      * Get 3CX Partners
      * @summary Get 3CX Partners
@@ -10373,7 +10441,14 @@ export declare class Class3CXApi extends BaseAPI {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getGetTcxExpiringKeys(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any, {}>>;
+    getGetTcxExpiringKeys(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ExpiringKeyDTO[], any, {}>>;
+    /**
+     * Get 3CX Expiring Keys
+     * @summary Get 3CX Expiring Keys
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetTcxExpiringKeysCsv(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any, {}>>;
     /**
      * Get 3CX Partners
      * @summary Get 3CX Partners
@@ -13853,10 +13928,11 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
      * Mark Order As Complete (Admin)
      * @summary Mark Order As Complete (Admin)
      * @param {number} id Order ID
+     * @param {boolean} complete Complete Status
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    patchCompleteOrder: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    patchCompleteOrder: (id: number, complete: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Add Order Note
      * @summary Add Order Note
@@ -14147,10 +14223,11 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
      * Mark Order As Complete (Admin)
      * @summary Mark Order As Complete (Admin)
      * @param {number} id Order ID
+     * @param {boolean} complete Complete Status
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    patchCompleteOrder(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrderDetailsDTO>>;
+    patchCompleteOrder(id: number, complete: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrderDetailsDTO>>;
     /**
      * Add Order Note
      * @summary Add Order Note
@@ -14441,10 +14518,11 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
      * Mark Order As Complete (Admin)
      * @summary Mark Order As Complete (Admin)
      * @param {number} id Order ID
+     * @param {boolean} complete Complete Status
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    patchCompleteOrder(id: number, options?: RawAxiosRequestConfig): AxiosPromise<OrderDetailsDTO>;
+    patchCompleteOrder(id: number, complete: boolean, options?: RawAxiosRequestConfig): AxiosPromise<OrderDetailsDTO>;
     /**
      * Add Order Note
      * @summary Add Order Note
@@ -14735,10 +14813,11 @@ export declare class OrdersApi extends BaseAPI {
      * Mark Order As Complete (Admin)
      * @summary Mark Order As Complete (Admin)
      * @param {number} id Order ID
+     * @param {boolean} complete Complete Status
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    patchCompleteOrder(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderDetailsDTO, any, {}>>;
+    patchCompleteOrder(id: number, complete: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderDetailsDTO, any, {}>>;
     /**
      * Add Order Note
      * @summary Add Order Note
@@ -15214,20 +15293,22 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
      * @summary Get Product
      * @param {string} sku Product SKU
      * @param {PostGetProductForCustomerRequest} postGetProductForCustomerRequest Product search criteria
+     * @param {number} [orderId] Order ID
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    postGetProduct: (sku: string, postGetProductForCustomerRequest: PostGetProductForCustomerRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    postGetProduct: (sku: string, postGetProductForCustomerRequest: PostGetProductForCustomerRequest, orderId?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Get Product For Customer
      * @summary Get Product For Customer
      * @param {number} customerId Customer ID
      * @param {string} sku Product SKU
      * @param {PostGetProductForCustomerRequest} postGetProductForCustomerRequest Product search criteria
+     * @param {number} [orderId] Order ID
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    postGetProductForCustomer: (customerId: number, sku: string, postGetProductForCustomerRequest: PostGetProductForCustomerRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    postGetProductForCustomer: (customerId: number, sku: string, postGetProductForCustomerRequest: PostGetProductForCustomerRequest, orderId?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * ProductsApi - functional programming interface
@@ -15301,20 +15382,22 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
      * @summary Get Product
      * @param {string} sku Product SKU
      * @param {PostGetProductForCustomerRequest} postGetProductForCustomerRequest Product search criteria
+     * @param {number} [orderId] Order ID
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    postGetProduct(sku: string, postGetProductForCustomerRequest: PostGetProductForCustomerRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductSummaryDTO>>;
+    postGetProduct(sku: string, postGetProductForCustomerRequest: PostGetProductForCustomerRequest, orderId?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductSummaryDTO>>;
     /**
      * Get Product For Customer
      * @summary Get Product For Customer
      * @param {number} customerId Customer ID
      * @param {string} sku Product SKU
      * @param {PostGetProductForCustomerRequest} postGetProductForCustomerRequest Product search criteria
+     * @param {number} [orderId] Order ID
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    postGetProductForCustomer(customerId: number, sku: string, postGetProductForCustomerRequest: PostGetProductForCustomerRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductSummaryDTO>>;
+    postGetProductForCustomer(customerId: number, sku: string, postGetProductForCustomerRequest: PostGetProductForCustomerRequest, orderId?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductSummaryDTO>>;
 };
 /**
  * ProductsApi - factory interface
@@ -15388,20 +15471,22 @@ export declare const ProductsApiFactory: (configuration?: Configuration, basePat
      * @summary Get Product
      * @param {string} sku Product SKU
      * @param {PostGetProductForCustomerRequest} postGetProductForCustomerRequest Product search criteria
+     * @param {number} [orderId] Order ID
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    postGetProduct(sku: string, postGetProductForCustomerRequest: PostGetProductForCustomerRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProductSummaryDTO>;
+    postGetProduct(sku: string, postGetProductForCustomerRequest: PostGetProductForCustomerRequest, orderId?: number, options?: RawAxiosRequestConfig): AxiosPromise<ProductSummaryDTO>;
     /**
      * Get Product For Customer
      * @summary Get Product For Customer
      * @param {number} customerId Customer ID
      * @param {string} sku Product SKU
      * @param {PostGetProductForCustomerRequest} postGetProductForCustomerRequest Product search criteria
+     * @param {number} [orderId] Order ID
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    postGetProductForCustomer(customerId: number, sku: string, postGetProductForCustomerRequest: PostGetProductForCustomerRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProductSummaryDTO>;
+    postGetProductForCustomer(customerId: number, sku: string, postGetProductForCustomerRequest: PostGetProductForCustomerRequest, orderId?: number, options?: RawAxiosRequestConfig): AxiosPromise<ProductSummaryDTO>;
 };
 /**
  * ProductsApi - object-oriented interface
@@ -15475,20 +15560,22 @@ export declare class ProductsApi extends BaseAPI {
      * @summary Get Product
      * @param {string} sku Product SKU
      * @param {PostGetProductForCustomerRequest} postGetProductForCustomerRequest Product search criteria
+     * @param {number} [orderId] Order ID
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    postGetProduct(sku: string, postGetProductForCustomerRequest: PostGetProductForCustomerRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProductSummaryDTO, any, {}>>;
+    postGetProduct(sku: string, postGetProductForCustomerRequest: PostGetProductForCustomerRequest, orderId?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProductSummaryDTO, any, {}>>;
     /**
      * Get Product For Customer
      * @summary Get Product For Customer
      * @param {number} customerId Customer ID
      * @param {string} sku Product SKU
      * @param {PostGetProductForCustomerRequest} postGetProductForCustomerRequest Product search criteria
+     * @param {number} [orderId] Order ID
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    postGetProductForCustomer(customerId: number, sku: string, postGetProductForCustomerRequest: PostGetProductForCustomerRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProductSummaryDTO, any, {}>>;
+    postGetProductForCustomer(customerId: number, sku: string, postGetProductForCustomerRequest: PostGetProductForCustomerRequest, orderId?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProductSummaryDTO, any, {}>>;
 }
 export declare const GetGetLegacyStockListFormatEnum: {
     readonly Xml: "XML";
@@ -15726,10 +15813,11 @@ export declare const ProvisioningApiAxiosParamCreator: (configuration?: Configur
     postAddFanvilMac: (id: string, mac: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Create a MAC address in FDPS
+     * @param {MacAddressDTO} [macAddressDTO] Mac Address
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    postCreateMac: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    postCreateMac: (macAddressDTO?: MacAddressDTO, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * ProvisioningApi - functional programming interface
@@ -15810,10 +15898,11 @@ export declare const ProvisioningApiFp: (configuration?: Configuration) => {
     postAddFanvilMac(id: string, mac: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
      * Create a MAC address in FDPS
+     * @param {MacAddressDTO} [macAddressDTO] Mac Address
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    postCreateMac(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MacAddressDTO>>;
+    postCreateMac(macAddressDTO?: MacAddressDTO, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MacAddressDTO>>;
 };
 /**
  * ProvisioningApi - factory interface
@@ -15894,10 +15983,11 @@ export declare const ProvisioningApiFactory: (configuration?: Configuration, bas
     postAddFanvilMac(id: string, mac: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
     /**
      * Create a MAC address in FDPS
+     * @param {MacAddressDTO} [macAddressDTO] Mac Address
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    postCreateMac(options?: RawAxiosRequestConfig): AxiosPromise<MacAddressDTO>;
+    postCreateMac(macAddressDTO?: MacAddressDTO, options?: RawAxiosRequestConfig): AxiosPromise<MacAddressDTO>;
 };
 /**
  * ProvisioningApi - object-oriented interface
@@ -15978,10 +16068,11 @@ export declare class ProvisioningApi extends BaseAPI {
     postAddFanvilMac(id: string, mac: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
     /**
      * Create a MAC address in FDPS
+     * @param {MacAddressDTO} [macAddressDTO] Mac Address
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    postCreateMac(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MacAddressDTO, any, {}>>;
+    postCreateMac(macAddressDTO?: MacAddressDTO, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MacAddressDTO, any, {}>>;
 }
 /**
  * SIPTrunksApi - axios parameter creator