@cllbk/ghl/dist/index.d.ts

A public Node.js compatible SDK for working with HighLevel's (GHL's) Version 2 API.

export declare const GHL: {
    blogs: {
        getAuthors: (options: {
            locationId: string;
            limit: number;
            offset: number;
        }, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/blogs").Blogs.AuthorsResponseDTO) | null>;
        getCategories: (options: {
            locationId: string;
            limit: number;
            offset: number;
        }, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/blogs").Blogs.CategoriesResponseDTO) | null>;
        checkSlug: (options: {
            locationId: string;
            urlSlug: string;
            postId?: string;
        }, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/blogs").Blogs.CheckUrlSlugResponseDTO) | null>;
        create: (options: import("./types/blogs").Blogs.CreatePostParams, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/blogs").Blogs.CreatePostResponseDTO) | null>;
        update: (postId: string, options: import("./types/blogs").Blogs.UpdatePostParams, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/blogs").Blogs.UpdatePostResponseDTO) | null>;
    };
    businesses: {
        get: (businessId: import("./types/businesses").Businesses.DTO["id"], authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/businesses").Businesses.GetResponseDTO) | null>;
        listByLocation: (locationId: import("./types/businesses").Businesses.DTO["locationId"], authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/businesses").Businesses.SearchResponseDTO) | null>;
        create: (options: import("./types/businesses").Businesses.CreateDTO, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/businesses").Businesses.CreateUpdateResponseDTO) | null>;
        update: (businessId: import("./types/businesses").Businesses.DTO["id"], options: import("./types/businesses").Businesses.UpdateDTO, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/businesses").Businesses.CreateUpdateResponseDTO) | null>;
        delete: (businessId: import("./types/businesses").Businesses.DTO["id"], authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/_global").SuccessDeleteDTO) | null>;
    };
    calendars: {
        get: (calendarId: CalendarDTO, authToken: string) => Promise<any | null>;
        search: (options: {
            locationId: string;
            showDrafted?: boolean;
            groupId?: string;
        }, authToken: string) => Promise<any | null>;
        create: (options: CalendarCreateDTO, authToken: string) => Promise<any | null>;
        update: (calendarId: CalendarDTO, options: CalendarUpdateDTO, authToken: string) => Promise<any | null>;
        delete: (calendarId: CalendarDTO, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/_global").SuccessDeleteDTO) | null>;
        freeSlots: {
            get: (calendarId: CalendarDTO, options: CalendarGetFreeSlotsDTO, authToken: string) => Promise<any> | null;
        };
        groups: {
            search: (locationId: CalendarGroupDTO, authToken: string) => Promise<any> | null;
            create: (options: CalendarGroupCreateDTO, authToken: string) => Promise<any> | null;
            update: (groupId: CalendarGroupDTO, options: CalendarGroupUpdateDTO, authToken: string) => Promise<any> | null;
            delete: (groupId: CalendarGroupDTO, authToken: string) => Promise<import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/_global").SuccessDeleteDTO> | null;
            disable: (groupId: CalendarGroupDTO, options: {
                isActive: boolean;
            }, authToken: string) => Promise<import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | {
                success: true;
            }> | null;
            validateSlug: (options: CalendarValidateGroupSlugPostBodyDTO, authToken: string) => Promise<any> | null;
        };
        appointments: {
            get: (calendarId: CalendarEventDTO, authToken: string) => Promise<any> | null;
            search: (options: {
                locationId: string;
                startTime: string;
                endTime: string;
                calendarId?: string;
                groupId?: string;
                userId?: string;
            }, authToken: string) => Promise<any> | null;
            create: (options: CalendarAppointmentCreateUpdateSchemaDTO, authToken: string) => Promise<any> | null;
            update: (eventId: CalendarEventDTO, options: Partial<CalendarAppointmentCreateUpdateSchemaDTO>, authToken: string) => Promise<any> | null;
            delete: (eventId: CalendarEventDTO, authToken: string) => Promise<import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/_global").SuccededDeleteDTO> | null;
        };
        notes: {
            search: (appointmentId: CalendarEventDTO, options: {
                limit: number;
                offset: number;
            }, authToken: string) => Promise<any> | null;
            create: (appointmentId: CalendarEventDTO, options: import("./types/contacts").ContactNotesDTO, authToken: string) => Promise<any> | null;
            update: (appointmentId: CalendarEventDTO, noteId: CalendarGetNoteSchemaDTO, options: import("./types/contacts").ContactNotesDTO, authToken: string) => Promise<any> | null;
            delete: (appointmentId: CalendarEventDTO, noteId: CalendarGetNoteSchemaDTO, authToken: string) => Promise<import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/_global").SuccessDeleteDTO> | null;
        };
        blocks: {
            search: (options: {
                locationId: string;
                startTime: string;
                endTime: string;
                calendarId?: string;
                groupId?: string;
                userId?: string;
            }, authToken: string) => Promise<any> | null;
            create: (options: CalendarBlockSlotCreateSchemaDTO, authToken: string) => Promise<any> | null;
            update: (eventId: CalendarEventDTO, options: CalendarBlockSlotEditSchemaDTO, authToken: string) => Promise<any> | null;
            delete: (eventId: CalendarEventDTO, authToken: string) => Promise<import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/_global").SuccededDeleteDTO> | null;
        };
        resources: {
            get: (resourceId: string, resourceType: CalendarResourceTypeDTO, authToken: string) => Promise<any> | null;
            search: (resourceType: CalendarResourceTypeDTO[], options: {
                locationId: CalendarResourceDTO;
                limit: number;
                skip: number;
            }, authToken: string) => Promise<any> | null;
            create: (resourceType: CalendarResourceTypeDTO, options: CalendarCreateResourceDTO, authToken: string) => Promise<any> | null;
            update: (resourceId: string, resourceType: CalendarResourceTypeDTO, options: Partial<CalendarCreateResourceDTO & {
                isActive: boolean;
            }>, authToken: string) => Promise<any | null>;
            delete: (resourceId: string, resourceType: CalendarResourceTypeDTO, authToken: string) => Promise<import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/_global").SuccessDeleteDTO> | null;
        };
    };
    campaigns: {
        search: (options: {
            locationId: string;
            status?: string;
        }, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/campaigns").CampaignsSuccessfulResponseDto) | null>;
    };
    companies: {
        get: (companyId: import("./types/companies").CompaniesGetByIdDTO["id"], authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/companies").CompaniesGetByIdSuccessfulResponseDTO) | null>;
    };
    contacts: {
        get: (contactId: import("./types/contacts").ContactDTO["id"], authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/contacts").ContactByIdSuccessfulResponseDTO) | null>;
        search: (options: import("./types/contacts").ContactSearchOptions, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/contacts").ContactSearchSuccessResponseDTO) | null>;
        findDuplicates: (options: {
            locationId: string;
            email?: string;
            phone?: string;
        }, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/contacts").ContactsSearchDuplicatesDTO) | null>;
        create: (options: import("./types/contacts").ContactCreateDTO, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/contacts").ContactByIdSuccessfulResponseDTO) | null>;
        update: (contactId: import("./types/contacts").ContactDTO["id"], options: import("./types/contacts").ContactUpdateDTO, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/contacts").ContactUpdateSuccessfulResponseDTO) | null>;
        upsert: (options: import("./types/contacts").ContactUpsertDTO, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/contacts").ContactUpsertSuccessfulResponseDTO) | null>;
        delete: (contactId: import("./types/contacts").ContactDTO["id"], authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/_global").SuccededDeleteDTO) | null>;
        tasks: {
            get: (contactId: import("./types/contacts").ContactDTO["id"], taskId: import("./types/contacts").ContactTaskDTO["id"], authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/contacts").ContactTaskByIsSuccessfulResponseDTO) | null>;
            search: (contactId: import("./types/contacts").ContactDTO["id"], authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/contacts").ContactTasksListSuccessfulResponseDTO) | null>;
            create: (contactId: import("./types/contacts").ContactDTO["id"], options: import("./types/contacts").ContactCreateTaskParamsDTO, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/contacts").ContactTaskByIsSuccessfulResponseDTO) | null>;
            update: (contactId: import("./types/contacts").ContactDTO["id"], taskId: import("./types/contacts").ContactTaskDTO["id"], options: import("./types/contacts").ContactUpdateTaskBodyDTO, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/contacts").ContactTaskByIsSuccessfulResponseDTO) | null>;
            updateStatus: (contactId: import("./types/contacts").ContactDTO["id"], taskId: import("./types/contacts").ContactTaskDTO["id"], options: import("./types/contacts").ContactUpdateTaskStatusParamsDTO, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/contacts").ContactTaskByIsSuccessfulResponseDTO) | null>;
            delete: (contactId: import("./types/contacts").ContactDTO["id"], taskId: import("./types/contacts").ContactTaskDTO["id"], authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/_global").SuccededDeleteDTO) | null>;
        };
        appointments: {
            search: (contactId: import("./types/contacts").ContactDTO["id"], authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/contacts").ContactGetEventsSuccessfulResponseDTO) | null>;
        };
        tags: {
            add: (contactId: string, options: import("./types/contacts").ContactTagsDTO, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/contacts").ContactTagsDTO) | null>;
            remove: (contactId: string, options: import("./types/contacts").ContactTagsDTO, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/contacts").ContactTagsDTO) | null>;
        };
        notes: {
            get: (contactId: import("./types/contacts").ContactDTO["id"], noteId: import("./types/contacts").ContactGetNoteDTO["id"], authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/contacts").ContactGetCreateUpdateNoteSuccessfulResponseDto) | null>;
            search: (contactId: import("./types/contacts").ContactDTO["id"], authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/contacts").ContactGetCreateUpdateNoteSuccessfulResponseDto) | null>;
            create: (contactId: import("./types/contacts").ContactDTO["id"], options: import("./types/contacts").ContactNotesDTO, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/contacts").ContactGetCreateUpdateNoteSuccessfulResponseDto) | null>;
            update: (contactId: import("./types/contacts").ContactDTO["id"], noteId: import("./types/contacts").ContactGetNoteDTO["id"], options: import("./types/contacts").ContactNotesDTO, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/contacts").ContactGetCreateUpdateNoteSuccessfulResponseDto) | null>;
            delete: (contactId: import("./types/contacts").ContactDTO["id"], noteId: import("./types/contacts").ContactGetNoteDTO["id"], authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/_global").SuccededDeleteDTO) | null>;
        };
        campaigns: {
            search: (options: {
                locationId: string;
                status?: string;
            }, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/campaigns").CampaignsSuccessfulResponseDto) | null>;
        };
        workflows: {
            add: (contactId: string, workflowId: string, options: import("./types/contacts").ContactCreateWorkflowDTO, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/contacts").ContactsWorkflowSuccessfulResponseDTO) | null>;
            remove: (contactId: string, workflowId: string, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/_global").SuccededDeleteDTO) | null>;
        };
        followers: {
            add: (contactId: string, options: import("./types/contacts").ContactFollowersDTO, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/contacts").ContactAddFollowersSuccessfulResponseDTO) | null>;
            remove: (contactId: string, options: import("./types/contacts").ContactFollowersDTO, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/contacts").ContactDeleteFollowersSuccessfulResponseDTO) | null>;
        };
    };
    conversations: {
        get: (conversationId: import("./types/conversations").ConversationDTO["id"], authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/conversations").ConversationGetByIdResponse) | null>;
        search: (options: import("./types/conversations").ConversationSearchParams, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/conversations").ConversationSendResponseDTO) | null>;
        create: (options: import("./types/conversations").CreateConversationDTO, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/conversations").ConversationGetSuccessfulResponse) | null>;
        update: (conversationId: import("./types/conversations").ConversationDTO["id"], options: import("./types/conversations").ConversationUpdateDTO, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/conversations").ConversationGetSuccessfulResponse) | null>;
        delete: (conversationId: import("./types/conversations").ConversationDTO["id"], authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/_global").SuccessDeleteDTO) | null>;
        emails: {
            get: (emailMessageId: import("./types/conversations").ConversationGetEmailMessageResponseDTO["id"], authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/conversations").ConversationGetEmailMessageResponseDTO) | null>;
            cancelScheduled: (emailMessageId: import("./types/conversations").ConversationGetEmailMessageResponseDTO["id"], authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/conversations").ConversationCancelScheduledResponseDTO) | null>;
        };
        messages: {
            get: (messageId: import("./types/conversations").ConversationGetMessageResponseDTO["id"], authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/conversations").ConversationGetMessageResponseDTO) | null>;
            search: (conversationId: string, options: {
                lastMessageId?: string;
                limit?: number;
                type?: string;
            }, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/conversations").ConversationGetMessagesByResponseDTO) | null>;
            send: (options: import("./types/conversations").ConversationSendMessageBodyDTO, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/conversations").ConversationSendMessageResponseDTO) | null>;
            addInbound: (options: import("./types/conversations").ConversationProcessMessageBodyDTO, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/conversations").ConversationProcessMessageResponseDto) | null>;
            addExternalOutboundCall: (options: import("./types/conversations").ConversationProcessOutboundMessageBodyDTO, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/conversations").ConversationProcessMessageResponseDto) | null>;
            cancelScheduled: (messageId: import("./types/conversations").ConversationGetMessageResponseDTO["id"], authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/conversations").ConversationCancelScheduledResponseDTO) | null>;
            uploadFileAttachments: (options: import("./types/conversations").ConversationUploadFilesDTO, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/conversations").ConversationUploadFilesResponseDTO | import("./types/conversations").ConversationUploadFilesErrorResponseDto) | null>;
            updateStatus: (messageId: import("./types/conversations").ConversationGetMessageResponseDTO["id"], options: import("./types/conversations").ConversationUpdateMessageStatusDTO, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/conversations").ConversationSendMessageResponseDTO) | null>;
            getTranscript: (locationId: string, messageId: import("./types/conversations").ConversationGetMessageResponseDTO["id"], authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/conversations").ConverstationGetMessageTranscriptionResponseDTO) | null>;
        };
    };
    courses: {
        import: (options: import("./types/courses").CoursePublicExporterPayload, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO) | null>;
    };
    emails: {
        search: (options: import("./types/emails").EmailsSearchOptions, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/emails").EmailsFetchBuilderSuccesfulResponseDTO) | null>;
        create: (options: import("./types/emails").EmailsCreateBuilderDTO, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/emails").EmailsCreateBuilderSuccesfulResponseDTO) | null>;
        update: (options: import("./types/emails").EmailsSaveBuilderDataDTO, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/emails").EmailsBuilderUpdateSuccessfulDTO) | null>;
        delete: (locationId: string, templateId: string, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/emails").EmailsDeleteBuilderSuccesfulResponseDTO) | null>;
    };
    forms: {
        search: (options: import("./types/forms").FormsSearchOptions, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/forms").FormsSuccessfulResponseDTO) | null>;
        submissions: {
            search: (options: import("./types/forms").FormsSubmissionsSearchOptions, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/forms").FormsSubmissionsSuccessfulResponseDTO) | null>;
        };
    };
    funnels: {
        listFunnels: (options: {
            locationId: string;
            category?: string;
            limit?: string;
            name?: string;
            offset?: string;
            parentId?: string;
            type?: string;
        }, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/funnels").FunnelsListResponseDTO) | null>;
        listPages: (options: {
            locationId: string;
            funnelId: string;
            limit: number;
            offset: number;
            name?: string;
        }, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/funnels").FunnelsPageResponseDTO) | null>;
        countPages: (options: {
            locationId: string;
            funnelId: string;
            name?: string;
        }, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/funnels").FunnelsPageCountResponseDTO) | null>;
        redirects: {
            search: (options: {
                locationId: string;
                limit: number;
                offset: number;
                search?: string;
            }, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/funnels").FunnelsRedirectListResponseDTO) | null>;
            create: (options: import("./types/funnels").FunnelsRedirectCreateParams, authToken: string) => Promise<import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/funnels").FunnelsRedirectCreateResponseDTO> | null;
            update: (redirectId: string, options: import("./types/funnels").FunnelsRedirectUpdateParams, authToken: string) => Promise<import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/funnels").FunnelsRedirectCreateResponseDTO> | null;
            delete: (locationId: string, redirectId: string, authToken: string) => Promise<import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/funnels").FunnelsRedirectDeleteResponseDTO> | null;
        };
    };
    invoices: {
        get: (invoiceId: string, options: import("./types/invoices").InvoicesVoidDTO, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/invoices").InvoicesGetResponseDTO) | null>;
        search: (options: import("./types/invoices").InvoicesSearchOptions, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/invoices").InvoicesListResponseDTO) | null>;
        create: (options: import("./types/invoices").InvoicesCreateDTO, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/invoices").InvoicesCreateResponseDTO) | null>;
        update: (invoiceId: string, options: import("./types/invoices").InvoicesUpdateDTO, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/invoices").InvoicesCreateResponseDTO) | null>;
        delete: (invoiceId: string, options: {
            altId: string;
            altType: "location";
        }, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/invoices").InvoicesCreateResponseDTO) | null>;
        send: (invoiceId: string, options: import("./types/invoices").InvoicesSendDTO, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/invoices").InvoicesSendResponseDTO) | null>;
        void: (invoiceId: string, options: import("./types/invoices").InvoicesVoidDTO, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/invoices").InvoicesCreateResponseDTO) | null>;
        recordPayment: (invoiceId: string, options: import("./types/invoices").InvoicesRecordPaymentDTO, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/invoices").InvoicesRecordPaymentResponseDTO) | null>;
        generateInvoiceNumber: (options: import("./types/invoices").InvoicesVoidDTO, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/invoices").InvoicesGenerateNumberResponseDTO) | null>;
        templates: {
            get: (templateId: string, options: import("./types/invoices").InvoicesVoidDTO, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/invoices").InvoicesGetTemplateResponseDTO) | null>;
            search: (options: import("./types/invoices").InvoicesScheduleSearchOptions, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/invoices").InvoicesListTemplatesResponseDTO) | null>;
            create: (options: import("./types/invoices").InvoicesCreateTemplateDTO, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/invoices").InvoicesGetTemplateResponseDTO) | null>;
            update: (templateId: string, options: import("./types/invoices").InvoicesUpdateTemplateDTO, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/invoices").InvoicesGetTemplateResponseDTO) | null>;
            delete: (templateId: string, options: import("./types/invoices").InvoicesVoidDTO, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/_global").SuccessDeleteDTO) | null>;
        };
        schedules: {
            get: (scheduleId: string, options: import("./types/invoices").InvoicesVoidDTO, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/invoices").InvoicesScheduleResponseDTO) | null>;
            search: (options: import("./types/invoices").InvoicesScheduleSearchOptions, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/invoices").InvoicesListSchedulesResponseDTO) | null>;
            create: (options: import("./types/invoices").InvoicesCreateScheduleDTO, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/invoices").InvoicesGetScheduleResponseDTO) | null>;
            update: (scheduleId: string, options: import("./types/invoices").InvoicesUpdateScheduleDTO, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/invoices").InvoicesGetScheduleResponseDTO) | null>;
            delete: (scheduleId: string, options: import("./types/invoices").InvoicesCancelScheduleDTO, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/_global").SuccessDeleteDTO) | null>;
            startSchedule: (scheduleId: string, options: import("./types/invoices").InvoicesScheduleDTO, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/invoices").InvoicesScheduleResponseDTO) | null>;
            manageAutoPay: (scheduleId: string, options: import("./types/invoices").InvoicesScheduleDTO, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/invoices").InvoicesScheduleResponseDTO) | null>;
            cancelScheduled: (scheduleId: string, options: import("./types/invoices").InvoicesCancelScheduleDTO, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/invoices").InvoicesScheduleResponseDTO) | null>;
        };
        text2pay: {
            createAndSend: (options: import("./types/invoices").InvoicesTTPDTO, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/invoices").InvoicesTTPResponseDTO) | null>;
        };
    };
    locations: {
        get: (locationId: string, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/locations").LocationsGetByIdResponseDTO) | null>;
        search: (options: import("./types/locations").LocationsSearchOptions, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/locations").LocationsSearchResponseDTO) | null>;
        create: (options: import("./types/locations").LocationsCreateDTO, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/locations").LocationsCreateResponseDTO) | null>;
        update: (locationId: string, options: import("./types/locations").LocationsUpdateDTO, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/locations").LocationsCreateResponseDTO) | null>;
        delete: (locationId: string, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/locations").LocationsDeleteResponseDTO) | null>;
        customFields: {
            get: (locationId: string, customFieldId: string, authToken: string) => Promise<import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/locations").LocationsCFResponseDTO> | null;
            search: (locationId: string, options: import("./types/locations").LocationsCFSearchParamsDTO, authToken: string) => Promise<import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/locations").LocationsCFsResponseDTO> | null;
            create: (locationId: string, options: import("./types/locations").LocationsCFCreateDTO, authToken: string) => Promise<import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/locations").LocationsCVResponseDTO> | null;
            update: (locationId: string, customFieldId: string, options: import("./types/locations").LocationsCFUpdateDTO, authToken: string) => Promise<import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/locations").LocationsCFResponseDTO> | null;
            delete: (locationId: string, customFieldId: string, authToken: string) => Promise<import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/_global").SuccededDeleteDTO> | null;
        };
        customValues: {
            get: (locationId: string, customValueId: string, authToken: string) => Promise<import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/locations").LocationsCVResponseDTO> | null;
            search: (locationId: string, authToken: string) => Promise<import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/locations").LocationsCFsResponseDTO> | null;
            create: (locationId: string, options: import("./types/locations").LocationsCVDTO, authToken: string) => Promise<import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/locations").LocationsCVResponseDTO> | null;
            update: (locationId: string, customValueId: string, options: import("./types/locations").LocationsCVDTO, authToken: string) => Promise<import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/locations").LocationsCVResponseDTO> | null;
            delete: (locationId: string, customValueId: string, authToken: string) => Promise<import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/_global").SuccededDeleteDTO> | null;
        };
        tags: {
            get: (locationId: string, tagId: string, authToken: string) => Promise<import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/locations").LocationsTagResponseDTO> | null;
            search: (locationId: string, authToken: string) => Promise<import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/locations").LocationsTagsResponseDTO> | null;
            create: (locationId: string, options: import("./types/locations").LocationsTagBodySchema, authToken: string) => Promise<import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/locations").LocationsTagResponseDTO> | null;
            update: (locationId: string, tagId: string, options: import("./types/locations").LocationsTagBodySchema, authToken: string) => Promise<import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/locations").LocationsTagResponseDTO> | null;
            delete: (locationId: string, tagId: string, authToken: string) => Promise<import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/_global").SuccededDeleteDTO> | null;
        };
        tasks: {
            search: (locationId: string, options: import("./types/locations").LocationsTaskSearchParamsDTO, authToken: string) => Promise<import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/locations").LocationsTaskListResponseDTO> | null;
        };
        timezones: {
            search: (locationId: string, authToken: string) => Promise<any> | null;
        };
    };
    oauth: {
        getAccessToken: (options: import("./types/oauth").GetAccessCodeBodyDTO) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/oauth").GetAccessCodeSuccessfulResponseDTO) | null>;
        getLocationsInstalled: (options: import("./types/oauth").OAuthSearchOptions) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/oauth").GetInstalledLocationsSuccessfulResponseDTO) | null>;
        getLocationTokenFromCompany: (options: import("./types/oauth").GetLocationAccessCodeBodyDTO, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/oauth").GetLocationAccessTokenSuccessfulResponseDTO) | null>;
    };
    opportunities: {
        get: (opportuniyId: string, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/opportunities").OpportunitiesCreateResponseDTO) | null>;
        create: (options: import("./types/opportunities").OpportunitiesCreateDTO, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/opportunities").OpportunitiesCreateResponseDTO) | null>;
        update: (opportunityId: string, options: import("./types/opportunities").OpportunityUpdateDTO, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/opportunities").OpportunitiesCreateResponseDTO) | null>;
        updateStatus: (opportunityId: string, options: import("./types/opportunities").OpportunitiesUpdateStatusDTO, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/opportunities").OpportunitiesCreateResponseDTO) | null>;
        upsert: (options: import("./types/opportunities").OpportunitiesUpsertDTO, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/opportunities").OpportunitiesUpsertResponseDTO) | null>;
        delete: (opportunityId: string, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/_global").SuccededDeleteDTO) | null>;
        followers: {
            add: (opportunityId: string, options: import("./types/opportunities").OpportunitiesFollowersDTO, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/opportunities").OpportunitiesAddFollowersResponseDTO) | null>;
            remove: (opportunityId: string, options: import("./types/opportunities").OpportunitiesFollowersDTO, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/opportunities").OpportunitiesRemoveFollowersResponseDTO) | null>;
        };
    };
    pipelines: {
        list: (locationId: string, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/pipelines").PipelinesGetResponseDTO) | null>;
    };
    payments: {
        integrations: {
            search: (options: {
                altId: string;
                altType: "location";
                limit?: number;
                offset?: number;
            }, authToken: string) => Promise<(import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/payments").PaymentsWLProviderListResponseDTO) | null>;
            create: (options: import("./types/payments").PaymentsWLProviderCreateDTO, authToken: string) => Promise<import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/payments").PaymentsIntegrationProviderSchema> | null;
        };
        orders: {
            get: (orderId: string, options: import("./types/payments").PaymentsOrderFullfillmentsGetOptions, authToken: string) => Promise<import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/payments").PaymentsOrderGetResponseDTO> | null;
            list: (options: import("./types/payments").PaymentsOrderFullfillmentsSearchOptions, authToken: string) => Promise<import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/payments").PaymentsOrderListResponseDTO> | null;
            fullfillments: {
                list: (orderId: string, options: {
                    altId: string;
                    altType: string;
                }, authToken: string) => Promise<import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/payments").PaymentsFullfillmentListResponseDTO> | null;
                create: (orderId: string, options: import("./types/payments").PaymentsFullfillmentCreateDTO, authToken: string) => Promise<import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./types/payments").PaymentsFullfillmentListResponseDTO> | null;
            };
        };
        transactions: {
            get: (transactionId: string, options: {
                altId: string;
                altType: string;
                locationId?: string;
            }, authToken: string) => Promise<import("./types/_global").BadRequestDTO | import("./types/_global").UnauthorizedDTO | import("./types/_global").UnprocessableDTO | import("./t