Module hub_fleet_management_system

easycarros/hub_fleet_management_system

1.0.0-alpha

Prints "Hello, World!" with a main function. [//]: # (above is the module summary)

Module Overview

Provides an overview about the module when generating the API documentations. For example, refer to https://lib.ballerina.io/ballerina/io/latest

Clients

hub_fleet_management_system: Client

Isolated

Documentation.

Constructor

Gets invoked to initialize the connector.

init (ConnectionConfig config, string serviceUrl)

config ConnectionConfig - The configurations to be used when initializing the connector

serviceUrl string - URL of the target service

Isolated FunctionRemote Function

function login(AccountLoginRequest payload) returns AccountLoginResponse|error

Parameters

payload AccountLoginRequest - login request

Return Type

AccountLoginResponse|error - Success

logincrossauth

Isolated FunctionRemote Function

function logincrossauth(string userPublicGuid, string companyPublicGuid) returns AccountLoginResponse|error

Parameters

userPublicGuid string - User public Guid

companyPublicGuid string - Company public Guid

Return Type

AccountLoginResponse|error - Success

driverdocs

Isolated FunctionRemote Function

function driverdocs() returns Response|error

Get required fields to register a driver in each state

Return Type

Response|error - Server Error

driver

Isolated FunctionRemote Function

function driver(string organizationId, DocsDriverByDriversLicenseRequest payload) returns Response|error

Get Driver By Driver's License

Parameters

organizationId string - Organization Id

payload DocsDriverByDriversLicenseRequest - Request Object Drivers

Return Type

Response|error - Server Error

driverstatus

Isolated FunctionRemote Function

function driverstatus(string organizationId, DocsDriverOnOffRequest payload) returns Response|error

Inactive or Active a driver on DOCS

Parameters

organizationId string - Organization Id

payload DocsDriverOnOffRequest - Request Object Driver License

Return Type

Response|error - Server Error

organization

Isolated FunctionRemote Function

function organization(string organizationId, DocsDriverGetAllRequest payload) returns Response|error

Get All Drivers

Parameters

organizationId string - Organization Id

payload DocsDriverGetAllRequest - Request Object Drivers

Return Type

Response|error - Server Error

driverdocscreate

Isolated FunctionRemote Function

function driverdocscreate(string organizationId, DocsDriverPostV2Request[] payload) returns Response|error

Creates Drivers (See "Model swagger documentation" for state rules)

Parameters

organizationId string - Organization Id

payload DocsDriverPostV2Request[] - Request Object Drivers

Return Type

Response|error - Server Error

trafficticket

Isolated FunctionRemote Function

function trafficticket(TrafficTicketDocsV1PostRequest payload) returns Response|error

Take all the tickets

Parameters

payload TrafficTicketDocsV1PostRequest - Request Object

Return Type

Response|error - Server Error

plate

Isolated FunctionRemote Function

function plate(TrafficTicketDocsPlateV1Request payload) returns Response|error

Take one ticket by plate

Parameters

payload TrafficTicketDocsPlateV1Request - Request Object

Return Type

Response|error - Server Error

externalid

Isolated FunctionRemote Function

function externalid(string organizationId, TrafficTicketDocsExternalIdRequest payload) returns Response|error

Take one ticket by ExternalId

Parameters

organizationId string - Organization Id

payload TrafficTicketDocsExternalIdRequest - Request Object

Return Type

Response|error - Server Error

user

Isolated FunctionRemote Function

function user(string companyPublicGuid) returns UserResponse|error

Take all the active users that have access to my companys

Parameters

companyPublicGuid string - Company public Guid

Return Type

UserResponse|error - Success

companygroup

Isolated FunctionRemote Function

function companygroup(string companyPublicGuid, UserPostRequest payload) returns UserResponse|error

Creates one item

Parameters

companyPublicGuid string - Company public Guid

payload UserPostRequest - Item definition

Return Type

UserResponse|error - Success

vehicle

Isolated FunctionRemote Function

function vehicle(VehicleDocsPostV1Request payload) returns VehicleDocsResponse|error

Take all the vehicle

Parameters

payload VehicleDocsPostV1Request - Request Object

Return Type

VehicleDocsResponse|error - Success

vehicleplate

Isolated FunctionRemote Function

function vehicleplate(VehicleDocsPlateV1Request payload) returns VehicleDocsResponse|error

Take one vehicle by plate

Parameters

payload VehicleDocsPlateV1Request - Request Object

Return Type

VehicleDocsResponse|error - Success

vehiclecreate

Isolated FunctionRemote Function

function vehiclecreate(string organizationId, VehicleDocsSaveRequest[] payload) returns Response|error

Creates vehicles

Parameters

organizationId string - Organization Id

payload VehicleDocsSaveRequest[] - Request Object Vehicle

Return Type

Response|error - Success

vehiclestatus

Isolated FunctionRemote Function

function vehiclestatus(string organizationId, VehicleDocsOnOffRequest payload) returns Response|error

Inactive or Active a vehicle

Parameters

organizationId string - Organization Id

payload VehicleDocsOnOffRequest - Request Object Vehicle

Return Type

Response|error - Server Error

Records

hub_fleet_management_system: AccountCompany

Fields

id int? -

name string? -

nationalNumber string? -

docsOrganizationId string? -

publicId string? -

'type int? -

hub_fleet_management_system: AccountLoginRequest

Fields

password string - Senha

hub_fleet_management_system: AccountLoginResponse

Fields

id int? - Id

publicId string? - Public key

name string? - User Name

companies AccountCompany[]? - Companys that this user have access

token string? - Token (JWT)

hub_fleet_management_system: ClientHttp1Settings

Closed record

Provides settings related to HTTP/1.x protocol.

Fields

keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests

chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request

proxy ProxyConfig? - Proxy server related options

hub_fleet_management_system: ConnectionConfig

Closed record

Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.

Fields

auth OAuth2ClientCredentialsGrantConfig - Configurations related to client authentication

httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client

http1Settings ClientHttp1Settings? - Configurations related to HTTP/1.x protocol

http2Settings ClientHttp2Settings? - Configurations related to HTTP/2 protocol

timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection

forwarded string(default "disable") - The choice of setting forwarded/x-forwarded header

poolConfig PoolConfiguration? - Configurations associated with request pooling

cache CacheConfig? - HTTP caching related configurations

compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (accept-encoding) header

circuitBreaker CircuitBreakerConfig? - Configurations associated with the behaviour of the Circuit Breaker

retryConfig RetryConfig? - Configurations associated with retrying

responseLimits ResponseLimitConfigs? - Configurations associated with inbound response size limits

secureSocket ClientSecureSocket? - SSL/TLS-related options

proxy ProxyConfig? - Proxy server related options

validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default

hub_fleet_management_system: DocsDriverByDriversLicenseRequest

Fields

driversLicense string? -

hub_fleet_management_system: DocsDriverGetAllRequest

Fields

nextPage string? -

previousPage string? -

hub_fleet_management_system: DocsDriverOnOffRequest

Fields

status string? -

driverLicense string? -

hub_fleet_management_system: DocsDriverPostV2Request

Fields

driversLicense string - Drivers License Number (Mandatory for all states)

driversLicenseExpiresAt string? - Drivers license expiration date (Mandatory for the state "PR")

driversFirstLicenseDate string? - Drivers first license date (Mandatory for the state "MG")

state string - Drivers license emission state (Mandatory for all states)

nationalNumber string - Drivers national number (CPF, Mandatory for all states)

birthdate string? - Drivers birthdate (Mandatory for the states "MG", "MT")

birthState string? - Drivers birth state (Mandatory for the state "AL")

birthCountyName string? - Drivers birth county name (Mandatory for the state "AL")

name string - Drivers name (Mandatory for the state "AL")

mirrorNumber string? - MirrorNumber

hub_fleet_management_system: DocsVehicle_Capacity_Response

Fields

cargo string? -

passenger int? -

hub_fleet_management_system: DocsVehicle_Datum_Response

Fields

plate string? -

createdAt string? -

updatedAt string? -

organization DocsVehicle_Organization_Response? -

id string? -

status string? -

updateIntervalInDays int? -

ipva string? -

dpvat string? -

licensing string? -

vehicleInfo DocsVehicle_VehicleInfo_Response? -

proprietorInfo DocsVehicle_ProprietorInfo_Response? -

licensingInfo DocsVehicle_LicensingInfo_Response? -

totalDebts DocsVehicle_TotalDebts_Response? -

ticketInfo DocsVehicle_TicketInfo_Response? -

latestUpdate DocsVehicle_LatestUpdate_Response? -

latestUpdateResult DocsVehicle_LatestUpdateResult_Response? -

hub_fleet_management_system: DocsVehicle_Engine_Response

Fields

power int? -

number string? -

capacity int? -

hub_fleet_management_system: DocsVehicle_LatestUpdate_Response

Fields

createdAt anydata? -

updatedAt anydata? -

status anydata? -

hub_fleet_management_system: DocsVehicle_LatestUpdateResult_Response

Fields

createdAt anydata? -

'error anydata? -

status anydata? -

hub_fleet_management_system: DocsVehicle_LicensingInfo_Response

Fields

date string? -

fiscalPeriod int? -

hub_fleet_management_system: DocsVehicle_Organization_Response

Fields

id string? -

hub_fleet_management_system: DocsVehicle_ProprietorInfo_Response

Fields

individualRegistration string? -

name string? -

hub_fleet_management_system: DocsVehicle_RootObject_Return

Fields

data DocsVehicle_Datum_Response[]? -

message string? -

statusCode int? -

hasNextPage string? -

hasPreviousPage string? -

nextPage string? -

previuosPage string? -

currentPage int? -

totalPages int? -

totalCount int? -

hub_fleet_management_system: DocsVehicle_TicketInfo_Response

Fields

count int? -

totalValue decimal? -

hub_fleet_management_system: DocsVehicle_TotalDebts_Response

Fields

ipva decimal? -

dpvat decimal? -

licenciamento decimal? -

taxesInfo record {}? -

dividaAtiva int? -

hub_fleet_management_system: DocsVehicle_VehicleInfo_Response

Fields

city string? -

'type string? -

brand string? -

color string? -

model string? -

state string? -

engine DocsVehicle_Engine_Response? -

renavam string? -

species string? -

capacity DocsVehicle_Capacity_Response? -

category string? -

fuelType string? -

chassisId string? -

modelYear string? -

manufacturingYear string? -

hub_fleet_management_system: DocsVehicleByPlate_Data_Response

Fields

plate string? -

createdAt string? -

updatedAt string? -

organization DocsVehicle_Organization_Response? -

id string? -

status string? -

updateIntervalInDays int? -

ipva string? -

dpvat string? -

licensing string? -

vehicleInfo DocsVehicle_VehicleInfo_Response? -

proprietorInfo DocsVehicle_ProprietorInfo_Response? -

licensingInfo DocsVehicle_LicensingInfo_Response? -

totalDebts DocsVehicle_TotalDebts_Response? -

ticketInfo DocsVehicle_TicketInfo_Response? -

latestUpdate DocsVehicle_LatestUpdate_Response? -

latestUpdateResult DocsVehicle_LatestUpdateResult_Response? -

hub_fleet_management_system: DocsVehicleByPlate_RootObject_Return

Fields

data DocsVehicleByPlate_Data_Response? -

message string? -

statusCode int? -

hub_fleet_management_system: OAuth2ClientCredentialsGrantConfig

Closed record

OAuth2 Client Credentials Grant Configs

Fields

Fields Included from * OAuth2ClientCredentialsGrantConfig

tokenUrl string
clientId string
clientSecret string
scopes string[]
defaultTokenExpTime decimal
clockSkew decimal
optionalParams map<string>
credentialBearer CredentialBearer
clientConfig ClientConfiguration

tokenUrl string(default "https://sts.choreo.dev:443/oauth2/token") - Token URL

hub_fleet_management_system: ProblemDetails

Fields

'type string? -

title string? -

status int? -

detail string? -

instance string? -

hub_fleet_management_system: ProxyConfig

Closed record

Proxy server configurations to be used with the HTTP client endpoint.

Fields

host string(default "") - Host name of the proxy server

port int(default 0) - Proxy server port

userName string(default "") - Proxy server username

password string(default "") - Proxy server password

hub_fleet_management_system: TrafficTicketDocsExternalIdRequest

Fields

externalId string? -

hub_fleet_management_system: TrafficTicketDocsPlateV1Request

Fields

organizationId string? -

plate string? -

hub_fleet_management_system: TrafficTicketDocsV1PostRequest

Fields

organizationId string? -

nextPage string? -

previousPage string? -

hub_fleet_management_system: UserPostRequest

Fields

entityVersion string? - Versão da entidade, utilizada para processos de concorrência. Caso a EntityVersion do Request for diferente do atual da aplicação, apresentará um erro de concorrência. Caso seja nulo, ignorará a concorrência.

nationalIndividualNumber string - National indivudual number (BR CPF)

name string - Name of the user

dateOfBirth string? - User date of birth

motherName string? - User mother name

occupationId int? - occupation id

password string - Password

hub_fleet_management_system: UserResponse

Fields

entityVersion string? - Versão da entidade, utilizada para processos de concorrência. Caso a EntityVersion do Request for diferente do atual da aplicação, apresentará um erro de concorrência. Caso seja nulo, ignorará a concorrência.

id int? - Id

inactiveIndicative boolean? - Inactive indicative

publicGuid string? - Public Guid

hub_fleet_management_system: VehicleDocsOnOffRequest

Fields

status string? -

plate string? -

hub_fleet_management_system: VehicleDocsPlateV1Request

Fields

organizationId string? -

plate string? -

hub_fleet_management_system: VehicleDocsPostV1Request

Fields

entityVersion string? - Versão da entidade, utilizada para processos de concorrência. Caso a EntityVersion do Request for diferente do atual da aplicação, apresentará um erro de concorrência. Caso seja nulo, ignorará a concorrência.

organizationId string? -

nextPage string? -

previousPage string? -

hub_fleet_management_system: VehicleDocsResponse

Fields

entityVersion string? - Versão da entidade, utilizada para processos de concorrência. Caso a EntityVersion do Request for diferente do atual da aplicação, apresentará um erro de concorrência. Caso seja nulo, ignorará a concorrência.

vehicleDocs DocsVehicle_RootObject_Return? -

vehicleByPlateDocs DocsVehicleByPlate_RootObject_Return? -

hub_fleet_management_system: VehicleDocsSaveRequest

Fields

plate string -

renavam string -

chassi string? -

state string? -

cpfCnpj string? -

Import

import easycarros/hub_fleet_management_system;

Metadata

Released date: about 1 year ago

Version: 1.0.0-alpha

Compatibility

Platform: any

Ballerina version: 2201.3.1

GraalVM compatible: Yes

Pull count

Total: 0

Current verison: 0

Weekly downloads

Other versions

1.0.0-alpha

Dependencies

ballerina/url/2.2.3 ballerina/constraint/1.0.2 ballerina/http/2.5.3

Cookie policy

Delete policy

clients

records

easycarros/hub_fleet_management_system

Module Overview

Clients

hub_fleet_management_system: Client

Constructor

login

Parameters

Return Type

logincrossauth

Parameters

Return Type

driverdocs

Return Type

driver

Parameters

Return Type

driverstatus

Parameters

Return Type

organization

Parameters

Return Type

driverdocscreate

Parameters

Return Type

trafficticket

Parameters

Return Type

plate

Parameters

Return Type

externalid

Parameters

Return Type

user

Parameters

Return Type

companygroup

Parameters

Return Type

vehicle

Parameters

Return Type

vehicleplate

Parameters

Return Type

vehiclecreate

Parameters

Return Type

vehiclestatus

Parameters

Return Type

Records

hub_fleet_management_system: AccountCompany

Fields

hub_fleet_management_system: AccountLoginRequest

Fields

hub_fleet_management_system: AccountLoginResponse

Fields

hub_fleet_management_system: ClientHttp1Settings

Fields

hub_fleet_management_system: ConnectionConfig

Fields

hub_fleet_management_system: DocsDriverByDriversLicenseRequest

Fields

hub_fleet_management_system: DocsDriverGetAllRequest

Fields

hub_fleet_management_system: DocsDriverOnOffRequest

Fields

hub_fleet_management_system: DocsDriverPostV2Request

Fields

hub_fleet_management_system: DocsVehicle_Capacity_Response

Fields

hub_fleet_management_system: DocsVehicle_Datum_Response

Fields

hub_fleet_management_system: DocsVehicle_Engine_Response

Fields

hub_fleet_management_system: DocsVehicle_LatestUpdate_Response