coinbase-api 0.3.2 → 0.5.0

package/dist/cjs/CBCommerceClient.d.ts

@@ -0,0 +1,110 @@
+import { AxiosRequestConfig } from 'axios';
+import { BaseRestClient } from './lib/BaseRestClient.js';
+import { RestClientOptions, RestClientType } from './lib/requestUtils.js';
+/**
+ * REST client for Coinbase Prime API:
+ * https://docs.cdp.coinbase.com/commerce-onchain/docs/welcome
+ */
+export declare class CBCommerceClient extends BaseRestClient {
+    constructor(restClientOptions?: RestClientOptions, requestOptions?: AxiosRequestConfig);
+    getClientType(): RestClientType;
+    /**
+     *
+     * Charges Endpoints
+     *
+     */
+    /**
+     * Creates a Charge
+     *
+     * Creates a charge.
+     */
+    createCharge(params: {
+        buyer_locale?: string;
+        cancel_url?: string;
+        checkout_id?: string;
+        local_price: {
+            amount: string;
+            currency: string;
+        };
+        metadata?: {
+            custom_field?: string;
+            custom_field_two?: string;
+        };
+        pricing_type: string;
+        redirect_url?: string;
+    }): Promise<any>;
+    /**
+     * Returns All Charges
+     *
+     * Returns all charges.
+     */
+    getAllCharges(): Promise<any>;
+    /**
+     * Returns the Charge with the Order Code
+     *
+     * Returns the charge with the order code.
+     */
+    getCharge(params: {
+        charge_code_or_charge_id: string;
+    }): Promise<any>;
+    /**
+     *
+     * Checkouts Endpoints
+     *
+     */
+    /**
+     * Creates a New Checkout
+     *
+     * Creates a new checkout.
+     */
+    createCheckout(params: {
+        buyer_locale?: string;
+        total_price: {
+            amount: string;
+            currency: string;
+        };
+        metadata?: {
+            custom_field?: string;
+            custom_field_two?: string;
+        };
+        pricing_type: string;
+        requested_info?: string[];
+    }): Promise<any>;
+    /**
+     * Returns All Checkout Sessions
+     *
+     * Returns all checkout sessions.
+     */
+    getAllCheckouts(): Promise<any>;
+    /**
+     * Returns a Specific Checkout Session
+     *
+     * Returns a specific checkout session.
+     */
+    getCheckout(params: {
+        checkout_id: string;
+    }): Promise<any>;
+    /**
+     *
+     * Events Endpoints
+     *
+     */
+    /**
+     * List Events
+     *
+     * Lists all events.
+     */
+    listEvents(headers: {
+        'X-CC-Version': string;
+    }): Promise<any>;
+    /**
+     * Show an Event
+     *
+     * Retrieves the details of an event. Supply the unique identifier of the event, which you might have received in a webhook.
+     */
+    showEvent(params: {
+        event_id: string;
+    }, headers: {
+        'X-CC-Version': string;
+    }): Promise<any>;
+}

package/dist/cjs/CBCommerceClient.js

