RestClient class abstract

Annotations

• @RestApi.new(baseUrl: null)

Constructors

RestClient(Dio dio, {String baseUrl})

factory

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

authorizeGatewayPayment({required String paymentId}) → Future<FinDoc>

calculateLedger() → Future<void>

captureGatewayPayment({required String paymentId}) → Future<FinDoc>

checkAgentRateLimit({required String instanceId, required String platform}) → Future<RateLimitCheck>

Check rate limit

checkEmail({required String email}) → Future<Map<String, bool>>

cloneMenuConfiguration({required String sourceMenuConfigurationId, String? name}) → Future<MenuConfiguration>

Clone menu configuration for user customization

closeTimePeriod({required String timePeriodId}) → Future<TimePeriods>

createActivity({required Activity activity}) → Future<Activity>

createAgentInstance({required AgentInstance agent}) → Future<AgentInstance>

Create agent instance

createApplication(Application application) → Future<Application>

createAssessment({String? pseudoId, required String assessmentName, String? description, String status = 'ACTIVE'}) → Future<Assessment>

createAssessmentQuestion({required String assessmentId, required String questionText, String? questionDescription, String? questionType, int? questionSequence, String? isRequired, List<Map<String, dynamic>>? options}) → Future<AssessmentQuestion>

createAsset({required Asset asset, required String classificationId}) → Future<Asset>

createCategory({required Category category, required String classificationId}) → Future<Category>

createChatMessage({required ChatMessage chatMessage}) → Future<ChatMessage>

createChatRoom({required ChatRoom chatRoom}) → Future<ChatRoom>

createCompany({required Company company}) → Future<Company>

createContentPlan({String? pseudoId, String? personaId, int? weekStartDate, String? theme}) → Future<ContentPlan>

createCredibilityInfo({required String landingPageId, String? creatorBio, String? backgroundText, String? creatorImageUrl, String? statisticsJson}) → Future<CredibilityInfo>

createFinDoc({required FinDoc finDoc}) → Future<FinDoc>

createGlAccount({required GlAccount glAccount}) → Future<GlAccount>

createInvoiceFromData({required Map<String, dynamic> invoiceData}) → Future<String>

createLandingPage({required String title, String? pseudoId, String? hookType, String? headline, String? subheading, String? privacyPolicyUrl, String? ctaActionType, String? ctaAssessmentId, String? ctaButtonLink, String status = 'DRAFT'}) → Future<LandingPage>

createLedgerJournal({required LedgerJournal ledgerJournal}) → Future<LedgerJournal>

createLocation({required Location location}) → Future<Location>

createMarketingPersona({required String name, String? pseudoId, String? demographics, String? painPoints, String? goals, String? toneOfVoice}) → Future<Persona>

createMenuConfiguration({required String appId, String? userId, required String name, String? description, String? isActive}) → Future<MenuConfiguration>

Create new menu configuration

createMenuOption({required String menuConfigurationId, String? itemKey, required String title, String? route, String? iconName, String? widgetName, String? image, String? selectedImage, String? userGroupsJson, int? sequenceNum, String? isActive}) → Future<MenuOption>

Create new menu option (main menu entry)

createOpportunity({required Opportunity opportunity}) → Future<Opportunity>

createOutreachCampaign({required Map<String, dynamic> campaign}) → Future<OutreachCampaign>

createOutreachMessage({String? marketingCampaignId, required String platform, String? recipientName, String? recipientProfileUrl, String? recipientHandle, String? recipientEmail, required String messageContent, String? status}) → Future<OutreachMessage>

createPageSection({required String landingPageId, required String sectionTitle, String? sectionDescription, String? sectionImageUrl, int? sectionSequence}) → Future<LandingPageSection>

createPlatformConfiguration({required String platform, String? isEnabled, int? dailyLimit, String? apiKey, String? apiSecret, String? username, String? password}) → Future<PlatformConfiguration>

createProduct({required Product product, required String classificationId}) → Future<Product>

createSocialPost({String? pseudoId, String? planId, String? type, String? platform, String? headline, String? draftContent, String? finalContent, String? status, int? scheduledDate}) → Future<SocialPost>

createSubscription({required Subscription subscription}) → Future<Subscription>

createTimeEntry({required TimeEntry timeEntry}) → Future<TimeEntry>

createUser({required User user}) → Future<User>

deleteAgentInstance({required String instanceId}) → Future<void>

Delete agent instance

