CompaniesApi class

Constructors

CompaniesApi([ApiClient? apiClient])

Properties

apiClient → ApiClient
final
hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

getCompaniesById(String companyId) → Future<GetCompaniesById200Response?>
Get details of the requestor's own company
getCompaniesByIdWithHttpInfo(String companyId) → Future<Response>
Get details of the requestor's own company
listCompanies(String companyId, {int? page, int? limit, String? sortBy, String? sortOrder, String? search}) → Future<ListCompaniesAnalyticsAssets200Response?>
Get the total number of requests allocated in the company's current subscription plan.
listCompaniesAnalyticsAssets(String companyId, {int? page, int? limit, String? sortBy, String? sortOrder, String? search}) → Future<ListCompaniesAnalyticsAssets200Response?>
Get asset performance analytics. Query params: start_date, end_date, limit, sort_by, include
listCompaniesAnalyticsAssetsWithHttpInfo(String companyId, {int? page, int? limit, String? sortBy, String? sortOrder, String? search}) → Future<Response>
Get asset performance analytics. Query params: start_date, end_date, limit, sort_by, include
listCompaniesAnalyticsCustomers(String companyId, {int? page, int? limit, String? sortBy, String? sortOrder, String? search}) → Future<ListCompaniesAnalyticsAssets200Response?>
Get customer analytics including growth and segmentation. Query params: start_date, end_date, group_by, segment_by
listCompaniesAnalyticsCustomersWithHttpInfo(String companyId, {int? page, int? limit, String? sortBy, String? sortOrder, String? search}) → Future<Response>
Get customer analytics including growth and segmentation. Query params: start_date, end_date, group_by, segment_by
listCompaniesAnalyticsDashboard(String companyId, {int? page, int? limit, String? sortBy, String? sortOrder, String? search}) → Future<ListCompaniesAnalyticsAssets200Response?>
Get comprehensive dashboard analytics for seller dashboard. Query params: start_date, end_date, period (day/week/month/quarter)
listCompaniesAnalyticsDashboardWithHttpInfo(String companyId, {int? page, int? limit, String? sortBy, String? sortOrder, String? search}) → Future<Response>
Get comprehensive dashboard analytics for seller dashboard. Query params: start_date, end_date, period (day/week/month/quarter)
listCompaniesAnalyticsMetrics(String companyId, {int? page, int? limit, String? sortBy, String? sortOrder, String? search}) → Future<ListCompaniesAnalyticsAssets200Response?>
Get summary metrics (counts only). No date params needed — returns all-time totals. Performance: < 0.1s
listCompaniesAnalyticsMetricsWithHttpInfo(String companyId, {int? page, int? limit, String? sortBy, String? sortOrder, String? search}) → Future<Response>
Get summary metrics (counts only). No date params needed — returns all-time totals. Performance: < 0.1s
listCompaniesAnalyticsSales(String companyId, {int? page, int? limit, String? sortBy, String? sortOrder, String? search}) → Future<ListCompaniesAnalyticsAssets200Response?>
Get sales over time analytics. Query params: start_date, end_date, group_by (day/week/month/quarter), metrics
listCompaniesAnalyticsSalesWithHttpInfo(String companyId, {int? page, int? limit, String? sortBy, String? sortOrder, String? search}) → Future<Response>
Get sales over time analytics. Query params: start_date, end_date, group_by (day/week/month/quarter), metrics
listCompaniesObjects(String companyId, {int? page, int? limit, String? sortBy, String? sortOrder, String? search}) → Future<ListCompaniesAnalyticsAssets200Response?>
Get all objects (connections, assets) of a single company
listCompaniesObjectsWithHttpInfo(String companyId, {int? page, int? limit, String? sortBy, String? sortOrder, String? search}) → Future<Response>
Get all objects (connections, assets) of a single company
listCompaniesRequestsUsage(String companyId, {int? page, int? limit, String? sortBy, String? sortOrder, String? search}) → Future<ListCompaniesAnalyticsAssets200Response?>
Get company request usage data for a specific month.
listCompaniesRequestsUsageWithHttpInfo(String companyId, {int? page, int? limit, String? sortBy, String? sortOrder, String? search}) → Future<Response>
Get company request usage data for a specific month.
listCompaniesWithHttpInfo(String companyId, {int? page, int? limit, String? sortBy, String? sortOrder, String? search}) → Future<Response>
Get the total number of requests allocated in the company's current subscription plan.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited
updateCompanies(String companyId, CompaniesUpdate companiesUpdate) → Future<UpdateCompanies200Response?>
Update an existing company by ID
updateCompaniesWithHttpInfo(String companyId, CompaniesUpdate companiesUpdate) → Future<Response>
Update an existing company by ID

Operators

operator ==(Object other) → bool
The equality operator.
inherited