Siigo_api_test NPM

siigo_alliances_api

SiigoAlliancesApi - JavaScript client for siigo_alliances_api No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) This SDK is automatically generated by the OpenAPI Generator project:

API version: V1
Package version: V1
Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

Installation

Using Node.js

npm install siigo_alliances_api --save

Getting Started

Initialization, add only one time in your project setup

With this configuration, the SDK will establish communication with the Siigo APIs, internally it is in charge of obtaining the access token for the calls to the APIs

import * as SiigoAlliancesApi from 'siigo_alliances_api';

// initial configuration for the SDK  
SiigoAlliancesApi.initialize({
  basePath: "The base URL for call APIs", // https://services.siigo.com/alliances/api
  urlSignIn: "The full url sign-in",       // https://services.siigo.com/alliances/api/siigoapi-users/v1/sign-in
  userName: "The user name to sign-in",   // testname
  accessKey: "The access key to sign-in", // euy3423uykwjehqwuywj
});

Example of use

- calls with promises

import * as SiigoAlliancesApi from 'siigo_alliances_api';

let apiInstance = new SiigoAlliancesApi.AlliancesApi();
let opts = {
  'eSiigoCloudTenantCode': "eSiigoCloudTenantCode_example", // String | 
  'NIT': "NIT_example" // String | 
};

apiInstance.apiAcceptedGet(opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

- calls with async await

import * as SiigoAlliancesApi from 'siigo_alliances_api';


async function main(){
  try {
    let apiInstance = new SiigoAlliancesApi.AlliancesApi();
    let opts = {
    'eSiigoCloudTenantCode': "eSiigoCloudTenantCode_example", // String | 
    'NIT': "NIT_example" // String | 
    };
    const data = await apiInstance.apiAcceptedGet(opts);
    console.log('API called successfully. Returned data: ' + data);
  } catch (error) {
    console.error(error);
  }
}

Documentation for API Endpoints

Class	Method	HTTP request	Description
SiigoAlliancesApi.AlliancesApi	apiAcceptedGet	GET /api/accepted	Get the Alliances' state of acceptance for a company
SiigoAlliancesApi.AlliancesApi	apiAccessKeyPost	POST /api/access-key	Generates credentials for an alliance
SiigoAlliancesApi.AlliancesApi	apiAlliancesDetailsAllianceIdGet	GET /api/alliances/details/{allianceId}	Get the Alliance with more information
SiigoAlliancesApi.AlliancesApi	apiAlliancesGet	GET /api/alliances	Get the Alliances List
SiigoAlliancesApi.AlliancesApi	apiApprovedGet	GET /api/approved	Get the Alliances' state of approved for a company that do not have PT
SiigoAlliancesApi.CompanyApi	apiCompaniesGet	GET /api/companies	Get the list of companies that have accepted agreements
SiigoAlliancesApi.ContactsApi	apiContactsGet	GET /api/contacts	Returns the contact details of the companies that have accepted an alliance
SiigoAlliancesApi.FinancialInformationApi	apiFinancialInformationGet	GET /api/financial-information
SiigoAlliancesApi.FinancialInformationApi	apiUpdateFinancialInformationPut	PUT /api/update-financial-information
SiigoAlliancesApi.HistoryApi	apiHistoryAllianceIdGet	GET /api/history/{allianceId}	Get last History by AllianceId
SiigoAlliancesApi.HistoryApi	apiHistoryPost	POST /api/history	Register a History record for the AllianceID
SiigoAlliancesApi.HistoryApi	apiRevokePost	POST /api/revoke	Register a Revoke record for the AllianceID
SiigoAlliancesApi.SegmentationApi	apiSegmentPost	POST /api/segment	Register a list of clients allowed for an alliance
SiigoAlliancesApi.TermsApi	apiTermsAllianceIdGet	GET /api/terms/{allianceId}	Get last Terms by AllianceId
SiigoAlliancesApi.TermsApi	apiUnauthorizedTermsPost	POST /api/unauthorized_terms	Unauthorized the terms
SiigoAlliancesApi.TokenApi	apiAuthPost	POST /api/auth	Returns a token valid for alliances