@cometh/checkout-sdk - npm Package Compare versions

Comparing version 1.0.3 to 1.0.4

dist/FiatMintingApi.d.ts

@@ -10,2 +10,3 @@ import type { BaseHttpRequest } from './core/BaseHttpRequest';
 import { TransactionsService } from './services/TransactionsService';
+import { WhitelistService } from './services/WhitelistService';
 type HttpRequestConstructor = new (config: OpenAPIConfig) => BaseHttpRequest;
@@ -20,2 +21,3 @@ export declare class FiatMintingApi {
     readonly transactions: TransactionsService;
+    readonly whitelist: WhitelistService;
     readonly request: BaseHttpRequest;
@@ -22,0 +24,0 @@ constructor(config?: Partial<OpenAPIConfig>, HttpRequest?: HttpRequestConstructor);

dist/FiatMintingApi.js

@@ -9,2 +9,3 @@ import { AxiosHttpRequest } from './core/AxiosHttpRequest';
 import { TransactionsService } from './services/TransactionsService';
+import { WhitelistService } from './services/WhitelistService';
 export class FiatMintingApi {
@@ -30,3 +31,4 @@ constructor(config, HttpRequest = AxiosHttpRequest) {
         this.transactions = new TransactionsService(this.request);
+        this.whitelist = new WhitelistService(this.request);
     }
 }

dist/index.d.ts

@@ -8,2 +8,4 @@ export { FiatMintingApi } from './FiatMintingApi';
 export type { AbiParamType } from './models/AbiParamType';
+export type { AdminWhitelistRequest } from './models/AdminWhitelistRequest';
+export type { AdminWhitelistUpdateRequest } from './models/AdminWhitelistUpdateRequest';
 export type { CheckoutSessionParameters } from './models/CheckoutSessionParameters';
@@ -23,3 +25,5 @@ export type { CheckoutSessionRequest } from './models/CheckoutSessionRequest';
 export type { ProjectSettings } from './models/ProjectSettings';
+export type { ProjectSettingsAndValidations } from './models/ProjectSettingsAndValidations';
 export type { PSP } from './models/PSP';
+export type { ReviewWhitelistRequest } from './models/ReviewWhitelistRequest';
 export type { StripeAccountId } from './models/StripeAccountId';
@@ -31,3 +35,6 @@ export type { StripeAddress } from './models/StripeAddress';
 export type { UserAddress } from './models/UserAddress';
-export type { WhitelistRequest } from './models/WhitelistRequest';
+export { ValidationStatus } from './models/ValidationStatus';
+export type { ValidationStatuses } from './models/ValidationStatuses';
+export type { WhitelistContract } from './models/WhitelistContract';
+export { WhitelistStatus } from './models/WhitelistStatus';
 export { AdminService } from './services/AdminService';
@@ -40,1 +47,2 @@ export { CheckoutSessionsService } from './services/CheckoutSessionsService';
 export { TransactionsService } from './services/TransactionsService';
+export { WhitelistService } from './services/WhitelistService';

dist/index.js

@@ -13,2 +13,4 @@ /* istanbul ignore file */
 export { Transaction } from './models/Transaction';
+export { ValidationStatus } from './models/ValidationStatus';
+export { WhitelistStatus } from './models/WhitelistStatus';
 export { AdminService } from './services/AdminService';
@@ -21,1 +23,2 @@ export { CheckoutSessionsService } from './services/CheckoutSessionsService';
 export { TransactionsService } from './services/TransactionsService';
+export { WhitelistService } from './services/WhitelistService';

dist/services/AdminService.d.ts

@@ -0,3 +1,5 @@
+import type { AdminWhitelistRequest } from '../models/AdminWhitelistRequest';
+import type { AdminWhitelistUpdateRequest } from '../models/AdminWhitelistUpdateRequest';
 import type { ContractAddress } from '../models/ContractAddress';
-import type { WhitelistRequest } from '../models/WhitelistRequest';
+import type { WhitelistContract } from '../models/WhitelistContract';
 import type { CancelablePromise } from '../core/CancelablePromise';
@@ -10,3 +12,3 @@ import type { BaseHttpRequest } from '../core/BaseHttpRequest';
      * Whitelist a client contract
-     * Allow a client to create Cometh Checkout products for their contract.
+     * Allow an admin to add a validated contract to the whitelist.
      * @param requestBody
@@ -16,3 +18,3 @@ * @returns any Contract is whitelisted.
      */
-    whitelistClientContract(requestBody: WhitelistRequest): CancelablePromise<any>;
+    whitelistClientContract(requestBody: AdminWhitelistRequest): CancelablePromise<any>;
     /**
@@ -22,6 +24,6 @@ * Get whitelisted contracts for a client project
      * @param projectId
-     * @returns ContractAddress List of whitelisted contracts
+     * @returns WhitelistContract List of whitelisted contracts
      * @throws ApiError
      */
-    getWhitelistedContractsOfProject(projectId: string): CancelablePromise<Array<ContractAddress>>;
+    getWhitelistedContractsOfProject(projectId: string): CancelablePromise<Array<WhitelistContract>>;
     /**
@@ -36,2 +38,12 @@ * Remove a contract from whitelist for a client project
     deleteFromWhitelistOfProject(projectId: string, contractAddress: ContractAddress): CancelablePromise<any>;
+    /**
+     * Update a contract in the whitelist. Used to update the status.
+     * Update status from whitelist.
+     * @param projectId
+     * @param contractAddress
+     * @param requestBody
+     * @returns any Contract removed from whitelist
+     * @throws ApiError
+     */
+    updateWhitelistContract(projectId: string, contractAddress: ContractAddress, requestBody: AdminWhitelistUpdateRequest): CancelablePromise<any>;
 }

