yellowgrid-api-ts 3.2.139-dev.0 → 3.2.141-dev.0

package/dist/api.d.ts

@@ -237,6 +237,40 @@ export interface AccountDetailedSummaryDTO {
      */
     'balance'?: number | null;
 }
+/**
+ * Account Finance DTO
+ */
+export interface AccountFinanceDTO {
+    /**
+     * Account ID
+     */
+    'id'?: number;
+    /**
+     * Account Xero ID
+     */
+    'xeroId'?: string;
+    /**
+     * Credit Limit
+     */
+    'creditLimit'?: number;
+    /**
+     * Balance Used
+     */
+    'balance'?: number;
+    /**
+     * Overdue Amount
+     */
+    'overdue'?: number;
+    'priceList'?: CustomerPriceListEnum;
+    /**
+     * SIP Trunk Channel Cost
+     */
+    'sipChannelCost'?: number;
+    /**
+     * Xero Contact URL
+     */
+    'xeroUrl'?: string;
+}
 /**
  * Account Page Details
  */
@@ -1831,6 +1865,10 @@ export interface CustomerItemRequestDTO {
      * 3CX Hosting
      */
     'hosting'?: boolean | null;
+    /**
+     * 3CX Renewal Years (Upgrade only)
+     */
+    'renewalYears'?: number | null;
     /**
      * Date Time
      */
@@ -1964,6 +2002,10 @@ export interface DetailedItemRequestDTO {
      * 3CX Hosting
      */
     'hosting'?: boolean | null;
+    /**
+     * 3CX Renewal Years (Upgrade only)
+     */
+    'renewalYears'?: number | null;
     /**
      * Date Time
      */
@@ -2902,6 +2944,10 @@ export interface ItemDTO {
      * 3CX Hosting
      */
     'hosting'?: boolean | null;
+    /**
+     * 3CX Renewal Years (Upgrade only)
+     */
+    'renewalYears'?: number | null;
     /**
      * Promo Item
      */
@@ -3727,6 +3773,10 @@ export interface OrderItemDTO {
      * 3CX Hosting
      */
     'hosting'?: boolean | null;
+    /**
+     * 3CX Renewal Years (Upgrade only)
+     */
+    'renewalYears'?: number | null;
     /**
      * Promo Item
      */
@@ -4131,6 +4181,34 @@ export interface PatchUpdateAccountVatNumberRequest {
      */
     'vatNumber'?: string;
 }
+export interface PatchUpdateCreditLimitRequest {
+    /**
+     * Credit Limit
+     */
+    'creditLimit'?: number;
+}
+export interface PatchUpdatePriceListRequest {
+    /**
+     * Price List
+     */
+    'priceList'?: PatchUpdatePriceListRequestPriceListEnum;
+}
+export declare const PatchUpdatePriceListRequestPriceListEnum: {
+    readonly Rrp: "RRP";
+    readonly Trade: "Trade";
+    readonly Wholesale: "Wholesale";
+    readonly Itsp: "ITSP";
+    readonly SubDisti: "Sub Disti";
+    readonly Distributor: "Distributor";
+    readonly HotelDisti: "Hotel Disti";
+};
+export type PatchUpdatePriceListRequestPriceListEnum = typeof PatchUpdatePriceListRequestPriceListEnum[keyof typeof PatchUpdatePriceListRequestPriceListEnum];
+export interface PatchUpdateSipChannelCostRequest {
+    /**
+     * SIP Channel Cost
+     */
+    'channelCost'?: number;
+}
 /**
  * Customer Account
  */
@@ -8118,6 +8196,13 @@ export declare const AccountsApiAxiosParamCreator: (configuration?: Configuratio
      * @throws {RequiredError}
      */
     deleteAdminUpdateAccountContact: (id: string, contactId: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Delete Account
+     * @param {string} id Account Xero ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteArchiveAccount: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Delete client credentials
      * @summary Delete client credentials
@@ -8126,6 +8211,13 @@ export declare const AccountsApiAxiosParamCreator: (configuration?: Configuratio
      * @throws {RequiredError}
      */
     deleteDeleteClientCredentials: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get Account Finance
+     * @param {string} id Account Xero ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteGetFinanceSettings: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Delete Account Contacts
      * @summary Delete Account Contact
@@ -8268,6 +8360,30 @@ export declare const AccountsApiAxiosParamCreator: (configuration?: Configuratio
      * @throws {RequiredError}
      */
     patchUpdateAccountVatNumber: (id: string, patchUpdateAccountVatNumberRequest?: PatchUpdateAccountVatNumberRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Set Account Credit Limit
+     * @param {string} id Xero ID
+     * @param {PatchUpdateCreditLimitRequest} [patchUpdateCreditLimitRequest] Credit Limit Request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchUpdateCreditLimit: (id: string, patchUpdateCreditLimitRequest?: PatchUpdateCreditLimitRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Set Account Price List
+     * @param {string} id Xero ID
+     * @param {PatchUpdatePriceListRequest} [patchUpdatePriceListRequest] Price List Request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchUpdatePriceList: (id: string, patchUpdatePriceListRequest?: PatchUpdatePriceListRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Set Account SIP Channel Cost
+     * @param {string} id Xero ID
+     * @param {PatchUpdateSipChannelCostRequest} [patchUpdateSipChannelCostRequest] SIP Channel Cost Request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchUpdateSipChannelCost: (id: string, patchUpdateSipChannelCostRequest?: PatchUpdateSipChannelCostRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Create Account Contact
      * @param {string} id Account Xero ID
@@ -8388,6 +8504,13 @@ export declare const AccountsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     deleteAdminUpdateAccountContact(id: string, contactId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Delete Account
+     * @param {string} id Account Xero ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteArchiveAccount(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
      * Delete client credentials
      * @summary Delete client credentials
@@ -8396,6 +8519,13 @@ export declare const AccountsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     deleteDeleteClientCredentials(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Get Account Finance
+     * @param {string} id Account Xero ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteGetFinanceSettings(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountFinanceDTO>>;
     /**
      * Delete Account Contacts
      * @summary Delete Account Contact
@@ -8538,6 +8668,30 @@ export declare const AccountsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     patchUpdateAccountVatNumber(id: string, patchUpdateAccountVatNumberRequest?: PatchUpdateAccountVatNumberRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Set Account Credit Limit
+     * @param {string} id Xero ID
+     * @param {PatchUpdateCreditLimitRequest} [patchUpdateCreditLimitRequest] Credit Limit Request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchUpdateCreditLimit(id: string, patchUpdateCreditLimitRequest?: PatchUpdateCreditLimitRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountFinanceDTO>>;
+    /**
+     * Set Account Price List
+     * @param {string} id Xero ID
+     * @param {PatchUpdatePriceListRequest} [patchUpdatePriceListRequest] Price List Request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchUpdatePriceList(id: string, patchUpdatePriceListRequest?: PatchUpdatePriceListRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountFinanceDTO>>;
+    /**
+     * Set Account SIP Channel Cost
+     * @param {string} id Xero ID
+     * @param {PatchUpdateSipChannelCostRequest} [patchUpdateSipChannelCostRequest] SIP Channel Cost Request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchUpdateSipChannelCost(id: string, patchUpdateSipChannelCostRequest?: PatchUpdateSipChannelCostRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountFinanceDTO>>;
     /**
      * Create Account Contact
      * @param {string} id Account Xero ID
@@ -8658,6 +8812,13 @@ export declare const AccountsApiFactory: (configuration?: Configuration, basePat
      * @throws {RequiredError}
      */
     deleteAdminUpdateAccountContact(id: string, contactId: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * Delete Account
+     * @param {string} id Account Xero ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteArchiveAccount(id: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
     /**
      * Delete client credentials
      * @summary Delete client credentials
@@ -8666,6 +8827,13 @@ export declare const AccountsApiFactory: (configuration?: Configuration, basePat
      * @throws {RequiredError}
      */
     deleteDeleteClientCredentials(id: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * Get Account Finance
+     * @param {string} id Account Xero ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteGetFinanceSettings(id: string, options?: RawAxiosRequestConfig): AxiosPromise<AccountFinanceDTO>;
     /**
      * Delete Account Contacts
      * @summary Delete Account Contact
@@ -8808,6 +8976,30 @@ export declare const AccountsApiFactory: (configuration?: Configuration, basePat
      * @throws {RequiredError}
      */
     patchUpdateAccountVatNumber(id: string, patchUpdateAccountVatNumberRequest?: PatchUpdateAccountVatNumberRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * Set Account Credit Limit
+     * @param {string} id Xero ID
+     * @param {PatchUpdateCreditLimitRequest} [patchUpdateCreditLimitRequest] Credit Limit Request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchUpdateCreditLimit(id: string, patchUpdateCreditLimitRequest?: PatchUpdateCreditLimitRequest, options?: RawAxiosRequestConfig): AxiosPromise<AccountFinanceDTO>;
+    /**
+     * Set Account Price List
+     * @param {string} id Xero ID
+     * @param {PatchUpdatePriceListRequest} [patchUpdatePriceListRequest] Price List Request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchUpdatePriceList(id: string, patchUpdatePriceListRequest?: PatchUpdatePriceListRequest, options?: RawAxiosRequestConfig): AxiosPromise<AccountFinanceDTO>;
+    /**
+     * Set Account SIP Channel Cost
+     * @param {string} id Xero ID
+     * @param {PatchUpdateSipChannelCostRequest} [patchUpdateSipChannelCostRequest] SIP Channel Cost Request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchUpdateSipChannelCost(id: string, patchUpdateSipChannelCostRequest?: PatchUpdateSipChannelCostRequest, options?: RawAxiosRequestConfig): AxiosPromise<AccountFinanceDTO>;
     /**
      * Create Account Contact
      * @param {string} id Account Xero ID
@@ -8928,6 +9120,13 @@ export declare class AccountsApi extends BaseAPI {
      * @throws {RequiredError}
      */
     deleteAdminUpdateAccountContact(id: string, contactId: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     * Delete Account
+     * @param {string} id Account Xero ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteArchiveAccount(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
     /**
      * Delete client credentials
      * @summary Delete client credentials
@@ -8936,6 +9135,13 @@ export declare class AccountsApi extends BaseAPI {
      * @throws {RequiredError}
      */
     deleteDeleteClientCredentials(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     * Get Account Finance
+     * @param {string} id Account Xero ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteGetFinanceSettings(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountFinanceDTO, any, {}>>;
     /**
      * Delete Account Contacts
      * @summary Delete Account Contact
@@ -9078,6 +9284,30 @@ export declare class AccountsApi extends BaseAPI {
      * @throws {RequiredError}
      */
     patchUpdateAccountVatNumber(id: string, patchUpdateAccountVatNumberRequest?: PatchUpdateAccountVatNumberRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     * Set Account Credit Limit
+     * @param {string} id Xero ID
+     * @param {PatchUpdateCreditLimitRequest} [patchUpdateCreditLimitRequest] Credit Limit Request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchUpdateCreditLimit(id: string, patchUpdateCreditLimitRequest?: PatchUpdateCreditLimitRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountFinanceDTO, any, {}>>;
+    /**
+     * Set Account Price List
+     * @param {string} id Xero ID
+     * @param {PatchUpdatePriceListRequest} [patchUpdatePriceListRequest] Price List Request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchUpdatePriceList(id: string, patchUpdatePriceListRequest?: PatchUpdatePriceListRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountFinanceDTO, any, {}>>;
+    /**
+     * Set Account SIP Channel Cost
+     * @param {string} id Xero ID
+     * @param {PatchUpdateSipChannelCostRequest} [patchUpdateSipChannelCostRequest] SIP Channel Cost Request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    patchUpdateSipChannelCost(id: string, patchUpdateSipChannelCostRequest?: PatchUpdateSipChannelCostRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountFinanceDTO, any, {}>>;
     /**
      * Create Account Contact
      * @param {string} id Account Xero ID