flexinet-api 0.0.416-prerelease0 → 0.0.428-prerelease0

package/dist/esm/api.js

@@ -159,6 +159,16 @@ export const ProgressState = {
     Active: 'active',
     Total: 'total'
 };
+/**
+ *
+ * @export
+ * @enum {string}
+ */
+export const PromotionSortByField = {
+    CreatedAt: 'createdAt',
+    StartsAt: 'startsAt',
+    EndsAt: 'endsAt'
+};
 /**
  *
  * @export
@@ -195,6 +205,15 @@ export const RuleGroupState = {
 export const RuleKind = {
     Tag: 'tag'
 };
+/**
+ *
+ * @export
+ * @enum {string}
+ */
+export const SortDirection = {
+    Asc: 'asc',
+    Desc: 'desc'
+};
 /**
  *
  * @export
@@ -3411,22 +3430,21 @@ export class ProductApi extends BaseAPI {
 export const ProgressApiAxiosParamCreator = function (configuration) {
     return {
         /**
-         * List all progress of a promotion
-         * @summary List promotion\'s progress
-         * @param {string} id Promotion ID
+         * List progress
+         * @summary List progress
+         * @param {Array<string>} promotionIDs Promotion ID to filter by
          * @param {number} [periodID] Period ID
-         * @param {string} [userID] User ID
-         * @param {string} [clientID] Client ID
+         * @param {Array<string>} [userIDs] User ID to filter by
+         * @param {Array<string>} [clientIDs] Client ID to filter by
          * @param {ListProgressIntervalEnum} [interval] Interval
          * @param {string} [nextToken] This is the pagination token
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listProgress: (id, periodID, userID, clientID, interval, nextToken, options = {}) => __awaiter(this, void 0, void 0, function* () {
-            // verify required parameter 'id' is not null or undefined
-            assertParamExists('listProgress', 'id', id);
-            const localVarPath = `/admins/promotions/{id}/progress`
-                .replace(`{${"id"}}`, encodeURIComponent(String(id)));
+        listProgress: (promotionIDs, periodID, userIDs, clientIDs, interval, nextToken, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'promotionIDs' is not null or undefined
+            assertParamExists('listProgress', 'promotionIDs', promotionIDs);
+            const localVarPath = `/admins/progress`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
             let baseOptions;
@@ -3439,14 +3457,17 @@ export const ProgressApiAxiosParamCreator = function (configuration) {
             // authentication jwt required
             // http bearer authentication required
             yield setBearerAuthToObject(localVarHeaderParameter, configuration);
+            if (promotionIDs) {
+                localVarQueryParameter['promotionIDs'] = promotionIDs;
+            }
             if (periodID !== undefined) {
                 localVarQueryParameter['periodID'] = periodID;
             }
-            if (userID !== undefined) {
-                localVarQueryParameter['userID'] = userID;
+            if (userIDs) {
+                localVarQueryParameter['userIDs'] = userIDs;
             }
-            if (clientID !== undefined) {
-                localVarQueryParameter['clientID'] = clientID;
+            if (clientIDs) {
+                localVarQueryParameter['clientIDs'] = clientIDs;
             }
             if (interval !== undefined) {
                 localVarQueryParameter['interval'] = interval;
@@ -3463,19 +3484,18 @@ export const ProgressApiAxiosParamCreator = function (configuration) {
             };
         }),
         /**
-         * List users progress of a promotion
-         * @summary List promotion\'s progress
-         * @param {string} id Promotion ID
+         * List users progress
+         * @summary List progress
+         * @param {Array<string>} promotionIDs Promotion ID to filter by
          * @param {number} [periodID] Period ID
          * @param {string} [nextToken] This is the pagination token
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listUserProgress: (id, periodID, nextToken, options = {}) => __awaiter(this, void 0, void 0, function* () {
-            // verify required parameter 'id' is not null or undefined
-            assertParamExists('listUserProgress', 'id', id);
-            const localVarPath = `/users/promotions/{id}/progress`
-                .replace(`{${"id"}}`, encodeURIComponent(String(id)));
+        listUserProgress: (promotionIDs, periodID, nextToken, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            // verify required parameter 'promotionIDs' is not null or undefined
+            assertParamExists('listUserProgress', 'promotionIDs', promotionIDs);
+            const localVarPath = `/users/progress`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
             let baseOptions;
@@ -3488,6 +3508,9 @@ export const ProgressApiAxiosParamCreator = function (configuration) {
             // authentication jwt required
             // http bearer authentication required
             yield setBearerAuthToObject(localVarHeaderParameter, configuration);
+            if (promotionIDs) {
+                localVarQueryParameter['promotionIDs'] = promotionIDs;
+            }
             if (periodID !== undefined) {
                 localVarQueryParameter['periodID'] = periodID;
             }
@@ -3512,35 +3535,35 @@ export const ProgressApiFp = function (configuration) {
     const localVarAxiosParamCreator = ProgressApiAxiosParamCreator(configuration);
     return {
         /**
-         * List all progress of a promotion
-         * @summary List promotion\'s progress
-         * @param {string} id Promotion ID
+         * List progress
+         * @summary List progress
+         * @param {Array<string>} promotionIDs Promotion ID to filter by
          * @param {number} [periodID] Period ID
-         * @param {string} [userID] User ID
-         * @param {string} [clientID] Client ID
+         * @param {Array<string>} [userIDs] User ID to filter by
+         * @param {Array<string>} [clientIDs] Client ID to filter by
          * @param {ListProgressIntervalEnum} [interval] Interval
          * @param {string} [nextToken] This is the pagination token
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listProgress(id, periodID, userID, clientID, interval, nextToken, options) {
+        listProgress(promotionIDs, periodID, userIDs, clientIDs, interval, nextToken, options) {
             return __awaiter(this, void 0, void 0, function* () {
-                const localVarAxiosArgs = yield localVarAxiosParamCreator.listProgress(id, periodID, userID, clientID, interval, nextToken, options);
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.listProgress(promotionIDs, periodID, userIDs, clientIDs, interval, nextToken, options);
                 return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
             });
         },
         /**
-         * List users progress of a promotion
-         * @summary List promotion\'s progress
-         * @param {string} id Promotion ID
+         * List users progress
+         * @summary List progress
+         * @param {Array<string>} promotionIDs Promotion ID to filter by
          * @param {number} [periodID] Period ID
          * @param {string} [nextToken] This is the pagination token
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listUserProgress(id, periodID, nextToken, options) {
+        listUserProgress(promotionIDs, periodID, nextToken, options) {
             return __awaiter(this, void 0, void 0, function* () {
-                const localVarAxiosArgs = yield localVarAxiosParamCreator.listUserProgress(id, periodID, nextToken, options);
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.listUserProgress(promotionIDs, periodID, nextToken, options);
                 return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
             });
         },
@@ -3554,31 +3577,31 @@ export const ProgressApiFactory = function (configuration, basePath, axios) {
     const localVarFp = ProgressApiFp(configuration);
     return {
         /**
-         * List all progress of a promotion
-         * @summary List promotion\'s progress
-         * @param {string} id Promotion ID
+         * List progress
+         * @summary List progress
+         * @param {Array<string>} promotionIDs Promotion ID to filter by
          * @param {number} [periodID] Period ID
-         * @param {string} [userID] User ID
-         * @param {string} [clientID] Client ID
+         * @param {Array<string>} [userIDs] User ID to filter by
+         * @param {Array<string>} [clientIDs] Client ID to filter by
          * @param {ListProgressIntervalEnum} [interval] Interval
          * @param {string} [nextToken] This is the pagination token
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listProgress(id, periodID, userID, clientID, interval, nextToken, options) {
-            return localVarFp.listProgress(id, periodID, userID, clientID, interval, nextToken, options).then((request) => request(axios, basePath));
+        listProgress(promotionIDs, periodID, userIDs, clientIDs, interval, nextToken, options) {
+            return localVarFp.listProgress(promotionIDs, periodID, userIDs, clientIDs, interval, nextToken, options).then((request) => request(axios, basePath));
         },
         /**
-         * List users progress of a promotion
-         * @summary List promotion\'s progress
-         * @param {string} id Promotion ID
+         * List users progress
+         * @summary List progress
+         * @param {Array<string>} promotionIDs Promotion ID to filter by
          * @param {number} [periodID] Period ID
          * @param {string} [nextToken] This is the pagination token
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listUserProgress(id, periodID, nextToken, options) {
-            return localVarFp.listUserProgress(id, periodID, nextToken, options).then((request) => request(axios, basePath));
+        listUserProgress(promotionIDs, periodID, nextToken, options) {
+            return localVarFp.listUserProgress(promotionIDs, periodID, nextToken, options).then((request) => request(axios, basePath));
         },
     };
 };
@@ -3590,33 +3613,33 @@ export const ProgressApiFactory = function (configuration, basePath, axios) {
  */
 export class ProgressApi extends BaseAPI {
     /**
-     * List all progress of a promotion
-     * @summary List promotion\'s progress
-     * @param {string} id Promotion ID
+     * List progress
+     * @summary List progress
+     * @param {Array<string>} promotionIDs Promotion ID to filter by
      * @param {number} [periodID] Period ID
-     * @param {string} [userID] User ID
-     * @param {string} [clientID] Client ID
+     * @param {Array<string>} [userIDs] User ID to filter by
+     * @param {Array<string>} [clientIDs] Client ID to filter by
      * @param {ListProgressIntervalEnum} [interval] Interval
      * @param {string} [nextToken] This is the pagination token
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof ProgressApi
      */
-    listProgress(id, periodID, userID, clientID, interval, nextToken, options) {
-        return ProgressApiFp(this.configuration).listProgress(id, periodID, userID, clientID, interval, nextToken, options).then((request) => request(this.axios, this.basePath));
+    listProgress(promotionIDs, periodID, userIDs, clientIDs, interval, nextToken, options) {
+        return ProgressApiFp(this.configuration).listProgress(promotionIDs, periodID, userIDs, clientIDs, interval, nextToken, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * List users progress of a promotion
-     * @summary List promotion\'s progress
-     * @param {string} id Promotion ID
+     * List users progress
+     * @summary List progress
+     * @param {Array<string>} promotionIDs Promotion ID to filter by
      * @param {number} [periodID] Period ID
      * @param {string} [nextToken] This is the pagination token
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof ProgressApi
      */
-    listUserProgress(id, periodID, nextToken, options) {
-        return ProgressApiFp(this.configuration).listUserProgress(id, periodID, nextToken, options).then((request) => request(this.axios, this.basePath));
+    listUserProgress(promotionIDs, periodID, nextToken, options) {
+        return ProgressApiFp(this.configuration).listUserProgress(promotionIDs, periodID, nextToken, options).then((request) => request(this.axios, this.basePath));
     }
 }
 /**
@@ -3932,10 +3955,12 @@ export const PromotionApiAxiosParamCreator = function (configuration) {
          * @param {string} [endingAfter] end time after time
          * @param {Array<string>} [clientIDs] client ID to filter by
          * @param {string} [search] search by name or description
+         * @param {PromotionSortByField} [sortBy] sort by field
+         * @param {SortDirection} [sortDirection] sort direction
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listPromotions: (nextToken, tags, segmentId, ownerID, type, startingAfter, endingBefore, startingBefore, endingAfter, clientIDs, search, options = {}) => __awaiter(this, void 0, void 0, function* () {
+        listPromotions: (nextToken, tags, segmentId, ownerID, type, startingAfter, endingBefore, startingBefore, endingAfter, clientIDs, search, sortBy, sortDirection, options = {}) => __awaiter(this, void 0, void 0, function* () {
             const localVarPath = `/admins/promotions`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -3990,6 +4015,12 @@ export const PromotionApiAxiosParamCreator = function (configuration) {
             if (search !== undefined) {
                 localVarQueryParameter['search'] = search;
             }
+            if (sortBy !== undefined) {
+                localVarQueryParameter['sortBy'] = sortBy;
+            }
+            if (sortDirection !== undefined) {
+                localVarQueryParameter['sortDirection'] = sortDirection;
+            }
             setSearchParams(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
@@ -4008,10 +4039,12 @@ export const PromotionApiAxiosParamCreator = function (configuration) {
          * @param {string} [startingBefore] start time before time
          * @param {string} [endingAfter] end time after time
          * @param {string} [search] search by name or description
+         * @param {PromotionSortByField} [sortBy] sort by field
+         * @param {SortDirection} [sortDirection] sort direction
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listUserPromotions: (nextToken, tags, startingAfter, endingBefore, startingBefore, endingAfter, search, options = {}) => __awaiter(this, void 0, void 0, function* () {
+        listUserPromotions: (nextToken, tags, startingAfter, endingBefore, startingBefore, endingAfter, search, sortBy, sortDirection, options = {}) => __awaiter(this, void 0, void 0, function* () {
             const localVarPath = `/users/promotions`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -4054,6 +4087,12 @@ export const PromotionApiAxiosParamCreator = function (configuration) {
             if (search !== undefined) {
                 localVarQueryParameter['search'] = search;
             }
+            if (sortBy !== undefined) {
+                localVarQueryParameter['sortBy'] = sortBy;
+            }
+            if (sortDirection !== undefined) {
+                localVarQueryParameter['sortDirection'] = sortDirection;
+            }
             setSearchParams(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
@@ -4241,12 +4280,14 @@ export const PromotionApiFp = function (configuration) {
          * @param {string} [endingAfter] end time after time
          * @param {Array<string>} [clientIDs] client ID to filter by
          * @param {string} [search] search by name or description
+         * @param {PromotionSortByField} [sortBy] sort by field
+         * @param {SortDirection} [sortDirection] sort direction
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listPromotions(nextToken, tags, segmentId, ownerID, type, startingAfter, endingBefore, startingBefore, endingAfter, clientIDs, search, options) {
+        listPromotions(nextToken, tags, segmentId, ownerID, type, startingAfter, endingBefore, startingBefore, endingAfter, clientIDs, search, sortBy, sortDirection, options) {
             return __awaiter(this, void 0, void 0, function* () {
-                const localVarAxiosArgs = yield localVarAxiosParamCreator.listPromotions(nextToken, tags, segmentId, ownerID, type, startingAfter, endingBefore, startingBefore, endingAfter, clientIDs, search, options);
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.listPromotions(nextToken, tags, segmentId, ownerID, type, startingAfter, endingBefore, startingBefore, endingAfter, clientIDs, search, sortBy, sortDirection, options);
                 return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
             });
         },
@@ -4260,12 +4301,14 @@ export const PromotionApiFp = function (configuration) {
          * @param {string} [startingBefore] start time before time
          * @param {string} [endingAfter] end time after time
          * @param {string} [search] search by name or description
+         * @param {PromotionSortByField} [sortBy] sort by field
+         * @param {SortDirection} [sortDirection] sort direction
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listUserPromotions(nextToken, tags, startingAfter, endingBefore, startingBefore, endingAfter, search, options) {
+        listUserPromotions(nextToken, tags, startingAfter, endingBefore, startingBefore, endingAfter, search, sortBy, sortDirection, options) {
             return __awaiter(this, void 0, void 0, function* () {
-                const localVarAxiosArgs = yield localVarAxiosParamCreator.listUserPromotions(nextToken, tags, startingAfter, endingBefore, startingBefore, endingAfter, search, options);
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.listUserPromotions(nextToken, tags, startingAfter, endingBefore, startingBefore, endingAfter, search, sortBy, sortDirection, options);
                 return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
             });
         },
@@ -4398,11 +4441,13 @@ export const PromotionApiFactory = function (configuration, basePath, axios) {
          * @param {string} [endingAfter] end time after time
          * @param {Array<string>} [clientIDs] client ID to filter by
          * @param {string} [search] search by name or description
+         * @param {PromotionSortByField} [sortBy] sort by field
+         * @param {SortDirection} [sortDirection] sort direction
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listPromotions(nextToken, tags, segmentId, ownerID, type, startingAfter, endingBefore, startingBefore, endingAfter, clientIDs, search, options) {
-            return localVarFp.listPromotions(nextToken, tags, segmentId, ownerID, type, startingAfter, endingBefore, startingBefore, endingAfter, clientIDs, search, options).then((request) => request(axios, basePath));
+        listPromotions(nextToken, tags, segmentId, ownerID, type, startingAfter, endingBefore, startingBefore, endingAfter, clientIDs, search, sortBy, sortDirection, options) {
+            return localVarFp.listPromotions(nextToken, tags, segmentId, ownerID, type, startingAfter, endingBefore, startingBefore, endingAfter, clientIDs, search, sortBy, sortDirection, options).then((request) => request(axios, basePath));
         },
         /**
          * List users promotions
@@ -4414,11 +4459,13 @@ export const PromotionApiFactory = function (configuration, basePath, axios) {
          * @param {string} [startingBefore] start time before time
          * @param {string} [endingAfter] end time after time
          * @param {string} [search] search by name or description
+         * @param {PromotionSortByField} [sortBy] sort by field
+         * @param {SortDirection} [sortDirection] sort direction
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listUserPromotions(nextToken, tags, startingAfter, endingBefore, startingBefore, endingAfter, search, options) {
-            return localVarFp.listUserPromotions(nextToken, tags, startingAfter, endingBefore, startingBefore, endingAfter, search, options).then((request) => request(axios, basePath));
+        listUserPromotions(nextToken, tags, startingAfter, endingBefore, startingBefore, endingAfter, search, sortBy, sortDirection, options) {
+            return localVarFp.listUserPromotions(nextToken, tags, startingAfter, endingBefore, startingBefore, endingAfter, search, sortBy, sortDirection, options).then((request) => request(axios, basePath));
         },
         /**
          * Update promotion by id
@@ -4555,12 +4602,14 @@ export class PromotionApi extends BaseAPI {
      * @param {string} [endingAfter] end time after time
      * @param {Array<string>} [clientIDs] client ID to filter by
      * @param {string} [search] search by name or description
+     * @param {PromotionSortByField} [sortBy] sort by field
+     * @param {SortDirection} [sortDirection] sort direction
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof PromotionApi
      */
-    listPromotions(nextToken, tags, segmentId, ownerID, type, startingAfter, endingBefore, startingBefore, endingAfter, clientIDs, search, options) {
-        return PromotionApiFp(this.configuration).listPromotions(nextToken, tags, segmentId, ownerID, type, startingAfter, endingBefore, startingBefore, endingAfter, clientIDs, search, options).then((request) => request(this.axios, this.basePath));
+    listPromotions(nextToken, tags, segmentId, ownerID, type, startingAfter, endingBefore, startingBefore, endingAfter, clientIDs, search, sortBy, sortDirection, options) {
+        return PromotionApiFp(this.configuration).listPromotions(nextToken, tags, segmentId, ownerID, type, startingAfter, endingBefore, startingBefore, endingAfter, clientIDs, search, sortBy, sortDirection, options).then((request) => request(this.axios, this.basePath));
     }
     /**
      * List users promotions
@@ -4572,12 +4621,14 @@ export class PromotionApi extends BaseAPI {
      * @param {string} [startingBefore] start time before time
      * @param {string} [endingAfter] end time after time
      * @param {string} [search] search by name or description
+     * @param {PromotionSortByField} [sortBy] sort by field
+     * @param {SortDirection} [sortDirection] sort direction
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof PromotionApi
      */
-    listUserPromotions(nextToken, tags, startingAfter, endingBefore, startingBefore, endingAfter, search, options) {
-        return PromotionApiFp(this.configuration).listUserPromotions(nextToken, tags, startingAfter, endingBefore, startingBefore, endingAfter, search, options).then((request) => request(this.axios, this.basePath));
+    listUserPromotions(nextToken, tags, startingAfter, endingBefore, startingBefore, endingAfter, search, sortBy, sortDirection, options) {
+        return PromotionApiFp(this.configuration).listUserPromotions(nextToken, tags, startingAfter, endingBefore, startingBefore, endingAfter, search, sortBy, sortDirection, options).then((request) => request(this.axios, this.basePath));
     }
     /**
      * Update promotion by id

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "flexinet-api",
-  "version": "0.0.416-prerelease0",
+  "version": "0.0.428-prerelease0",
   "description": "OpenAPI client for flexinet-api",
   "author": "OpenAPI-Generator Contributors",
   "repository": {