npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@gemini-commerce/js-client-product-configurator

v1.0.0

Published

## Introduction This comprehensive guide will equip you with the knowledge to integrate and leverage our Product Configurator Service in your applications. ## Quick Start Get up and running in no time! Follow these steps to kickstart your integration:

Downloads

3

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Maintainers

fabiomancinfabiomancinmarcatosmarcatos

Keywords

Readme

@gemini-commerce/js-client-product-configurator

GeminiCommerceJsClientProductConfigurator - JavaScript client for @gemini-commerce/js-client-product-configurator

Introduction

This comprehensive guide will equip you with the knowledge to integrate and leverage our Product Configurator Service in your applications.

Quick Start

Get up and running in no time! Follow these steps to kickstart your integration:

  1. Authentication: Obtain your integration JWT to authenticate your requests.
  2. Client Libraries: Explore our GitHub repositories to grab client libraries in your preferred programming language.
  3. API Overview: Familiarize yourself with our RESTful API using the OpenAPI specification.

Integration

API Overview

Our RESTful API is the gateway to unlocking the full potential of Product Configurator. Check out the detailed API Reference for a granular understanding of each endpoint and request/response format.

Client Libraries

To expedite your integration process, we provide client libraries for various programming languages. Find the one that suits your stack in our GitHub repositories.

Authentication

Security is paramount. Learn how to authenticate your requests using JWT. This ensures a secure and reliable connection between your application and Product Configurator.

Configuration Management

Configurator Lifecycle

Understand the lifecycle of configurators, from draft to active and deleted. This flexibility allows you to manage configurations at your own pace.

Steps and Options

Configure product steps with ease and define options effortlessly. Explore the power of dependencies to create dynamic and intuitive configurations.

Matrices

Delve into matrices—your secret weapon. Explore price and weight matrices, and learn how configured steps influence properties and pricing.

Price Management

Unleash dynamic pricing with our versatile price matrices. From fixed prices to incremental structures, adapt to diverse pricing models effortlessly.

Security

Your data is in safe hands. Discover how Product Configurator ensures security through JWT authentication, safeguarding your sensitive information.

Backward Compatibility

Stay ahead of the curve. Learn about our versioning strategy, providing backward compatibility while allowing our service to evolve seamlessly.

Developer Support

Have questions? Need assistance? Write to us at [email protected] and we will get back to you. This SDK is automatically generated by the OpenAPI Generator project:

  • API version: 1.0.0
  • Package version: 1.0.0
  • Build package: org.openapitools.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 @gemini-commerce/js-client-product-configurator --save

Finally, you need to build the module:

npm run build
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

To use the link you just defined in your project, switch to the directory you want to use your @gemini-commerce/js-client-product-configurator from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/gemini-commerce/js-client-product-configurator then install it via:

    npm install gemini-commerce/js-client-product-configurator --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 GeminiCommerceJsClientProductConfigurator = require('@gemini-commerce/js-client-product-configurator');

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