deleteApplication(Application application) → Future<Application>

deleteAssessment({required String assessmentId}) → Future<void>

deleteAssessmentQuestion({required String assessmentId, required String questionId}) → Future<void>

deleteCategory({required Category category}) → Future<Category>

deleteChatRoom({required String chatRoomId}) → Future<ChatRoom>

deleteContentPlan({required String planId}) → Future<void>

deleteCredibilityInfo({required String landingPageId, required String credibilityInfoId}) → Future<void>

deleteCredibilityStatistic({required String credibilityInfoId, required String credibilityStatisticId}) → Future<void>

deleteLandingPage({required String landingPageId}) → Future<void>

deleteLocation({required Location location}) → Future<Location>

deleteMarketingPersona({required String personaId}) → Future<void>

deleteMenuConfiguration({required String menuConfigurationId}) → Future<Map<String, int>>

Delete menu configuration and all its items

deleteMenuOption({required String menuOptionId}) → Future<Map<String, int>>

Delete menu option and its child links

deleteOpportunity({required Opportunity opportunity}) → Future<Opportunity>

deleteOutreachCampaign({required String marketingCampaignId}) → Future<void>

deleteOutreachMessage({required String messageId}) → Future<void>

deletePageSection({required String landingPageId, required String pageSectionId}) → Future<void>

deletePlatformConfiguration({required String configId}) → Future<void>

deleteProduct({required Product product}) → Future<Product>

deleteSocialPost({required String postId}) → Future<void>

deleteSubscription({required Subscription subscription}) → Future<Subscription>

deleteTimeEntry({required TimeEntry timeEntry}) → Future<TimeEntry>

deleteUser({required String partyId, required bool deleteCompanyToo}) → Future<User>

draftSocialPostWithAI({required String postId}) → Future<SocialPost>

exportGlAccounts({String entityName = 'GlAccount'}) → Future<String>

exportScreenCategories({String entityName = 'Category', String? classificationId}) → Future<String>

exportScreenCompanyUsers({String entityName = 'CompanyUser'}) → Future<String>

exportScreenProducts({String entityName = 'Product', required String classificationId}) → Future<String>

exportWebsite() → Future<Website>

finalizeImport({required int start, required int limit, required String part}) → Future<Map<String, String>>

generateContentPlanWithAI({required String personaId, int? weekStartDate}) → Future<ContentPlan>

generateLandingPageWithAI({required String businessDescription, String? targetAudience, String? industry, String tone = 'professional', int numSections = 5}) → Future<LandingPageGenerationResponse>

generateMarketingPersonaWithAI({required String businessDescription, String? targetMarket}) → Future<Persona>

generatePlatformMessage({required String campaignTemplate, required String platform, required String actionType}) → Future<Map<String, String>>

getAccountClass({int? limit, String? searchString}) → Future<AccountClasses>

getAccountType({int? limit, String? searchString}) → Future<AccountTypes>

getActivity({String? activityId, ActivityType? activityType, int? start, int? limit, bool? open, bool? my, bool? isForDropDown, String? searchString, String? companyPseudoId, String? userPseudoId}) → Future<Activities>

getAgentApprovalRequests({String? status}) → Future<List<ApprovalRequest>>

List approval requests

getAgentDashboard() → Future<AgentDashboard>

Get agent dashboard data

getAgentInstance({required String instanceId}) → Future<AgentInstance>

Get single agent instance

getAgentInstances({String? status, int? start, int? limit}) → Future<AgentInstances>

List agent instances

getAllAssessmentResults({int? start, int? limit}) → Future<AssessmentResults>

getApplication() → Future<Applications>

getAssessment({String? assessmentId, String? pseudoId, int? start, int? limit, String? searchString, String? statusId}) → Future<Assessments>

getAssessmentComplete({String? assessmentId, String? pseudoId, String? ownerPartyId}) → Future<Assessment>

getAssessmentQuestion({required String assessmentId, int? start, int? limit}) → Future<AssessmentQuestions>

getAssessmentQuestions({required String assessmentId, int? start, int? limit}) → Future<AssessmentQuestions>

getAssessmentResults({String? assessmentId, int? start, int? limit}) → Future<AssessmentResults>

getAssessmentThresholds({required String assessmentId}) → Future<ScoringThresholds>

getAsset({int? start, int? limit, String? companyPartyId, String? assetClassId, String? assetId, String? productId, bool? isForDropDown, String? searchString}) → Future<Assets>

