1.0.0 • Published 2 years ago

distributor_ppu_service_yoomobile v1.0.0

Weekly downloads
-
License
Unlicense
Repository
-
Last release
2 years ago

distributor_ppu_service

DistributorPpuService - JavaScript client for distributor_ppu_service © KnowRoaming LTD 2017 This SDK is automatically generated by the Swagger Codegen project:

  • API version: v1.0.0
  • Package version: v1.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 distributor_ppu_service --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 DistributorPpuService = require('distributor_ppu_service');

var api = new DistributorPpuService.AuthorizationApi()
var distributorId = 56; // {Number} The ID of the Distributor to check the authorization
var opts = { 
  'requestId': "requestId_example" // {String} It will be returned in the response header, the purpose of the RequestId to provide a reference ID to the client side developer if one is using a asynchronous system
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDistributorAuthorization(distributorId, opts, callback);

Documentation for API Endpoints

All URIs are relative to /ds/u/distributorPPUService/v1

ClassMethodHTTP requestDescription
DistributorPpuService.AuthorizationApigetDistributorAuthorizationGET /authorization/distributor/{distributorId}Returns the permissions the logged in user has on the Distributor
DistributorPpuService.AuthorizationApigetGroupAuthorizationGET /authorization/group/{groupId}Returns the permissions the logged in user has on the Group
DistributorPpuService.AuthorizationApigetIccidAuthorizationGET /authorization/iccid/{iccid}Returns the permissions the logged in user has on the ICCID
DistributorPpuService.AuthorizationApigetInventoryAuthorizationGET /authorization/inventory/{inventoryId}Returns the permissions the logged in user has on the Inventory
DistributorPpuService.AuthorizationApigetPackageAuthorizationGET /authorization/package/{packageId}Returns the permissions the logged in user has on the Package
DistributorPpuService.AuthorizationApigetPackageTemplateAuthorizationGET /authorization/packageTemplate/{packageTemplateId}Returns the permissions the logged in user has on the Package Template
DistributorPpuService.AuthorizationApigetSponsoredImsiAuthorizationGET /authorization/networkSubscriber/{sponsoredImsi}Returns the permissions the logged in user has on the Sponsored IMSI
DistributorPpuService.AuthorizationApigetWhitelistAuthorizationGET /authorization/whitelist/{whitelistId}Returns the permissions the logged in user has on the Whitelist
DistributorPpuService.CompanyTopUpApigetPaymentGET /{distributorId}/payments/{paymentId}Get a Payment
DistributorPpuService.CountryApigetCountriesGET /countryGet the list of Countries
DistributorPpuService.DataSessionsServiceApigetOpenedDataSessionGET /openDataSessionsGet opened data session
DistributorPpuService.DistributorApicreateInventoryPOST /{distributorId}/distributor/{id}/inventoriesCreates Inventory under a child Distributor
DistributorPpuService.DistributorApigetDistributorGET /{distributorId}/distributor/{id}Returns the Distributor by Distributor Id
DistributorPpuService.DistributorApigetDistributorsGET /{distributorId}/distributorReturns the list of Distributors that are accessible to the user performing the request
DistributorPpuService.DistributorApigetInventoriesGET /{distributorId}/distributor/{id}/inventoriesRetrieve Inventories
DistributorPpuService.DistributorApigetSimHistoryGET /{distributorId}/distributor/{id}/sim-historyFetch SIM history of a given distributor
DistributorPpuService.DistributorApiprovisionDistributorPOST /{distributorId}/distributorProvision a new distributor
DistributorPpuService.DistributorApiupdateDistributorStatusPUT /{distributorId}/distributor/{id}/statusUpdate the Distributor's status
DistributorPpuService.GroupApiadjustGroupBalancePOST /{distributorId}/group/{groupId}/adjustBalanceModify the balance of a group
DistributorPpuService.GroupApicreateGroupSubgroupPOST /{distributorId}/group/{groupId}/subGroupCreate a sub-group
DistributorPpuService.GroupApideleteGroupDELETE /{distributorId}/group/{groupId}Delete a group
DistributorPpuService.GroupApigetALegDataEntriesGET /{distributorId}/group/{groupId}/dataalegratesGet a list of A Leg rates for a given Group for Data service
DistributorPpuService.GroupApigetALegSmsEntriesGET /{distributorId}/group/{groupId}/smsalegratesGet a list of A Leg rates for a given Group for SMS service
DistributorPpuService.GroupApigetALegVoiceEntriesGET /{distributorId}/group/{groupId}/voicealegratesGet a list of A Leg rates for a given Group for Voice service
DistributorPpuService.GroupApigetBLegSmsEntriesGET /{distributorId}/group/{groupId}/smsblegratesGet a list of B Leg rates for a given Group for SMS service
DistributorPpuService.GroupApigetBLegVoiceEntriesGET /{distributorId}/group/{groupId}/voiceblegratesGet a list of B Leg rates for a given Group for Voice service
DistributorPpuService.GroupApigetGroupGET /{distributorId}/group/{groupId}/infoGet a group information
DistributorPpuService.GroupApigetGroupBalanceGET /{distributorId}/group/{groupId}/balanceGet a group balance
DistributorPpuService.GroupApigetGroupDetailsGET /{distributorId}/group/{groupId}Get the details of a group
DistributorPpuService.GroupApigetGroupOverdraftGET /{distributorId}/group/{groupId}/overdraftGet the overdraft of a group
DistributorPpuService.GroupApigetGroupSimsGET /{distributorId}/group/{groupId}/simsGet SIMs owned by a group
DistributorPpuService.GroupApigetGroupSubgroupsGET /{distributorId}/group/{groupId}/subGroupsGet sub-groups owned by a group
DistributorPpuService.GroupApisetGroupOverdraftPOST /{distributorId}/group/{groupId}/overdraftSet the overdraft of a group
DistributorPpuService.GroupApisetGroupParentPOST /{distributorId}/group/{groupId}/setParentSet a group parent
DistributorPpuService.GroupApiupdateALegDataEntriesPUT /{distributorId}/group/{groupId}/dataalegratesUpdate (or create if non-existent) rate entries of A Leg for a given Group for Data service
DistributorPpuService.GroupApiupdateALegSmsEntriesPUT /{distributorId}/group/{groupId}/smsalegratesUpdate (or create if non-existent) rate entries of A Leg for a given Group for SMS service
DistributorPpuService.GroupApiupdateALegVoiceEntriesPUT /{distributorId}/group/{groupId}/voicealegratesUpdate (or create if non-existent) rate entries of A Leg for a given Group for Voice service
DistributorPpuService.IMSIApigetImsiByImsiIdGET /{distributorId}/imsis/{imsiId}Get a IMSI information
DistributorPpuService.IMSIApiupdateImsiWhiteListPOST /{distributorId}/imsis/{imsiId}/whitelistUpdate Whitelist information for IMSI
DistributorPpuService.ImsiSlotProfilesApicreateImsiSlotProfilePOST /{distributorId}/imsi-slot-profilesCreate IMSI to Slot Profile
DistributorPpuService.ImsiSlotProfilesApigetImsiSlotProfileByIdGET /{distributorId}/imsi-slot-profiles/{imsiSlotProfileId}Get IMSI to Slot Profile by ID
DistributorPpuService.InventoryApicreateInventoryGroupPOST /{distributorId}/inventory/{inventoryId}/createGroupCreate a new group under the inventory
DistributorPpuService.InventoryApicreatePackageTypePOST /{distributorId}/inventory/{inventoryId}/packageTypeCreate a package type
DistributorPpuService.InventoryApicreatePaymentPOST /{distributorId}/inventory/{inventoryId}/paymentsCreate a payment to top up the Inventory balance
DistributorPpuService.InventoryApicreateWhitelistPOST /{distributorId}/inventory/{inventoryId}/whitelistCreate a whitelist
DistributorPpuService.InventoryApigetInventoryGET /{distributorId}/inventory/{inventoryId}Get Inventory
DistributorPpuService.InventoryApigetInventoryBalanceGET /{distributorId}/inventory/{inventoryId}/balanceGet the balance of an inventory
DistributorPpuService.InventoryApigetInventoryCurrencyGET /{distributorId}/inventory/{inventoryId}/currencyGet the Inventory's currency
DistributorPpuService.InventoryApigetInventoryDataRatesGET /{distributorId}/inventory/{inventoryId}/dataratesRetrieves the Data Rates for the inventory
DistributorPpuService.InventoryApigetInventoryGroupsGET /{distributorId}/inventory/{inventoryId}/groupsGet groups owned by an inventory
DistributorPpuService.InventoryApigetInventoryOverdraftGET /{distributorId}/inventory/{inventoryId}/overdraftGet the overdraft of an inventory
DistributorPpuService.InventoryApigetInventoryPackageTypesGET /{distributorId}/inventory/{inventoryId}/packageTypesGet all package types within an inventory
DistributorPpuService.InventoryApigetInventoryRouteConfigGET /{distributorId}/inventory/{inventoryId}/routeconfigGet the Inventory's route config details
DistributorPpuService.InventoryApigetInventorySmsRatesGET /{distributorId}/inventory/{inventoryId}/smsratesRetrieves the SMS Rates for the inventory
DistributorPpuService.InventoryApigetInventoryStatusGET /{distributorId}/inventory/{inventoryId}/statusGet the Inventory's status
DistributorPpuService.InventoryApigetInventoryVoiceRatesGET /{distributorId}/inventory/{inventoryId}/voiceratesRetrieves the Voice Rates for the inventory
DistributorPpuService.InventoryApigetNetworkAccessEntriesGET /{distributorId}/inventory/{inventoryId}/networkaccessGet the Network Access entries
DistributorPpuService.InventoryApilistInventoriesGET /{distributorId}/inventory/listList inventories
DistributorPpuService.InventoryApiprovisionSimsOnInventoryPOST /{distributorId}/inventory/{inventoryId}/simsProvision SIMs under an inventory
DistributorPpuService.InventoryApiremoveSimsFromInventoryDELETE /{distributorId}/inventory/{inventoryId}/simsRemove SIMs under an inventory
DistributorPpuService.InventoryApiupdateALegDataEntriesPUT /{distributorId}/inventory/{inventoryId}/dataratesUpdate (or create if non-existent) rate entries of A Leg for a given Inventory for Data service
DistributorPpuService.InventoryApiupdateALegSmsEntriesPUT /{distributorId}/inventory/{inventoryId}/smsratesUpdate (or create if non-existent) rate entries of A Leg for a given Inventory for SMS service
DistributorPpuService.InventoryApiupdateALegVoiceEntriesPUT /{distributorId}/inventory/{inventoryId}/voiceratesUpdate (or create if non-existent) rate entries of A Leg for a given Inventory for Voice service
DistributorPpuService.InventoryApiupdateInventoryStatusPUT /{distributorId}/inventory/{inventoryId}/statusUpdate the Inventory's status
DistributorPpuService.InventoryApiupdateNetworkAccessEntriesPUT /{distributorId}/inventory/{inventoryId}/networkaccessAdd or Update the Network Access entries
DistributorPpuService.NetworkApigetNetworkMccMncPairsGET /{distributorId}/network/{networkId}/mcc-mnc-pairGet network mcc/mnc pairs
DistributorPpuService.NetworkSubscriberApisendSmsPOST /{distributorId}/networkSubscriber/{imsi}/sendSmsSend an SMS
DistributorPpuService.NetworkSubscriberApisendSmsBinaryPOST /{distributorId}/networkSubscriber/{imsi}/sendSmsBinarySend an SMS in binary
DistributorPpuService.NetworkSubscriberApisendSmsBinaryCustomPOST /{distributorId}/networkSubscriber/{imsi}/sendSmsBinaryCustomSend a binary SMS with custom SMPP and GSM SMS parameters
DistributorPpuService.PackageApigetPackageGET /{distributorId}/package/{packageId}/infoGet a package information
DistributorPpuService.PackageApisetPackageStatusPOST /{distributorId}/package/{packageId}/statusSet a package status
DistributorPpuService.PackageAutomationApicreatePackageAutomationPOST /{distributorId}/package-automationCreate a Package Automation for the logged in Distributor
DistributorPpuService.PackageAutomationApideactivatePackageAutomationDELETE /{distributorId}/package-automation/{packageAutomationId}Deactivate a Package Automation for the logged in Distributor
DistributorPpuService.PackageAutomationApigetPackageAutomationGET /{distributorId}/package-automation/{packageAutomationId}Get a Package Automation for the logged in Distributor
DistributorPpuService.PackageAutomationApigetPackageAutomationsGET /{distributorId}/package-automationGet a paginated list of Package Automations for the logged in Distributor.The results are sorted descending by ID
DistributorPpuService.PackageTypeApigetPackageTypeGET /{distributorId}/packageType/{packageTypeId}Get a package type information
DistributorPpuService.PackageTypeApiupdatePackageTypeStatusPUT /{distributorId}/packageType/{packageTypeId}/statusUpdate the PackageType status
DistributorPpuService.SIMApiadjustSimBalancePOST /{distributorId}/sim/{iccid}/adjustBalanceAdjust the balance of a SIM
DistributorPpuService.SIMApicancelSimLocationUpdatePOST /{distributorId}/sim/{iccid}/cancelLocationUpdateCancel SIM location update
DistributorPpuService.SIMApicreateSimPackagePOST /{distributorId}/sim/{iccid}/addPackageAdd a package to a SIM
DistributorPpuService.SIMApigetRoutingConfigurationGET /{distributorId}/sim/{iccid}/routingConfigurationGet the routing configuration
DistributorPpuService.SIMApigetSimGET /{distributorId}/sim/{iccid}/infoGet a SIM information
DistributorPpuService.SIMApigetSimBalanceGET /{distributorId}/sim/{iccid}/balanceGet the balance of a SIM
DistributorPpuService.SIMApigetSimBalanceDrainGET /{distributorId}/sim/{iccid}/balanceDrainGet the balance drain of a SIM
DistributorPpuService.SIMApigetSimByIccidGET /{distributorId}/sim/{iccid}Get a SIM information
DistributorPpuService.SIMApigetSimCliGET /{distributorId}/sim/{iccid}/cliGet calling line identification of a SIM
DistributorPpuService.SIMApigetSimDidsGET /{distributorId}/sim/{iccid}/didsGet DID numbers of a SIM
DistributorPpuService.SIMApigetSimOverdraftGET /{distributorId}/sim/{iccid}/overdraftGet the overdraft of a SIM
DistributorPpuService.SIMApigetSimPackagesGET /{distributorId}/sim/{iccid}/package/infosGet packages owned by a SIM
DistributorPpuService.SIMApigetSimStatusGET /{distributorId}/sim/{iccid}/statusGet the status of a SIM
DistributorPpuService.SIMApigetSimThrottleGET /{distributorId}/sim/{iccid}/throttleGet the throttle speed of a SIM
DistributorPpuService.SIMApipurgeDELETE /{distributorId}/sim/{iccid}/purgeTerminate a SIM
DistributorPpuService.SIMApisendSmsPOST /{distributorId}/sim/{iccid}/sendSmsSend an SMS
DistributorPpuService.SIMApisendSmsBinaryPOST /{distributorId}/sim/{iccid}/sendSmsBinarySend an SMS in binary
DistributorPpuService.SIMApisendSmsBinaryCustomPOST /{distributorId}/sim/{iccid}/sendSmsBinaryCustomSend a binary SMS with custom SMPP and GSM SMS parameters
DistributorPpuService.SIMApisetSimBalanceDrainPOST /{distributorId}/sim/{iccid}/balanceDrainSet the balance drain of a SIM
DistributorPpuService.SIMApisetSimOverdraftPOST /{distributorId}/sim/{iccid}/overdraftSet the overdraft of a SIM
DistributorPpuService.SIMApisetSimParentPOST /{distributorId}/sim/{iccid}/setParentSet a SIM parent
DistributorPpuService.SIMApisetSimStatusPOST /{distributorId}/sim/{iccid}/statusSet the status of a SIM
DistributorPpuService.SIMApisetSimThrottlePOST /{distributorId}/sim/{iccid}/throttleSet the throttle speed of a SIM
DistributorPpuService.SIMApiswitchProfileOTAPOST /{distributorId}/sim/{iccid}/switchProfileOTASwitch IMSI profile Over-The-Air
DistributorPpuService.SIMApiupdateRoutingConfigurationPOST /{distributorId}/sim/{iccid}/updateRoutingConfigurationUpdate the routing configuration for a sim ICCID
DistributorPpuService.SearchApisearchDataCdrGET /{distributorId}/search/cdr/dataSearch Data CDRs
DistributorPpuService.SearchApisearchDistributorsGET /{distributorId}/search/distributorSearch distributors
DistributorPpuService.SearchApisearchGroupsGET /{distributorId}/search/groupSearch Groups
DistributorPpuService.SearchApisearchImisGET /{distributorId}/search/imsisSearch IMSIs
DistributorPpuService.SearchApisearchImsiSlotProfilesGET /{distributorId}/search/imsi-slot-profilesGet IMSI Slot Profile entries
DistributorPpuService.SearchApisearchInventoriesGET /{distributorId}/search/inventorySearch inventories
DistributorPpuService.SearchApisearchLuGET /{distributorId}/search/luSearch Location Updates
DistributorPpuService.SearchApisearchPackageTypesGET /{distributorId}/search/packageTypeSearch package types
DistributorPpuService.SearchApisearchPackagesGET /{distributorId}/search/packageSearch packages
DistributorPpuService.SearchApisearchSimsGET /{distributorId}/search/simSearch SIMs
DistributorPpuService.SearchApisearchSmsCdrGET /{distributorId}/search/cdr/smsSearch SMS CDRs
DistributorPpuService.SearchApisearchTrafficPoliciesGET /{distributorId}/search/trafficPolicySearch traffic policies
DistributorPpuService.SearchApisearchVoiceCdrGET /{distributorId}/search/cdr/voiceSearch Voice CDRs
DistributorPpuService.SearchApisearchWhitelistEntriesGET /{distributorId}/search/whitelistEntryGet whitelist entries
DistributorPpuService.SearchApisearchWhitelistsGET /{distributorId}/search/whitelistSearch whitelists
DistributorPpuService.SimNotificationApicreateSimNotificationPOST /{userDistributorId}/sim-notificationCreate a Sim Notification entity
DistributorPpuService.SimNotificationApigetSimNotificationGET /{userDistributorId}/sim-notification/{id}Get a single Sim Notification
DistributorPpuService.SimNotificationApigetSimNotificationsGET /{userDistributorId}/sim-notificationGet a list of Sim Notifications
DistributorPpuService.SimNotificationApiupdateSimNotificationPUT /{userDistributorId}/sim-notification/{id}Update a Sim Notification entity
DistributorPpuService.TrafficPolicyApigetTrafficPolicyGET /{distributorId}/trafficPolicy/{trafficPolicyId}Get a traffic policy
DistributorPpuService.WhitelistApiduplicateWhitelistPOST /{distributorId}/whitelist/{whitelistId}/duplicateDuplicate whitelist
DistributorPpuService.WhitelistApigetWhitelistByIdGET /{distributorId}/whitelist/{whitelistId}Get Whitelist details
DistributorPpuService.WhitelistApiupdateWhitelistEntriesPOST /{distributorId}/whitelist/{whitelistId}/entryUpdate whitelist entries
DistributorPpuService.WhitelistApiupdateWhitelistImsisPOST /{distributorId}/whitelist/{whitelistId}/imsisUpdate whitelist IMSIs
DistributorPpuService.WhitelistApiupdateWhitelistNamePOST /{distributorId}/whitelist/{whitelistId}/nameUpdate whitelist name
DistributorPpuService.WhitelistApiupdateWhitelistSimsPOST /{distributorId}/whitelist/{whitelistId}/simUpdate whitelist SIMs

Documentation for Models

Documentation for Authorization

APIKeyToken

  • Type: API key
  • API key parameter name: ApiKey
  • Location: HTTP header

authentication

  • Type: HTTP basic authentication
superagent
@infinitebrahmanuniverse/nolb-dist@everything-registry/sub-chunk-1488
1.0.0

2 years ago