@rarible/api-client - npm Package Compare versions

Comparing version 1.123.0 to 1.124.0

build/apis/ChartControllerApi.d.ts

@@ -18,3 +18,10 @@ /**
     size: number;
+    endTime?: Date;
 }
+export interface GetVolumeChartRequest {
+    id: string;
+    period: OlapPeriod;
+    size: number;
+    endTime?: Date;
+}
 /**
@@ -25,3 +32,3 @@ * no description
     /**
-     * Returns list of historical floor prices aggregated at even intervals in the specified time period - last day, last month etc.
+     * Returns list of historical floor prices aggregated at even intervals in the specified time period - last day, last month etc.  Each points represents the aggregated value of the interval after it.  The last point represents the current floor price.
      * Get historical data of floor price for collection for charting purposes
@@ -31,6 +38,16 @@ */
     /**
-     * Returns list of historical floor prices aggregated at even intervals in the specified time period - last day, last month etc.
+     * Returns list of historical floor prices aggregated at even intervals in the specified time period - last day, last month etc.  Each points represents the aggregated value of the interval after it.  The last point represents the current floor price.
      * Get historical data of floor price for collection for charting purposes
      */
     getFloorPriceChart(requestParameters: GetFloorPriceChartRequest): Promise<OlapChartResponse>;
+    /**
+     * Given a time period and the desired number of points, returns points which represent total worth of collection sales in the interval after that point.  The last point always has no value.
+     * Get historical data of collection volume (total sales worth) for charting purposes
+     */
+    getVolumeChartRaw(requestParameters: GetVolumeChartRequest): Promise<GetVolumeChartResponse>;
+    /**
+     * Given a time period and the desired number of points, returns points which represent total worth of collection sales in the interval after that point.  The last point always has no value.
+     * Get historical data of collection volume (total sales worth) for charting purposes
+     */
+    getVolumeChart(requestParameters: GetVolumeChartRequest): Promise<OlapChartResponse>;
 }
@@ -54,1 +71,18 @@ export type GetFloorPriceChart200 = {
 export type GetFloorPriceChartResponse = GetFloorPriceChart200 | GetFloorPriceChart400 | GetFloorPriceChart404 | GetFloorPriceChart500;
+export type GetVolumeChart200 = {
+    status: 200;
+    value: OlapChartResponse;
+};
+export type GetVolumeChart400 = {
+    status: 400;
+    value: OlapError;
+};
+export type GetVolumeChart404 = {
+    status: 404;
+    value: OlapError;
+};
+export type GetVolumeChart500 = {
+    status: 500;
+    value: OlapError;
+};
+export type GetVolumeChartResponse = GetVolumeChart200 | GetVolumeChart400 | GetVolumeChart404 | GetVolumeChart500;

build/apis/ChartControllerApi.js

@@ -101,3 +101,3 @@ "use strict";
     /**
-     * Returns list of historical floor prices aggregated at even intervals in the specified time period - last day, last month etc.
+     * Returns list of historical floor prices aggregated at even intervals in the specified time period - last day, last month etc.  Each points represents the aggregated value of the interval after it.  The last point represents the current floor price.
      * Get historical data of floor price for collection for charting purposes
@@ -128,2 +128,5 @@ */
                         }
+                        if (requestParameters.endTime !== undefined) {
+                            queryParameters['endTime'] = requestParameters.endTime.toISOString();
+                        }
                         headerParameters = {};
@@ -178,3 +181,3 @@ if (this.configuration && this.configuration.apiKey) {
     /**
-     * Returns list of historical floor prices aggregated at even intervals in the specified time period - last day, last month etc.
+     * Returns list of historical floor prices aggregated at even intervals in the specified time period - last day, last month etc.  Each points represents the aggregated value of the interval after it.  The last point represents the current floor price.
      * Get historical data of floor price for collection for charting purposes
@@ -198,4 +201,102 @@ */
     };