getAuthenticate({required String classificationId}) → Future<Authenticate>

getBalanceSheet({String? periodName}) → Future<LedgerReport>

getBalanceSummary({String? periodName}) → Future<LedgerReport>

getCampaignMetrics({required String marketingCampaignId}) → Future<CampaignMetrics>

getCampaignProgress({required String marketingCampaignId}) → Future<CampaignProgress>

getCategories({int? limit}) → Future<Categories>

getCategory({int? start, int? limit, String? companyPartyId, bool? isForDropDown, String? searchString, String? classificationId}) → Future<Categories>

getChatMessages({String? chatRoomId, int? start, int? limit, String? searchString}) → Future<ChatMessages>

getChatRooms({bool? hasRead, String? userId, String? chatRoomName, String? chatRoomId, int? start, int? limit, bool? isPrivate, String? searchString, String? filter}) → Future<ChatRooms>

getCompanies({bool? mainCompanies, String? searchString, int? start, int? limit}) → Future<Companies>

getCompany({String? companyPartyId, String? companyName, String? userPartyId, String? ownerPartyId, Role? role, int? start, int? limit, String? firstName, String? lastName, String? searchString, bool? isForDropDown}) → Future<Companies>

getCompanyFromHost(String? hostName) → Future<Company>

getCompanyUser({Role? role, int? start, int? limit, String? searchString, String? partyId}) → Future<CompaniesUsers>

getContentPlans({String? searchString, int? start, int? limit}) → Future<ContentPlans>

getCountries(String? id, String? name) → Future<Countries>

getCredibilityInfo({required String landingPageId}) → Future<CredibilityInfoList>

getDailyRentalOccupancy({String? productId}) → Future<ProductRentalDates>

getFinDoc({String? finDocId, String? pseudoId, bool? sales, FinDocType? docType, String? companyPartyId, String? searchString, String? journalId, int? start, int? limit, bool? my, FinDocStatusVal? status}) → Future<FinDocs>

getGlAccount({int? start = 0, int? limit = 10, String? searchString, bool? trialBalance}) → Future<GlAccounts>

getItemTypes({bool? sales}) → Future<ItemTypes>

getLandingPage({String? landingPageId, String? pseudoId, String? ownerPartyId}) → Future<LandingPage>

getLandingPages({String? landingPageId, String? pseudoId, int? start, int? limit, String? searchString, String? statusId}) → Future<LandingPages>

getLedger() → Future<LedgerReport>

getLedgerJournal({String? ledgerJournalId, int? start, int? limit, String? searchString}) → Future<LedgerJournals>

getLocation({int? start, int? limit, String? filter, String? searchString}) → Future<Locations>

getMarketingPersonas({String? searchString, int? start, int? limit}) → Future<Personas>

getMenuConfiguration({String? menuConfigurationId, String? appId, String? userId}) → Future<MenuConfiguration>

Get menu configuration by ID or appId+userLoginId Returns configuration with hierarchical menu items

getNotifications({int? limit}) → Future<Notifications>

getOperatingRevenueExpenseChart({String? periodName}) → Future<LedgerReport>

getOpportunity({int? start, int? limit, String? opportunityId, String? searchString}) → Future<Opportunities>

getOutreachCampaignDetail({String? marketingCampaignId, String? pseudoId}) → Future<CampaignDetail>

getOutreachCampaigns({String? marketingCampaignId, String? pseudoId, String? statusId, int? start, int? limit}) → Future<OutreachCampaigns>

getPageSections({required String landingPageId}) → Future<LandingPageSections>

getPaymentTypes({bool? sales}) → Future<PaymentTypes>

getPlatformConfiguration({required String platform}) → Future<PlatformConfiguration>

getProduct({int? start, int? limit, String? companyPartyId, String? ownerPartyId, bool? isForDropDown, String? searchString, String? classificationId, String? categoryId, String? productId, String? productTypeId, String? assetClassId}) → Future<Products>

getProducts({int? limit, String? classificationId}) → Future<Products>

getRestRequest({String? hitId, String? userId, String? ownerPartyId, String? startDateTime, String? endDateTime, int? start, int? limit}) → Future<RestRequests>

getSocialPosts({String? searchString, String? planId, int? start, int? limit}) → Future<SocialPosts>

getSubscription({int? start, int? limit, String? subscriptionId, bool? growerp, String? searchString}) → Future<Subscriptions>

getTimePeriod({String? periodType = 'Y', String? year}) → Future<TimePeriods>

