@trata/[email protected]

This generator creates TypeScript/JavaScript client that utilizes axios. The generated Node module can be used in the following environments:

Environment

• Node.js
• Webpack
• Browserify

Language level

• ES5 - you must have a Promises/A+ library installed
• ES6

Module system

• CommonJS
• ES6 module system

It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via package.json. (Reference)

Building

To build and compile the typescript sources to javascript use:

npm install
npm run build

Publishing

First build the package then run npm publish

Consuming

navigate to the folder of your consuming project and run one of the following commands.

published:

npm install @trata/[email protected] --save

unPublished (not recommended):

npm install PATH_TO_GENERATED_PACKAGE --save

Documentation for API Endpoints

All URIs are relative to http://localhost

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- CallsApi | cancelCallApiV1CallCancelPost | POST /api/v1/call/cancel | Cancel Call CallsApi | getCallPricingApiV1CallPricingGet | GET /api/v1/call/pricing | Get Call Pricing CallsApi | getCallStatusApiV1CallCallIdGet | GET /api/v1/call/{call_id} | Get Call Status CallsApi | listCallsApiV1CallGet | GET /api/v1/call/ | List Calls CallsApi | startCallApiV1CallStartPost | POST /api/v1/call/start | Start Call ContactsApi | createContactApiV1ContactsPost | POST /api/v1/contacts/ | Create Contact ContactsApi | deleteContactApiV1ContactsContactIdDelete | DELETE /api/v1/contacts/{contact_id} | Delete Contact ContactsApi | getContactApiV1ContactsContactIdGet | GET /api/v1/contacts/{contact_id} | Get Contact ContactsApi | listContactsApiV1ContactsGet | GET /api/v1/contacts/ | List Contacts ContactsApi | syncContactsApiV1ContactsSyncPost | POST /api/v1/contacts/sync | Sync Contacts ContactsApi | updateContactApiV1ContactsContactIdPut | PUT /api/v1/contacts/{contact_id} | Update Contact CreditsApi | getCreditsApiV1CreditsBalanceGet | GET /api/v1/credits/balance | Get Credits CreditsApi | getCreditsHistoryApiV1CreditsHistoryGet | GET /api/v1/credits/history | Get Credits History DailyWebhooksApi | dailyWebhookApiV1WebhooksDailyPost | POST /api/v1/webhooks/daily | Daily Webhook DefaultApi | healthCheckHealthGet | GET /health | Health Check DefaultApi | rootGet | GET / | Root DefaultApi | versionsVersionsGet | GET /versions | Versions FilesApi | deleteRecordingApiV1FilesCallIdDelete | DELETE /api/v1/files/{call_id} | Delete Recording FilesApi | getRecordingApiV1FilesCallIdGet | GET /api/v1/files/{call_id} | Get Recording FilesApi | getSignedUrlApiV1FilesSignedUrlGet | GET /api/v1/files/signed-url | Get Signed Url FilesApi | uploadRecordingApiV1FilesUploadPost | POST /api/v1/files/upload | Upload Recording PaymentsApi | createPaymentIntentApiV1PaymentIntentPost | POST /api/v1/payment/intent | Create Payment Intent PaymentsApi | stripeWebhookApiV1PaymentWebhookPost | POST /api/v1/payment/webhook | Stripe Webhook PreferencesApi | getPreferencesApiV1PreferencesGet | GET /api/v1/preferences | Get Preferences PreferencesApi | updatePreferencesApiV1PreferencesPut | PUT /api/v1/preferences | Update Preferences PropelAuthWebhooksApi | propelAuthWebhookV1ApiPropelHooksPost | POST /v1/api/propel-hooks | Propel Auth Webhook WebhooksApi | telnyxWebhookApiV1WebhooksTelnyxPost | POST /api/v1/webhooks/telnyx | Telnyx Webhook WebhooksApi | testTelnyxWebhookApiV1WebhooksTelnyxTestPost | POST /api/v1/webhooks/telnyx/test | Test Telnyx Webhook WebhooksApi | twilioVoiceWebhookApiV1WebhooksTwilioVoicePost | POST /api/v1/webhooks/twilio-voice | Twilio Voice Webhook WebhooksApi | twilioWebhookApiV1WebhooksTwilioPost | POST /api/v1/webhooks/twilio | Twilio Webhook

Documentation For Models

• CallCancelRequest
• CallCancelResponse
• CallListResponse
• CallPriceResponse
• CallRecordingResponse
• CallRecordingUploadResponse
• CallStartRequest
• CallStartResponse
• CallStatus
• CallStatusResponse
• ContactCreate
• ContactListResponse
• ContactResponse
• ContactSyncRequest
• ContactSyncResponse
• ContactUpdate
• CreditsHistoryEntry
• CreditsHistoryResponse
• CreditsResponse
• HTTPValidationError
• LocationInner
• PaymentIntentRequest
• PaymentIntentResponse
• PreferencesResponse
• PreferencesUpdate
• ValidationError
• WebhookResponse

Documentation For Authorization

Authentication schemes defined for the API:

HTTPBearer

• Type: Bearer authentication