Test-siigo-npm_qa-sdk NPM

siigo_api

SiigoApi - JavaScript client for siigo_api Siigo Api v1 This SDK is automatically generated by the OpenAPI Generator project:

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

Installation

Using Node.js

npm install siigo_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 SiigoApi from 'siigo_api';

// initial configuration for the SDK  
SiigoApi.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 SiigoApi from 'siigo_api';

let apiInstance = new SiigoApi.AccountGroupsApi();

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

- calls with async await

import * as SiigoApi from 'siigo_api';


async function main(){
  try {
    let apiInstance = new SiigoApi.AccountGroupsApi();
    const data = await apiInstance.getAccountGroups();
    console.log('API called successfully. Returned data: ' + data);
  } catch (error) {
    console.error(error);
  }
}

Documentation for API Endpoints

Class	Method	HTTP request	Description
SiigoApi.AccountGroupsApi	getAccountGroups	GET /v1/account-groups	Gets a list of AccountGroups.
SiigoApi.CostCenterApi	getCostCenters	GET /v1/cost-centers	Gets a list of Cost Centers.
SiigoApi.CreditNoteApi	createCreditNote	POST /v1/credit-notes	Creates a Credit Note.
SiigoApi.CreditNoteApi	getCreditNote	GET /v1/credit-notes/{id}	Gets a CreditNote by GUID.
SiigoApi.CreditNoteApi	getCreditNotePdf	GET /v1/credit-notes/{id}/pdf	Gets a Credit Note PDF by GUID.
SiigoApi.CreditNoteApi	getCreditNotes	GET /v1/credit-notes	Gets a list of Credit Notes with pagination.
SiigoApi.CustomerApi	createCustomer	POST /v1/customers	Creates a Customer.
SiigoApi.CustomerApi	deleteCustomer	DELETE /v1/customers/{id}	Deletes a Customer by GUID.
SiigoApi.CustomerApi	getCustomer	GET /v1/customers/{id}	Gets a Customer by GUID.
SiigoApi.CustomerApi	getCustomers	GET /v1/customers	Gets a list of Customers.
SiigoApi.CustomerApi	updateCustomer	PUT /v1/customers/{id}	Updates a Customer by GUID.
SiigoApi.DocumentTypeApi	getDocumentTypes	GET /v1/document-types	Gets a list of Document Types.
SiigoApi.FixedAssetsApi	getAssetGroups	GET /v1/asset-groups	Gets a list of fixed assets.
SiigoApi.FixedAssetsApi	getFixedAssets	GET /v1/fixed-assets	Gets a list of fixed assets.
SiigoApi.InvoiceApi	createInvoice	POST /v1/invoices	Creates an Invoice.
SiigoApi.InvoiceApi	getInvoice	GET /v1/invoices/{id}	Gets an Invoice by GUID.
SiigoApi.InvoiceApi	getInvoiceErrors	GET /v1/invoices/{id}/stamp/errors	Get errors for a rejected invoice by GUID.
SiigoApi.InvoiceApi	getInvoicePDF	GET /v1/invoices/{id}/pdf	Gets an Invoice PDF by GUID.
SiigoApi.InvoiceApi	getInvoices	GET /v1/invoices	Gets a list of Invoices with pagination.
SiigoApi.JournalEntryApi	createJournal	POST /v1/journals	Creates JournalEntry.
SiigoApi.JournalEntryApi	getJournal	GET /v1/journals/{id}	Gets a Journal by GUID.
SiigoApi.JournalEntryApi	getJournals	GET /v1/journals	Gets a list of Journals Entry with pagination.
SiigoApi.PaymentTypesApi	getPaymentTypes	GET /v1/payment-types	Get a list of Payment Types.
SiigoApi.PriceListsApi	getPriceList	GET /v1/price-lists	Get a list of Price Lists.
SiigoApi.ProductApi	createProduct	POST /v1/products	Creates a produc
SiigoApi.ProductApi	deleteProduct	DELETE /v1/products/{id}	Deletes a Product by GUID
SiigoApi.ProductApi	getProduct	GET /v1/products/{id}	Gets a Product by GUID.
SiigoApi.ProductApi	getProducts	GET /v1/products	Gets a list of Products with pagination.
SiigoApi.ProductApi	updateProduct	PUT /v1/products/{id}	Updates a Product by GUID
SiigoApi.TaxesApi	getTaxes	GET /v1/taxes	Gets a list of Taxes.
SiigoApi.UsersApi	getUsers	GET /v1/users	Gets a list of Users with pagination.
SiigoApi.VoucherApi	createVoucher	POST /v1/vouchers	Creates a Voucher.
SiigoApi.VoucherApi	getVoucher	GET /v1/vouchers/{id}	Gets a Voucher by GUID.
SiigoApi.VoucherApi	getVouchers	GET /v1/vouchers	Gets a list of Vouchers with pagination.
SiigoApi.WarehousesApi	getProductWarehouse	GET /v1/warehouses	Gets a list of Warehouses.

Documentation for Models

Documentation for Authorization

Bearer

Type: Bearer authentication

SDK SIIGO

@babel/cli superagent

@infinitebrahmanuniverse/nolb-test-s @everything-registry/sub-chunk-2918

1.0.0

2 years ago