@gohighlevel/api-client/dist/lib/code/saas-api/saas-api.d.ts

Official SDK for HighLevel Public APIs

import { AxiosInstance, AxiosRequestConfig } from 'axios';
import * as Models from './models/saas-api';
/**
 * SaasApi Service
 * API Service for SaaS
 */
export declare class SaasApi {
    private client;
    constructor(httpClient: AxiosInstance);
    /**
     * Get locations by stripeId with companyId
     * Get locations by stripeCustomerId or stripeSubscriptionId with companyId
     * @deprecated This method is deprecated
     */
    locationsDeprecated(params: {
        customerId?: string;
        subscriptionId?: string;
        companyId: string;
    }, options?: AxiosRequestConfig): Promise<string[]>;
    /**
     * Update SaaS subscription
     * Update SaaS subscription for given locationId and customerId
     * @deprecated This method is deprecated
     */
    updateSaasSubscriptionDeprecated(params: {
        locationId: string;
    }, requestBody: Models.UpdateSubscriptionDto, options?: AxiosRequestConfig): Promise<string>;
    /**
     * Disable SaaS for locations
     * Disable SaaS for locations for given locationIds
     * @deprecated This method is deprecated
     */
    bulkDisableSaasDeprecated(params: {
        companyId: string;
    }, requestBody: Models.BulkDisableSaasDto, options?: AxiosRequestConfig): Promise<Models.BulkDisableSaasResponseDto>;
    /**
     * Enable SaaS for Sub-Account (Formerly Location)
     * &lt;div&gt;
                    &lt;p&gt;Enable SaaS for Sub-Account (Formerly Location) based on the data provided&lt;/p&gt;
                    &lt;div&gt;
                      &lt;span style&#x3D; &quot;display: inline-block;
                                  width: 25px; height: 25px;
                                  background-color: yellow;
                                  color: black;
                                  font-weight: bold;
                                  font-size: 24px;
                                  text-align: center;
                                  line-height: 22px;
                                  border: 2px solid black;
                                  border-radius: 10%;
                                  margin-right: 10px;&quot;&gt;
                                  !
                        &lt;/span&gt;
                        &lt;span&gt;
                          &lt;strong&gt;
                            This feature is only available on Agency Pro ($497) plan.
                          &lt;/strong&gt;
                        &lt;/span&gt;
                    &lt;/div&gt;
                  &lt;/div&gt;
      
     * @deprecated This method is deprecated
     */
    enableSaasLocationDeprecated(params: {
        locationId: string;
    }, requestBody: Models.EnableSaasDto, options?: AxiosRequestConfig): Promise<Models.EnableSaasResponseDto>;
    /**
     * Pause location
     * Pause Sub account for given locationId
     * @deprecated This method is deprecated Use Sub account for given locationId instead.
     */
    pauseLocationDeprecated(params: {
        locationId: string;
    }, requestBody: Models.PauseLocationDto, options?: AxiosRequestConfig): Promise<boolean>;
    /**
     * Update Rebilling
     * Bulk update rebilling for given locationIds
     * @deprecated This method is deprecated
     */
    updateRebillingDeprecated(params: {
        companyId: string;
    }, requestBody: Models.UpdateRebillingDto, options?: AxiosRequestConfig): Promise<Models.UpdateRebillingResponseDto>;
    /**
     * Get Agency Plans
     * Fetch all agency subscription plans for a given company ID
     * @deprecated This method is deprecated
     */
    getAgencyPlansDeprecated(params: {
        companyId: string;
    }, options?: AxiosRequestConfig): Promise<Models.AgencyPlanResponseDto[]>;
    /**
     * Get Location Subscription Details
     * Fetch subscription details for a specific location from location metadata
     * @deprecated This method is deprecated
     */
    getLocationSubscriptionDeprecated(params: {
        locationId: string;
        companyId: string;
    }, options?: AxiosRequestConfig): Promise<Models.LocationSubscriptionResponseDto>;
    /**
     * Bulk Enable SaaS
     * Enable SaaS mode for multiple locations with support for both SaaS v1 and v2
     * @deprecated This method is deprecated
     */
    bulkEnableSaasDeprecated(params: {
        companyId: string;
    }, requestBody: Models.BulkEnableSaasRequestDto, options?: AxiosRequestConfig): Promise<Models.BulkEnableSaasResponseDto>;
    /**
     * Get SaaS Locations
     * Fetch all SaaS-activated locations for a company with pagination
     * @deprecated This method is deprecated
     */
    getSaasLocationsDeprecated(params: {
        companyId: string;
        page?: number;
    }, options?: AxiosRequestConfig): Promise<Models.GetSaasLocationsResponseDto>;
    /**
     * Get SaaS Plan
     * Fetch a specific SaaS plan by plan ID
     * @deprecated This method is deprecated
     */
    getSaasPlanDeprecated(params: {
        planId: string;
        companyId: string;
    }, options?: AxiosRequestConfig): Promise<Models.SaasPlanResponseDto>;
    /**
     * Get locations by stripeId with companyId
     * Get locations by stripeCustomerId or stripeSubscriptionId with companyId
     */
    locations(params: {
        customerId: string;
        subscriptionId: string;
        companyId: string;
    }, options?: AxiosRequestConfig): Promise<any>;
    /**
     * Update SaaS subscription
     * Update SaaS subscription for given locationId and customerId
     */
    generatePaymentLink(params: {
        locationId: string;
    }, requestBody: Models.UpdateSubscriptionDto, options?: AxiosRequestConfig): Promise<any>;
    /**
     * Disable SaaS for locations
     * Disable SaaS for locations for given locationIds
     */
    bulkDisableSaas(params: {
        companyId: string;
    }, requestBody: Models.BulkDisableSaasDto, options?: AxiosRequestConfig): Promise<any>;
    /**
     * Enable SaaS for Sub-Account (Formerly Location)
     * &lt;div&gt;
                    &lt;p&gt;Enable SaaS for Sub-Account (Formerly Location) based on the data provided&lt;/p&gt;
                    &lt;div&gt;
                      &lt;span style&#x3D; &quot;display: inline-block;
                                  width: 25px; height: 25px;
                                  background-color: yellow;
                                  color: black;
                                  font-weight: bold;
                                  font-size: 24px;
                                  text-align: center;
                                  line-height: 22px;
                                  border: 2px solid black;
                                  border-radius: 10%;
                                  margin-right: 10px;&quot;&gt;
                                  !
                        &lt;/span&gt;
                        &lt;span&gt;
                          &lt;strong&gt;
                            This feature is only available on Agency Pro ($497) plan.
                          &lt;/strong&gt;
                        &lt;/span&gt;
                    &lt;/div&gt;
                  &lt;/div&gt;
      
     */
    enableSaasLocation(params: {
        locationId: string;
    }, requestBody: Models.EnableSaasDto, options?: AxiosRequestConfig): Promise<any>;
    /**
     * Pause location
     * Pause Sub account for given locationId
     */
    pauseLocation(params: {
        locationId: string;
    }, requestBody: Models.PauseLocationDto, options?: AxiosRequestConfig): Promise<any>;
    /**
     * Update Rebilling
     * Bulk update rebilling for given locationIds
     */
    updateRebilling(params: {
        companyId: string;
    }, requestBody: Models.UpdateRebillingDto, options?: AxiosRequestConfig): Promise<any>;
    /**
     * Get Agency Plans
     * Fetch all agency subscription plans for a given company ID
     */
    getAgencyPlans(params: {
        companyId: string;
    }, options?: AxiosRequestConfig): Promise<any>;
    /**
     * Get Location Subscription Details
     * Fetch subscription details for a specific location from location metadata
     */
    getLocationSubscription(params: {
        locationId: string;
        companyId: string;
    }, options?: AxiosRequestConfig): Promise<any>;
    /**
     * Bulk Enable SaaS
     * Enable SaaS mode for multiple locations with support for both SaaS v1 and v2
     */
    bulkEnableSaas(params: {
        companyId: string;
    }, requestBody: Models.BulkEnableSaasRequestDto, options?: AxiosRequestConfig): Promise<any>;
    /**
     * Get SaaS Locations
     * Fetch all SaaS-activated locations for a company with pagination
     */
    getSaasLocations(params: {
        companyId: string;
        page: number;
    }, options?: AxiosRequestConfig): Promise<any>;
    /**
     * Get SaaS Plan
     * Fetch a specific SaaS plan by plan ID
     */
    getSaasPlan(params: {
        planId: string;
        companyId: string;
    }, options?: AxiosRequestConfig): Promise<any>;
}
export default SaasApi;
//# sourceMappingURL=saas-api.d.ts.map