@matchi/api 0.20231011.1 → 0.20231023.1

package/README.md

@@ -2,10 +2,16 @@
 
 MATCHi API Client
 
+## Introduction
+
+This is the MATCHi API client for JavaScript and TypeScript. It is generated from the OpenAPI specification and is intended to be used when building applications that integrates with the MATCHi API.
+
 ## Installation
 
 ```bash
-npm install @matchi/api
+npm install @matchi/api # using npm
+yarn add @matchi/api # using yarn
+bun install @matchi/api # using bun
 ```
 
 ## Get started
@@ -30,12 +36,48 @@ OpenAPI.TOKEN = getValidAccessToken;
 
 ## Usage
 
+### Basic usage
+
 ```typescript
+// Once you've got the dependency locally, you can inspect the exports to
+// see what's available.
+
+// The classes that ends in "Service" are entrypoints for making HTTP calls.
 import { AnonymousService } from "@matchi/api";
 
 try {
+  // fetch() is used as the underlying HTTP client
   const activities = await AnonymousService.listActivities();
 } catch (error) {
   // Handle error
 }
 ```
+
+### Custom timeout
+
+```typescript
+import { AnonymousService } from "@matchi/api";
+
+try {
+  // Create a promise that will fetch the activities
+  const promise = AnonymousService.listActivities();
+
+  const timeoutId = setTimeout(() => {
+    // If the promise hasn't resolved within 1 second, cancel it
+    promise.cancel();
+
+    // Throw an error to indicate that the request timed out
+    throw new Error("Timeout");
+  }, 1000);
+
+  // Wait for the promise to resolve
+  const activities = await promise;
+
+  // Clear the timeout, since the promise resolved within 1 second
+  clearTimeout(timeoutId);
+
+  return activities;
+} catch (error) {
+  // Handle error
+}
+```

package/dist/index.d.mts

@@ -354,6 +354,9 @@ type valueCardOutcome = {
     valueCard: giftCard;
 };
 
+/**
+ * The attribute price is the price after discounts from e.g. promo codes. priceBase is the original price without discounts
+ */
 type checkoutResponse = {
     facilityName: string;
     facilityOrgNr?: string;
@@ -376,6 +379,14 @@ type checkoutResponse = {
     orderId: number;
     orderStatus: string;
     canUsePromoCode?: boolean;
+    /**
+     * Is what is left to pay e.g. the attribute price minus sum of other payment methods that have been applied, e.g. value cards
+     */
+    amountToPay: string;
+    /**
+     * How much the payment method has to be charged with. This will be a reservation where the diff to amountToPay eventually will be released
+     */
+    reservationAmount: string;
 };
 
 type competitionAdminAccount = {

package/dist/index.d.ts

@@ -354,6 +354,9 @@ type valueCardOutcome = {
     valueCard: giftCard;
 };
 
+/**
+ * The attribute price is the price after discounts from e.g. promo codes. priceBase is the original price without discounts
+ */
 type checkoutResponse = {
     facilityName: string;
     facilityOrgNr?: string;
@@ -376,6 +379,14 @@ type checkoutResponse = {
     orderId: number;
     orderStatus: string;
     canUsePromoCode?: boolean;
+    /**
+     * Is what is left to pay e.g. the attribute price minus sum of other payment methods that have been applied, e.g. value cards
+     */
+    amountToPay: string;
+    /**
+     * How much the payment method has to be charged with. This will be a reservation where the diff to amountToPay eventually will be released
+     */
+    reservationAmount: string;
 };
 
 type competitionAdminAccount = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@matchi/api",
-  "version": "0.20231011.1",
+  "version": "0.20231023.1",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "module": "dist/index.mjs",