@cometh/checkout-sdk - npm Package Compare versions

Comparing version 1.0.11 to 1.0.12

dist/schemas.gen.d.ts

@@ -166,2 +166,13 @@ export declare const $LydiaSettings: {
 };
+export declare const $Price: {
+    readonly description: "A positive integer representing how much to charge in the smallest currency.<br /> For example: <ul>\n  <li>$12.34 would be <code>1234</code></li>\n  <li>12.34 USDC (6 decimals) would be <code>12340000</code></li>\n  <li>ETH amounts (18 decimals) would be stored in wei</li>\n</ul>";
+    readonly type: "string";
+    readonly pattern: "^[0-9]+$";
+    readonly example: "1234";
+};
+export declare const $Currency: {
+    readonly description: "Currency";
+    readonly type: "string";
+    readonly enum: readonly ["EUR", "GBP", "USD", "INR"];
+};
 export declare const $Product: {
@@ -198,11 +209,6 @@ readonly additionalProperties: false;
         readonly price: {
-            readonly description: "A positive integer representing how much to charge in the smallest currency.<br /> For example: <ul>\n  <li>$12.34 would be <code>1234</code></li>\n  <li>12.34 USDC (6 decimals) would be <code>12340000</code></li>\n  <li>ETH amounts (18 decimals) would be stored in wei</li>\n</ul>";
-            readonly type: "string";
-            readonly pattern: "^[0-9]+$";
-            readonly example: "1234";
+            readonly $ref: "#/components/schemas/Price";
         };
         readonly currency: {
-            readonly description: "Currency of product price";
-            readonly type: "string";
-            readonly enum: readonly ["EUR", "GBP", "USD", "INR"];
+            readonly $ref: "#/components/schemas/Currency";
         };
@@ -298,3 +304,3 @@ };
     readonly type: "object";
