1.0.1 • Published 3 years ago

sandboxapi v1.0.1

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

b2_c_commerce_developer_sandbox_rest_api

B2CCommerceDeveloperSandboxRestApi - JavaScript client for b2_c_commerce_developer_sandbox_rest_api B2C Commerce provides a REST API to manage developer sandboxes. The API allows you to create, manage, and delete developer sandboxes. This SDK is automatically generated by the Swagger Codegen project:

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 b2_c_commerce_developer_sandbox_rest_api --save
Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

Finally, switch to the directory you want to use your b2_c_commerce_developer_sandbox_rest_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('b2_c_commerce_developer_sandbox_rest_api') in javascript files from the directory you ran the last command above from.

git

If the library is hosted at a git repository, e.g. https://github.com/YOUR_USERNAME/b2_c_commerce_developer_sandbox_rest_api then install it via:

    npm install YOUR_USERNAME/b2_c_commerce_developer_sandbox_rest_api --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, that's to say your javascript file where you actually use this library):

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 B2CCommerceDeveloperSandboxRestApi = require('b2_c_commerce_developer_sandbox_rest_api');

var defaultClient = B2CCommerceDeveloperSandboxRestApi.ApiClient.instance;

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

var api = new B2CCommerceDeveloperSandboxRestApi.CommonApi()

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

Documentation for API Endpoints

All URIs are relative to https://localhost/api/v1

ClassMethodHTTP requestDescription
B2CCommerceDeveloperSandboxRestApi.CommonApimeGetGET /meRetrieve user information.
B2CCommerceDeveloperSandboxRestApi.CommonApirootGetGET /Retrieve API information.
B2CCommerceDeveloperSandboxRestApi.CommonApisystemGetGET /systemRetrieve system information
B2CCommerceDeveloperSandboxRestApi.RealmsApirealmsRealmConfigurationGetGET /realms/{realm}/configurationShow realm configuration.
B2CCommerceDeveloperSandboxRestApi.RealmsApirealmsRealmConfigurationPatchPATCH /realms/{realm}/configurationUpdate realm configuration.
B2CCommerceDeveloperSandboxRestApi.RealmsApirealmsRealmGetGET /realms/{realm}Show realm information.
B2CCommerceDeveloperSandboxRestApi.RealmsApirealmsRealmUsageGetGET /realms/{realm}/usageShow usage information for realm.
B2CCommerceDeveloperSandboxRestApi.SandboxesApisandboxesGetGET /sandboxesList sandboxes.
B2CCommerceDeveloperSandboxRestApi.SandboxesApisandboxesPostPOST /sandboxesCreate sandbox.
B2CCommerceDeveloperSandboxRestApi.SandboxesApisandboxesSandboxIdAliasesGetGET /sandboxes/{sandboxId}/aliasesRead all sandbox aliases
B2CCommerceDeveloperSandboxRestApi.SandboxesApisandboxesSandboxIdAliasesPostPOST /sandboxes/{sandboxId}/aliasesCreate sandbox alias.
B2CCommerceDeveloperSandboxRestApi.SandboxesApisandboxesSandboxIdAliasesSandboxAliasIdDeleteDELETE /sandboxes/{sandboxId}/aliases/{sandboxAliasId}Delete Alias configuration
B2CCommerceDeveloperSandboxRestApi.SandboxesApisandboxesSandboxIdAliasesSandboxAliasIdGetGET /sandboxes/{sandboxId}/aliases/{sandboxAliasId}Read Alias configuration
B2CCommerceDeveloperSandboxRestApi.SandboxesApisandboxesSandboxIdDeleteDELETE /sandboxes/{sandboxId}Delete sandbox.
B2CCommerceDeveloperSandboxRestApi.SandboxesApisandboxesSandboxIdGetGET /sandboxes/{sandboxId}Retrieve sandbox information.
B2CCommerceDeveloperSandboxRestApi.SandboxesApisandboxesSandboxIdOperationsGetGET /sandboxes/{sandboxId}/operationsList sandbox operations.
B2CCommerceDeveloperSandboxRestApi.SandboxesApisandboxesSandboxIdOperationsOperationIdGetGET /sandboxes/{sandboxId}/operations/{operationId}Retrieve sandbox operation.
B2CCommerceDeveloperSandboxRestApi.SandboxesApisandboxesSandboxIdOperationsPostPOST /sandboxes/{sandboxId}/operationsRun sandbox operation.
B2CCommerceDeveloperSandboxRestApi.SandboxesApisandboxesSandboxIdPatchPATCH /sandboxes/{sandboxId}Update sandbox.
B2CCommerceDeveloperSandboxRestApi.SandboxesApisandboxesSandboxIdSettingsGetGET /sandboxes/{sandboxId}/settingsShow sandbox settings.
B2CCommerceDeveloperSandboxRestApi.SandboxesApisandboxesSandboxIdStorageGetGET /sandboxes/{sandboxId}/storageShow sandbox storage
B2CCommerceDeveloperSandboxRestApi.SandboxesApisandboxesSandboxIdUsageGetGET /sandboxes/{sandboxId}/usageShow sandbox usage.

Documentation for Models

Documentation for Authorization

AccountManager

superagentquerystring
@infinitebrahmanuniverse/nolb-sand@everything-registry/sub-chunk-2707
1.0.1

3 years ago