+    /**
+     * Given a time period and the desired number of points, returns points which represent total worth of collection sales in the interval after that point.  The last point always has no value.
+     * Get historical data of collection volume (total sales worth) for charting purposes
+     */
+    ChartControllerApi.prototype.getVolumeChartRaw = function (requestParameters) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, response;
+            var _a, _b, _c, _d;
+            return __generator(this, function (_e) {
+                switch (_e.label) {
+                    case 0:
+                        if (requestParameters.id === null || requestParameters.id === undefined) {
+                            throw new runtime.RequiredError('id', 'Required parameter requestParameters.id was null or undefined when calling getVolumeChart.');
+                        }
+                        if (requestParameters.period === null || requestParameters.period === undefined) {
+                            throw new runtime.RequiredError('period', 'Required parameter requestParameters.period was null or undefined when calling getVolumeChart.');
+                        }
+                        if (requestParameters.size === null || requestParameters.size === undefined) {
+                            throw new runtime.RequiredError('size', 'Required parameter requestParameters.size was null or undefined when calling getVolumeChart.');
+                        }
+                        queryParameters = {};
+                        if (requestParameters.period !== undefined) {
+                            queryParameters['period'] = requestParameters.period;
+                        }
+                        if (requestParameters.size !== undefined) {
+                            queryParameters['size'] = requestParameters.size;
+                        }
+                        if (requestParameters.endTime !== undefined) {
+                            queryParameters['endTime'] = requestParameters.endTime.toISOString();
+                        }
+                        headerParameters = {};
+                        if (this.configuration && this.configuration.apiKey) {
+                            headerParameters["X-API-KEY"] = this.configuration.apiKey("X-API-KEY"); // ApiKeyAuth authentication
+                        }
+                        return [4 /*yield*/, this.request({
+                                path: "/v2.0/data/collections/{id}/charts/volume".replace("{".concat("id", "}"), encodeURIComponent(String(requestParameters.id))),
+                                method: 'GET',
+                                headers: headerParameters,
+                                query: queryParameters,
+                            })];
+                    case 1:
+                        response = _e.sent();
+                        if (!(response.status === 200)) return [3 /*break*/, 3];
+                        _a = {
+                            status: 200
+                        };
+                        return [4 /*yield*/, response.json()];
+                    case 2: return [2 /*return*/, (_a.value = _e.sent(),
+                            _a)];
+                    case 3:
+                        if (!(response.status === 400)) return [3 /*break*/, 5];
+                        _b = {
+                            status: 400
+                        };
+                        return [4 /*yield*/, response.json()];
+                    case 4: return [2 /*return*/, (_b.value = _e.sent(),
+                            _b)];
+                    case 5:
+                        if (!(response.status === 404)) return [3 /*break*/, 7];
+                        _c = {
+                            status: 404
+                        };
+                        return [4 /*yield*/, response.json()];
+                    case 6: return [2 /*return*/, (_c.value = _e.sent(),
+                            _c)];
+                    case 7:
+                        if (!(response.status === 500)) return [3 /*break*/, 9];
+                        _d = {
+                            status: 500
+                        };
+                        return [4 /*yield*/, response.json()];
+                    case 8: return [2 /*return*/, (_d.value = _e.sent(),
+                            _d)];
+                    case 9: throw response;
+                }
+            });
+        });
+    };
+    /**
+     * Given a time period and the desired number of points, returns points which represent total worth of collection sales in the interval after that point.  The last point always has no value.
+     * Get historical data of collection volume (total sales worth) for charting purposes
+     */
+    ChartControllerApi.prototype.getVolumeChart = function (requestParameters) {
+        return __awaiter(this, void 0, void 0, function () {
+            var response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.getVolumeChartRaw(requestParameters)];
+                    case 1:
+                        response = _a.sent();
+                        if (response.status === 200) {
+                            return [2 /*return*/, response.value];
+                        }
+                        throw response;
+                }
+            });
+        });
+    };
     return ChartControllerApi;
 }(runtime.BaseAPI));
 exports.ChartControllerApi = ChartControllerApi;

build/models/Blockchain.d.ts

@@ -45,3 +45,4 @@ export declare enum Blockchain {
     GOAT = "GOAT",
-    HYPEREVM = "HYPEREVM"
+    HYPEREVM = "HYPEREVM",
+    HEDERA = "HEDERA"
 }

build/models/Blockchain.js

@@ -50,2 +50,3 @@ "use strict";
     Blockchain["HYPEREVM"] = "HYPEREVM";
+    Blockchain["HEDERA"] = "HEDERA";
 })(Blockchain = exports.Blockchain || (exports.Blockchain = {}));

build/models/BlockchainGroup.d.ts

@@ -6,3 +6,4 @@ export declare enum BlockchainGroup {
     TEZOS = "TEZOS",
-    SOLANA = "SOLANA"
+    SOLANA = "SOLANA",
+    HEDERA = "HEDERA"
 }

build/models/BlockchainGroup.js

@@ -11,2 +11,3 @@ "use strict";
     BlockchainGroup["SOLANA"] = "SOLANA";
+    BlockchainGroup["HEDERA"] = "HEDERA";
 })(BlockchainGroup = exports.BlockchainGroup || (exports.BlockchainGroup = {}));

build/models/Collection.d.ts

@@ -47,3 +47,4 @@ import { Blockchain } from "./Blockchain";
     IMMUTABLEX = "IMMUTABLEX",
-    APTOS = "APTOS"
+    APTOS = "APTOS",
+    HEDERA = "HEDERA"
 }
@@ -50,0 +51,0 @@ export declare enum CollectionStatus {

build/models/Collection.js

@@ -22,2 +22,3 @@ "use strict";
     CollectionType["APTOS"] = "APTOS";
+    CollectionType["HEDERA"] = "HEDERA";
 })(CollectionType = exports.CollectionType || (exports.CollectionType = {}));
@@ -24,0 +25,0 @@ var CollectionStatus;

build/models/OlapBlockchain.d.ts

@@ -45,3 +45,4 @@ export declare enum OlapBlockchain {
     GOAT = "GOAT",
-    HYPEREVM = "HYPEREVM"
+    HYPEREVM = "HYPEREVM",
+    HEDERA = "HEDERA"
 }

build/models/OlapBlockchain.js

@@ -50,2 +50,3 @@ "use strict";
     OlapBlockchain["HYPEREVM"] = "HYPEREVM";
+    OlapBlockchain["HEDERA"] = "HEDERA";
 })(OlapBlockchain = exports.OlapBlockchain || (exports.OlapBlockchain = {}));

package.json

 {
   "name": "@rarible/api-client",
-  "version": "1.123.0",
+  "version": "1.124.0",
   "keywords": [
@@ -5,0 +5,0 @@ "axios",

No alert changes

Improved metrics

Total package byte prevSize

740754

increased by1.06%

Lines of code

15823

increased by0.91%

No dependency changes