getUom(List<String>? uomTypes) → Future<Uoms>

getUser({String? partyId, Role? role, int? start, int? limit, String? firstName, String? lastName, String? searchString, bool? isForDropDown, bool? loginOnly}) → Future<Users>

getUsers(String limit) → Future<Users>

getWebsite() → Future<Website>

getWebsiteContent({required String path, required String text}) → Future<Content>

importAssets(List<Asset> assets, String classificationId) → Future<void>

importCategories(List<Category> categories) → Future<void>

importCompanies(List<Company> companies) → Future<void>

importCompanyUsers(List<CompanyUser> companyUsers) → Future<String>

importFinDoc(List<FinDoc> finDocs) → Future<void>

importFinDocItem(List<FinDocItem> finDocItems, String classificationId) → Future<void>

importGlAccounts(List<GlAccount> glAccounts) → Future<String>

importItemTypes(List<ItemType> itemTypes) → Future<String>

importPaymentTypes(List<PaymentType> paymentTypes) → Future<String>

importProducts(List<Product> products, String classificationId) → Future<void>

importScreenCategories({required List categories, required String classificationId}) → Future<String>

importScreenProducts({required List<Product> products, required String classificationId}) → Future<String>

importUsers(List<User> users) → Future<void>

importWebsite(Website website) → Future<void>

linkMenuItem({required String menuOptionId, required String menuItemId, int? sequenceNum}) → Future<MenuOption>

Link a MenuItem (tab) to a MenuOption

listMenuConfigurations({String? menuConfigurationId, String? appId, String? userId, String? isActive, int? start, int? limit, String? search}) → Future<MenuConfigurations>

List all menu configurations with pagination

listOutreachCampaigns({String? status, int? start, int? limit, String? searchString}) → Future<OutreachCampaigns>

listOutreachMessages({String? marketingCampaignId, String? status, int? start, int? limit, String? search}) → Future<OutreachMessages>

listPlatformConfigurations() → Future<PlatformConfigurations>

login({required String username, required String password, String? creditCardNumber, String? creditCardType, String? nameOnCard, String? expireMonth, String? expireYear, String? cVC, String? plan, String? companyName, String? currencyId, bool? demoData, required String classificationId, String? timeZoneOffset, int? testDaysOffset}) → Future<Authenticate>

logout() → Future<String>

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

obsUpload({required Obsidian obsidian}) → Future<Website>

pauseAgentInstance({required String instanceId}) → Future<void>

Pause agent instance

pauseCampaignAutomation({required String marketingCampaignId}) → Future

processInvoiceImage({required String imageData, required String prompt, required String mimeType}) → Future<String>

publishLandingPage({required String landingPageId}) → Future<LandingPage>

receiveShipment({required FinDoc finDoc}) → Future<FinDoc>

register({required String classificationId, required String firstName, required String lastName, required String email, String? companyPartyId, String? newPassword, UserGroup? userGroup, String? timeZoneOffset, String? locale}) → Future<Authenticate>

releaseGatewayPayment({required String paymentId}) → Future<FinDoc>

reorderMenuOptions({required String menuConfigurationId, required List<Map<String, dynamic>> optionSequences}) → Future<Map<String, int>>

Reorder multiple menu options (batch sequence update)

resetMenuConfiguration({required String menuConfigurationId}) → Future<void>

Reset menu configuration to default (copies items from default app config)

resetPassword({required String username}) → Future<String>

resolveAgentApprovalRequest({required String requestId, required bool approved, String? comment}) → Future<void>

Resolve (approve/reject) approval request

searchAssessments({String? searchString, int? start, int? limit, String? statusId}) → Future<Assessments>

sendOutreachEmail({required String marketingCampaignId, required String toEmail, String? toName, required String subject, required String body, String? bodyContentType}) → Future<OutreachMessage>

startAgentInstance({required String instanceId}) → Future<void>

Start agent instance

startCampaignAutomation({required String marketingCampaignId}) → Future

stopAgentInstance({required String instanceId}) → Future<void>

Stop agent instance

submitAssessment({required String assessmentId, required String answers, required String respondentName, required String respondentEmail, String? respondentPhone, String? respondentCompany, String? ownerPartyId, String? campaignId}) → Future<AssessmentResult>

toggleMenuOptionActive({required String menuOptionId}) → Future<MenuOption>

Toggle menu option active status

toString() → String

A string representation of this object.

inherited