var api = new GeminiCommerceJsClientProductConfigurator.ConfigurationApi()
var tenantId = "tenantId_example"; // {String} 
var productId = "productId_example"; // {String} 
var opts = {
  'configuratorId': "configuratorId_example" // {String} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.productConfiguratorGetAvailableConfiguration(tenantId, productId, opts, callback);

Documentation for API Endpoints

All URIs are relative to https://product-configurator.api.gogemini.io

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- GeminiCommerceJsClientProductConfigurator.ConfigurationApi | productConfiguratorGetAvailableConfiguration | GET /v1/{tenantId}/product/{productId}/configuration | Get Available Configuration GeminiCommerceJsClientProductConfigurator.ConfigurationApi | productConfiguratorGetAvailableConfiguration2 | POST /v1/{tenantId}/product/{productId}/configuration | Get Available Configuration GeminiCommerceJsClientProductConfigurator.ConfigurationApi | productConfiguratorGetConfigurationFromSelections | POST /v1/{tenantId}/product/{productId}/configuration-from-selections | Get Configuration from Selections GeminiCommerceJsClientProductConfigurator.ConfiguratorApi | productConfiguratorCopyConfigurator | POST /v1/{tenantId}/product/{sourceConfiguratorId}/copy | Copy Configurator GeminiCommerceJsClientProductConfigurator.ConfiguratorApi | productConfiguratorCreateConfigurator | POST /v1/{tenantId}/product/{productId}/create | Create Configurator GeminiCommerceJsClientProductConfigurator.ConfiguratorApi | productConfiguratorDeleteConfigurator | DELETE /v1/{tenantId}/configurator/{configuratorId} | Delete Configurator GeminiCommerceJsClientProductConfigurator.ConfiguratorApi | productConfiguratorGetConfiguratorByProductId | GET /v1/{tenantId}/product/{productId} | Get Product Configurator by Product ID GeminiCommerceJsClientProductConfigurator.ConfiguratorApi | productConfiguratorGetConfiguratorByProductId2 | GET /v1/{tenantId}/product/{productId}/status/{status} | Get Product Configurator by Product ID GeminiCommerceJsClientProductConfigurator.ConfiguratorApi | productConfiguratorListConfigurators | POST /v1/{tenantId}/product/{productId}/page-size/{pageSize}/configurators | List Product Configurators GeminiCommerceJsClientProductConfigurator.ConfiguratorApi | productConfiguratorUpdateConfigurator | PUT /v1/{tenantId}/configurator/{configuratorId} | Update Configurator GeminiCommerceJsClientProductConfigurator.DependencyApi | productConfiguratorCreateDependency | POST /v1/{tenantId}/step/{stepId}/dependency/create | Create Dependency GeminiCommerceJsClientProductConfigurator.DependencyApi | productConfiguratorDeleteDependency | DELETE /v1/{tenantId}/dependency/{dependencyId} | Delete Dependency GeminiCommerceJsClientProductConfigurator.DependencyApi | productConfiguratorListDependencies | POST /v1/{tenantId}/page-size/{pageSize}/dependencies | List Dependencies GeminiCommerceJsClientProductConfigurator.DependencyApi | productConfiguratorUpdateDependency | PUT /v1/{tenantId}/dependency/{dependencyId} | Update Dependency GeminiCommerceJsClientProductConfigurator.MatrixApi | productConfiguratorCreateMatrix | POST /v1/{tenantId}/matrix/create | Create Matrix GeminiCommerceJsClientProductConfigurator.MatrixApi | productConfiguratorDeleteMatrix | DELETE /v1/{tenantId}/matrix/{matrixId} | Delete Matrix GeminiCommerceJsClientProductConfigurator.MatrixApi | productConfiguratorGetMatrix | GET /v1/{tenantId}/matrix/{matrixId} | Get Matrix GeminiCommerceJsClientProductConfigurator.MatrixApi | productConfiguratorListMatrices | POST /v1/{tenantId}/configurator/{configuratorId}/page-size/{pageSize}/matrices | List Matrices GeminiCommerceJsClientProductConfigurator.MatrixApi | productConfiguratorRemovePricelistFromMatrix | DELETE /v1/{tenantId}/matrix/{matrixId}/pricelist/{pricelistGrn} | Remove Pricelist from Matrix GeminiCommerceJsClientProductConfigurator.MatrixApi | productConfiguratorUpdateMatrix | PUT /v1/{tenantId}/matrix/{matrixId} | Update Matrix GeminiCommerceJsClientProductConfigurator.OptionApi | productConfiguratorBulkCreateOptions | POST /v1/{tenantId}/step/{stepId}/option/create/bulk | Bulk Create Options GeminiCommerceJsClientProductConfigurator.OptionApi | productConfiguratorBulkDeleteOptions | POST /v1/{tenantId}/option/delete/bulk | Bulk Delete Options GeminiCommerceJsClientProductConfigurator.OptionApi | productConfiguratorBulkUpdateOptions | PUT /v1/{tenantId}/option/bulk | Bulk Update Options GeminiCommerceJsClientProductConfigurator.OptionApi | productConfiguratorCopyOption | POST /v1/{tenantId}/option/{sourceOptionId}/copy | Copy Option GeminiCommerceJsClientProductConfigurator.OptionApi | productConfiguratorCreateOption | POST /v1/{tenantId}/step/{stepId}/option/create | Create Option GeminiCommerceJsClientProductConfigurator.OptionApi | productConfiguratorDeleteOption | DELETE /v1/{tenantId}/option/{optionId} | Delete Option GeminiCommerceJsClientProductConfigurator.OptionApi | productConfiguratorListOptions | POST /v1/{tenantId}/step/{stepId}/page-size/{pageSize}/options | List Options GeminiCommerceJsClientProductConfigurator.OptionApi | productConfiguratorUpdateOption | PUT /v1/{tenantId}/option/{optionId} | Update Option GeminiCommerceJsClientProductConfigurator.PropertyApi | productConfiguratorBulkCreateProperties | POST /v1/{tenantId}/property/create/bulk | Bulk Create Properties GeminiCommerceJsClientProductConfigurator.PropertyApi | productConfiguratorBulkUpdateProperties | PUT /v1/{tenantId}/properties/bulk | Bulk Update Properties GeminiCommerceJsClientProductConfigurator.PropertyApi | productConfiguratorCreateProperty | POST /v1/{tenantId}/property/create | Create Property GeminiCommerceJsClientProductConfigurator.PropertyApi | productConfiguratorListProperties | POST /v1/{tenantId}/matrix/{matrixId}/page-size/{pageSize}/properties | List Properties GeminiCommerceJsClientProductConfigurator.PropertyApi | productConfiguratorUpdateProperty | PUT /v1/{tenantId}/property/{propertyId} | Update Property GeminiCommerceJsClientProductConfigurator.StepApi | productConfiguratorBulkCreateSteps | POST /v1/{tenantId}/configurator/{configuratorId}/step/create/bulk | Bulk Create Steps GeminiCommerceJsClientProductConfigurator.StepApi | productConfiguratorBulkDeleteSteps | POST /v1/{tenantId}/step/delete/bulk | Bulk Delete Steps GeminiCommerceJsClientProductConfigurator.StepApi | productConfiguratorCopyStep | POST /v1/{tenantId}/step/{sourceStepId}/copy | Copy Step GeminiCommerceJsClientProductConfigurator.StepApi | productConfiguratorCreateStep | POST /v1/{tenantId}/configurator/{configuratorId}/step/create | Create Step GeminiCommerceJsClientProductConfigurator.StepApi | productConfiguratorDeleteStep | DELETE /v1/{tenantId}/step/{stepId} | Delete Step GeminiCommerceJsClientProductConfigurator.StepApi | productConfiguratorUpdateStep | PUT /v1/{tenantId}/step/{stepId} | Update Step

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

standardAuthorization

  • Type: OAuth
  • Flow: implicit
  • Authorization URL: https://iambackoffice.gogemini.io/iambackoffice.IamBackoffice/Login
  • Scopes: N/A