dist/services/AdminService.js

@@ -7,3 +7,3 @@ export class AdminService {
      * Whitelist a client contract
-     * Allow a client to create Cometh Checkout products for their contract.
+     * Allow an admin to add a validated contract to the whitelist.
      * @param requestBody
@@ -33,3 +33,3 @@ * @returns any Contract is whitelisted.
      * @param projectId
-     * @returns ContractAddress List of whitelisted contracts
+     * @returns WhitelistContract List of whitelisted contracts
      * @throws ApiError
@@ -70,2 +70,26 @@ */
     }
+    /**
+     * Update a contract in the whitelist. Used to update the status.
+     * Update status from whitelist.
+     * @param projectId
+     * @param contractAddress
+     * @param requestBody
+     * @returns any Contract removed from whitelist
+     * @throws ApiError
+     */
+    updateWhitelistContract(projectId, contractAddress, requestBody) {
+        return this.httpRequest.request({
+            method: 'PUT',
+            url: '/admin/whitelists/{projectId}/{contractAddress}',
+            path: {
+                'projectId': projectId,
+                'contractAddress': contractAddress,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+            errors: {
+                403: `Resource is access restricted.`,
+            },
+        });
+    }
 }

dist/services/SettingsService.d.ts

 import type { ProjectSettings } from '../models/ProjectSettings';
+import type { ProjectSettingsAndValidations } from '../models/ProjectSettingsAndValidations';
 import type { CancelablePromise } from '../core/CancelablePromise';
@@ -9,7 +10,7 @@ import type { BaseHttpRequest } from '../core/BaseHttpRequest';
      * Fetch project settings
-     * Fetch project details with PSP settings
-     * @returns ProjectSettings Project settings
+     * Fetch project details with PSP settings and validations status.
+     * @returns ProjectSettingsAndValidations Project settings
      * @throws ApiError
      */
-    getProjectSettings(): CancelablePromise<ProjectSettings>;
+    getProjectSettings(): CancelablePromise<ProjectSettingsAndValidations>;
     /**
@@ -16,0 +17,0 @@ * Set project settings

dist/services/SettingsService.js

@@ -7,4 +7,4 @@ export class SettingsService {
      * Fetch project settings
-     * Fetch project details with PSP settings
-     * @returns ProjectSettings Project settings
+     * Fetch project details with PSP settings and validations status.
+     * @returns ProjectSettingsAndValidations Project settings
      * @throws ApiError
@@ -11,0 +11,0 @@ */

package.json

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

No alert changes

Improved metrics

Total package byte prevSize

67996

increased by14.39%

Number of package files

103

increased by24.1%

Lines of code

1887

increased by15.34%

No dependency changes