❤
npm
Sign UpSign In

commercengine
TypeScript icon, indicating that this package has built-in type declarations

0.2.0 • Public • Published

openapi

🏗 Welcome to your new SDK! 🏗

It has been generated successfully based on your OpenAPI spec. However, it is not yet ready for production use. Here are some next steps:

SDK Installation

NPM

npm add commercengine

Yarn

yarn add commercengine

SDK Example Usage

Example

import { SDK } from "commercengine";
import { Channel, TypeT } from "commercengine/dist/sdk/models/shared";

async function run() {
    const sdk = new SDK({
        authorization: "<YOUR_BEARER_TOKEN_HERE>",
    });

    const res = await sdk.analytics.getAnalyticsTrack({
        channel: Channel.Website,
        context: {
            ip: "120.241.208.40",
            userAgent: "string",
        },
        event: "string",
        messageId: "string",
        properties: {},
        sentAt: new Date("2023-04-12T14:54:43.161Z"),
        timestamp: new Date("2022-10-04T02:51:38.958Z"),
        type: TypeT.Track,
        userId: "string",
    });

    if (res.statusCode == 200) {
        // handle response
    }
}

run();

Available Resources and Operations

analytics

auth

campaignsAPI

cartsAPI

catalogAPI

checkoutAPI

commonAPI

customersAPI

couponsAndPromotionsAPI

ordersAPI

paymentsAPI

shippingAPI

Error Handling

Handling errors in this SDK should largely match your expectations. All operations return a response object or throw an error. If Error objects are specified in your OpenAPI Spec, the SDK will throw the appropriate Error type.

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

Example

import { SDK } from "commercengine";
import { Channel, TypeT } from "commercengine/dist/sdk/models/shared";

async function run() {
    const sdk = new SDK({
        authorization: "<YOUR_BEARER_TOKEN_HERE>",
    });

    let res;
    try {
        res = await sdk.analytics.getAnalyticsTrack({
            channel: Channel.Website,
            context: {
                ip: "120.241.208.40",
                userAgent: "string",
            },
            event: "string",
            messageId: "string",
            properties: {},
            sentAt: new Date("2023-04-12T14:54:43.161Z"),
            timestamp: new Date("2022-10-04T02:51:38.958Z"),
            type: TypeT.Track,
            userId: "string",
        });
    } catch (err) {
        if (err instanceof errors.SDKError) {
            console.error(err); // handle exception
            throw err;
        }
    }

    if (res.statusCode == 200) {
        // handle response
    }
}

run();

Server Selection

Select Server by Index

You can override the default server globally by passing a server index to the serverIdx: number optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:

# Server Variables
0 https://{subdomain}.commercengine.dev/api/v1/{store_id}/storefront store_id (default is x2yh61zw4k), subdomain (default is reset)
1 https://api.commercengine.app/api/v1/{store_id}/admin store_id (default is x2yh61zw4k)
2 https://stoplight.io/mocks/tarkaikaman/ce-apis/217963442 None

Example

import { SDK } from "commercengine";
import { Channel, TypeT } from "commercengine/dist/sdk/models/shared";

async function run() {
    const sdk = new SDK({
        serverIdx: 2,
        authorization: "<YOUR_BEARER_TOKEN_HERE>",
    });

    const res = await sdk.analytics.getAnalyticsTrack({
        channel: Channel.Website,
        context: {
            ip: "120.241.208.40",
            userAgent: "string",
        },
        event: "string",
        messageId: "string",
        properties: {},
        sentAt: new Date("2023-04-12T14:54:43.161Z"),
        timestamp: new Date("2022-10-04T02:51:38.958Z"),
        type: TypeT.Track,
        userId: "string",
    });

    if (res.statusCode == 200) {
        // handle response
    }
}

run();

Variables

Some of the server options above contain variables. If you want to set the values of those variables, the following optional parameters are available when initializing the SDK client instance:

  • storeId: string
  • subdomain: string

Override Server URL Per-Client

The default server can also be overridden globally by passing a URL to the serverURL: str optional parameter when initializing the SDK client instance. For example:

import { SDK } from "commercengine";
import { Channel, TypeT } from "commercengine/dist/sdk/models/shared";

async function run() {
    const sdk = new SDK({
        serverURL: "https://{subdomain}.commercengine.dev/api/v1/{store_id}/storefront",
        authorization: "<YOUR_BEARER_TOKEN_HERE>",
    });

    const res = await sdk.analytics.getAnalyticsTrack({
        channel: Channel.Website,
        context: {
            ip: "120.241.208.40",
            userAgent: "string",
        },
        event: "string",
        messageId: "string",
        properties: {},
        sentAt: new Date("2023-04-12T14:54:43.161Z"),
        timestamp: new Date("2022-10-04T02:51:38.958Z"),
        type: TypeT.Track,
        userId: "string",
    });

    if (res.statusCode == 200) {
        // handle response
    }
}

run();

Custom HTTP Client

The Typescript SDK makes API calls using the axios HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with a custom AxiosInstance object.

For example, you could specify a header for every request that your sdk makes as follows:

import { commercengine } from "SDK";
import axios from "axios";

const httpClient = axios.create({
    headers: {'x-custom-header': 'someValue'}
})

const sdk = new SDK({defaultClient: httpClient});

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name Type Scheme
authorization http HTTP Bearer

To authenticate with the API the authorization parameter must be set when initializing the SDK client instance. For example:

import { SDK } from "commercengine";
import { Channel, TypeT } from "commercengine/dist/sdk/models/shared";

async function run() {
    const sdk = new SDK({
        authorization: "<YOUR_BEARER_TOKEN_HERE>",
    });

    const res = await sdk.analytics.getAnalyticsTrack({
        channel: Channel.Website,
        context: {
            ip: "120.241.208.40",
            userAgent: "string",
        },
        event: "string",
        messageId: "string",
        properties: {},
        sentAt: new Date("2023-04-12T14:54:43.161Z"),
        timestamp: new Date("2022-10-04T02:51:38.958Z"),
        type: TypeT.Track,
        userId: "string",
    });

    if (res.statusCode == 200) {
        // handle response
    }
}

run();

Per-Operation Security Schemes

Some operations in this SDK require the security scheme to be specified at the request level. For example:

import { SDK } from "commercengine";
import { GetAuthAnonymousSecurity } from "commercengine/dist/sdk/models/operations";

async function run() {
    const sdk = new SDK();
    const operationSecurity: GetAuthAnonymousSecurity = "<YOUR_API_KEY_HERE>";

    const res = await sdk.auth.getAuthAnonymous(operationSecurity);

    if (res.statusCode == 200) {
        // handle response
    }
}

run();

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!

SDK Created by Speakeasy

Readme

Keywords

none

Package Sidebar

Install

npm i commercengine

Repository

github.com/tark-ai/ce-sdk

Homepage

github.com/tark-ai/ce-sdk#readme

Weekly Downloads

0

Version

0.2.0

License

none

Unpacked Size

3.29 MB

Total Files

943

Last publish

Collaborators

  • saranshchaudhary
Try on RunKit
Report malware