@randock/nameshift-api-client 0.0.448 → 0.0.450

package/dist/apis/NotificationsApi.js

@@ -76,14 +76,14 @@ var NotificationsApi = /** @class */ (function (_super) {
         return _super !== null && _super.apply(this, arguments) || this;
     }
     /**
-     * Marks multiple seller notifications as read or unread based on the readStatus parameter.
+     * Marks multiple seller notifications as read or unread based on the readStatus parameter.  **API key scope required:** `NOTIFICATIONS_WRITE`. Requests authenticated with a seller session do not need any scope.
      * Bulk mark notifications as read or unread
      */
     NotificationsApi.prototype.bulkMarkNotificationsAsReadRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
-            var queryParameters, headerParameters, token, tokenString, response;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
+            var queryParameters, headerParameters, _a, _b, token, tokenString, response;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
                     case 0:
                         if (requestParameters['bulkMarkNotificationsAsReadInputDto'] == null) {
                             throw new runtime.RequiredError('bulkMarkNotificationsAsReadInputDto', 'Required parameter "bulkMarkNotificationsAsReadInputDto" was null or undefined when calling bulkMarkNotificationsAsRead().');
@@ -91,31 +91,39 @@ var NotificationsApi = /** @class */ (function (_super) {
                         queryParameters = {};
                         headerParameters = {};
                         headerParameters['Content-Type'] = 'application/json';
-                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        if (!(this.configuration && this.configuration.apiKey)) return [3 /*break*/, 2];
+                        _a = headerParameters;
+                        _b = "apikey";
+                        return [4 /*yield*/, this.configuration.apiKey("apikey")];
+                    case 1:
+                        _a[_b] = _c.sent(); // api_key authentication
+                        _c.label = 2;
+                    case 2:
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 4];
                         token = this.configuration.accessToken;
                         return [4 /*yield*/, token("bearer", [])];
-                    case 1:
-                        tokenString = _a.sent();
+                    case 3:
+                        tokenString = _c.sent();
                         if (tokenString) {
                             headerParameters["Authorization"] = "Bearer ".concat(tokenString);
                         }
-                        _a.label = 2;
-                    case 2: return [4 /*yield*/, this.request({
+                        _c.label = 4;
+                    case 4: return [4 /*yield*/, this.request({
                             path: "/private/notifications/bulk-mark-as-read",
                             method: 'PATCH',
                             headers: headerParameters,
                             query: queryParameters,
                             body: (0, index_1.BulkMarkNotificationsAsReadInputDtoToJSON)(requestParameters['bulkMarkNotificationsAsReadInputDto']),
                         }, initOverrides)];
-                    case 3:
-                        response = _a.sent();
+                    case 5:
+                        response = _c.sent();
                         return [2 /*return*/, new runtime.VoidApiResponse(response)];
                 }
             });
         });
     };
     /**
-     * Marks multiple seller notifications as read or unread based on the readStatus parameter.
+     * Marks multiple seller notifications as read or unread based on the readStatus parameter.  **API key scope required:** `NOTIFICATIONS_WRITE`. Requests authenticated with a seller session do not need any scope.
      * Bulk mark notifications as read or unread
      */
     NotificationsApi.prototype.bulkMarkNotificationsAsRead = function (requestParameters, initOverrides) {
@@ -131,14 +139,14 @@ var NotificationsApi = /** @class */ (function (_super) {
         });
     };
     /**
-     * Downloads a file attachment from a seller notification.
+     * Downloads a file attachment from a seller notification.  **API key scope required:** `NOTIFICATIONS_READ`. Requests authenticated with a seller session do not need any scope.
      * Download notification attachment
      */
     NotificationsApi.prototype.downloadNotificationAttachmentRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
