yellowgrid-api-ts 3.2.143-dev.0 → 3.2.145-dev.0

package/api.ts

@@ -4199,6 +4199,51 @@ export interface OrderedItemModel {
      */
     'returnedStock'?: number;
 }
+/**
+ * 3CX Partner Details
+ */
+export interface PartnerDTO {
+    /**
+     * 3CX Partner ID
+     */
+    'partnerId'?: string;
+    /**
+     * 3CX Partner Company Name
+     */
+    'companyName'?: string;
+    /**
+     * 3CX Partner Contact Name
+     */
+    'contactName'?: string;
+    /**
+     * 3CX Partner Contact Phone
+     */
+    'contactPhone'?: string;
+    /**
+     * 3CX Partner Contact Email
+     */
+    'contactEmail'?: string;
+    /**
+     * 3CX Partner Level
+     */
+    'partnerLevel'?: string;
+    /**
+     * 3CX Partner Licence Discount Percent
+     */
+    'licenceDiscountPercent'?: number;
+    /**
+     * 3CX Partner Hosting Discount Percent
+     */
+    'hostingDisountPercent'?: number;
+    /**
+     * 3CX Hosting Price List
+     */
+    'hostingPriceList'?: string;
+    /**
+     * 3CX Installation URL
+     */
+    'installationUrl'?: string;
+}
 export interface PatchUpdateAccountCnameRequest {
     /**
      * CNAME
@@ -4260,6 +4305,29 @@ export interface PatchUpdateSipChannelCostRequest {
      */
     'channelCost'?: number;
 }
+export interface PatchUpdateTcxHostingPriceListRequest {
+    /**
+     * Price List
+     */
+    'priceList'?: PatchUpdateTcxHostingPriceListRequestPriceListEnum;
+}
+
+export const PatchUpdateTcxHostingPriceListRequestPriceListEnum = {
+    _1: '1',
+    _2: '2',
+    _3: '3',
+    _4: '4',
+    _5: '5'
+} as const;
+
+export type PatchUpdateTcxHostingPriceListRequestPriceListEnum = typeof PatchUpdateTcxHostingPriceListRequestPriceListEnum[keyof typeof PatchUpdateTcxHostingPriceListRequestPriceListEnum];
+
+export interface PatchUpdateTcxPartnerIdRequest {
+    /**
+     * Set Account 3CX Partner ID
+     */
+    'partnerId'?: string;
+}
 /**
  * Customer Account
  */