-    readonly required: readonly ["id", "productId", "chainId", "status", "userAddress", "email", "pspType", "pspIdentifier", "pspInfos", "relayedTxnId"];
+    readonly required: readonly ["id", "productId", "price", "currency", "chainId", "status", "userAddress", "email", "pspType", "pspIdentifier", "pspInfos", "relayedTxnId"];
     readonly properties: {
@@ -312,2 +318,10 @@ readonly id: {
         };
+        readonly price: {
+            readonly $ref: "#/components/schemas/Price";
+            readonly readOnly: true;
+        };
+        readonly currency: {
+            readonly $ref: "#/components/schemas/Currency";
+            readonly readOnly: true;
+        };
         readonly chainId: {
@@ -314,0 +328,0 @@ readonly type: "integer";

dist/schemas.gen.js

@@ -169,2 +169,17 @@ // This file is auto-generated by @hey-api/openapi-ts
 };
+export const $Price = {
+    description: `A positive integer representing how much to charge in the smallest currency.<br /> For example: <ul>
+  <li>$12.34 would be <code>1234</code></li>
+  <li>12.34 USDC (6 decimals) would be <code>12340000</code></li>
+  <li>ETH amounts (18 decimals) would be stored in wei</li>
+</ul>`,
+    type: 'string',
+    pattern: '^[0-9]+$',
+    example: '1234'
+};
+export const $Currency = {
+    description: 'Currency',
+    type: 'string',
+    enum: ['EUR', 'GBP', 'USD', 'INR']
+};
 export const $Product = {
@@ -201,15 +216,6 @@ additionalProperties: false,
         price: {
-            description: `A positive integer representing how much to charge in the smallest currency.<br /> For example: <ul>
-  <li>$12.34 would be <code>1234</code></li>
-  <li>12.34 USDC (6 decimals) would be <code>12340000</code></li>
-  <li>ETH amounts (18 decimals) would be stored in wei</li>
-</ul>`,
-            type: 'string',
-            pattern: '^[0-9]+$',
-            example: '1234'
+            '$ref': '#/components/schemas/Price'
         },
         currency: {
-            description: 'Currency of product price',
-            type: 'string',
-            enum: ['EUR', 'GBP', 'USD', 'INR']
+            '$ref': '#/components/schemas/Currency'
         }
@@ -305,3 +311,3 @@ }
     type: 'object',
-    required: ['id', 'productId', 'chainId', 'status', 'userAddress', 'email', 'pspType', 'pspIdentifier', 'pspInfos', 'relayedTxnId'],
+    required: ['id', 'productId', 'price', 'currency', 'chainId', 'status', 'userAddress', 'email', 'pspType', 'pspIdentifier', 'pspInfos', 'relayedTxnId'],
     properties: {
@@ -319,2 +325,10 @@ id: {
         },
+        price: {
+            '$ref': '#/components/schemas/Price',
+            readOnly: true
+        },
+        currency: {
+            '$ref': '#/components/schemas/Currency',
+            readOnly: true
+        },
         chainId: {
@@ -321,0 +335,0 @@ type: 'integer',

dist/types.gen.d.ts

@@ -98,2 +98,23 @@ export type LydiaSettings = {
 };
+/**
+ * A positive integer representing how much to charge in the smallest currency.<br /> For example: <ul>
+ * <li>$12.34 would be <code>1234</code></li>
+ * <li>12.34 USDC (6 decimals) would be <code>12340000</code></li>
+ * <li>ETH amounts (18 decimals) would be stored in wei</li>
+ * </ul>
+ */
+export type Price = string;
+/**
+ * Currency
+ */
+export type Currency = 'EUR' | 'GBP' | 'USD' | 'INR';
+/**
+ * Currency
+ */
+export declare const Currency: {
+    readonly EUR: "EUR";
+    readonly GBP: "GBP";
+    readonly USD: "USD";
+    readonly INR: "INR";
+};
 export type Product = {
@@ -118,29 +139,6 @@ readonly id?: number;
     parametersStaticValues?: ParametersStaticValues;
-    /**
-     * A positive integer representing how much to charge in the smallest currency.<br /> For example: <ul>
-     * <li>$12.34 would be <code>1234</code></li>
-     * <li>12.34 USDC (6 decimals) would be <code>12340000</code></li>
-     * <li>ETH amounts (18 decimals) would be stored in wei</li>
-     * </ul>
-     */
-    price: string;
-    /**
-     * Currency of product price
-     */
-    currency: 'EUR' | 'GBP' | 'USD' | 'INR';
+    price: Price;
+    currency: Currency;
 };
 /**
- * Currency of product price
- */
-export type currency = 'EUR' | 'GBP' | 'USD' | 'INR';
-/**
- * Currency of product price
- */
-export declare const currency: {
-    readonly EUR: "EUR";
-    readonly GBP: "GBP";
-    readonly USD: "USD";
-    readonly INR: "INR";
-};
-/**
  * The Ethereum address of the user.
@@ -197,2 +195,4 @@ */
     readonly productId: number;
+    readonly price: Price;
+    readonly currency: Currency;
     readonly chainId: number;
@@ -199,0 +199,0 @@ /**

dist/types.gen.js

@@ -15,5 +15,5 @@ // This file is auto-generated by @hey-api/openapi-ts
 /**
- * Currency of product price
+ * Currency
  */
-export const currency = {
+export const Currency = {
     EUR: 'EUR',
@@ -20,0 +20,0 @@ GBP: 'GBP',

package.json

 {
   "name": "@cometh/checkout-sdk",
-  "version": "1.0.11",
+  "version": "1.0.12",
   "description": "SDK to use Cometh Checkout API",
@@ -5,0 +5,0 @@ "main": "dist/index.js",

README.md

@@ -1,2 +0,2 @@
-# @alembic/fiat-minting-api-sdk
+# @cometh/checkout-sdk
 
@@ -6,5 +6,5 @@ This is a TypeScript SDK for interacting with the Fiat Minting API. It simplifies the process of making requests to the API by providing convenient methods for various operations related to NFTs (Non-Fungible Tokens). These operations include managing and searching for assets, handling collections, and analyzing NFT data.
 
-##  [SDK Reference documentation](https://api.marketplace.develop.cometh.tech/v1/client-doc/classes/NftApi.html)
-##  [API reference documentation](https://api.marketplace.develop.cometh.tech/v1/doc)
-##  [Alembic documentation](https://docs.alembic.tech/introduction/overview)
+##  [SDK Reference documentation](https://checkout.cometh.io/v1/client-doc/)
+##  [API reference documentation](https://checkout.cometh.io/v1/doc/)
+##  [Cometh Checkout documentation](https://docs.cometh.io/checkout)
 
@@ -14,10 +14,10 @@
 
-To add the @alembic/fiat-minting-api-sdk to your project, you can use npm or yarn:
+To add the @cometh/checkout-sdk to your project, you can use npm or yarn:
 
 ```bash
-npm install @alembic/fiat-minting-api-sdk
+npm install @cometh/checkout-sdk
 ```
 
 ```bash
-yarn add @alembic/fiat-minting-api-sdk
+yarn add @cometh/checkout-sdk
 ```
@@ -27,12 +27,12 @@
 
-After installation, you can import `NftApi` from the SDK in your TypeScript code:
+After installation, you can import `CheckoutAPI` from the SDK in your TypeScript code:
 
 ```ts
-import { FiatMintingApi } from '@alembic/fiat-minting-api-sdk';
+import { CheckoutAPI } from '@cometh/checkout-sdk';
 ```
 
-Create an instance of `FiatMintingApi` and call its methods to interact with the NFT API.
+Create an instance of `CheckoutAPI` and call its methods to interact with the NFT API.
 
 ```ts
-const fiatApi = new FiatMintingApi();
+const fiatApi = new CheckoutAPI();
 ```

schemas.gen.ts

@@ -182,2 +182,19 @@ // This file is auto-generated by @hey-api/openapi-ts
 
+export const $Price = {
+    description: `A positive integer representing how much to charge in the smallest currency.<br /> For example: <ul>
+  <li>$12.34 would be <code>1234</code></li>
+  <li>12.34 USDC (6 decimals) would be <code>12340000</code></li>
+  <li>ETH amounts (18 decimals) would be stored in wei</li>
+</ul>`,
+    type: 'string',
+    pattern: '^[0-9]+$',
+    example: '1234'
+} as const;
+
+export const $Currency = {
+    description: 'Currency',
+    type: 'string',
+    enum: ['EUR', 'GBP', 'USD', 'INR']
+} as const;
+
 export const $Product = {
@@ -214,15 +231,6 @@ additionalProperties: false,
         price: {
-            description: `A positive integer representing how much to charge in the smallest currency.<br /> For example: <ul>
-  <li>$12.34 would be <code>1234</code></li>
-  <li>12.34 USDC (6 decimals) would be <code>12340000</code></li>
-  <li>ETH amounts (18 decimals) would be stored in wei</li>
-</ul>`,
-            type: 'string',
-            pattern: '^[0-9]+$',
-            example: '1234'
+            '$ref': '#/components/schemas/Price'
         },
         currency: {
-            description: 'Currency of product price',
-            type: 'string',
-            enum: ['EUR', 'GBP', 'USD', 'INR']
+            '$ref': '#/components/schemas/Currency'
         }
@@ -325,3 +333,3 @@ }
     type: 'object',
-    required: ['id', 'productId', 'chainId', 'status', 'userAddress', 'email', 'pspType', 'pspIdentifier', 'pspInfos', 'relayedTxnId'],
+    required: ['id', 'productId', 'price', 'currency', 'chainId', 'status', 'userAddress', 'email', 'pspType', 'pspIdentifier', 'pspInfos', 'relayedTxnId'],
     properties: {
@@ -339,2 +347,10 @@ id: {
         },
+        price: {
+            '$ref': '#/components/schemas/Price',
+            readOnly: true
+        },
+        currency: {
+            '$ref': '#/components/schemas/Currency',
+            readOnly: true
+        },
         chainId: {
@@ -341,0 +357,0 @@ type: 'integer',

types.gen.ts

@@ -115,2 +115,26 @@ // This file is auto-generated by @hey-api/openapi-ts
 
+/**
+ * A positive integer representing how much to charge in the smallest currency.<br /> For example: <ul>
+ * <li>$12.34 would be <code>1234</code></li>
+ * <li>12.34 USDC (6 decimals) would be <code>12340000</code></li>
+ * <li>ETH amounts (18 decimals) would be stored in wei</li>
+ * </ul>
+ */
+export type Price = string;
+
+/**
+ * Currency
+ */
+export type Currency = 'EUR' | 'GBP' | 'USD' | 'INR';
+
+/**
+ * Currency
+ */
+export const Currency = {
+    EUR: 'EUR',
+    GBP: 'GBP',
+    USD: 'USD',
+    INR: 'INR'
+} as const;
+
 export type Product = {
@@ -135,32 +159,7 @@ readonly id?: number;
     parametersStaticValues?: ParametersStaticValues;
-    /**
-     * A positive integer representing how much to charge in the smallest currency.<br /> For example: <ul>
-     * <li>$12.34 would be <code>1234</code></li>
-     * <li>12.34 USDC (6 decimals) would be <code>12340000</code></li>
-     * <li>ETH amounts (18 decimals) would be stored in wei</li>
-     * </ul>
-     */
-    price: string;
-    /**
-     * Currency of product price
-     */
-    currency: 'EUR' | 'GBP' | 'USD' | 'INR';
+    price: Price;
+    currency: Currency;
 };
 
 /**
- * Currency of product price
- */
-export type currency = 'EUR' | 'GBP' | 'USD' | 'INR';
-
-/**
- * Currency of product price
- */
-export const currency = {
-    EUR: 'EUR',
-    GBP: 'GBP',
-    USD: 'USD',
-    INR: 'INR'
-} as const;
-
-/**
  * The Ethereum address of the user.
@@ -223,2 +222,4 @@ */
     readonly productId: number;
+    readonly price: Price;
+    readonly currency: Currency;
     readonly chainId: number;
@@ -225,0 +226,0 @@ /**

No alert changes

Improved metrics

Total package byte prevSize

222898

increased by0.38%

Lines of code

6964

increased by0.61%

No dependency changes