@@ -0,0 +1,105 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CBCommerceClient = void 0;
+const BaseRestClient_js_1 = require("./lib/BaseRestClient.js");
+const requestUtils_js_1 = require("./lib/requestUtils.js");
+/**
+ * REST client for Coinbase Prime API:
+ * https://docs.cdp.coinbase.com/commerce-onchain/docs/welcome
+ */
+class CBCommerceClient extends BaseRestClient_js_1.BaseRestClient {
+    constructor(restClientOptions = {}, requestOptions = {}) {
+        super(restClientOptions, requestOptions);
+        return this;
+    }
+    getClientType() {
+        return requestUtils_js_1.REST_CLIENT_TYPE_ENUM.commerce;
+    }
+    /**
+     *
+     * Charges Endpoints
+     *
+     */
+    /**
+     * Creates a Charge
+     *
+     * Creates a charge.
+     */
+    createCharge(params) {
+        return this.postPrivate('/charges', {
+            body: params,
+        });
+    }
+    /**
+     * Returns All Charges
+     *
+     * Returns all charges.
+     */
+    getAllCharges() {
+        return this.getPrivate('/charges');
+    }
+    /**
+     * Returns the Charge with the Order Code
+     *
+     * Returns the charge with the order code.
+     */
+    getCharge(params) {
+        return this.getPrivate(`/charges/${params.charge_code_or_charge_id}`);
+    }
+    /**
+     *
+     * Checkouts Endpoints
+     *
+     */
+    /**
+     * Creates a New Checkout
+     *
+     * Creates a new checkout.
+     */
+    createCheckout(params) {
+        return this.postPrivate('/checkouts', {
+            body: params,
+        });
+    }
+    /**
+     * Returns All Checkout Sessions
+     *
+     * Returns all checkout sessions.
+     */
+    getAllCheckouts() {
+        return this.getPrivate('/checkouts');
+    }
+    /**
+     * Returns a Specific Checkout Session
+     *
+     * Returns a specific checkout session.
+     */
+    getCheckout(params) {
+        return this.getPrivate(`/checkouts/${params.checkout_id}`);
+    }
+    /**
+     *
+     * Events Endpoints
+     *
+     */
+    /**
+     * List Events
+     *
+     * Lists all events.
+     */
+    listEvents(headers) {
+        return this.getPrivate('/events', {
+            headers: headers,
+        });
+    }
+    /**
+     * Show an Event
+     *
+     * Retrieves the details of an event. Supply the unique identifier of the event, which you might have received in a webhook.
+     */
+    showEvent(params, headers) {
+        return this.getPrivate(`/events/${params.event_id}`, { headers: headers });
+    }
+}
+exports.CBCommerceClient = CBCommerceClient;
+//# sourceMappingURL=CBCommerceClient.js.map

package/dist/cjs/CBCommerceClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CBCommerceClient.js","sourceRoot":"","sources":["../../src/CBCommerceClient.ts"],"names":[],"mappings":";;;AAEA,+DAAyD;AACzD,2DAI+B;AAE/B;;;GAGG;AACH,MAAa,gBAAiB,SAAQ,kCAAc;IAClD,YACE,oBAAuC,EAAE,EACzC,iBAAqC,EAAE;QAEvC,KAAK,CAAC,iBAAiB,EAAE,cAAc,CAAC,CAAC;QACzC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,aAAa;QACX,OAAO,uCAAqB,CAAC,QAAQ,CAAC;IACxC,CAAC;IAED;;;;OAIG;IAEH;;;;OAIG;IACH,YAAY,CAAC,MAcZ;QACC,OAAO,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE;YAClC,IAAI,EAAE,MAAM;SACb,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,aAAa;QACX,OAAO,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;IACrC,CAAC;IAED;;;;OAIG;IACH,SAAS,CAAC,MAA4C;QACpD,OAAO,IAAI,CAAC,UAAU,CAAC,YAAY,MAAM,CAAC,wBAAwB,EAAE,CAAC,CAAC;IACxE,CAAC;IAED;;;;OAIG;IAEH;;;;OAIG;IACH,cAAc,CAAC,MAYd;QACC,OAAO,IAAI,CAAC,WAAW,CAAC,YAAY,EAAE;YACpC,IAAI,EAAE,MAAM;SACb,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,eAAe;QACb,OAAO,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;IACvC,CAAC;IAED;;;;OAIG;IACH,WAAW,CAAC,MAA+B;QACzC,OAAO,IAAI,CAAC,UAAU,CAAC,cAAc,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC;IAC7D,CAAC;IAED;;;;OAIG;IAEH;;;;OAIG;IACH,UAAU,CAAC,OAAmC;QAC5C,OAAO,IAAI,CAAC,UAAU,CAAC,SAAS,EAAE;YAChC,OAAO,EAAE,OAAO;SACjB,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,SAAS,CACP,MAA4B,EAC5B,OAAmC;QAEnC,OAAO,IAAI,CAAC,UAAU,CAAC,WAAW,MAAM,CAAC,QAAQ,EAAE,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;IAC7E,CAAC;CACF;AAzID,4CAyIC"}