@@ -4426,20 +4494,10 @@ export interface PostGetProductForCustomerRequest {
      * 3CX Sales Code
      */
     'tcxSalesCode'?: string | null;
-}
-export interface PostGetProductRequest {
-    /**
-     * Quantity
-     */
-    'quantity'?: number | null;
     /**
-     * 3CX Licence Key
+     * 3CX Renewal Years (Upgrade Only)
      */
-    'licenceKey'?: string | null;
-    /**
-     * 3CX Hosting
-     */
-    'hosting'?: boolean | null;
+    'renewalYears'?: number | null;
 }
 export interface PostSendWelcomeEmailRequest {
     /**
@@ -8744,6 +8802,39 @@ export const AccountsApiAxiosParamCreator = function (configuration?: Configurat
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Get Account 3CX Details
+         * @param {string} id Xero ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getGetTcxPartnerDetails: async (id: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('getGetTcxPartnerDetails', 'id', id)
+            const localVarPath = `/admin/accounts/{id}/tcx/partner`
+                .replace(`{${"id"}}`, encodeURIComponent(String(id)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            localVarHeaderParameter['Accept'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * Verify account email address
          * @summary Verify account email address
@@ -9170,6 +9261,78 @@ export const AccountsApiAxiosParamCreator = function (configuration?: Configurat
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Set Account 3CX Hosting Price List
+         * @param {string} id Xero ID
+         * @param {PatchUpdateTcxHostingPriceListRequest} [patchUpdateTcxHostingPriceListRequest] 3CX Hosting Price List Request
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        patchUpdateTcxHostingPriceList: async (id: string, patchUpdateTcxHostingPriceListRequest?: PatchUpdateTcxHostingPriceListRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('patchUpdateTcxHostingPriceList', 'id', id)
+            const localVarPath = `/admin/accounts/{id}/tcx/hosting/priceList`
+                .replace(`{${"id"}}`, encodeURIComponent(String(id)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            localVarHeaderParameter['Accept'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(patchUpdateTcxHostingPriceListRequest, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Set Account 3CX Partner ID
+         * @param {string} id Xero ID
+         * @param {PatchUpdateTcxPartnerIdRequest} [patchUpdateTcxPartnerIdRequest] Set Account 3CX Partner ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        patchUpdateTcxPartnerId: async (id: string, patchUpdateTcxPartnerIdRequest?: PatchUpdateTcxPartnerIdRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('patchUpdateTcxPartnerId', 'id', id)
+            const localVarPath = `/admin/accounts{id}/tcx/partner/id`
+                .replace(`{${"id"}}`, encodeURIComponent(String(id)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            localVarHeaderParameter['Accept'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(patchUpdateTcxPartnerIdRequest, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * Create Account Contact
          * @param {string} id Account Xero ID
@@ -9800,6 +9963,18 @@ export const AccountsApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['AccountsApi.getGetFinanceSettings']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * Get Account 3CX Details
+         * @param {string} id Xero ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getGetTcxPartnerDetails(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PartnerDTO>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getGetTcxPartnerDetails(id, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['AccountsApi.getGetTcxPartnerDetails']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * Verify account email address
          * @summary Verify account email address
@@ -9956,6 +10131,32 @@ export const AccountsApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['AccountsApi.patchUpdateSipChannelCost']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * Set Account 3CX Hosting Price List
+         * @param {string} id Xero ID
+         * @param {PatchUpdateTcxHostingPriceListRequest} [patchUpdateTcxHostingPriceListRequest] 3CX Hosting Price List Request
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async patchUpdateTcxHostingPriceList(id: string, patchUpdateTcxHostingPriceListRequest?: PatchUpdateTcxHostingPriceListRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PartnerDTO>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.patchUpdateTcxHostingPriceList(id, patchUpdateTcxHostingPriceListRequest, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['AccountsApi.patchUpdateTcxHostingPriceList']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+        /**
+         * Set Account 3CX Partner ID
+         * @param {string} id Xero ID
+         * @param {PatchUpdateTcxPartnerIdRequest} [patchUpdateTcxPartnerIdRequest] Set Account 3CX Partner ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async patchUpdateTcxPartnerId(id: string, patchUpdateTcxPartnerIdRequest?: PatchUpdateTcxPartnerIdRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PartnerDTO>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.patchUpdateTcxPartnerId(id, patchUpdateTcxPartnerIdRequest, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['AccountsApi.patchUpdateTcxPartnerId']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * Create Account Contact
          * @param {string} id Account Xero ID
@@ -10263,6 +10464,15 @@ export const AccountsApiFactory = function (configuration?: Configuration, baseP
         getGetFinanceSettings(id: string, options?: RawAxiosRequestConfig): AxiosPromise<AccountFinanceDTO> {
             return localVarFp.getGetFinanceSettings(id, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Get Account 3CX Details
+         * @param {string} id Xero ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getGetTcxPartnerDetails(id: string, options?: RawAxiosRequestConfig): AxiosPromise<PartnerDTO> {
+            return localVarFp.getGetTcxPartnerDetails(id, options).then((request) => request(axios, basePath));
+        },
         /**
          * Verify account email address
          * @summary Verify account email address
@@ -10383,6 +10593,26 @@ export const AccountsApiFactory = function (configuration?: Configuration, baseP
         patchUpdateSipChannelCost(id: string, patchUpdateSipChannelCostRequest?: PatchUpdateSipChannelCostRequest, options?: RawAxiosRequestConfig): AxiosPromise<AccountFinanceDTO> {
             return localVarFp.patchUpdateSipChannelCost(id, patchUpdateSipChannelCostRequest, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Set Account 3CX Hosting Price List
+         * @param {string} id Xero ID
+         * @param {PatchUpdateTcxHostingPriceListRequest} [patchUpdateTcxHostingPriceListRequest] 3CX Hosting Price List Request
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        patchUpdateTcxHostingPriceList(id: string, patchUpdateTcxHostingPriceListRequest?: PatchUpdateTcxHostingPriceListRequest, options?: RawAxiosRequestConfig): AxiosPromise<PartnerDTO> {
+            return localVarFp.patchUpdateTcxHostingPriceList(id, patchUpdateTcxHostingPriceListRequest, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Set Account 3CX Partner ID
+         * @param {string} id Xero ID
+         * @param {PatchUpdateTcxPartnerIdRequest} [patchUpdateTcxPartnerIdRequest] Set Account 3CX Partner ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        patchUpdateTcxPartnerId(id: string, patchUpdateTcxPartnerIdRequest?: PatchUpdateTcxPartnerIdRequest, options?: RawAxiosRequestConfig): AxiosPromise<PartnerDTO> {
+            return localVarFp.patchUpdateTcxPartnerId(id, patchUpdateTcxPartnerIdRequest, options).then((request) => request(axios, basePath));
+        },
         /**
          * Create Account Contact
          * @param {string} id Account Xero ID
@@ -10662,6 +10892,16 @@ export class AccountsApi extends BaseAPI {
         return AccountsApiFp(this.configuration).getGetFinanceSettings(id, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * Get Account 3CX Details
+     * @param {string} id Xero ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public getGetTcxPartnerDetails(id: string, options?: RawAxiosRequestConfig) {
+        return AccountsApiFp(this.configuration).getGetTcxPartnerDetails(id, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * Verify account email address
      * @summary Verify account email address
@@ -10794,6 +11034,28 @@ export class AccountsApi extends BaseAPI {
         return AccountsApiFp(this.configuration).patchUpdateSipChannelCost(id, patchUpdateSipChannelCostRequest, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * Set Account 3CX Hosting Price List
+     * @param {string} id Xero ID
+     * @param {PatchUpdateTcxHostingPriceListRequest} [patchUpdateTcxHostingPriceListRequest] 3CX Hosting Price List Request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public patchUpdateTcxHostingPriceList(id: string, patchUpdateTcxHostingPriceListRequest?: PatchUpdateTcxHostingPriceListRequest, options?: RawAxiosRequestConfig) {
+        return AccountsApiFp(this.configuration).patchUpdateTcxHostingPriceList(id, patchUpdateTcxHostingPriceListRequest, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * Set Account 3CX Partner ID
+     * @param {string} id Xero ID
+     * @param {PatchUpdateTcxPartnerIdRequest} [patchUpdateTcxPartnerIdRequest] Set Account 3CX Partner ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public patchUpdateTcxPartnerId(id: string, patchUpdateTcxPartnerIdRequest?: PatchUpdateTcxPartnerIdRequest, options?: RawAxiosRequestConfig) {
+        return AccountsApiFp(this.configuration).patchUpdateTcxPartnerId(id, patchUpdateTcxPartnerIdRequest, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * Create Account Contact
      * @param {string} id Account Xero ID
@@ -21257,15 +21519,15 @@ export const ProductsApiAxiosParamCreator = function (configuration?: Configurat
          * Get Product
          * @summary Get Product
          * @param {string} sku Product SKU
-         * @param {PostGetProductRequest} postGetProductRequest Product search criteria
+         * @param {PostGetProductForCustomerRequest} postGetProductForCustomerRequest Product search criteria
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        postGetProduct: async (sku: string, postGetProductRequest: PostGetProductRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+        postGetProduct: async (sku: string, postGetProductForCustomerRequest: PostGetProductForCustomerRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
             // verify required parameter 'sku' is not null or undefined
             assertParamExists('postGetProduct', 'sku', sku)
-            // verify required parameter 'postGetProductRequest' is not null or undefined
-            assertParamExists('postGetProduct', 'postGetProductRequest', postGetProductRequest)
+            // verify required parameter 'postGetProductForCustomerRequest' is not null or undefined
+            assertParamExists('postGetProduct', 'postGetProductForCustomerRequest', postGetProductForCustomerRequest)
             const localVarPath = `/products/{sku}`
                 .replace(`{${"sku"}}`, encodeURIComponent(String(sku)));
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
@@ -21285,7 +21547,7 @@ export const ProductsApiAxiosParamCreator = function (configuration?: Configurat
             setSearchParams(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
-            localVarRequestOptions.data = serializeDataIfNeeded(postGetProductRequest, localVarRequestOptions, configuration)
+            localVarRequestOptions.data = serializeDataIfNeeded(postGetProductForCustomerRequest, localVarRequestOptions, configuration)
 
             return {
                 url: toPathString(localVarUrlObj),
@@ -21454,12 +21716,12 @@ export const ProductsApiFp = function(configuration?: Configuration) {
          * Get Product
          * @summary Get Product
          * @param {string} sku Product SKU
-         * @param {PostGetProductRequest} postGetProductRequest Product search criteria
+         * @param {PostGetProductForCustomerRequest} postGetProductForCustomerRequest Product search criteria
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async postGetProduct(sku: string, postGetProductRequest: PostGetProductRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductSummaryDTO>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.postGetProduct(sku, postGetProductRequest, options);
+        async postGetProduct(sku: string, postGetProductForCustomerRequest: PostGetProductForCustomerRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductSummaryDTO>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.postGetProduct(sku, postGetProductForCustomerRequest, options);
             const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
             const localVarOperationServerBasePath = operationServerMap['ProductsApi.postGetProduct']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -21571,12 +21833,12 @@ export const ProductsApiFactory = function (configuration?: Configuration, baseP
          * Get Product
          * @summary Get Product
          * @param {string} sku Product SKU
-         * @param {PostGetProductRequest} postGetProductRequest Product search criteria
+         * @param {PostGetProductForCustomerRequest} postGetProductForCustomerRequest Product search criteria
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        postGetProduct(sku: string, postGetProductRequest: PostGetProductRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProductSummaryDTO> {
-            return localVarFp.postGetProduct(sku, postGetProductRequest, options).then((request) => request(axios, basePath));
+        postGetProduct(sku: string, postGetProductForCustomerRequest: PostGetProductForCustomerRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProductSummaryDTO> {
+            return localVarFp.postGetProduct(sku, postGetProductForCustomerRequest, options).then((request) => request(axios, basePath));
         },
         /**
          * Get Product For Customer
@@ -21688,12 +21950,12 @@ export class ProductsApi extends BaseAPI {
      * Get Product
      * @summary Get Product
      * @param {string} sku Product SKU
-     * @param {PostGetProductRequest} postGetProductRequest Product search criteria
+     * @param {PostGetProductForCustomerRequest} postGetProductForCustomerRequest Product search criteria
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    public postGetProduct(sku: string, postGetProductRequest: PostGetProductRequest, options?: RawAxiosRequestConfig) {
-        return ProductsApiFp(this.configuration).postGetProduct(sku, postGetProductRequest, options).then((request) => request(this.axios, this.basePath));
+    public postGetProduct(sku: string, postGetProductForCustomerRequest: PostGetProductForCustomerRequest, options?: RawAxiosRequestConfig) {
+        return ProductsApiFp(this.configuration).postGetProduct(sku, postGetProductForCustomerRequest, options).then((request) => request(this.axios, this.basePath));
     }
 
     /**