framas_api

Description:

framas api

framas_api (EXPERIMENTAL) #
Framas System API
This Dart package is automatically generated by the OpenAPI Generator project:

API version: 1.0
Build package: org.openapitools.codegen.languages.DartDioClientCodegen
For more information, please visit https://framas.com

Requirements #

Dart 2.15.0+ or Flutter 2.8.0+
Dio 5.0.0+ (https://pub.dev/packages/dio)

Installation & Usage #
pub.dev #
To use the package from pub.dev, please include the following in pubspec.yaml
dependencies:
framas_api: 1.0.0
copied to clipboard
Github #
If this Dart package is published to Github, please include the following in pubspec.yaml
dependencies:
framas_api:
git:
url: https://github.com/GIT_USER_ID/GIT_REPO_ID.git
#ref: main
copied to clipboard
Local development #
To use the package from your local drive, please include the following in pubspec.yaml
dependencies:
framas_api:
path: /path/to/framas_api
copied to clipboard
Getting Started #
Please follow the installation procedure and then run the following:
import 'package:framas_api/framas_api.dart';


final api = FramasApi().getAppFunctionApi();
final AddAppFunctionRequest addAppFunctionRequest = ; // AddAppFunctionRequest |

try {
final response = await api.appFunctionAdd(addAppFunctionRequest);
print(response);
} catch on DioError (e) {
print("Exception when calling AppFunctionApi->appFunctionAdd: $e\n");
}

copied to clipboard
Documentation for API Endpoints #
All URIs are relative to http://localhost



Class
Method
HTTP request
Description




AppFunctionApi
appFunctionAdd
POST /api/appfunction
Add a app function


AppFunctionApi
appFunctionDelete
DELETE /api/appfunction/{id}
Delete a app function


AppFunctionApi
appFunctionExport
POST /api/appfunction/export
Export a list of app function to specified file format


AppFunctionApi
appFunctionGet
GET /api/appfunction/{id}
Find app function detail by it Id


AppFunctionApi
appFunctionGetAll
GET /api/appfunction
Get a list of all app functions


AppFunctionApi
appFunctionSearch
POST /api/appfunction/search
Search app function using available filters


AppFunctionApi
appFunctionUpdate
PUT /api/appfunction
Update a app function


ApplicationApi
applicationAdd
POST /api/application
Add a application


ApplicationApi
applicationAssignFuntions
POST /api/application/assign_functions
Assign functions for application


ApplicationApi
applicationAssignPlugins
POST /api/application/assign_plugins
Assign plugins for application


ApplicationApi
applicationDelete
DELETE /api/application/{id}
Delete a application


ApplicationApi
applicationExport
POST /api/application/export
Export a list of application to specified file format


ApplicationApi
applicationGet
GET /api/application/{id}
Find application detail by it Id


ApplicationApi
applicationGetAll
GET /api/application
Get a list of all applications


ApplicationApi
applicationGetSettings
GET /api/application/settings/{id}
Find application settings by it Id


ApplicationApi
applicationSearch
POST /api/application/search
Search application using available filters


ApplicationApi
applicationUpdate
PUT /api/application
Update a application


ApplicationApi
applicationUpdateSettings
PUT /api/application/settings
Update a application settings


CompanyApi
companyAdd
POST /api/company
Add a new company


CompanyApi
companyDelete
DELETE /api/company/{id}
Delete a company by it Id


CompanyApi
companyExport
POST /api/company/export
Export a list of user to specified file format


CompanyApi
companyGet
GET /api/company/{id}
Find company detail by it Id


CompanyApi
companyGetAll
GET /api/company
Get a list of all companies


CompanyApi
companyGetSupportCompaniesForApplication
GET /support/{appId}
Get a list of companies that the application id is support


CompanyApi
companySearch
POST /api/company/search
Search company using available filters


CompanyApi
companyUpdate
PUT /api/company
Update a company


ConfigApi
configAdd
POST /api/config
Add a config


ConfigApi
configDelete
DELETE /api/config/{id}
Delete a config


ConfigApi
configExport
POST /api/config/export
Export a list of config to specified file format


ConfigApi
configGet
GET /api/config/{id}
Find config detail by it Id


ConfigApi
configGetAll
GET /api/config
Get a list of all configs


ConfigApi
configSearch
POST /api/config/search
Search config using available filters


ConfigApi
configUpdate
PUT /api/config
Update a config


ConnectionApi
connectionAdd
POST /api/connection
Add a connection


ConnectionApi
connectionDelete
DELETE /api/connection/{id}
Delete a connection


ConnectionApi
connectionExport
POST /api/connection/export
Export a list of connection to specified file format


ConnectionApi
connectionGet
GET /api/connection/{id}
Find connection detail by it Id


ConnectionApi
connectionGetAll
GET /api/connection
Get a list of all connections


ConnectionApi
connectionSearch
POST /api/connection/search
Search connection using available filters


ConnectionApi
connectionUpdate
PUT /api/connection
Update a connection


EmailSenderProfileApi
emailSenderProfileAdd
POST /api/emailsenderprofile
Add a email sender profile


EmailSenderProfileApi
emailSenderProfileDelete
DELETE /api/emailsenderprofile/{id}
Delete a email sender profile


EmailSenderProfileApi
emailSenderProfileExport
POST /api/emailsenderprofile/export
Export a list of email sender profile to specified file format


EmailSenderProfileApi
emailSenderProfileGet
GET /api/emailsenderprofile/{id}
Find email sender profile detail by it Id


EmailSenderProfileApi
emailSenderProfileGetAll
GET /api/emailsenderprofile
Get a list of all email sender profiles


EmailSenderProfileApi
emailSenderProfileSearch
POST /api/emailsenderprofile/search
Search email sender profile using available filters


EmailSenderProfileApi
emailSenderProfileUpdate
PUT /api/emailsenderprofile
Update a email sender profile


EmailTemplateApi
emailTemplateAdd
POST /api/emailtemplate
Add a email template


EmailTemplateApi
emailTemplateDelete
DELETE /api/emailtemplate/{id}
Delete a email template


EmailTemplateApi
emailTemplateExport
POST /api/emailtemplate/export
Export a list of email template to specified file format


EmailTemplateApi
emailTemplateGet
GET /api/emailtemplate/{id}
Find email template detail by it Id


EmailTemplateApi
emailTemplateGetAll
GET /api/emailtemplate
Get a list of all email templates


EmailTemplateApi
emailTemplateRender
POST /api/emailtemplate/render
Render a email template


EmailTemplateApi
emailTemplateSearch
POST /api/emailtemplate/search
Search email template using available filters


EmailTemplateApi
emailTemplateUpdate
PUT /api/emailtemplate
Update a email template


EmailTemplateApi
emailTemplateUpdateContent
PUT /api/emailtemplate/content
Update a email template content


LabelGeneratorApi
labelGeneratorGenerateOrderLabels
POST /api/labelgenerator/generateorderlabels
Generate all label model from oc number or specifed OCNum#BoxCode


LabelGeneratorApi
labelGeneratorGetOrderLabels
GET /api/labelgenerator/{key}
Generate all label model from oc number or specifed OCNum#BoxCode


PersonalControlApi
personalControlGetPermissions
GET /api/personalcontrol/permissions
Get permissions of currently logged in user.


PluginApi
pluginAdd
POST /api/plugin
Add a new plugin


PluginApi
pluginDelete
DELETE /api/plugin/{id}
Delete a plugin by it Id


PluginApi
pluginExport
POST /api/plugin/export
Export a list of plugin to specified file format


PluginApi
pluginGetAll
GET /api/plugin
Get a list of all plugin


PluginApi
pluginSearch
POST /api/plugin/search
Search plugin using available filters


PluginApi
pluginUpdate
PUT /api/plugin
Update a plugin


PluginApi
pluginUploadData
POST /api/plugin/upload
Upload a dll data into a plugin.


ReportApi
reportGet
GET /api/report
Export report to specified format


ReportApi
reportGetByPost
POST /api/report
Export report to specified format


ReportLayoutApi
reportLayoutAdd
POST /api/reportlayout
Add a report layout


ReportLayoutApi
reportLayoutDelete
DELETE /api/reportlayout/{id}
Delete a report layout


ReportLayoutApi
reportLayoutExport
POST /api/reportlayout/export
Export a list of report layout to specified file format


ReportLayoutApi
reportLayoutGet
GET /api/reportlayout/{id}
Find report layout detail by it Id


ReportLayoutApi
reportLayoutGetAll
GET /api/reportlayout
Get a list of all report layouts


ReportLayoutApi
reportLayoutGetWithData
GET /api/reportlayout/data/{id}
Find report layout detail by it Id


ReportLayoutApi
reportLayoutSearch
POST /api/reportlayout/search
Search report layout using available filters


ReportLayoutApi
reportLayoutUpdate
PUT /api/reportlayout
Update a report layout


RoleApi
roleAdd
POST /api/role
Add a role


RoleApi
roleAssignFunctions
POST /api/role/assign_functions
Update a role's assigned functions


RoleApi
roleDelete
DELETE /api/role/{id}
Delete a role


RoleApi
roleExport
POST /api/role/export
Export a list of role to specified file format


RoleApi
roleGet
GET /api/role/{id}
Find role detail by it Id


RoleApi
roleGetAll
GET /api/role
Get a list of all roles


RoleApi
roleGetRoleFunctions
GET /api/role/functions/{id}
Find functions that assigned for role


RoleApi
roleSearch
POST /api/role/search
Search role using available filters


RoleApi
roleUpdate
PUT /api/role
Update a role


RoleClaimApi
roleClaimAdd
POST /api/roleclaim
Add a role claim


RoleClaimApi
roleClaimDelete
DELETE /api/roleclaim/{id}
Delete a role claim


RoleClaimApi
roleClaimExport
POST /api/roleclaim/export
Export a list of role claim to specified file format


RoleClaimApi
roleClaimGet
GET /api/roleclaim/{id}
Find role claim detail by it Id


RoleClaimApi
roleClaimGetAll
GET /api/roleclaim
Get a list of all role claims


RoleClaimApi
roleClaimSearch
POST /api/roleclaim/search
Search role claim using available filters


RoleClaimApi
roleClaimUpdate
PUT /api/roleclaim
Update a role claim


TokenApi
tokenLogin
POST /api/token/login
Request an access token using credentials.


TokenApi
tokenRefreshToken
POST /api/token/refresh
Request an access token using a refresh token.


UserApi
userAdd
POST /api/user
Add a new user


UserApi
userAssignFunctions
POST /api/user/assign_functions
Update a user's assigned functions


UserApi
userAssignRoles
POST /api/user/assign_roles
Update a user's assigned roles


UserApi
userChangePassword
POST /api/user/change-password
Change a user's password


UserApi
userDelete
DELETE /api/user/{id}
Delete a user


UserApi
userExport
POST /api/user/export
Export a list of user to specified file format


UserApi
userForgotPassword
POST /api/user/forgot-password
Request a password reset email for a user


UserApi
userGet
GET /api/user/{id}
Find user detail by it Id


UserApi
userGetAll
GET /api/user
Get a list of all users


UserApi
userGetUserFunctions
GET /api/user/functions/{id}
Find function that assigned for user


UserApi
userGetUserRoles
GET /api/user/roles/{id}
Find roles that assigned for user


UserApi
userResetPassword
POST /api/user/reset-password
Reset a user's password


UserApi
userSearch
POST /api/user/search
Search user using available filters


UserApi
userUpdate
PUT /api/user
Update a user


UserClaimApi
userClaimAdd
POST /api/userclaim
Add a user claim


UserClaimApi
userClaimDelete
DELETE /api/userclaim/{id}
Delete a user claim


UserClaimApi
userClaimExport
POST /api/userclaim/export
Export a list of user claim to specified file format


UserClaimApi
userClaimGet
GET /api/userclaim/{id}
Find user claim detail by it Id


UserClaimApi
userClaimGetAll
GET /api/userclaim
Get a list of all user claims


UserClaimApi
userClaimSearch
POST /api/userclaim/search
Search user claim using available filters


UserClaimApi
userClaimUpdate
PUT /api/userclaim
Update a user claim


WorkflowTriggerApi
workflowTriggerAdd
POST /api/workflowtrigger
Add a workflow trigger


WorkflowTriggerApi
workflowTriggerExport
POST /api/workflowtrigger/export
Export a list of workflow trigger to specified file format


WorkflowTriggerApi
workflowTriggerGet
GET /api/workflowtrigger/{id}
Find workflow trigger detail by it Id


WorkflowTriggerApi
workflowTriggerGetAll
GET /api/workflowtrigger
Get a list of all workflow triggers


WorkflowTriggerApi
workflowTriggerPostSendSignal
POST /api/workflowtrigger/sendsignal
Send the signal to trigger workflow using POST method


WorkflowTriggerApi
workflowTriggerSearch
POST /api/workflowtrigger/search
Search workflow trigger using available filters


WorkflowTriggerApi
workflowTriggerSendSignal
GET /api/workflowtrigger/sendsignal/{token}
Send the signal to trigger workflow


WorkflowTriggerApi
workflowTriggerUpdateStatus
PUT /api/workflowtrigger/status
Update a workflow trigger status



Documentation For Models #

AddAppFunctionRequest
AddApplicationRequest
AddCompanyRequest
AddConfigRequest
AddConnectionRequest
AddEmailSenderProfileRequest
AddEmailTemplateRequest
AddPluginRequest
AddRoleClaimRequest
AddRoleRequest
AddUserClaimRequest
AddUserRequest
AddWorkflowTriggerRequest
AppFunctionDto
AppFunctionDtoPaginationResponse
ApplicationDto
ApplicationDtoPaginationResponse
ApplicationSettingsDto
AssignAppFunctionsRequest
AssignAppPluginsRequest
AssignRoleFunctionsRequest
AssignUserFunctionsRequest
AssignUserRolesRequest
ChangePasswordRequest
CollectedWorkflowDto
CompanyDto
CompanyDtoPaginationResponse
ConfigContext
ConfigDto
ConfigDtoPaginationResponse
ConnectionDto
ConnectionDtoPaginationResponse
EmailSenderProfileDto
EmailSenderProfileDtoPaginationResponse
EmailTemplateDto
EmailTemplateDtoPaginationResponse
ErrorResult
ExportAppFunctionRequest
ExportApplicationRequest
ExportCompanyRequest
ExportConfigRequest
ExportConnectionRequest
ExportContentType
ExportEmailSenderProfileRequest
ExportEmailTemplateRequest
ExportPluginRequest
ExportReportLayoutRequest
ExportReportRequest
ExportRoleClaimRequest
ExportRoleRequest
ExportUserClaimRequest
ExportUserRequest
ExportWorkflowTriggerRequest
Filter
ForgotPasswordRequest
GetOrderLabelRequest
OrderLabel
PluginDto
PluginDtoPaginationResponse
RefreshTokenRequest
RenderEmailTemplateRequest
RenderEmailTemplateResponse
ReportDataSourceType
ReportLayoutDataDto
ReportLayoutDto
ReportLayoutDtoPaginationResponse
ReportLayoutFormat
ResetPasswordRequest
RoleClaimDto
RoleClaimDtoPaginationResponse
RoleDto
RoleDtoPaginationResponse
RoleFunctionDto
Search
SearchAppFunctionRequest
SearchApplicationRequest
SearchCompanyRequest
SearchConfigRequest
SearchConnectionRequest
SearchEmailSenderProfileRequest
SearchEmailTemplateRequest
SearchPluginRequest
SearchReportLayoutRequest
SearchRoleClaimRequest
SearchRoleRequest
SearchUserClaimRequest
SearchUserRequest
SearchWorkflowTriggerRequest
SendWorkflowSignalRequest
TokenRequest
TokenResponse
UpdateAppFunctionRequest
UpdateApplicationRequest
UpdateApplicationSettingsRequest
UpdateCompanyRequest
UpdateConfigRequest
UpdateConnectionRequest
UpdateEmailSenderProfileRequest
UpdateEmailTemplateContentRequest
UpdateEmailTemplateRequest
UpdatePluginRequest
UpdateReportLayoutRequest
UpdateRoleClaimRequest
UpdateRoleRequest
UpdateUserClaimRequest
UpdateUserRequest
UpdateWorkflowTriggerStatusRequest
UserClaimDto
UserClaimDtoPaginationResponse
UserDto
UserDtoPaginationResponse
UserFunctionDto
UserRoleDto
ValidationProblemDetails
WorkflowInstanceDto
WorkflowTriggerDto
WorkflowTriggerDtoPaginationResponse

Documentation For Authorization #
Authentication schemes defined for the API:
Bearer #

Type: HTTP basic authentication

Basic #

Type: HTTP basic authentication

Author #
[email protected]