Newline Proliferating Maniac

    apm_terminals

    1.0.7 • Public • Published

    apm_terminals

    ApmTerminals - JavaScript client for apm_terminals No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) This SDK is automatically generated by the Swagger Codegen project:

    • API version: 1.0.0
    • Package version: 1.0.0
    • Build package: io.swagger.codegen.v3.generators.javascript.JavaScriptClientCodegen

    Installation

    For Node.js

    npm

    To publish the library as a npm, please follow the procedure in "Publishing npm packages".

    Then install it via:

    npm install apm_terminals --save

    git

    If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

        npm install GIT_USER_ID/GIT_REPO_ID --save

    For browser

    The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

    browserify main.js > bundle.js

    Then include bundle.js in the HTML pages.

    Webpack Configuration

    Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

    module: {
      rules: [
        {
          parser: {
            amd: false
          }
        }
      ]
    }

    Getting Started

    Please follow the installation instruction and execute the following JS code:

    var ApmTerminals = require('apm_terminals');
    var defaultClient = ApmTerminals.ApiClient.instance;
    
    
    var api = new ApmTerminals.ArrivalsApi()
    var callback = function(error, data, response) {
      if (error) {
        console.error(error);
      } else {
        console.log('API called successfully. Returned data: ' + data);
      }
    };
    api.getBarges(callback);

    Documentation for API Endpoints

    All URIs are relative to https://apps.apm-terminals.com.ar/CGCApp/v1

    Class Method HTTP request Description
    ApmTerminals.ArrivalsApi getBarges GET /barges Get barges arrivals
    ApmTerminals.ArrivalsApi getVessels GET /vessels Get vessels
    ApmTerminals.ContainersApi getContainersInfo GET /containers/{entity}/{tracking_number} get containers info for a tracking number
    ApmTerminals.DevicesApi registerDevice POST /auth/register Register device to send notifications
    ApmTerminals.DocumentsApi getContainerDocument GET /documents/{document_type}/{tracking_number} get container VGM or GatePass document
    ApmTerminals.EventsApi registerEvent POST /events Register an event in api terminals
    ApmTerminals.NewsApi getNews GET /news Get new news
    ApmTerminals.NotificationsApi getUserNotifications GET /users/me/notifications Get user notifications
    ApmTerminals.NotificationsApi readNotification PATCH /users/me/notifications/{id} Mark as read a notification
    ApmTerminals.ParkingApi getTruckParkingStatus GET /parking/{container_id} get truck parking status for a container
    ApmTerminals.PermissionsApi getPermissions GET /permissions/{track_id} get status container or truck
    ApmTerminals.SubscriptionsApi subscriptionEvent POST /users/me/subscriptions Subscription to recieve a notifications
    ApmTerminals.SubscriptionsApi unSubscriptionEvent POST /users/me/unsubscriptions Subscription to recieve a notifications

    Documentation for Models

    Documentation for Authorization

    ApiKeyAuth

    • Type: API key
    • API key parameter name: X-API-KEY
    • Location: HTTP header

    bearerAuth

    Keywords

    none

    Install

    npm i apm_terminals

    DownloadsWeekly Downloads

    3

    Version

    1.0.7

    License

    MIT

    Unpacked Size

    414 kB

    Total Files

    83

    Last publish

    Collaborators

    • rperezmidas