-            var queryParameters, headerParameters, token, tokenString, response;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
+            var queryParameters, headerParameters, _a, _b, token, tokenString, response;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
                     case 0:
                         if (requestParameters['notificationId'] == null) {
                             throw new runtime.RequiredError('notificationId', 'Required parameter "notificationId" was null or undefined when calling downloadNotificationAttachment().');
@@ -148,30 +156,38 @@ var NotificationsApi = /** @class */ (function (_super) {
                         }
                         queryParameters = {};
                         headerParameters = {};
-                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        if (!(this.configuration && this.configuration.apiKey)) return [3 /*break*/, 2];
+                        _a = headerParameters;
+                        _b = "apikey";
+                        return [4 /*yield*/, this.configuration.apiKey("apikey")];
+                    case 1:
+                        _a[_b] = _c.sent(); // api_key authentication
+                        _c.label = 2;
+                    case 2:
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 4];
                         token = this.configuration.accessToken;
                         return [4 /*yield*/, token("bearer", [])];
-                    case 1:
-                        tokenString = _a.sent();
+                    case 3:
+                        tokenString = _c.sent();
                         if (tokenString) {
                             headerParameters["Authorization"] = "Bearer ".concat(tokenString);
                         }
-                        _a.label = 2;
-                    case 2: return [4 /*yield*/, this.request({
+                        _c.label = 4;
+                    case 4: return [4 /*yield*/, this.request({
                             path: "/private/notifications/{notificationId}/attachments/{attachmentId}/download".replace("{".concat("notificationId", "}"), encodeURIComponent(String(requestParameters['notificationId']))).replace("{".concat("attachmentId", "}"), encodeURIComponent(String(requestParameters['attachmentId']))),
                             method: 'GET',
                             headers: headerParameters,
                             query: queryParameters,
                         }, initOverrides)];
-                    case 3:
-                        response = _a.sent();
+                    case 5:
+                        response = _c.sent();
                         return [2 /*return*/, new runtime.BlobApiResponse(response)];
                 }
             });
         });
     };
     /**
-     * Downloads a file attachment from a seller notification.
+     * Downloads a file attachment from a seller notification.  **API key scope required:** `NOTIFICATIONS_READ`. Requests authenticated with a seller session do not need any scope.
      * Download notification attachment
      */
     NotificationsApi.prototype.downloadNotificationAttachment = function (requestParameters, initOverrides) {
@@ -189,44 +205,52 @@ var NotificationsApi = /** @class */ (function (_super) {
         });
     };
     /**
-     * Returns notification information for the seller user.
+     * Returns notification information for the seller user.  **API key scope required:** `NOTIFICATIONS_READ`. Requests authenticated with a seller session do not need any scope.
      * Get notification details
      */
     NotificationsApi.prototype.getNotificationByIdRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
-            var queryParameters, headerParameters, token, tokenString, response;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
+            var queryParameters, headerParameters, _a, _b, token, tokenString, response;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
                     case 0:
                         if (requestParameters['notificationId'] == null) {
                             throw new runtime.RequiredError('notificationId', 'Required parameter "notificationId" was null or undefined when calling getNotificationById().');
                         }
                         queryParameters = {};
                         headerParameters = {};
-                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        if (!(this.configuration && this.configuration.apiKey)) return [3 /*break*/, 2];
+                        _a = headerParameters;
+                        _b = "apikey";
+                        return [4 /*yield*/, this.configuration.apiKey("apikey")];
+                    case 1:
+                        _a[_b] = _c.sent(); // api_key authentication
+                        _c.label = 2;
+                    case 2:
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 4];
                         token = this.configuration.accessToken;
                         return [4 /*yield*/, token("bearer", [])];
-                    case 1:
-                        tokenString = _a.sent();
+                    case 3:
+                        tokenString = _c.sent();
                         if (tokenString) {
                             headerParameters["Authorization"] = "Bearer ".concat(tokenString);
                         }
-                        _a.label = 2;
-                    case 2: return [4 /*yield*/, this.request({
+                        _c.label = 4;
+                    case 4: return [4 /*yield*/, this.request({
                             path: "/private/notifications/{notificationId}".replace("{".concat("notificationId", "}"), encodeURIComponent(String(requestParameters['notificationId']))),
                             method: 'GET',
                             headers: headerParameters,
                             query: queryParameters,
                         }, initOverrides)];
-                    case 3:
-                        response = _a.sent();
+                    case 5:
+                        response = _c.sent();
                         return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.UserNotificationDtoFromJSON)(jsonValue); })];
                 }
             });
         });
     };
     /**
-     * Returns notification information for the seller user.
+     * Returns notification information for the seller user.  **API key scope required:** `NOTIFICATIONS_READ`. Requests authenticated with a seller session do not need any scope.
      * Get notification details
      */
     NotificationsApi.prototype.getNotificationById = function (requestParameters, initOverrides) {
@@ -244,14 +268,14 @@ var NotificationsApi = /** @class */ (function (_super) {
         });
     };
     /**
-     * Lists notifications for the seller user.
+     * Lists notifications for the seller user.  **API key scope required:** `NOTIFICATIONS_READ`. Requests authenticated with a seller session do not need any scope.
      * List seller notifications
      */
     NotificationsApi.prototype.listNotificationsRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
