@snokam/[email protected]

A TypeScript SDK client for the webshop.api.snokam.no API.

Usage

First, install the SDK from npm.

npm install @snokam/webshop-client --save

Next, try it out.

import {
  Configuration,
  WebshopClient,
} from '@snokam/webshop-client';
import type { AssignOrdersToEmployeesRequest } from '@snokam/webshop-client';

async function example() {
  console.log("🚀 Testing @snokam/webshop-client SDK...");
  const config = new Configuration({ 
    // To configure OAuth2 access token for authorization: Implicit implicit
    accessToken: "YOUR ACCESS TOKEN",
  });
  const api = new WebshopClient(config);

  const body = {
    // Array<string> | List of order IDs to assign
    requestBody: ...,
  } satisfies AssignOrdersToEmployeesRequest;

  try {
    const data = await api.assignOrdersToEmployees(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Documentation

API Endpoints

All URIs are relative to https://webshop.api.snokam.no

| Class | Method | HTTP request | Description | ----- | ------ | ------------ | ------------- WebshopClient | assignOrdersToEmployees | POST /v1.1/AssignOrdersToEmployees | Assigns orders to employees WebshopClient | getAllOrdersGroupedByEmployee | GET /v1.1/GetAllOrdersGroupedByEmployee | Gets all orders grouped by employee WebshopClient | getAllOrdersGroupedByEquipment | GET /v1.1/GetAllOrdersGroupedByEquipment | Gets all orders grouped by equipment WebshopClient | getMyOrders | GET /v1.1/GetMyOrders | Gets user's orders WebshopClient | getWebshopProducts | GET /v1.1/GetWebshopProducts | Gets webshop products WebshopClient | placeMyOrder | POST /v1.1/PlaceMyOrder | Places an order WebshopClient | removeMyOrder | POST /v1.1/RemoveMyOrder | Removes an order

Models

• AdminOrder
• AvailableVariants
• Description
• DescriptionChild
• Employee
• Equipment
• Image
• ImageAsset
• InnerOrder
• Order
• RemoveOrder
• Variant

Authorization

Authentication schemes defined for the API:

Implicit implicit

• Type: OAuth
• Flow: implicit
• Authorization URL: https://login.microsoftonline.com/81a4f38d-6712-4b65-868b-c3771f9ba91e/oauth2/v2.0/authorize
• Scopes:
  • api://5814647d-d6dc-413e-b091-b70231e5530e/user_impersonation: Default function scope

About

This TypeScript SDK client supports the Fetch API and is automatically generated by the OpenAPI Generator project:

• API version: v1.0.0
• Package version: 1.5.6
• Generator version: 7.17.0
• Build package: org.openapitools.codegen.languages.TypeScriptFetchClientCodegen

The generated npm module supports the following:

• Environments
  • Node.js
  • Webpack
  • Browserify
• Language levels
  • ES5 - you must have a Promises/A+ library installed
  • ES6
• Module systems
  • CommonJS
  • ES6 module system

Development

Building

To build the TypeScript source code, you need to have Node.js and npm installed. After cloning the repository, navigate to the project directory and run:

npm install
npm run build

Publishing

Once you've built the package, you can publish it to npm:

npm publish

License