flexinet-api 0.0.703-prerelease0 → 0.0.710-prerelease0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/api.ts +43 -29
- package/dist/api.d.ts +32 -26
- package/dist/api.js +35 -26
- package/dist/esm/api.d.ts +32 -26
- package/dist/esm/api.js +33 -24
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## flexinet-api@0.0.
|
|
1
|
+
## flexinet-api@0.0.710-prerelease0
|
|
2
2
|
|
|
3
3
|
This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
|
|
4
4
|
|
|
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
|
|
|
36
36
|
_published:_
|
|
37
37
|
|
|
38
38
|
```
|
|
39
|
-
npm install flexinet-api@0.0.
|
|
39
|
+
npm install flexinet-api@0.0.710-prerelease0 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
package/api.ts
CHANGED
|
@@ -1899,6 +1899,22 @@ export interface Progress {
|
|
|
1899
1899
|
}
|
|
1900
1900
|
|
|
1901
1901
|
|
|
1902
|
+
/**
|
|
1903
|
+
*
|
|
1904
|
+
* @export
|
|
1905
|
+
* @enum {string}
|
|
1906
|
+
*/
|
|
1907
|
+
|
|
1908
|
+
export const ProgressInterval = {
|
|
1909
|
+
_100: '100',
|
|
1910
|
+
_9975: '99-75',
|
|
1911
|
+
_7550: '75-50',
|
|
1912
|
+
_501: '50-1'
|
|
1913
|
+
} as const;
|
|
1914
|
+
|
|
1915
|
+
export type ProgressInterval = typeof ProgressInterval[keyof typeof ProgressInterval];
|
|
1916
|
+
|
|
1917
|
+
|
|
1902
1918
|
/**
|
|
1903
1919
|
*
|
|
1904
1920
|
* @export
|
|
@@ -7631,12 +7647,12 @@ export const ProgressApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
7631
7647
|
* @param {number} [periodID] Period ID
|
|
7632
7648
|
* @param {Array<string>} [userIDs] User IDs to filter by
|
|
7633
7649
|
* @param {Array<string>} [clientIDs] Client IDs to filter by
|
|
7634
|
-
* @param {
|
|
7650
|
+
* @param {ProgressInterval} [interval] Interval
|
|
7635
7651
|
* @param {string} [nextToken] This is the pagination token
|
|
7636
7652
|
* @param {*} [options] Override http request option.
|
|
7637
7653
|
* @throws {RequiredError}
|
|
7638
7654
|
*/
|
|
7639
|
-
listProgress: async (promotionIDs: Array<string>, periodID?: number, userIDs?: Array<string>, clientIDs?: Array<string>, interval?:
|
|
7655
|
+
listProgress: async (promotionIDs: Array<string>, periodID?: number, userIDs?: Array<string>, clientIDs?: Array<string>, interval?: ProgressInterval, nextToken?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
7640
7656
|
// verify required parameter 'promotionIDs' is not null or undefined
|
|
7641
7657
|
assertParamExists('listProgress', 'promotionIDs', promotionIDs)
|
|
7642
7658
|
const localVarPath = `/admins/progress`;
|
|
@@ -7758,12 +7774,12 @@ export const ProgressApiFp = function(configuration?: Configuration) {
|
|
|
7758
7774
|
* @param {number} [periodID] Period ID
|
|
7759
7775
|
* @param {Array<string>} [userIDs] User IDs to filter by
|
|
7760
7776
|
* @param {Array<string>} [clientIDs] Client IDs to filter by
|
|
7761
|
-
* @param {
|
|
7777
|
+
* @param {ProgressInterval} [interval] Interval
|
|
7762
7778
|
* @param {string} [nextToken] This is the pagination token
|
|
7763
7779
|
* @param {*} [options] Override http request option.
|
|
7764
7780
|
* @throws {RequiredError}
|
|
7765
7781
|
*/
|
|
7766
|
-
async listProgress(promotionIDs: Array<string>, periodID?: number, userIDs?: Array<string>, clientIDs?: Array<string>, interval?:
|
|
7782
|
+
async listProgress(promotionIDs: Array<string>, periodID?: number, userIDs?: Array<string>, clientIDs?: Array<string>, interval?: ProgressInterval, nextToken?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgressResponse>> {
|
|
7767
7783
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listProgress(promotionIDs, periodID, userIDs, clientIDs, interval, nextToken, options);
|
|
7768
7784
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
7769
7785
|
},
|
|
@@ -7797,12 +7813,12 @@ export const ProgressApiFactory = function (configuration?: Configuration, baseP
|
|
|
7797
7813
|
* @param {number} [periodID] Period ID
|
|
7798
7814
|
* @param {Array<string>} [userIDs] User IDs to filter by
|
|
7799
7815
|
* @param {Array<string>} [clientIDs] Client IDs to filter by
|
|
7800
|
-
* @param {
|
|
7816
|
+
* @param {ProgressInterval} [interval] Interval
|
|
7801
7817
|
* @param {string} [nextToken] This is the pagination token
|
|
7802
7818
|
* @param {*} [options] Override http request option.
|
|
7803
7819
|
* @throws {RequiredError}
|
|
7804
7820
|
*/
|
|
7805
|
-
listProgress(promotionIDs: Array<string>, periodID?: number, userIDs?: Array<string>, clientIDs?: Array<string>, interval?:
|
|
7821
|
+
listProgress(promotionIDs: Array<string>, periodID?: number, userIDs?: Array<string>, clientIDs?: Array<string>, interval?: ProgressInterval, nextToken?: string, options?: any): AxiosPromise<ProgressResponse> {
|
|
7806
7822
|
return localVarFp.listProgress(promotionIDs, periodID, userIDs, clientIDs, interval, nextToken, options).then((request) => request(axios, basePath));
|
|
7807
7823
|
},
|
|
7808
7824
|
/**
|
|
@@ -7834,13 +7850,13 @@ export class ProgressApi extends BaseAPI {
|
|
|
7834
7850
|
* @param {number} [periodID] Period ID
|
|
7835
7851
|
* @param {Array<string>} [userIDs] User IDs to filter by
|
|
7836
7852
|
* @param {Array<string>} [clientIDs] Client IDs to filter by
|
|
7837
|
-
* @param {
|
|
7853
|
+
* @param {ProgressInterval} [interval] Interval
|
|
7838
7854
|
* @param {string} [nextToken] This is the pagination token
|
|
7839
7855
|
* @param {*} [options] Override http request option.
|
|
7840
7856
|
* @throws {RequiredError}
|
|
7841
7857
|
* @memberof ProgressApi
|
|
7842
7858
|
*/
|
|
7843
|
-
public listProgress(promotionIDs: Array<string>, periodID?: number, userIDs?: Array<string>, clientIDs?: Array<string>, interval?:
|
|
7859
|
+
public listProgress(promotionIDs: Array<string>, periodID?: number, userIDs?: Array<string>, clientIDs?: Array<string>, interval?: ProgressInterval, nextToken?: string, options?: AxiosRequestConfig) {
|
|
7844
7860
|
return ProgressApiFp(this.configuration).listProgress(promotionIDs, periodID, userIDs, clientIDs, interval, nextToken, options).then((request) => request(this.axios, this.basePath));
|
|
7845
7861
|
}
|
|
7846
7862
|
|
|
@@ -7859,16 +7875,6 @@ export class ProgressApi extends BaseAPI {
|
|
|
7859
7875
|
}
|
|
7860
7876
|
}
|
|
7861
7877
|
|
|
7862
|
-
/**
|
|
7863
|
-
* @export
|
|
7864
|
-
*/
|
|
7865
|
-
export const ListProgressIntervalEnum = {
|
|
7866
|
-
_100: '100',
|
|
7867
|
-
_9975: '99-75',
|
|
7868
|
-
_7550: '75-50',
|
|
7869
|
-
_501: '50-1'
|
|
7870
|
-
} as const;
|
|
7871
|
-
export type ListProgressIntervalEnum = typeof ListProgressIntervalEnum[keyof typeof ListProgressIntervalEnum];
|
|
7872
7878
|
|
|
7873
7879
|
|
|
7874
7880
|
/**
|
|
@@ -8236,11 +8242,12 @@ export const PromotionApiAxiosParamCreator = function (configuration?: Configura
|
|
|
8236
8242
|
* @param {number} [periodID] Period ID
|
|
8237
8243
|
* @param {boolean} [hasProgress] Beneficiary has progress
|
|
8238
8244
|
* @param {string} [nextToken] This is the pagination token
|
|
8239
|
-
* @param {string} [search] search string
|
|
8245
|
+
* @param {string} [search] search string, searches in client name/referenceID or user name/referenceID
|
|
8246
|
+
* @param {ProgressInterval} [interval] Progress interval to filter by
|
|
8240
8247
|
* @param {*} [options] Override http request option.
|
|
8241
8248
|
* @throws {RequiredError}
|
|
8242
8249
|
*/
|
|
8243
|
-
listPromotionBeneficiaries: async (id: string, periodID?: number, hasProgress?: boolean, nextToken?: string, search?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
8250
|
+
listPromotionBeneficiaries: async (id: string, periodID?: number, hasProgress?: boolean, nextToken?: string, search?: string, interval?: ProgressInterval, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
8244
8251
|
// verify required parameter 'id' is not null or undefined
|
|
8245
8252
|
assertParamExists('listPromotionBeneficiaries', 'id', id)
|
|
8246
8253
|
const localVarPath = `/admins/promotions/{id}/beneficiaries`
|
|
@@ -8276,6 +8283,10 @@ export const PromotionApiAxiosParamCreator = function (configuration?: Configura
|
|
|
8276
8283
|
localVarQueryParameter['search'] = search;
|
|
8277
8284
|
}
|
|
8278
8285
|
|
|
8286
|
+
if (interval !== undefined) {
|
|
8287
|
+
localVarQueryParameter['interval'] = interval;
|
|
8288
|
+
}
|
|
8289
|
+
|
|
8279
8290
|
|
|
8280
8291
|
|
|
8281
8292
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -8653,12 +8664,13 @@ export const PromotionApiFp = function(configuration?: Configuration) {
|
|
|
8653
8664
|
* @param {number} [periodID] Period ID
|
|
8654
8665
|
* @param {boolean} [hasProgress] Beneficiary has progress
|
|
8655
8666
|
* @param {string} [nextToken] This is the pagination token
|
|
8656
|
-
* @param {string} [search] search string
|
|
8667
|
+
* @param {string} [search] search string, searches in client name/referenceID or user name/referenceID
|
|
8668
|
+
* @param {ProgressInterval} [interval] Progress interval to filter by
|
|
8657
8669
|
* @param {*} [options] Override http request option.
|
|
8658
8670
|
* @throws {RequiredError}
|
|
8659
8671
|
*/
|
|
8660
|
-
async listPromotionBeneficiaries(id: string, periodID?: number, hasProgress?: boolean, nextToken?: string, search?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PromotionBeneficiariesResponse>> {
|
|
8661
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listPromotionBeneficiaries(id, periodID, hasProgress, nextToken, search, options);
|
|
8672
|
+
async listPromotionBeneficiaries(id: string, periodID?: number, hasProgress?: boolean, nextToken?: string, search?: string, interval?: ProgressInterval, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PromotionBeneficiariesResponse>> {
|
|
8673
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listPromotionBeneficiaries(id, periodID, hasProgress, nextToken, search, interval, options);
|
|
8662
8674
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
8663
8675
|
},
|
|
8664
8676
|
/**
|
|
@@ -8826,12 +8838,13 @@ export const PromotionApiFactory = function (configuration?: Configuration, base
|
|
|
8826
8838
|
* @param {number} [periodID] Period ID
|
|
8827
8839
|
* @param {boolean} [hasProgress] Beneficiary has progress
|
|
8828
8840
|
* @param {string} [nextToken] This is the pagination token
|
|
8829
|
-
* @param {string} [search] search string
|
|
8841
|
+
* @param {string} [search] search string, searches in client name/referenceID or user name/referenceID
|
|
8842
|
+
* @param {ProgressInterval} [interval] Progress interval to filter by
|
|
8830
8843
|
* @param {*} [options] Override http request option.
|
|
8831
8844
|
* @throws {RequiredError}
|
|
8832
8845
|
*/
|
|
8833
|
-
listPromotionBeneficiaries(id: string, periodID?: number, hasProgress?: boolean, nextToken?: string, search?: string, options?: any): AxiosPromise<PromotionBeneficiariesResponse> {
|
|
8834
|
-
return localVarFp.listPromotionBeneficiaries(id, periodID, hasProgress, nextToken, search, options).then((request) => request(axios, basePath));
|
|
8846
|
+
listPromotionBeneficiaries(id: string, periodID?: number, hasProgress?: boolean, nextToken?: string, search?: string, interval?: ProgressInterval, options?: any): AxiosPromise<PromotionBeneficiariesResponse> {
|
|
8847
|
+
return localVarFp.listPromotionBeneficiaries(id, periodID, hasProgress, nextToken, search, interval, options).then((request) => request(axios, basePath));
|
|
8835
8848
|
},
|
|
8836
8849
|
/**
|
|
8837
8850
|
* List all promotions
|
|
@@ -9013,13 +9026,14 @@ export class PromotionApi extends BaseAPI {
|
|
|
9013
9026
|
* @param {number} [periodID] Period ID
|
|
9014
9027
|
* @param {boolean} [hasProgress] Beneficiary has progress
|
|
9015
9028
|
* @param {string} [nextToken] This is the pagination token
|
|
9016
|
-
* @param {string} [search] search string
|
|
9029
|
+
* @param {string} [search] search string, searches in client name/referenceID or user name/referenceID
|
|
9030
|
+
* @param {ProgressInterval} [interval] Progress interval to filter by
|
|
9017
9031
|
* @param {*} [options] Override http request option.
|
|
9018
9032
|
* @throws {RequiredError}
|
|
9019
9033
|
* @memberof PromotionApi
|
|
9020
9034
|
*/
|
|
9021
|
-
public listPromotionBeneficiaries(id: string, periodID?: number, hasProgress?: boolean, nextToken?: string, search?: string, options?: AxiosRequestConfig) {
|
|
9022
|
-
return PromotionApiFp(this.configuration).listPromotionBeneficiaries(id, periodID, hasProgress, nextToken, search, options).then((request) => request(this.axios, this.basePath));
|
|
9035
|
+
public listPromotionBeneficiaries(id: string, periodID?: number, hasProgress?: boolean, nextToken?: string, search?: string, interval?: ProgressInterval, options?: AxiosRequestConfig) {
|
|
9036
|
+
return PromotionApiFp(this.configuration).listPromotionBeneficiaries(id, periodID, hasProgress, nextToken, search, interval, options).then((request) => request(this.axios, this.basePath));
|
|
9023
9037
|
}
|
|
9024
9038
|
|
|
9025
9039
|
/**
|
package/dist/api.d.ts
CHANGED
|
@@ -1802,6 +1802,18 @@ export interface Progress {
|
|
|
1802
1802
|
*/
|
|
1803
1803
|
'claimedAt'?: string;
|
|
1804
1804
|
}
|
|
1805
|
+
/**
|
|
1806
|
+
*
|
|
1807
|
+
* @export
|
|
1808
|
+
* @enum {string}
|
|
1809
|
+
*/
|
|
1810
|
+
export declare const ProgressInterval: {
|
|
1811
|
+
readonly _100: "100";
|
|
1812
|
+
readonly _9975: "99-75";
|
|
1813
|
+
readonly _7550: "75-50";
|
|
1814
|
+
readonly _501: "50-1";
|
|
1815
|
+
};
|
|
1816
|
+
export type ProgressInterval = typeof ProgressInterval[keyof typeof ProgressInterval];
|
|
1805
1817
|
/**
|
|
1806
1818
|
*
|
|
1807
1819
|
* @export
|
|
@@ -5419,12 +5431,12 @@ export declare const ProgressApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
5419
5431
|
* @param {number} [periodID] Period ID
|
|
5420
5432
|
* @param {Array<string>} [userIDs] User IDs to filter by
|
|
5421
5433
|
* @param {Array<string>} [clientIDs] Client IDs to filter by
|
|
5422
|
-
* @param {
|
|
5434
|
+
* @param {ProgressInterval} [interval] Interval
|
|
5423
5435
|
* @param {string} [nextToken] This is the pagination token
|
|
5424
5436
|
* @param {*} [options] Override http request option.
|
|
5425
5437
|
* @throws {RequiredError}
|
|
5426
5438
|
*/
|
|
5427
|
-
listProgress: (promotionIDs: Array<string>, periodID?: number, userIDs?: Array<string>, clientIDs?: Array<string>, interval?:
|
|
5439
|
+
listProgress: (promotionIDs: Array<string>, periodID?: number, userIDs?: Array<string>, clientIDs?: Array<string>, interval?: ProgressInterval, nextToken?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
5428
5440
|
/**
|
|
5429
5441
|
* List users progress
|
|
5430
5442
|
* @summary List progress
|
|
@@ -5448,12 +5460,12 @@ export declare const ProgressApiFp: (configuration?: Configuration) => {
|
|
|
5448
5460
|
* @param {number} [periodID] Period ID
|
|
5449
5461
|
* @param {Array<string>} [userIDs] User IDs to filter by
|
|
5450
5462
|
* @param {Array<string>} [clientIDs] Client IDs to filter by
|
|
5451
|
-
* @param {
|
|
5463
|
+
* @param {ProgressInterval} [interval] Interval
|
|
5452
5464
|
* @param {string} [nextToken] This is the pagination token
|
|
5453
5465
|
* @param {*} [options] Override http request option.
|
|
5454
5466
|
* @throws {RequiredError}
|
|
5455
5467
|
*/
|
|
5456
|
-
listProgress(promotionIDs: Array<string>, periodID?: number, userIDs?: Array<string>, clientIDs?: Array<string>, interval?:
|
|
5468
|
+
listProgress(promotionIDs: Array<string>, periodID?: number, userIDs?: Array<string>, clientIDs?: Array<string>, interval?: ProgressInterval, nextToken?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgressResponse>>;
|
|
5457
5469
|
/**
|
|
5458
5470
|
* List users progress
|
|
5459
5471
|
* @summary List progress
|
|
@@ -5477,12 +5489,12 @@ export declare const ProgressApiFactory: (configuration?: Configuration, basePat
|
|
|
5477
5489
|
* @param {number} [periodID] Period ID
|
|
5478
5490
|
* @param {Array<string>} [userIDs] User IDs to filter by
|
|
5479
5491
|
* @param {Array<string>} [clientIDs] Client IDs to filter by
|
|
5480
|
-
* @param {
|
|
5492
|
+
* @param {ProgressInterval} [interval] Interval
|
|
5481
5493
|
* @param {string} [nextToken] This is the pagination token
|
|
5482
5494
|
* @param {*} [options] Override http request option.
|
|
5483
5495
|
* @throws {RequiredError}
|
|
5484
5496
|
*/
|
|
5485
|
-
listProgress(promotionIDs: Array<string>, periodID?: number, userIDs?: Array<string>, clientIDs?: Array<string>, interval?:
|
|
5497
|
+
listProgress(promotionIDs: Array<string>, periodID?: number, userIDs?: Array<string>, clientIDs?: Array<string>, interval?: ProgressInterval, nextToken?: string, options?: any): AxiosPromise<ProgressResponse>;
|
|
5486
5498
|
/**
|
|
5487
5499
|
* List users progress
|
|
5488
5500
|
* @summary List progress
|
|
@@ -5508,13 +5520,13 @@ export declare class ProgressApi extends BaseAPI {
|
|
|
5508
5520
|
* @param {number} [periodID] Period ID
|
|
5509
5521
|
* @param {Array<string>} [userIDs] User IDs to filter by
|
|
5510
5522
|
* @param {Array<string>} [clientIDs] Client IDs to filter by
|
|
5511
|
-
* @param {
|
|
5523
|
+
* @param {ProgressInterval} [interval] Interval
|
|
5512
5524
|
* @param {string} [nextToken] This is the pagination token
|
|
5513
5525
|
* @param {*} [options] Override http request option.
|
|
5514
5526
|
* @throws {RequiredError}
|
|
5515
5527
|
* @memberof ProgressApi
|
|
5516
5528
|
*/
|
|
5517
|
-
listProgress(promotionIDs: Array<string>, periodID?: number, userIDs?: Array<string>, clientIDs?: Array<string>, interval?:
|
|
5529
|
+
listProgress(promotionIDs: Array<string>, periodID?: number, userIDs?: Array<string>, clientIDs?: Array<string>, interval?: ProgressInterval, nextToken?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgressResponse, any>>;
|
|
5518
5530
|
/**
|
|
5519
5531
|
* List users progress
|
|
5520
5532
|
* @summary List progress
|
|
@@ -5527,16 +5539,6 @@ export declare class ProgressApi extends BaseAPI {
|
|
|
5527
5539
|
*/
|
|
5528
5540
|
listUserProgress(promotionIDs: Array<string>, periodID?: number, nextToken?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgressResponse, any>>;
|
|
5529
5541
|
}
|
|
5530
|
-
/**
|
|
5531
|
-
* @export
|
|
5532
|
-
*/
|
|
5533
|
-
export declare const ListProgressIntervalEnum: {
|
|
5534
|
-
readonly _100: "100";
|
|
5535
|
-
readonly _9975: "99-75";
|
|
5536
|
-
readonly _7550: "75-50";
|
|
5537
|
-
readonly _501: "50-1";
|
|
5538
|
-
};
|
|
5539
|
-
export type ListProgressIntervalEnum = typeof ListProgressIntervalEnum[keyof typeof ListProgressIntervalEnum];
|
|
5540
5542
|
/**
|
|
5541
5543
|
* PromotionApi - axios parameter creator
|
|
5542
5544
|
* @export
|
|
@@ -5623,11 +5625,12 @@ export declare const PromotionApiAxiosParamCreator: (configuration?: Configurati
|
|
|
5623
5625
|
* @param {number} [periodID] Period ID
|
|
5624
5626
|
* @param {boolean} [hasProgress] Beneficiary has progress
|
|
5625
5627
|
* @param {string} [nextToken] This is the pagination token
|
|
5626
|
-
* @param {string} [search] search string
|
|
5628
|
+
* @param {string} [search] search string, searches in client name/referenceID or user name/referenceID
|
|
5629
|
+
* @param {ProgressInterval} [interval] Progress interval to filter by
|
|
5627
5630
|
* @param {*} [options] Override http request option.
|
|
5628
5631
|
* @throws {RequiredError}
|
|
5629
5632
|
*/
|
|
5630
|
-
listPromotionBeneficiaries: (id: string, periodID?: number, hasProgress?: boolean, nextToken?: string, search?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
5633
|
+
listPromotionBeneficiaries: (id: string, periodID?: number, hasProgress?: boolean, nextToken?: string, search?: string, interval?: ProgressInterval, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
5631
5634
|
/**
|
|
5632
5635
|
* List all promotions
|
|
5633
5636
|
* @summary List promotions
|
|
@@ -5762,11 +5765,12 @@ export declare const PromotionApiFp: (configuration?: Configuration) => {
|
|
|
5762
5765
|
* @param {number} [periodID] Period ID
|
|
5763
5766
|
* @param {boolean} [hasProgress] Beneficiary has progress
|
|
5764
5767
|
* @param {string} [nextToken] This is the pagination token
|
|
5765
|
-
* @param {string} [search] search string
|
|
5768
|
+
* @param {string} [search] search string, searches in client name/referenceID or user name/referenceID
|
|
5769
|
+
* @param {ProgressInterval} [interval] Progress interval to filter by
|
|
5766
5770
|
* @param {*} [options] Override http request option.
|
|
5767
5771
|
* @throws {RequiredError}
|
|
5768
5772
|
*/
|
|
5769
|
-
listPromotionBeneficiaries(id: string, periodID?: number, hasProgress?: boolean, nextToken?: string, search?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PromotionBeneficiariesResponse>>;
|
|
5773
|
+
listPromotionBeneficiaries(id: string, periodID?: number, hasProgress?: boolean, nextToken?: string, search?: string, interval?: ProgressInterval, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PromotionBeneficiariesResponse>>;
|
|
5770
5774
|
/**
|
|
5771
5775
|
* List all promotions
|
|
5772
5776
|
* @summary List promotions
|
|
@@ -5901,11 +5905,12 @@ export declare const PromotionApiFactory: (configuration?: Configuration, basePa
|
|
|
5901
5905
|
* @param {number} [periodID] Period ID
|
|
5902
5906
|
* @param {boolean} [hasProgress] Beneficiary has progress
|
|
5903
5907
|
* @param {string} [nextToken] This is the pagination token
|
|
5904
|
-
* @param {string} [search] search string
|
|
5908
|
+
* @param {string} [search] search string, searches in client name/referenceID or user name/referenceID
|
|
5909
|
+
* @param {ProgressInterval} [interval] Progress interval to filter by
|
|
5905
5910
|
* @param {*} [options] Override http request option.
|
|
5906
5911
|
* @throws {RequiredError}
|
|
5907
5912
|
*/
|
|
5908
|
-
listPromotionBeneficiaries(id: string, periodID?: number, hasProgress?: boolean, nextToken?: string, search?: string, options?: any): AxiosPromise<PromotionBeneficiariesResponse>;
|
|
5913
|
+
listPromotionBeneficiaries(id: string, periodID?: number, hasProgress?: boolean, nextToken?: string, search?: string, interval?: ProgressInterval, options?: any): AxiosPromise<PromotionBeneficiariesResponse>;
|
|
5909
5914
|
/**
|
|
5910
5915
|
* List all promotions
|
|
5911
5916
|
* @summary List promotions
|
|
@@ -6051,12 +6056,13 @@ export declare class PromotionApi extends BaseAPI {
|
|
|
6051
6056
|
* @param {number} [periodID] Period ID
|
|
6052
6057
|
* @param {boolean} [hasProgress] Beneficiary has progress
|
|
6053
6058
|
* @param {string} [nextToken] This is the pagination token
|
|
6054
|
-
* @param {string} [search] search string
|
|
6059
|
+
* @param {string} [search] search string, searches in client name/referenceID or user name/referenceID
|
|
6060
|
+
* @param {ProgressInterval} [interval] Progress interval to filter by
|
|
6055
6061
|
* @param {*} [options] Override http request option.
|
|
6056
6062
|
* @throws {RequiredError}
|
|
6057
6063
|
* @memberof PromotionApi
|
|
6058
6064
|
*/
|
|
6059
|
-
listPromotionBeneficiaries(id: string, periodID?: number, hasProgress?: boolean, nextToken?: string, search?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PromotionBeneficiariesResponse, any>>;
|
|
6065
|
+
listPromotionBeneficiaries(id: string, periodID?: number, hasProgress?: boolean, nextToken?: string, search?: string, interval?: ProgressInterval, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PromotionBeneficiariesResponse, any>>;
|
|
6060
6066
|
/**
|
|
6061
6067
|
* List all promotions
|
|
6062
6068
|
* @summary List promotions
|
package/dist/api.js
CHANGED
|
@@ -22,8 +22,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
22
22
|
});
|
|
23
23
|
};
|
|
24
24
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
25
|
-
exports.
|
|
26
|
-
exports.TenantApi = exports.TenantApiFactory = exports.TenantApiFp = exports.TenantApiAxiosParamCreator = exports.TagApi = exports.TagApiFactory = exports.TagApiFp = exports.TagApiAxiosParamCreator = exports.SegmentApi = exports.SegmentApiFactory = exports.SegmentApiFp = exports.SegmentApiAxiosParamCreator = exports.PromotionApi = exports.PromotionApiFactory = exports.PromotionApiFp = exports.PromotionApiAxiosParamCreator = exports.
|
|
25
|
+
exports.ClientApiFp = exports.ClientApiAxiosParamCreator = exports.CategoryApi = exports.CategoryApiFactory = exports.CategoryApiFp = exports.CategoryApiAxiosParamCreator = exports.BalanceApi = exports.BalanceApiFactory = exports.BalanceApiFp = exports.BalanceApiAxiosParamCreator = exports.AuditApi = exports.AuditApiFactory = exports.AuditApiFp = exports.AuditApiAxiosParamCreator = exports.WebhookKind = exports.UserSource = exports.UserRole = exports.TransactionSource = exports.TransactionKind = exports.TransactionEventKind = exports.TargetMu = exports.TagValidatorType = exports.TagRuleKind = exports.TagDataType = exports.SortDirection = exports.RuleKind = exports.RuleGroupState = exports.Repetition = exports.PromotionType = exports.PromotionSortByField = exports.ProgressState = exports.ProgressInterval = exports.ProductUsage = exports.ProductStatus = exports.ProductRequestStatus = exports.ProductRequestApprovalRequestStatusEnum = exports.ProductKind = exports.ProductAvailability = exports.OrderKindEnum = exports.NotificationStatus = exports.NotificationKind = exports.NotificationChannel = exports.Feature = exports.EventCreationRequestKindEnum = exports.CustomDealRestrictionPriority = exports.Condition = exports.BonusMu = exports.BeneficiaryKind = exports.AuditLogObjectType = exports.AuditLogActionEnum = void 0;
|
|
26
|
+
exports.TenantApi = exports.TenantApiFactory = exports.TenantApiFp = exports.TenantApiAxiosParamCreator = exports.TagApi = exports.TagApiFactory = exports.TagApiFp = exports.TagApiAxiosParamCreator = exports.SegmentApi = exports.SegmentApiFactory = exports.SegmentApiFp = exports.SegmentApiAxiosParamCreator = exports.PromotionApi = exports.PromotionApiFactory = exports.PromotionApiFp = exports.PromotionApiAxiosParamCreator = exports.ProgressApi = exports.ProgressApiFactory = exports.ProgressApiFp = exports.ProgressApiAxiosParamCreator = exports.ProductApi = exports.ProductApiFactory = exports.ProductApiFp = exports.ProductApiAxiosParamCreator = exports.OrderApi = exports.OrderApiFactory = exports.OrderApiFp = exports.OrderApiAxiosParamCreator = exports.NotificationApi = exports.NotificationApiFactory = exports.NotificationApiFp = exports.NotificationApiAxiosParamCreator = exports.IntegrationApi = exports.IntegrationApiFactory = exports.IntegrationApiFp = exports.IntegrationApiAxiosParamCreator = exports.DefaultApi = exports.DefaultApiFactory = exports.DefaultApiFp = exports.DefaultApiAxiosParamCreator = exports.CustomDealsApi = exports.CustomDealsApiFactory = exports.CustomDealsApiFp = exports.CustomDealsApiAxiosParamCreator = exports.ConfigurationApi = exports.ConfigurationApiFactory = exports.ConfigurationApiFp = exports.ConfigurationApiAxiosParamCreator = exports.ClientApi = exports.ClientApiFactory = void 0;
|
|
27
27
|
exports.UserApi = exports.UserApiFactory = exports.UserApiFp = exports.UserApiAxiosParamCreator = exports.TransactionApi = exports.TransactionApiFactory = exports.TransactionApiFp = exports.TransactionApiAxiosParamCreator = void 0;
|
|
28
28
|
const axios_1 = require("axios");
|
|
29
29
|
// Some imports not used depending on template conditions
|
|
@@ -181,6 +181,17 @@ exports.ProductUsage = {
|
|
|
181
181
|
Promotion: 'promotion',
|
|
182
182
|
SalesBudget: 'sales_budget'
|
|
183
183
|
};
|
|
184
|
+
/**
|
|
185
|
+
*
|
|
186
|
+
* @export
|
|
187
|
+
* @enum {string}
|
|
188
|
+
*/
|
|
189
|
+
exports.ProgressInterval = {
|
|
190
|
+
_100: '100',
|
|
191
|
+
_9975: '99-75',
|
|
192
|
+
_7550: '75-50',
|
|
193
|
+
_501: '50-1'
|
|
194
|
+
};
|
|
184
195
|
/**
|
|
185
196
|
*
|
|
186
197
|
* @export
|
|
@@ -3992,7 +4003,7 @@ const ProgressApiAxiosParamCreator = function (configuration) {
|
|
|
3992
4003
|
* @param {number} [periodID] Period ID
|
|
3993
4004
|
* @param {Array<string>} [userIDs] User IDs to filter by
|
|
3994
4005
|
* @param {Array<string>} [clientIDs] Client IDs to filter by
|
|
3995
|
-
* @param {
|
|
4006
|
+
* @param {ProgressInterval} [interval] Interval
|
|
3996
4007
|
* @param {string} [nextToken] This is the pagination token
|
|
3997
4008
|
* @param {*} [options] Override http request option.
|
|
3998
4009
|
* @throws {RequiredError}
|
|
@@ -4098,7 +4109,7 @@ const ProgressApiFp = function (configuration) {
|
|
|
4098
4109
|
* @param {number} [periodID] Period ID
|
|
4099
4110
|
* @param {Array<string>} [userIDs] User IDs to filter by
|
|
4100
4111
|
* @param {Array<string>} [clientIDs] Client IDs to filter by
|
|
4101
|
-
* @param {
|
|
4112
|
+
* @param {ProgressInterval} [interval] Interval
|
|
4102
4113
|
* @param {string} [nextToken] This is the pagination token
|
|
4103
4114
|
* @param {*} [options] Override http request option.
|
|
4104
4115
|
* @throws {RequiredError}
|
|
@@ -4141,7 +4152,7 @@ const ProgressApiFactory = function (configuration, basePath, axios) {
|
|
|
4141
4152
|
* @param {number} [periodID] Period ID
|
|
4142
4153
|
* @param {Array<string>} [userIDs] User IDs to filter by
|
|
4143
4154
|
* @param {Array<string>} [clientIDs] Client IDs to filter by
|
|
4144
|
-
* @param {
|
|
4155
|
+
* @param {ProgressInterval} [interval] Interval
|
|
4145
4156
|
* @param {string} [nextToken] This is the pagination token
|
|
4146
4157
|
* @param {*} [options] Override http request option.
|
|
4147
4158
|
* @throws {RequiredError}
|
|
@@ -4178,7 +4189,7 @@ class ProgressApi extends base_1.BaseAPI {
|
|
|
4178
4189
|
* @param {number} [periodID] Period ID
|
|
4179
4190
|
* @param {Array<string>} [userIDs] User IDs to filter by
|
|
4180
4191
|
* @param {Array<string>} [clientIDs] Client IDs to filter by
|
|
4181
|
-
* @param {
|
|
4192
|
+
* @param {ProgressInterval} [interval] Interval
|
|
4182
4193
|
* @param {string} [nextToken] This is the pagination token
|
|
4183
4194
|
* @param {*} [options] Override http request option.
|
|
4184
4195
|
* @throws {RequiredError}
|
|
@@ -4202,15 +4213,6 @@ class ProgressApi extends base_1.BaseAPI {
|
|
|
4202
4213
|
}
|
|
4203
4214
|
}
|
|
4204
4215
|
exports.ProgressApi = ProgressApi;
|
|
4205
|
-
/**
|
|
4206
|
-
* @export
|
|
4207
|
-
*/
|
|
4208
|
-
exports.ListProgressIntervalEnum = {
|
|
4209
|
-
_100: '100',
|
|
4210
|
-
_9975: '99-75',
|
|
4211
|
-
_7550: '75-50',
|
|
4212
|
-
_501: '50-1'
|
|
4213
|
-
};
|
|
4214
4216
|
/**
|
|
4215
4217
|
* PromotionApi - axios parameter creator
|
|
4216
4218
|
* @export
|
|
@@ -4520,11 +4522,12 @@ const PromotionApiAxiosParamCreator = function (configuration) {
|
|
|
4520
4522
|
* @param {number} [periodID] Period ID
|
|
4521
4523
|
* @param {boolean} [hasProgress] Beneficiary has progress
|
|
4522
4524
|
* @param {string} [nextToken] This is the pagination token
|
|
4523
|
-
* @param {string} [search] search string
|
|
4525
|
+
* @param {string} [search] search string, searches in client name/referenceID or user name/referenceID
|
|
4526
|
+
* @param {ProgressInterval} [interval] Progress interval to filter by
|
|
4524
4527
|
* @param {*} [options] Override http request option.
|
|
4525
4528
|
* @throws {RequiredError}
|
|
4526
4529
|
*/
|
|
4527
|
-
listPromotionBeneficiaries: (id, periodID, hasProgress, nextToken, search, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
4530
|
+
listPromotionBeneficiaries: (id, periodID, hasProgress, nextToken, search, interval, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
4528
4531
|
// verify required parameter 'id' is not null or undefined
|
|
4529
4532
|
(0, common_1.assertParamExists)('listPromotionBeneficiaries', 'id', id);
|
|
4530
4533
|
const localVarPath = `/admins/promotions/{id}/beneficiaries`
|
|
@@ -4553,6 +4556,9 @@ const PromotionApiAxiosParamCreator = function (configuration) {
|
|
|
4553
4556
|
if (search !== undefined) {
|
|
4554
4557
|
localVarQueryParameter['search'] = search;
|
|
4555
4558
|
}
|
|
4559
|
+
if (interval !== undefined) {
|
|
4560
|
+
localVarQueryParameter['interval'] = interval;
|
|
4561
|
+
}
|
|
4556
4562
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
4557
4563
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
4558
4564
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
@@ -4902,13 +4908,14 @@ const PromotionApiFp = function (configuration) {
|
|
|
4902
4908
|
* @param {number} [periodID] Period ID
|
|
4903
4909
|
* @param {boolean} [hasProgress] Beneficiary has progress
|
|
4904
4910
|
* @param {string} [nextToken] This is the pagination token
|
|
4905
|
-
* @param {string} [search] search string
|
|
4911
|
+
* @param {string} [search] search string, searches in client name/referenceID or user name/referenceID
|
|
4912
|
+
* @param {ProgressInterval} [interval] Progress interval to filter by
|
|
4906
4913
|
* @param {*} [options] Override http request option.
|
|
4907
4914
|
* @throws {RequiredError}
|
|
4908
4915
|
*/
|
|
4909
|
-
listPromotionBeneficiaries(id, periodID, hasProgress, nextToken, search, options) {
|
|
4916
|
+
listPromotionBeneficiaries(id, periodID, hasProgress, nextToken, search, interval, options) {
|
|
4910
4917
|
return __awaiter(this, void 0, void 0, function* () {
|
|
4911
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.listPromotionBeneficiaries(id, periodID, hasProgress, nextToken, search, options);
|
|
4918
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.listPromotionBeneficiaries(id, periodID, hasProgress, nextToken, search, interval, options);
|
|
4912
4919
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
4913
4920
|
});
|
|
4914
4921
|
},
|
|
@@ -5083,12 +5090,13 @@ const PromotionApiFactory = function (configuration, basePath, axios) {
|
|
|
5083
5090
|
* @param {number} [periodID] Period ID
|
|
5084
5091
|
* @param {boolean} [hasProgress] Beneficiary has progress
|
|
5085
5092
|
* @param {string} [nextToken] This is the pagination token
|
|
5086
|
-
* @param {string} [search] search string
|
|
5093
|
+
* @param {string} [search] search string, searches in client name/referenceID or user name/referenceID
|
|
5094
|
+
* @param {ProgressInterval} [interval] Progress interval to filter by
|
|
5087
5095
|
* @param {*} [options] Override http request option.
|
|
5088
5096
|
* @throws {RequiredError}
|
|
5089
5097
|
*/
|
|
5090
|
-
listPromotionBeneficiaries(id, periodID, hasProgress, nextToken, search, options) {
|
|
5091
|
-
return localVarFp.listPromotionBeneficiaries(id, periodID, hasProgress, nextToken, search, options).then((request) => request(axios, basePath));
|
|
5098
|
+
listPromotionBeneficiaries(id, periodID, hasProgress, nextToken, search, interval, options) {
|
|
5099
|
+
return localVarFp.listPromotionBeneficiaries(id, periodID, hasProgress, nextToken, search, interval, options).then((request) => request(axios, basePath));
|
|
5092
5100
|
},
|
|
5093
5101
|
/**
|
|
5094
5102
|
* List all promotions
|
|
@@ -5261,13 +5269,14 @@ class PromotionApi extends base_1.BaseAPI {
|
|
|
5261
5269
|
* @param {number} [periodID] Period ID
|
|
5262
5270
|
* @param {boolean} [hasProgress] Beneficiary has progress
|
|
5263
5271
|
* @param {string} [nextToken] This is the pagination token
|
|
5264
|
-
* @param {string} [search] search string
|
|
5272
|
+
* @param {string} [search] search string, searches in client name/referenceID or user name/referenceID
|
|
5273
|
+
* @param {ProgressInterval} [interval] Progress interval to filter by
|
|
5265
5274
|
* @param {*} [options] Override http request option.
|
|
5266
5275
|
* @throws {RequiredError}
|
|
5267
5276
|
* @memberof PromotionApi
|
|
5268
5277
|
*/
|
|
5269
|
-
listPromotionBeneficiaries(id, periodID, hasProgress, nextToken, search, options) {
|
|
5270
|
-
return (0, exports.PromotionApiFp)(this.configuration).listPromotionBeneficiaries(id, periodID, hasProgress, nextToken, search, options).then((request) => request(this.axios, this.basePath));
|
|
5278
|
+
listPromotionBeneficiaries(id, periodID, hasProgress, nextToken, search, interval, options) {
|
|
5279
|
+
return (0, exports.PromotionApiFp)(this.configuration).listPromotionBeneficiaries(id, periodID, hasProgress, nextToken, search, interval, options).then((request) => request(this.axios, this.basePath));
|
|
5271
5280
|
}
|
|
5272
5281
|
/**
|
|
5273
5282
|
* List all promotions
|
package/dist/esm/api.d.ts
CHANGED
|
@@ -1802,6 +1802,18 @@ export interface Progress {
|
|
|
1802
1802
|
*/
|
|
1803
1803
|
'claimedAt'?: string;
|
|
1804
1804
|
}
|
|
1805
|
+
/**
|
|
1806
|
+
*
|
|
1807
|
+
* @export
|
|
1808
|
+
* @enum {string}
|
|
1809
|
+
*/
|
|
1810
|
+
export declare const ProgressInterval: {
|
|
1811
|
+
readonly _100: "100";
|
|
1812
|
+
readonly _9975: "99-75";
|
|
1813
|
+
readonly _7550: "75-50";
|
|
1814
|
+
readonly _501: "50-1";
|
|
1815
|
+
};
|
|
1816
|
+
export type ProgressInterval = typeof ProgressInterval[keyof typeof ProgressInterval];
|
|
1805
1817
|
/**
|
|
1806
1818
|
*
|
|
1807
1819
|
* @export
|
|
@@ -5419,12 +5431,12 @@ export declare const ProgressApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
5419
5431
|
* @param {number} [periodID] Period ID
|
|
5420
5432
|
* @param {Array<string>} [userIDs] User IDs to filter by
|
|
5421
5433
|
* @param {Array<string>} [clientIDs] Client IDs to filter by
|
|
5422
|
-
* @param {
|
|
5434
|
+
* @param {ProgressInterval} [interval] Interval
|
|
5423
5435
|
* @param {string} [nextToken] This is the pagination token
|
|
5424
5436
|
* @param {*} [options] Override http request option.
|
|
5425
5437
|
* @throws {RequiredError}
|
|
5426
5438
|
*/
|
|
5427
|
-
listProgress: (promotionIDs: Array<string>, periodID?: number, userIDs?: Array<string>, clientIDs?: Array<string>, interval?:
|
|
5439
|
+
listProgress: (promotionIDs: Array<string>, periodID?: number, userIDs?: Array<string>, clientIDs?: Array<string>, interval?: ProgressInterval, nextToken?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
5428
5440
|
/**
|
|
5429
5441
|
* List users progress
|
|
5430
5442
|
* @summary List progress
|
|
@@ -5448,12 +5460,12 @@ export declare const ProgressApiFp: (configuration?: Configuration) => {
|
|
|
5448
5460
|
* @param {number} [periodID] Period ID
|
|
5449
5461
|
* @param {Array<string>} [userIDs] User IDs to filter by
|
|
5450
5462
|
* @param {Array<string>} [clientIDs] Client IDs to filter by
|
|
5451
|
-
* @param {
|
|
5463
|
+
* @param {ProgressInterval} [interval] Interval
|
|
5452
5464
|
* @param {string} [nextToken] This is the pagination token
|
|
5453
5465
|
* @param {*} [options] Override http request option.
|
|
5454
5466
|
* @throws {RequiredError}
|
|
5455
5467
|
*/
|
|
5456
|
-
listProgress(promotionIDs: Array<string>, periodID?: number, userIDs?: Array<string>, clientIDs?: Array<string>, interval?:
|
|
5468
|
+
listProgress(promotionIDs: Array<string>, periodID?: number, userIDs?: Array<string>, clientIDs?: Array<string>, interval?: ProgressInterval, nextToken?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProgressResponse>>;
|
|
5457
5469
|
/**
|
|
5458
5470
|
* List users progress
|
|
5459
5471
|
* @summary List progress
|
|
@@ -5477,12 +5489,12 @@ export declare const ProgressApiFactory: (configuration?: Configuration, basePat
|
|
|
5477
5489
|
* @param {number} [periodID] Period ID
|
|
5478
5490
|
* @param {Array<string>} [userIDs] User IDs to filter by
|
|
5479
5491
|
* @param {Array<string>} [clientIDs] Client IDs to filter by
|
|
5480
|
-
* @param {
|
|
5492
|
+
* @param {ProgressInterval} [interval] Interval
|
|
5481
5493
|
* @param {string} [nextToken] This is the pagination token
|
|
5482
5494
|
* @param {*} [options] Override http request option.
|
|
5483
5495
|
* @throws {RequiredError}
|
|
5484
5496
|
*/
|
|
5485
|
-
listProgress(promotionIDs: Array<string>, periodID?: number, userIDs?: Array<string>, clientIDs?: Array<string>, interval?:
|
|
5497
|
+
listProgress(promotionIDs: Array<string>, periodID?: number, userIDs?: Array<string>, clientIDs?: Array<string>, interval?: ProgressInterval, nextToken?: string, options?: any): AxiosPromise<ProgressResponse>;
|
|
5486
5498
|
/**
|
|
5487
5499
|
* List users progress
|
|
5488
5500
|
* @summary List progress
|
|
@@ -5508,13 +5520,13 @@ export declare class ProgressApi extends BaseAPI {
|
|
|
5508
5520
|
* @param {number} [periodID] Period ID
|
|
5509
5521
|
* @param {Array<string>} [userIDs] User IDs to filter by
|
|
5510
5522
|
* @param {Array<string>} [clientIDs] Client IDs to filter by
|
|
5511
|
-
* @param {
|
|
5523
|
+
* @param {ProgressInterval} [interval] Interval
|
|
5512
5524
|
* @param {string} [nextToken] This is the pagination token
|
|
5513
5525
|
* @param {*} [options] Override http request option.
|
|
5514
5526
|
* @throws {RequiredError}
|
|
5515
5527
|
* @memberof ProgressApi
|
|
5516
5528
|
*/
|
|
5517
|
-
listProgress(promotionIDs: Array<string>, periodID?: number, userIDs?: Array<string>, clientIDs?: Array<string>, interval?:
|
|
5529
|
+
listProgress(promotionIDs: Array<string>, periodID?: number, userIDs?: Array<string>, clientIDs?: Array<string>, interval?: ProgressInterval, nextToken?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgressResponse, any>>;
|
|
5518
5530
|
/**
|
|
5519
5531
|
* List users progress
|
|
5520
5532
|
* @summary List progress
|
|
@@ -5527,16 +5539,6 @@ export declare class ProgressApi extends BaseAPI {
|
|
|
5527
5539
|
*/
|
|
5528
5540
|
listUserProgress(promotionIDs: Array<string>, periodID?: number, nextToken?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgressResponse, any>>;
|
|
5529
5541
|
}
|
|
5530
|
-
/**
|
|
5531
|
-
* @export
|
|
5532
|
-
*/
|
|
5533
|
-
export declare const ListProgressIntervalEnum: {
|
|
5534
|
-
readonly _100: "100";
|
|
5535
|
-
readonly _9975: "99-75";
|
|
5536
|
-
readonly _7550: "75-50";
|
|
5537
|
-
readonly _501: "50-1";
|
|
5538
|
-
};
|
|
5539
|
-
export type ListProgressIntervalEnum = typeof ListProgressIntervalEnum[keyof typeof ListProgressIntervalEnum];
|
|
5540
5542
|
/**
|
|
5541
5543
|
* PromotionApi - axios parameter creator
|
|
5542
5544
|
* @export
|
|
@@ -5623,11 +5625,12 @@ export declare const PromotionApiAxiosParamCreator: (configuration?: Configurati
|
|
|
5623
5625
|
* @param {number} [periodID] Period ID
|
|
5624
5626
|
* @param {boolean} [hasProgress] Beneficiary has progress
|
|
5625
5627
|
* @param {string} [nextToken] This is the pagination token
|
|
5626
|
-
* @param {string} [search] search string
|
|
5628
|
+
* @param {string} [search] search string, searches in client name/referenceID or user name/referenceID
|
|
5629
|
+
* @param {ProgressInterval} [interval] Progress interval to filter by
|
|
5627
5630
|
* @param {*} [options] Override http request option.
|
|
5628
5631
|
* @throws {RequiredError}
|
|
5629
5632
|
*/
|
|
5630
|
-
listPromotionBeneficiaries: (id: string, periodID?: number, hasProgress?: boolean, nextToken?: string, search?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
5633
|
+
listPromotionBeneficiaries: (id: string, periodID?: number, hasProgress?: boolean, nextToken?: string, search?: string, interval?: ProgressInterval, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
5631
5634
|
/**
|
|
5632
5635
|
* List all promotions
|
|
5633
5636
|
* @summary List promotions
|
|
@@ -5762,11 +5765,12 @@ export declare const PromotionApiFp: (configuration?: Configuration) => {
|
|
|
5762
5765
|
* @param {number} [periodID] Period ID
|
|
5763
5766
|
* @param {boolean} [hasProgress] Beneficiary has progress
|
|
5764
5767
|
* @param {string} [nextToken] This is the pagination token
|
|
5765
|
-
* @param {string} [search] search string
|
|
5768
|
+
* @param {string} [search] search string, searches in client name/referenceID or user name/referenceID
|
|
5769
|
+
* @param {ProgressInterval} [interval] Progress interval to filter by
|
|
5766
5770
|
* @param {*} [options] Override http request option.
|
|
5767
5771
|
* @throws {RequiredError}
|
|
5768
5772
|
*/
|
|
5769
|
-
listPromotionBeneficiaries(id: string, periodID?: number, hasProgress?: boolean, nextToken?: string, search?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PromotionBeneficiariesResponse>>;
|
|
5773
|
+
listPromotionBeneficiaries(id: string, periodID?: number, hasProgress?: boolean, nextToken?: string, search?: string, interval?: ProgressInterval, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PromotionBeneficiariesResponse>>;
|
|
5770
5774
|
/**
|
|
5771
5775
|
* List all promotions
|
|
5772
5776
|
* @summary List promotions
|
|
@@ -5901,11 +5905,12 @@ export declare const PromotionApiFactory: (configuration?: Configuration, basePa
|
|
|
5901
5905
|
* @param {number} [periodID] Period ID
|
|
5902
5906
|
* @param {boolean} [hasProgress] Beneficiary has progress
|
|
5903
5907
|
* @param {string} [nextToken] This is the pagination token
|
|
5904
|
-
* @param {string} [search] search string
|
|
5908
|
+
* @param {string} [search] search string, searches in client name/referenceID or user name/referenceID
|
|
5909
|
+
* @param {ProgressInterval} [interval] Progress interval to filter by
|
|
5905
5910
|
* @param {*} [options] Override http request option.
|
|
5906
5911
|
* @throws {RequiredError}
|
|
5907
5912
|
*/
|
|
5908
|
-
listPromotionBeneficiaries(id: string, periodID?: number, hasProgress?: boolean, nextToken?: string, search?: string, options?: any): AxiosPromise<PromotionBeneficiariesResponse>;
|
|
5913
|
+
listPromotionBeneficiaries(id: string, periodID?: number, hasProgress?: boolean, nextToken?: string, search?: string, interval?: ProgressInterval, options?: any): AxiosPromise<PromotionBeneficiariesResponse>;
|
|
5909
5914
|
/**
|
|
5910
5915
|
* List all promotions
|
|
5911
5916
|
* @summary List promotions
|
|
@@ -6051,12 +6056,13 @@ export declare class PromotionApi extends BaseAPI {
|
|
|
6051
6056
|
* @param {number} [periodID] Period ID
|
|
6052
6057
|
* @param {boolean} [hasProgress] Beneficiary has progress
|
|
6053
6058
|
* @param {string} [nextToken] This is the pagination token
|
|
6054
|
-
* @param {string} [search] search string
|
|
6059
|
+
* @param {string} [search] search string, searches in client name/referenceID or user name/referenceID
|
|
6060
|
+
* @param {ProgressInterval} [interval] Progress interval to filter by
|
|
6055
6061
|
* @param {*} [options] Override http request option.
|
|
6056
6062
|
* @throws {RequiredError}
|
|
6057
6063
|
* @memberof PromotionApi
|
|
6058
6064
|
*/
|
|
6059
|
-
listPromotionBeneficiaries(id: string, periodID?: number, hasProgress?: boolean, nextToken?: string, search?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PromotionBeneficiariesResponse, any>>;
|
|
6065
|
+
listPromotionBeneficiaries(id: string, periodID?: number, hasProgress?: boolean, nextToken?: string, search?: string, interval?: ProgressInterval, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PromotionBeneficiariesResponse, any>>;
|
|
6060
6066
|
/**
|
|
6061
6067
|
* List all promotions
|
|
6062
6068
|
* @summary List promotions
|
package/dist/esm/api.js
CHANGED
|
@@ -176,6 +176,17 @@ export const ProductUsage = {
|
|
|
176
176
|
Promotion: 'promotion',
|
|
177
177
|
SalesBudget: 'sales_budget'
|
|
178
178
|
};
|
|
179
|
+
/**
|
|
180
|
+
*
|
|
181
|
+
* @export
|
|
182
|
+
* @enum {string}
|
|
183
|
+
*/
|
|
184
|
+
export const ProgressInterval = {
|
|
185
|
+
_100: '100',
|
|
186
|
+
_9975: '99-75',
|
|
187
|
+
_7550: '75-50',
|
|
188
|
+
_501: '50-1'
|
|
189
|
+
};
|
|
179
190
|
/**
|
|
180
191
|
*
|
|
181
192
|
* @export
|
|
@@ -3943,7 +3954,7 @@ export const ProgressApiAxiosParamCreator = function (configuration) {
|
|
|
3943
3954
|
* @param {number} [periodID] Period ID
|
|
3944
3955
|
* @param {Array<string>} [userIDs] User IDs to filter by
|
|
3945
3956
|
* @param {Array<string>} [clientIDs] Client IDs to filter by
|
|
3946
|
-
* @param {
|
|
3957
|
+
* @param {ProgressInterval} [interval] Interval
|
|
3947
3958
|
* @param {string} [nextToken] This is the pagination token
|
|
3948
3959
|
* @param {*} [options] Override http request option.
|
|
3949
3960
|
* @throws {RequiredError}
|
|
@@ -4048,7 +4059,7 @@ export const ProgressApiFp = function (configuration) {
|
|
|
4048
4059
|
* @param {number} [periodID] Period ID
|
|
4049
4060
|
* @param {Array<string>} [userIDs] User IDs to filter by
|
|
4050
4061
|
* @param {Array<string>} [clientIDs] Client IDs to filter by
|
|
4051
|
-
* @param {
|
|
4062
|
+
* @param {ProgressInterval} [interval] Interval
|
|
4052
4063
|
* @param {string} [nextToken] This is the pagination token
|
|
4053
4064
|
* @param {*} [options] Override http request option.
|
|
4054
4065
|
* @throws {RequiredError}
|
|
@@ -4090,7 +4101,7 @@ export const ProgressApiFactory = function (configuration, basePath, axios) {
|
|
|
4090
4101
|
* @param {number} [periodID] Period ID
|
|
4091
4102
|
* @param {Array<string>} [userIDs] User IDs to filter by
|
|
4092
4103
|
* @param {Array<string>} [clientIDs] Client IDs to filter by
|
|
4093
|
-
* @param {
|
|
4104
|
+
* @param {ProgressInterval} [interval] Interval
|
|
4094
4105
|
* @param {string} [nextToken] This is the pagination token
|
|
4095
4106
|
* @param {*} [options] Override http request option.
|
|
4096
4107
|
* @throws {RequiredError}
|
|
@@ -4126,7 +4137,7 @@ export class ProgressApi extends BaseAPI {
|
|
|
4126
4137
|
* @param {number} [periodID] Period ID
|
|
4127
4138
|
* @param {Array<string>} [userIDs] User IDs to filter by
|
|
4128
4139
|
* @param {Array<string>} [clientIDs] Client IDs to filter by
|
|
4129
|
-
* @param {
|
|
4140
|
+
* @param {ProgressInterval} [interval] Interval
|
|
4130
4141
|
* @param {string} [nextToken] This is the pagination token
|
|
4131
4142
|
* @param {*} [options] Override http request option.
|
|
4132
4143
|
* @throws {RequiredError}
|
|
@@ -4149,15 +4160,6 @@ export class ProgressApi extends BaseAPI {
|
|
|
4149
4160
|
return ProgressApiFp(this.configuration).listUserProgress(promotionIDs, periodID, nextToken, options).then((request) => request(this.axios, this.basePath));
|
|
4150
4161
|
}
|
|
4151
4162
|
}
|
|
4152
|
-
/**
|
|
4153
|
-
* @export
|
|
4154
|
-
*/
|
|
4155
|
-
export const ListProgressIntervalEnum = {
|
|
4156
|
-
_100: '100',
|
|
4157
|
-
_9975: '99-75',
|
|
4158
|
-
_7550: '75-50',
|
|
4159
|
-
_501: '50-1'
|
|
4160
|
-
};
|
|
4161
4163
|
/**
|
|
4162
4164
|
* PromotionApi - axios parameter creator
|
|
4163
4165
|
* @export
|
|
@@ -4467,11 +4469,12 @@ export const PromotionApiAxiosParamCreator = function (configuration) {
|
|
|
4467
4469
|
* @param {number} [periodID] Period ID
|
|
4468
4470
|
* @param {boolean} [hasProgress] Beneficiary has progress
|
|
4469
4471
|
* @param {string} [nextToken] This is the pagination token
|
|
4470
|
-
* @param {string} [search] search string
|
|
4472
|
+
* @param {string} [search] search string, searches in client name/referenceID or user name/referenceID
|
|
4473
|
+
* @param {ProgressInterval} [interval] Progress interval to filter by
|
|
4471
4474
|
* @param {*} [options] Override http request option.
|
|
4472
4475
|
* @throws {RequiredError}
|
|
4473
4476
|
*/
|
|
4474
|
-
listPromotionBeneficiaries: (id, periodID, hasProgress, nextToken, search, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
4477
|
+
listPromotionBeneficiaries: (id, periodID, hasProgress, nextToken, search, interval, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
4475
4478
|
// verify required parameter 'id' is not null or undefined
|
|
4476
4479
|
assertParamExists('listPromotionBeneficiaries', 'id', id);
|
|
4477
4480
|
const localVarPath = `/admins/promotions/{id}/beneficiaries`
|
|
@@ -4500,6 +4503,9 @@ export const PromotionApiAxiosParamCreator = function (configuration) {
|
|
|
4500
4503
|
if (search !== undefined) {
|
|
4501
4504
|
localVarQueryParameter['search'] = search;
|
|
4502
4505
|
}
|
|
4506
|
+
if (interval !== undefined) {
|
|
4507
|
+
localVarQueryParameter['interval'] = interval;
|
|
4508
|
+
}
|
|
4503
4509
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4504
4510
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
4505
4511
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
@@ -4848,13 +4854,14 @@ export const PromotionApiFp = function (configuration) {
|
|
|
4848
4854
|
* @param {number} [periodID] Period ID
|
|
4849
4855
|
* @param {boolean} [hasProgress] Beneficiary has progress
|
|
4850
4856
|
* @param {string} [nextToken] This is the pagination token
|
|
4851
|
-
* @param {string} [search] search string
|
|
4857
|
+
* @param {string} [search] search string, searches in client name/referenceID or user name/referenceID
|
|
4858
|
+
* @param {ProgressInterval} [interval] Progress interval to filter by
|
|
4852
4859
|
* @param {*} [options] Override http request option.
|
|
4853
4860
|
* @throws {RequiredError}
|
|
4854
4861
|
*/
|
|
4855
|
-
listPromotionBeneficiaries(id, periodID, hasProgress, nextToken, search, options) {
|
|
4862
|
+
listPromotionBeneficiaries(id, periodID, hasProgress, nextToken, search, interval, options) {
|
|
4856
4863
|
return __awaiter(this, void 0, void 0, function* () {
|
|
4857
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.listPromotionBeneficiaries(id, periodID, hasProgress, nextToken, search, options);
|
|
4864
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.listPromotionBeneficiaries(id, periodID, hasProgress, nextToken, search, interval, options);
|
|
4858
4865
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
4859
4866
|
});
|
|
4860
4867
|
},
|
|
@@ -5028,12 +5035,13 @@ export const PromotionApiFactory = function (configuration, basePath, axios) {
|
|
|
5028
5035
|
* @param {number} [periodID] Period ID
|
|
5029
5036
|
* @param {boolean} [hasProgress] Beneficiary has progress
|
|
5030
5037
|
* @param {string} [nextToken] This is the pagination token
|
|
5031
|
-
* @param {string} [search] search string
|
|
5038
|
+
* @param {string} [search] search string, searches in client name/referenceID or user name/referenceID
|
|
5039
|
+
* @param {ProgressInterval} [interval] Progress interval to filter by
|
|
5032
5040
|
* @param {*} [options] Override http request option.
|
|
5033
5041
|
* @throws {RequiredError}
|
|
5034
5042
|
*/
|
|
5035
|
-
listPromotionBeneficiaries(id, periodID, hasProgress, nextToken, search, options) {
|
|
5036
|
-
return localVarFp.listPromotionBeneficiaries(id, periodID, hasProgress, nextToken, search, options).then((request) => request(axios, basePath));
|
|
5043
|
+
listPromotionBeneficiaries(id, periodID, hasProgress, nextToken, search, interval, options) {
|
|
5044
|
+
return localVarFp.listPromotionBeneficiaries(id, periodID, hasProgress, nextToken, search, interval, options).then((request) => request(axios, basePath));
|
|
5037
5045
|
},
|
|
5038
5046
|
/**
|
|
5039
5047
|
* List all promotions
|
|
@@ -5205,13 +5213,14 @@ export class PromotionApi extends BaseAPI {
|
|
|
5205
5213
|
* @param {number} [periodID] Period ID
|
|
5206
5214
|
* @param {boolean} [hasProgress] Beneficiary has progress
|
|
5207
5215
|
* @param {string} [nextToken] This is the pagination token
|
|
5208
|
-
* @param {string} [search] search string
|
|
5216
|
+
* @param {string} [search] search string, searches in client name/referenceID or user name/referenceID
|
|
5217
|
+
* @param {ProgressInterval} [interval] Progress interval to filter by
|
|
5209
5218
|
* @param {*} [options] Override http request option.
|
|
5210
5219
|
* @throws {RequiredError}
|
|
5211
5220
|
* @memberof PromotionApi
|
|
5212
5221
|
*/
|
|
5213
|
-
listPromotionBeneficiaries(id, periodID, hasProgress, nextToken, search, options) {
|
|
5214
|
-
return PromotionApiFp(this.configuration).listPromotionBeneficiaries(id, periodID, hasProgress, nextToken, search, options).then((request) => request(this.axios, this.basePath));
|
|
5222
|
+
listPromotionBeneficiaries(id, periodID, hasProgress, nextToken, search, interval, options) {
|
|
5223
|
+
return PromotionApiFp(this.configuration).listPromotionBeneficiaries(id, periodID, hasProgress, nextToken, search, interval, options).then((request) => request(this.axios, this.basePath));
|
|
5215
5224
|
}
|
|
5216
5225
|
/**
|
|
5217
5226
|
* List all promotions
|