-            var queryParameters, headerParameters, token, tokenString, response;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
+            var queryParameters, headerParameters, _a, _b, token, tokenString, response;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
                     case 0:
                         queryParameters = {};
                         if (requestParameters['filter'] != null) {
@@ -273,30 +297,38 @@ var NotificationsApi = /** @class */ (function (_super) {
                             queryParameters['filter[type]'] = requestParameters['filterType'];
                         }
                         headerParameters = {};
-                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        if (!(this.configuration && this.configuration.apiKey)) return [3 /*break*/, 2];
+                        _a = headerParameters;
+                        _b = "apikey";
+                        return [4 /*yield*/, this.configuration.apiKey("apikey")];
+                    case 1:
+                        _a[_b] = _c.sent(); // api_key authentication
+                        _c.label = 2;
+                    case 2:
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 4];
                         token = this.configuration.accessToken;
                         return [4 /*yield*/, token("bearer", [])];
-                    case 1:
-                        tokenString = _a.sent();
+                    case 3:
+                        tokenString = _c.sent();
                         if (tokenString) {
                             headerParameters["Authorization"] = "Bearer ".concat(tokenString);
                         }
-                        _a.label = 2;
-                    case 2: return [4 /*yield*/, this.request({
+                        _c.label = 4;
+                    case 4: return [4 /*yield*/, this.request({
                             path: "/private/notifications",
                             method: 'GET',
                             headers: headerParameters,
                             query: queryParameters,
                         }, initOverrides)];
-                    case 3:
-                        response = _a.sent();
+                    case 5:
+                        response = _c.sent();
                         return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, index_1.ListNotifications200ResponseFromJSON)(jsonValue); })];
                 }
             });
         });
     };
     /**
-     * Lists notifications for the seller user.
+     * Lists notifications for the seller user.  **API key scope required:** `NOTIFICATIONS_READ`. Requests authenticated with a seller session do not need any scope.
      * List seller notifications
      */
     NotificationsApi.prototype.listNotifications = function () {

package/dist/apis/StatsApi.d.ts

@@ -29,72 +29,72 @@ export interface StatsApiGetTotalEarningsByCurrencyOverTimeRequest {
  */
 export declare class StatsApi extends runtime.BaseAPI {
     /**
-     * Returns the total pending payout amounts grouped by currency for the seller.
+     * Returns the total pending payout amounts grouped by currency for the seller.  **API key scope required:** `STATS_READ`. Requests authenticated with a seller session do not need any scope.
      * Get pending payouts by currency
      */
     getPendingPayoutsByCurrencyRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<SellerPendingPayoutsByCurrencyStatsItemDto>>>;
     /**
-     * Returns the total pending payout amounts grouped by currency for the seller.
+     * Returns the total pending payout amounts grouped by currency for the seller.  **API key scope required:** `STATS_READ`. Requests authenticated with a seller session do not need any scope.
      * Get pending payouts by currency
      */
     getPendingPayoutsByCurrency(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<SellerPendingPayoutsByCurrencyStatsItemDto>>;
     /**
-     * Returns remaining versus total lease-to-own income grouped by currency for the seller.
+     * Returns remaining versus total lease-to-own income grouped by currency for the seller.  **API key scope required:** `STATS_READ`. Requests authenticated with a seller session do not need any scope.
      * Get lease-to-own income comparison
      */
     getRemainingVsTotalLeaseToOwnByCurrencyRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<SellerRemainingAndTotalLeaseToOwnByCurrencyStatsItemDto>>>;
     /**
-     * Returns remaining versus total lease-to-own income grouped by currency for the seller.
+     * Returns remaining versus total lease-to-own income grouped by currency for the seller.  **API key scope required:** `STATS_READ`. Requests authenticated with a seller session do not need any scope.
      * Get lease-to-own income comparison
      */
     getRemainingVsTotalLeaseToOwnByCurrency(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<SellerRemainingAndTotalLeaseToOwnByCurrencyStatsItemDto>>;
     /**
-     * Returns sales statistics grouped by top-level domain for the seller within the specified date range and currency.
+     * Returns sales statistics grouped by top-level domain for the seller within the specified date range and currency.  **API key scope required:** `STATS_READ`. Requests authenticated with a seller session do not need any scope.
      * Get sales by TLD
      */
     getSalesByTldRaw(requestParameters: StatsApiGetSalesByTldRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<SellerSalesByTldStatsItemDto>>>;
     /**
-     * Returns sales statistics grouped by top-level domain for the seller within the specified date range and currency.
+     * Returns sales statistics grouped by top-level domain for the seller within the specified date range and currency.  **API key scope required:** `STATS_READ`. Requests authenticated with a seller session do not need any scope.
      * Get sales by TLD
      */
     getSalesByTld(requestParameters: StatsApiGetSalesByTldRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<SellerSalesByTldStatsItemDto>>;
     /**
-     * Returns the number of sales for the current seller account within the specified date range.
+     * Returns the number of sales for the current seller account within the specified date range.  **API key scope required:** `STATS_READ`. Requests authenticated with a seller session do not need any scope.
      * Get sales count stats
      */
     getSalesCountRaw(requestParameters: StatsApiGetSalesCountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<SellerSalesCountStatsItemDto>>>;
     /**
-     * Returns the number of sales for the current seller account within the specified date range.
+     * Returns the number of sales for the current seller account within the specified date range.  **API key scope required:** `STATS_READ`. Requests authenticated with a seller session do not need any scope.
      * Get sales count stats
      */
     getSalesCount(requestParameters?: StatsApiGetSalesCountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<SellerSalesCountStatsItemDto>>;
     /**
-     * Returns total earnings grouped by currency for the seller, optionally filtered by date range.
+     * Returns total earnings grouped by currency for the seller, optionally filtered by date range.  **API key scope required:** `STATS_READ`. Requests authenticated with a seller session do not need any scope.
      * Get total earnings by currency
      */
     getTotalEarningsByCurrencyRaw(requestParameters: StatsApiGetTotalEarningsByCurrencyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<SellerTotalEarningsByCurrencyStatsItemDto>>>;
     /**
-     * Returns total earnings grouped by currency for the seller, optionally filtered by date range.
+     * Returns total earnings grouped by currency for the seller, optionally filtered by date range.  **API key scope required:** `STATS_READ`. Requests authenticated with a seller session do not need any scope.
      * Get total earnings by currency
      */
     getTotalEarningsByCurrency(requestParameters?: StatsApiGetTotalEarningsByCurrencyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<SellerTotalEarningsByCurrencyStatsItemDto>>;
     /**
-     * Returns total earnings over time grouped by currency for the seller within the specified date range.
+     * Returns total earnings over time grouped by currency for the seller within the specified date range.  **API key scope required:** `STATS_READ`. Requests authenticated with a seller session do not need any scope.
      * Get earnings over time by currency
      */
     getTotalEarningsByCurrencyOverTimeRaw(requestParameters: StatsApiGetTotalEarningsByCurrencyOverTimeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<SellerTotalEarningsByCurrencyOverTimeStatsItemDto>>>;
     /**
-     * Returns total earnings over time grouped by currency for the seller within the specified date range.
+     * Returns total earnings over time grouped by currency for the seller within the specified date range.  **API key scope required:** `STATS_READ`. Requests authenticated with a seller session do not need any scope.
      * Get earnings over time by currency
      */
     getTotalEarningsByCurrencyOverTime(requestParameters?: StatsApiGetTotalEarningsByCurrencyOverTimeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<SellerTotalEarningsByCurrencyOverTimeStatsItemDto>>;
     /**
-     * Returns the total monthly rent income grouped by currency for the seller.
+     * Returns the total monthly rent income grouped by currency for the seller.  **API key scope required:** `STATS_READ`. Requests authenticated with a seller session do not need any scope.
      * Get monthly rent income by currency
      */
     getTotalMonthlyRentIncomeByCurrencyRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<SellerTotalRentMonthlyIncomeByCurrencyStatsItemDto>>>;
     /**
-     * Returns the total monthly rent income grouped by currency for the seller.
+     * Returns the total monthly rent income grouped by currency for the seller.  **API key scope required:** `STATS_READ`. Requests authenticated with a seller session do not need any scope.
      * Get monthly rent income by currency
      */
     getTotalMonthlyRentIncomeByCurrency(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<SellerTotalRentMonthlyIncomeByCurrencyStatsItemDto>>;