billingprofiles_javascript_sdk

BillingprofilesJavascriptSdk - JavaScript client for billingprofiles_javascript_sdk No descripton provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) This SDK is automatically generated by the Swagger Codegen project:

API version: 1.0
Package version: 1.0.20
Build date: 2017-04-19T14:23:40.207+02:00
Build package: class io.swagger.codegen.languages.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 billingprofiles_javascript_sdk --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.

Getting Started

Please follow the installation instruction and execute the following JS code:

var BillingprofilesJavascriptSdk = require('billingprofiles_javascript_sdk');

var defaultClient = BillingprofilesJavascriptSdk.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth_2_0_client_credentials
var oauth_2_0_client_credentials = defaultClient.authentications['oauth_2_0_client_credentials'];
oauth_2_0_client_credentials.accessToken = "YOUR ACCESS TOKEN"

var api = new BillingprofilesJavascriptSdk.DefaultApi()

var bestForPayment = true; // {Boolean} Determines whether to return only the identified best billing profile of the provided customer identifier. The best billing profile is always eligible for use with the Payments API and is owned by the customer specified. Currently, only the value \"true\" is supported. 

var sCSVersion = "sCSVersion_example"; // {String} The version of the API, value must be \"**<<SCS-Version>>**\".  This header indicates which version of the API should serve the request. If the value of the header is missing or it indicates a wrong version, the API returns an error message. 

var opts = { 
  'customerId': 3.4, // {Number} The Swisscom customer identifier that uniquely identifies a customer. Performing the request with this query parameter returns the list of billing profiles owned by the Swisscom customer identifier provided. It is mandatory when using the client credentials grant. 
  'sCSRequestID': "sCSRequestID_example" // {String} The request ID.  It is used by the API to trace the fulfillment of a request. The API user may provide its own request ID or can accept the request ID generated by the API. In both cases the request ID is returned in the header of the response.  This ID should be refered by the API users in their communication with Swisscom whenever requesting details about the execution of a request. 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.gETBillingprofiles(bestForPayment, sCSVersion, opts, callback);

Documentation for API Endpoints

All URIs are relative to https://api.swisscom.com/

Class	Method	HTTP request
BillingprofilesJavascriptSdk.DefaultApi	gETBillingprofiles	GET /billingprofiles
BillingprofilesJavascriptSdk.DefaultApi	gETBillingprofilesBillingProfileId	GET /billingprofiles/{billingProfileId}
BillingprofilesJavascriptSdk.DefaultApi	gETBillingprofilesBillingProfileIdEligibility	GET /billingprofiles/{billingProfileId}/eligibility

Documentation for Models

Documentation for Authorization

oauth_2_0_authorization_code

Type: OAuth
Flow: accessCode
Authorization URL: https://consent.swisscom.com/c/oauth2/auth
Scopes:
- read-payment: Allows reading payments.
- write-payment: Allows writing payments.
- cbt: Allows placing charges on a Swisscom bill.
- read-billingprofile-details: Allows reading billing profiles details.
- read-billingprofile-eligibility: Allows checking whether a billing profile is eligible for payment.

oauth_2_0_client_credentials

Type: OAuth
Flow: application
Authorization URL:
Scopes: N/A