unlinkMenuItem({required String menuOptionId, required String menuItemId}) → Future<Map<String, int>>

Unlink a MenuItem (tab) from a MenuOption

updateActivity({required Activity activity}) → Future<Activity>

updateAgentInstance({required AgentInstance agent}) → Future<AgentInstance>

Update agent instance

updateAssessment({required String assessmentId, String? pseudoId, String? assessmentName, String? description, String? status}) → Future<Assessment>

updateAssessmentQuestion({required String assessmentId, required String questionId, String? questionText, String? questionDescription, String? questionType, int? questionSequence, String? isRequired, List<Map<String, dynamic>>? options}) → Future<AssessmentQuestion>

updateAssessmentThresholds({required String assessmentId, required List<ScoringThreshold> thresholds}) → Future<ScoringThresholds>

updateAsset({required Asset asset, required String classificationId}) → Future<Asset>

updateCategory({required Category category, required String classificationId}) → Future<Category>

updateChatRoom({required ChatRoom chatRoom}) → Future<ChatRoom>

updateCompany({required Company company}) → Future<Company>

updateContentPlan({required String planId, String? pseudoId, String? personaId, int? weekStartDate, String? theme}) → Future<ContentPlan>

updateCredibilityInfo({required String landingPageId, required String credibilityInfoId, String? pseudoId, String? creatorBio, String? backgroundText, String? creatorImageUrl, String? statisticsJson}) → Future<CredibilityInfo>

updateFinDoc({required FinDoc finDoc}) → Future<FinDoc>

updateGlAccount({required GlAccount glAccount}) → Future<GlAccount>

updateItemType({required ItemType itemType, bool? update, bool? delete}) → Future<ItemType>

updateLandingPage({required String landingPageId, String? pseudoId, String? title, String? hookType, String? headline, String? subheading, String? ctaActionType, String? ctaAssessmentId, String? ctaButtonLink, String? privacyPolicyUrl, String? status}) → Future<LandingPage>

updateLedgerJournal({required LedgerJournal ledgerJournal}) → Future<LedgerJournal>

updateLocation({required Location location}) → Future<Location>

updateMarketingPersona({required String personaId, String? pseudoId, String? name, String? demographics, String? painPoints, String? goals, String? toneOfVoice}) → Future<Persona>

updateMenuConfiguration({required String menuConfigurationId, String? name, String? description, String? isActive}) → Future<MenuConfiguration>

Update menu configuration

updateMenuOption({required String menuOptionId, String? itemKey, String? title, String? route, String? iconName, String? widgetName, String? image, String? selectedImage, String? userGroupsJson, int? sequenceNum, String? isActive}) → Future<MenuOption>

Update menu option

updateOpportunity({required Opportunity opportunity}) → Future<Opportunity>

updateOutreachCampaign({required Map<String, dynamic> campaign}) → Future<OutreachCampaign>

updateOutreachMessageStatus({required String messageId, required String status, int? responseDate, String? errorMessage}) → Future<OutreachMessage>

updatePageSection({required String landingPageId, required String pageSectionId, String? sectionTitle, String? sectionDescription, String? sectionImageUrl, int? sectionSequence}) → Future<LandingPageSection>

updatePassword({required String username, required String oldPassword, required String newPassword, required String classificationId}) → Future<Authenticate>

updatePaymentType({required PaymentType paymentType, bool? update, bool? delete}) → Future<PaymentType>

updatePlatformConfiguration({required String configId, String? isEnabled, int? dailyLimit, String? apiKey, String? apiSecret, String? username, String? password}) → Future<PlatformConfiguration>

updateProduct({required Product product, required String classificationId}) → Future<Product>

updateSocialPost({required String postId, String? pseudoId, String? planId, String? type, String? platform, String? headline, String? draftContent, String? finalContent, String? status, int? scheduledDate}) → Future<SocialPost>

updateSubscription({required Subscription subscription}) → Future<Subscription>

updateTimeEntry({required TimeEntry timeEntry}) → Future<TimeEntry>

updateTimePeriod({required String timePeriodId, bool? createNext, bool? createPrevious, bool? delete}) → Future<TimePeriods>

updateUser({required User user}) → Future<User>

updateWebsite({required Website website}) → Future<Website>

uploadEntities({required dynamic entities, required String classificationId}) → Future<void>

uploadWebsiteContent({required Content content}) → Future<Content>

Operators

operator ==(Object other) → bool

The equality operator.

inherited