flexinet-api 0.0.416-prerelease0 → 0.0.428-prerelease0

package/dist/esm/api.d.ts

@@ -1838,6 +1838,17 @@ export interface PromotionRequest {
      */
     'endAt': string;
 }
+/**
+ *
+ * @export
+ * @enum {string}
+ */
+export declare const PromotionSortByField: {
+    readonly CreatedAt: "createdAt";
+    readonly StartsAt: "startsAt";
+    readonly EndsAt: "endsAt";
+};
+export type PromotionSortByField = typeof PromotionSortByField[keyof typeof PromotionSortByField];
 /**
  *
  * @export
@@ -2041,6 +2052,16 @@ export interface SegmentListResponse {
      */
     'hasMore': boolean;
 }
+/**
+ *
+ * @export
+ * @enum {string}
+ */
+export declare const SortDirection: {
+    readonly Asc: "asc";
+    readonly Desc: "desc";
+};
+export type SortDirection = typeof SortDirection[keyof typeof SortDirection];
 /**
  *
  * @export
@@ -4676,28 +4697,28 @@ export declare class ProductApi extends BaseAPI {
  */
 export declare const ProgressApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
-     * 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: string, periodID?: number, userID?: string, clientID?: string, interval?: ListProgressIntervalEnum, nextToken?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    listProgress: (promotionIDs: Array<string>, periodID?: number, userIDs?: Array<string>, clientIDs?: Array<string>, interval?: ListProgressIntervalEnum, nextToken?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * 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: string, periodID?: number, nextToken?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    listUserProgress: (promotionIDs: Array<string>, periodID?: number, nextToken?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * ProgressApi - functional programming interface
@@ -4705,28 +4726,28 @@ export declare const ProgressApiAxiosParamCreator: (configuration?: Configuratio
  */
 export declare const ProgressApiFp: (configuration?: Configuration) => {
     /**
-     * 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: string, periodID?: number, userID?: string, clientID?: string, interval?: ListProgressIntervalEnum, nextToken?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgressResponse>>;
+    listProgress(promotionIDs: Array<string>, periodID?: number, userIDs?: Array<string>, clientIDs?: Array<string>, interval?: ListProgressIntervalEnum, nextToken?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgressResponse>>;
     /**
-     * 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: string, periodID?: number, nextToken?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgressResponse>>;
+    listUserProgress(promotionIDs: Array<string>, periodID?: number, nextToken?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgressResponse>>;
 };
 /**
  * ProgressApi - factory interface
@@ -4734,28 +4755,28 @@ export declare const ProgressApiFp: (configuration?: Configuration) => {
  */
 export declare const ProgressApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
-     * 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: string, periodID?: number, userID?: string, clientID?: string, interval?: ListProgressIntervalEnum, nextToken?: string, options?: any): AxiosPromise<ProgressResponse>;
+    listProgress(promotionIDs: Array<string>, periodID?: number, userIDs?: Array<string>, clientIDs?: Array<string>, interval?: ListProgressIntervalEnum, nextToken?: string, options?: any): AxiosPromise<ProgressResponse>;
     /**
-     * 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: string, periodID?: number, nextToken?: string, options?: any): AxiosPromise<ProgressResponse>;
+    listUserProgress(promotionIDs: Array<string>, periodID?: number, nextToken?: string, options?: any): AxiosPromise<ProgressResponse>;
 };
 /**
  * ProgressApi - object-oriented interface
@@ -4765,30 +4786,30 @@ export declare const ProgressApiFactory: (configuration?: Configuration, basePat
  */
 export declare 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: string, periodID?: number, userID?: string, clientID?: string, interval?: ListProgressIntervalEnum, nextToken?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgressResponse, any>>;
+    listProgress(promotionIDs: Array<string>, periodID?: number, userIDs?: Array<string>, clientIDs?: Array<string>, interval?: ListProgressIntervalEnum, nextToken?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgressResponse, any>>;
     /**
-     * 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: string, periodID?: number, nextToken?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgressResponse, any>>;
+    listUserProgress(promotionIDs: Array<string>, periodID?: number, nextToken?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgressResponse, any>>;
 }
 /**
  * @export
@@ -4893,10 +4914,12 @@ export declare const PromotionApiAxiosParamCreator: (configuration?: Configurati
      * @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?: string, tags?: string, segmentId?: string, ownerID?: string, type?: PromotionType, startingAfter?: string, endingBefore?: string, startingBefore?: string, endingAfter?: string, clientIDs?: Array<string>, search?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    listPromotions: (nextToken?: string, tags?: string, segmentId?: string, ownerID?: string, type?: PromotionType, startingAfter?: string, endingBefore?: string, startingBefore?: string, endingAfter?: string, clientIDs?: Array<string>, search?: string, sortBy?: PromotionSortByField, sortDirection?: SortDirection, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * List users promotions
      * @summary List promotions
@@ -4907,10 +4930,12 @@ export declare const PromotionApiAxiosParamCreator: (configuration?: Configurati
      * @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?: string, tags?: string, startingAfter?: string, endingBefore?: string, startingBefore?: string, endingAfter?: string, search?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    listUserPromotions: (nextToken?: string, tags?: string, startingAfter?: string, endingBefore?: string, startingBefore?: string, endingAfter?: string, search?: string, sortBy?: PromotionSortByField, sortDirection?: SortDirection, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Update promotion by id
      * @summary Update promotion
@@ -5014,10 +5039,12 @@ export declare const PromotionApiFp: (configuration?: 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?: string, tags?: string, segmentId?: string, ownerID?: string, type?: PromotionType, startingAfter?: string, endingBefore?: string, startingBefore?: string, endingAfter?: string, clientIDs?: Array<string>, search?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PromotionsResponse>>;
+    listPromotions(nextToken?: string, tags?: string, segmentId?: string, ownerID?: string, type?: PromotionType, startingAfter?: string, endingBefore?: string, startingBefore?: string, endingAfter?: string, clientIDs?: Array<string>, search?: string, sortBy?: PromotionSortByField, sortDirection?: SortDirection, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PromotionsResponse>>;
     /**
      * List users promotions
      * @summary List promotions
@@ -5028,10 +5055,12 @@ export declare const PromotionApiFp: (configuration?: 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?: string, tags?: string, startingAfter?: string, endingBefore?: string, startingBefore?: string, endingAfter?: string, search?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PromotionsResponse>>;
+    listUserPromotions(nextToken?: string, tags?: string, startingAfter?: string, endingBefore?: string, startingBefore?: string, endingAfter?: string, search?: string, sortBy?: PromotionSortByField, sortDirection?: SortDirection, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PromotionsResponse>>;
     /**
      * Update promotion by id
      * @summary Update promotion
@@ -5135,10 +5164,12 @@ export declare const PromotionApiFactory: (configuration?: Configuration, basePa
      * @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?: string, tags?: string, segmentId?: string, ownerID?: string, type?: PromotionType, startingAfter?: string, endingBefore?: string, startingBefore?: string, endingAfter?: string, clientIDs?: Array<string>, search?: string, options?: any): AxiosPromise<PromotionsResponse>;
+    listPromotions(nextToken?: string, tags?: string, segmentId?: string, ownerID?: string, type?: PromotionType, startingAfter?: string, endingBefore?: string, startingBefore?: string, endingAfter?: string, clientIDs?: Array<string>, search?: string, sortBy?: PromotionSortByField, sortDirection?: SortDirection, options?: any): AxiosPromise<PromotionsResponse>;
     /**
      * List users promotions
      * @summary List promotions
@@ -5149,10 +5180,12 @@ export declare const PromotionApiFactory: (configuration?: Configuration, basePa
      * @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?: string, tags?: string, startingAfter?: string, endingBefore?: string, startingBefore?: string, endingAfter?: string, search?: string, options?: any): AxiosPromise<PromotionsResponse>;
+    listUserPromotions(nextToken?: string, tags?: string, startingAfter?: string, endingBefore?: string, startingBefore?: string, endingAfter?: string, search?: string, sortBy?: PromotionSortByField, sortDirection?: SortDirection, options?: any): AxiosPromise<PromotionsResponse>;
     /**
      * Update promotion by id
      * @summary Update promotion
@@ -5267,11 +5300,13 @@ export declare 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?: string, tags?: string, segmentId?: string, ownerID?: string, type?: PromotionType, startingAfter?: string, endingBefore?: string, startingBefore?: string, endingAfter?: string, clientIDs?: Array<string>, search?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PromotionsResponse, any>>;
+    listPromotions(nextToken?: string, tags?: string, segmentId?: string, ownerID?: string, type?: PromotionType, startingAfter?: string, endingBefore?: string, startingBefore?: string, endingAfter?: string, clientIDs?: Array<string>, search?: string, sortBy?: PromotionSortByField, sortDirection?: SortDirection, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PromotionsResponse, any>>;
     /**
      * List users promotions
      * @summary List promotions
@@ -5282,11 +5317,13 @@ export declare 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?: string, tags?: string, startingAfter?: string, endingBefore?: string, startingBefore?: string, endingAfter?: string, search?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PromotionsResponse, any>>;
+    listUserPromotions(nextToken?: string, tags?: string, startingAfter?: string, endingBefore?: string, startingBefore?: string, endingAfter?: string, search?: string, sortBy?: PromotionSortByField, sortDirection?: SortDirection, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PromotionsResponse, any>>;
     /**
      * Update promotion by id
      * @summary Update promotion