2.1.0 • Published 4 years ago

phonespeak_client v2.1.0

Weekly downloads
-
License
Proprietary
Repository
-
Last release
4 years ago

phone_speak_api

PhoneSpeakApi - JavaScript client for phone_speak_api API Service for Internal use only This SDK is automatically generated by the Swagger Codegen project:

  • API version: 1.0
  • Package version: 1.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 phone_speak_api --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 PhoneSpeakApi = require('phone_speak_api');

var api = new PhoneSpeakApi.AccountApi()
var version = "version_example"; // {String} 
var opts = { 
  'email': "email_example", // {String} 
  'code': "code_example" // {String} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiVersionAccountConfirmationGet(version, opts, callback);

Documentation for API Endpoints

All URIs are relative to /

ClassMethodHTTP requestDescription
PhoneSpeakApi.AccountApiapiVersionAccountConfirmationGetGET /api/{version}/account/confirmation
PhoneSpeakApi.AccountApiapiVersionAccountSignupAccountPostPOST /api/{version}/account/signup/account
PhoneSpeakApi.AccountApiapiVersionAccountSignupOrdernumberPostPOST /api/{version}/account/signup/ordernumber
PhoneSpeakApi.AccountApiapiVersionAccountSignupReservenumberPostPOST /api/{version}/account/signup/reservenumber
PhoneSpeakApi.AccountApiapiVersionAccountSignupSubscriptionPostPOST /api/{version}/account/signup/subscription
PhoneSpeakApi.CSRUserApiapiVersionCsrGetGET /api/{version}/csrRetrieve current Login CSR User info
PhoneSpeakApi.CSRUserApiapiVersionCsrUserForgotpasswordPostPOST /api/{version}/csr/user/forgotpasswordForgotPassword
PhoneSpeakApi.CSRUserApiapiVersionCsrUserGetGET /api/{version}/csr/userReturns a list of active CSR User.
PhoneSpeakApi.CSRUserApiapiVersionCsrUserIdDeleteDELETE /api/{version}/csr/user/{id}Delete Csr User
PhoneSpeakApi.CSRUserApiapiVersionCsrUserIdGetGET /api/{version}/csr/user/{id}Retrieve existing CSR User account
PhoneSpeakApi.CSRUserApiapiVersionCsrUserIdProfileimagePostPOST /api/{version}/csr/user/{id}/profileimageUpload Profile Image
PhoneSpeakApi.CSRUserApiapiVersionCsrUserIdPutPUT /api/{version}/csr/user/{id}Update existing Csr User
PhoneSpeakApi.CSRUserApiapiVersionCsrUserPostPOST /api/{version}/csr/userCreate Csr User
PhoneSpeakApi.CallCreditApiapiVersionCallcreditPutPUT /api/{version}/callcreditUpdate Top up call credit
PhoneSpeakApi.CallRecordingApiapiVersionCallrecordingDeleteDELETE /api/{version}/callrecordingDelete Call Recording
PhoneSpeakApi.CallRecordingApiapiVersionCallrecordingGetGET /api/{version}/callrecordingList Call Recording
PhoneSpeakApi.CallRecordingApiapiVersionCallrecordingIdGetGET /api/{version}/callrecording/{id}Get Call Recording
PhoneSpeakApi.CallRecordingApiapiVersionCallrecordingPostPOST /api/{version}/callrecordingCreate Call Recording
PhoneSpeakApi.CompanyApiapiVersionCompanyGetGET /api/{version}/companyList Company
PhoneSpeakApi.CompanyApiapiVersionCompanyIdDeleteDELETE /api/{version}/company/{id}Delete company
PhoneSpeakApi.CompanyApiapiVersionCompanyIdGetGET /api/{version}/company/{id}Get a company detail
PhoneSpeakApi.CompanyApiapiVersionCompanyIdPutPUT /api/{version}/company/{id}Update Company
PhoneSpeakApi.CompanyApiapiVersionCompanyPostPOST /api/{version}/companyCreate Company
PhoneSpeakApi.CouponApiapiVersionCouponGetGET /api/{version}/couponList of coupon to applied that can be applied to subscriptions or invoice
PhoneSpeakApi.LocationApiapiVersionLocationGetGET /api/{version}/locationGet User State
PhoneSpeakApi.MusicOnHoldApiapiVersionMusiconholdIdDeleteDELETE /api/{version}/musiconhold/{id}Delete music on hold
PhoneSpeakApi.MusicOnHoldApiapiVersionMusiconholdPostPOST /api/{version}/musiconholdCreate music on hold
PhoneSpeakApi.MusicOnHoldApiapiVersionMusiconholdPutPUT /api/{version}/musiconholdUpdate music on hold
PhoneSpeakApi.NoteApiapiVersionNoteGetGET /api/{version}/noteList note
PhoneSpeakApi.NoteApiapiVersionNoteIdDeleteDELETE /api/{version}/note/idDelete note
PhoneSpeakApi.NoteApiapiVersionNotePostPOST /api/{version}/noteCreate note
PhoneSpeakApi.NumberApiapiVersionNumberCountryGetGET /api/{version}/number/{country}Search Number
PhoneSpeakApi.NumberApiapiVersionNumberCountryPurchasePostPOST /api/{version}/number/{country}/purchasePurchase Number
PhoneSpeakApi.NumberApiapiVersionNumberCountryReleaseNumberDeleteDELETE /api/{version}/number/{country}/release/{number}Release number
PhoneSpeakApi.NumberApiapiVersionNumberCountryReservePostPOST /api/{version}/number/{country}/reserveReserve Number
PhoneSpeakApi.PackageApiapiVersionPackageGetGET /api/{version}/packageReturns a list of your package.
PhoneSpeakApi.PackageApiapiVersionPackageIdDeleteDELETE /api/{version}/package/{id}Delete existing package.
PhoneSpeakApi.PackageApiapiVersionPackageIdGetGET /api/{version}/package/{id}Retrieves the details of an existing package.
PhoneSpeakApi.PackageApiapiVersionPackageIdPutPUT /api/{version}/package/{id}Updates the specific package.
PhoneSpeakApi.PackageApiapiVersionPackagePostPOST /api/{version}/packageCreate Package
PhoneSpeakApi.PbxApiapiVersionUserPbxDeleteDELETE /api/{version}/user/pbx(Auth policies: AdminAndCsrAdminOnlyPolicy)
PhoneSpeakApi.PbxApiapiVersionUserPbxGetGET /api/{version}/user/pbx(Auth policies: AdminAndCsrAdminOnlyPolicy)
PhoneSpeakApi.PbxApiapiVersionUserPbxPostPOST /api/{version}/user/pbx(Auth policies: AdminAndCsrAdminOnlyPolicy)
PhoneSpeakApi.PbxApiapiVersionUserPbxPutPUT /api/{version}/user/pbx(Auth policies: AdminAndCsrAdminOnlyPolicy)
PhoneSpeakApi.PhoneNumberApiapiVersionCompanyIdPhonenumberPhoneNumberIdDeleteDELETE /api/{version}/company/{id}/phonenumber/{phoneNumberId}Company Delete Phone Number of respective company
PhoneSpeakApi.PhoneNumberApiapiVersionCompanyIdPhonenumberPhoneNumberIdPutPUT /api/{version}/company/{id}/phonenumber/{phoneNumberId}Company Update Phone Number of respective company
PhoneSpeakApi.PhoneNumberApiapiVersionCompanyIdPhonenumberPostPOST /api/{version}/company/{id}/phonenumberCompany Add Phone Number to respective company
PhoneSpeakApi.PhoneNumberApiapiVersionCsrTenantIdPhonenumberGetGET /api/{version}/csr/tenant/{id}/phonenumberCSR List Phone Number
PhoneSpeakApi.PhoneNumberApiapiVersionCsrTenantIdPhonenumberPhoneNumberIdPutPUT /api/{version}/csr/tenant/{id}/phonenumber/{phoneNumberId}CSR Update Phone Number
PhoneSpeakApi.PhoneNumberApiapiVersionCsrTenantIdPhonenumberPostPOST /api/{version}/csr/tenant/{id}/phonenumberCSR Create Phone Number
PhoneSpeakApi.PhoneNumberApiapiVersionTeammateIdPhonenumberPhoneNumberIdDeleteDELETE /api/{version}/teammate/{id}/phonenumber/{phoneNumberId}Teammate Delete Phone Number of respective teammate
PhoneSpeakApi.PhoneNumberApiapiVersionTeammateIdPhonenumberPhoneNumberIdPutPUT /api/{version}/teammate/{id}/phonenumber/{phoneNumberId}Teammate Update Phone Number of respective teammate
PhoneSpeakApi.PhoneNumberApiapiVersionTeammateIdPhonenumberPostPOST /api/{version}/teammate/{id}/phonenumberTeammate Add Phone Number to respective teammate
PhoneSpeakApi.PlanApiapiVersionPlanGetGET /api/{version}/planReturns a list of plan.
PhoneSpeakApi.ProductApiapiVersionProductGetGET /api/{version}/productReturns a list of your products.
PhoneSpeakApi.ProductApiapiVersionProductIdDeleteDELETE /api/{version}/product/{id}Delete a product.
PhoneSpeakApi.ProductApiapiVersionProductIdGetGET /api/{version}/product/{id}Retrieves the details of an existing product.
PhoneSpeakApi.ProductApiapiVersionProductPutPUT /api/{version}/productUpdates the specific product.
PhoneSpeakApi.ResellerApiapiVersionResellerGetGET /api/{version}/resellerReturns a list of active Reseller.
PhoneSpeakApi.ResellerApiapiVersionResellerIdDeleteDELETE /api/{version}/reseller/{id}Delete Csr User
PhoneSpeakApi.ResellerApiapiVersionResellerIdGetGET /api/{version}/reseller/{id}Retrieve existing Reseller information
PhoneSpeakApi.ResellerApiapiVersionResellerIdPutPUT /api/{version}/reseller/{id}Update existing Reseller
PhoneSpeakApi.ResellerApiapiVersionResellerPostPOST /api/{version}/resellerCreate a new Reseller
PhoneSpeakApi.SessionApiapiVersionSessionPostPOST /api/{version}/sessionCreate session for checkout
PhoneSpeakApi.SessionApiapiVersionSessionPutPUT /api/{version}/sessioncheckout
PhoneSpeakApi.SubscriptionApiapiVersionSubscriptionIdDeleteDELETE /api/{version}/subscription/{id}Cancel existing subscription.
PhoneSpeakApi.SubscriptionApiapiVersionSubscriptionIdGetGET /api/{version}/subscription/{id}Retrieves the details of an existing subscription.
PhoneSpeakApi.SubscriptionApiapiVersionSubscriptionPostPOST /api/{version}/subscriptionCreate Subscription
PhoneSpeakApi.SubscriptionApiapiVersionSubscriptionPutPUT /api/{version}/subscriptionUpdates the specific subscription.
PhoneSpeakApi.SubscriptionItemApiapiVersionSubscriptionitemPutPUT /api/{version}/subscriptionitemUpdates the specific subscription.
PhoneSpeakApi.TeammatesApiapiVersionUserTeammatesDeleteDELETE /api/{version}/user/teammates(Auth policies: AdminAndCsrAdminOnlyPolicy)
PhoneSpeakApi.TeammatesApiapiVersionUserTeammatesGetGET /api/{version}/user/teammates(Auth policies: AdminAndCsrAdminOnlyPolicy)
PhoneSpeakApi.TeammatesApiapiVersionUserTeammatesListGetGET /api/{version}/user/teammates/list(Auth policies: AdminAndCsrAdminOnlyPolicy)
PhoneSpeakApi.TeammatesApiapiVersionUserTeammatesPostPOST /api/{version}/user/teammates(Auth policies: AdminAndCsrAdminOnlyPolicy)
PhoneSpeakApi.TeammatesApiapiVersionUserTeammatesPutPUT /api/{version}/user/teammates(Auth policies: AdminAndCsrAdminOnlyPolicy)
PhoneSpeakApi.TeamsApiapiVersionUserTeamsDeleteDELETE /api/{version}/user/teamsDelete Team
PhoneSpeakApi.TeamsApiapiVersionUserTeamsGetPostPOST /api/{version}/user/teams/getGet Team
PhoneSpeakApi.TeamsApiapiVersionUserTeamsListPostPOST /api/{version}/user/teams/listList Team
PhoneSpeakApi.TeamsApiapiVersionUserTeamsPutPUT /api/{version}/user/teamsUpdate Team
PhoneSpeakApi.TenantApiapiVersionCsrTenantGetGET /api/{version}/csr/tenantCSR Returns a list of active Tenant
PhoneSpeakApi.TenantApiapiVersionCsrTenantIdGetGET /api/{version}/csr/tenant/{id}CSR Retrieve existing Tenant
PhoneSpeakApi.TenantApiapiVersionCsrTenantIdPutPUT /api/{version}/csr/tenant/{id}CSR Update Tenant
PhoneSpeakApi.TenantApiapiVersionCsrTenantIdStatusStatusPutPUT /api/{version}/csr/tenant/{id}/status/{status}CSR Update Tenant Status
PhoneSpeakApi.TenantApiapiVersionCsrTenantPostPOST /api/{version}/csr/tenantCSR Create Tenant
PhoneSpeakApi.TenantApiapiVersionTenantGetGET /api/{version}/tenantGet Tenant
PhoneSpeakApi.TenantApiapiVersionTenantPutPUT /api/{version}/tenantUpdate Tenant
PhoneSpeakApi.UrlApiapiVersionUrlGetGET /api/{version}/urlReturns a list of your url.
PhoneSpeakApi.UrlApiapiVersionUrlIdDeleteDELETE /api/{version}/url/{id}Delete existing url.
PhoneSpeakApi.UrlApiapiVersionUrlIdGetGET /api/{version}/url/{id}Retrieves the details of an existing url.
PhoneSpeakApi.UrlApiapiVersionUrlIdPutPUT /api/{version}/url/{id}Updates the specific url.
PhoneSpeakApi.UrlApiapiVersionUrlPostPOST /api/{version}/urlCreate Url
PhoneSpeakApi.VoicemailApiapiVersionVoipVoicemailDeleteDELETE /api/{version}/voip/voicemailDelete Voicemail
PhoneSpeakApi.VoicemailApiapiVersionVoipVoicemailIdGetGET /api/{version}/voip/voicemail/{id}Get Voicemail
PhoneSpeakApi.VoicemailApiapiVersionVoipVoicemailListGetGET /api/{version}/voip/voicemail/listList Voicemail
PhoneSpeakApi.VoicemailApiapiVersionVoipVoicemailPutPUT /api/{version}/voip/voicemailUpdate Voicemail
PhoneSpeakApi.VoicemailApiapiVersionVoipVoicemailUnreadcountGetGET /api/{version}/voip/voicemail/unreadcountGet Voicemail Unread Count
PhoneSpeakApi.VoicemailGreetingApiapiVersionVoicemailgreetingDeleteDELETE /api/{version}/voicemailgreetingDelete music on hold
PhoneSpeakApi.VoicemailGreetingApiapiVersionVoicemailgreetingOwnerIdPostPOST /api/{version}/voicemailgreeting/{ownerId}Create music on hold
PhoneSpeakApi.VoicemailGreetingApiapiVersionVoicemailgreetingPutPUT /api/{version}/voicemailgreetingUpdate music on hold

Documentation for Models

Documentation for Authorization

oauth2

babelbabel-clisuperagent
2.1.0

4 years ago

2.0.0

4 years ago