flexinet-api 0.0.700-prerelease0 → 0.0.707-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 +67 -25
- package/dist/api.d.ts +48 -22
- package/dist/api.js +45 -22
- package/dist/esm/api.d.ts +48 -22
- package/dist/esm/api.js +43 -20
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## flexinet-api@0.0.
|
|
1
|
+
## flexinet-api@0.0.707-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.707-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
|
|
@@ -2128,6 +2144,12 @@ export interface PromotionClientBeneficiaries {
|
|
|
2128
2144
|
* @memberof PromotionClientBeneficiaries
|
|
2129
2145
|
*/
|
|
2130
2146
|
'beneficiaries': Array<Client>;
|
|
2147
|
+
/**
|
|
2148
|
+
* This is the pagination token
|
|
2149
|
+
* @type {string}
|
|
2150
|
+
* @memberof PromotionClientBeneficiaries
|
|
2151
|
+
*/
|
|
2152
|
+
'nextToken'?: string;
|
|
2131
2153
|
}
|
|
2132
2154
|
|
|
2133
2155
|
|
|
@@ -2327,6 +2349,12 @@ export interface PromotionUserBeneficiaries {
|
|
|
2327
2349
|
* @memberof PromotionUserBeneficiaries
|
|
2328
2350
|
*/
|
|
2329
2351
|
'beneficiaries': Array<User>;
|
|
2352
|
+
/**
|
|
2353
|
+
* This is the pagination token
|
|
2354
|
+
* @type {string}
|
|
2355
|
+
* @memberof PromotionUserBeneficiaries
|
|
2356
|
+
*/
|
|
2357
|
+
'nextToken'?: string;
|
|
2330
2358
|
}
|
|
2331
2359
|
|
|
2332
2360
|
|
|
@@ -7619,12 +7647,12 @@ export const ProgressApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
7619
7647
|
* @param {number} [periodID] Period ID
|
|
7620
7648
|
* @param {Array<string>} [userIDs] User IDs to filter by
|
|
7621
7649
|
* @param {Array<string>} [clientIDs] Client IDs to filter by
|
|
7622
|
-
* @param {
|
|
7650
|
+
* @param {ProgressInterval} [interval] Interval
|
|
7623
7651
|
* @param {string} [nextToken] This is the pagination token
|
|
7624
7652
|
* @param {*} [options] Override http request option.
|
|
7625
7653
|
* @throws {RequiredError}
|
|
7626
7654
|
*/
|
|
7627
|
-
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> => {
|
|
7628
7656
|
// verify required parameter 'promotionIDs' is not null or undefined
|
|
7629
7657
|
assertParamExists('listProgress', 'promotionIDs', promotionIDs)
|
|
7630
7658
|
const localVarPath = `/admins/progress`;
|
|
@@ -7746,12 +7774,12 @@ export const ProgressApiFp = function(configuration?: Configuration) {
|
|
|
7746
7774
|
* @param {number} [periodID] Period ID
|
|
7747
7775
|
* @param {Array<string>} [userIDs] User IDs to filter by
|
|
7748
7776
|
* @param {Array<string>} [clientIDs] Client IDs to filter by
|
|
7749
|
-
* @param {
|
|
7777
|
+
* @param {ProgressInterval} [interval] Interval
|
|
7750
7778
|
* @param {string} [nextToken] This is the pagination token
|
|
7751
7779
|
* @param {*} [options] Override http request option.
|
|
7752
7780
|
* @throws {RequiredError}
|
|
7753
7781
|
*/
|
|
7754
|
-
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>> {
|
|
7755
7783
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listProgress(promotionIDs, periodID, userIDs, clientIDs, interval, nextToken, options);
|
|
7756
7784
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
7757
7785
|
},
|
|
@@ -7785,12 +7813,12 @@ export const ProgressApiFactory = function (configuration?: Configuration, baseP
|
|
|
7785
7813
|
* @param {number} [periodID] Period ID
|
|
7786
7814
|
* @param {Array<string>} [userIDs] User IDs to filter by
|
|
7787
7815
|
* @param {Array<string>} [clientIDs] Client IDs to filter by
|
|
7788
|
-
* @param {
|
|
7816
|
+
* @param {ProgressInterval} [interval] Interval
|
|
7789
7817
|
* @param {string} [nextToken] This is the pagination token
|
|
7790
7818
|
* @param {*} [options] Override http request option.
|
|
7791
7819
|
* @throws {RequiredError}
|
|
7792
7820
|
*/
|
|
7793
|
-
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> {
|
|
7794
7822
|
return localVarFp.listProgress(promotionIDs, periodID, userIDs, clientIDs, interval, nextToken, options).then((request) => request(axios, basePath));
|
|
7795
7823
|
},
|
|
7796
7824
|
/**
|
|
@@ -7822,13 +7850,13 @@ export class ProgressApi extends BaseAPI {
|
|
|
7822
7850
|
* @param {number} [periodID] Period ID
|
|
7823
7851
|
* @param {Array<string>} [userIDs] User IDs to filter by
|
|
7824
7852
|
* @param {Array<string>} [clientIDs] Client IDs to filter by
|
|
7825
|
-
* @param {
|
|
7853
|
+
* @param {ProgressInterval} [interval] Interval
|
|
7826
7854
|
* @param {string} [nextToken] This is the pagination token
|
|
7827
7855
|
* @param {*} [options] Override http request option.
|
|
7828
7856
|
* @throws {RequiredError}
|
|
7829
7857
|
* @memberof ProgressApi
|
|
7830
7858
|
*/
|
|
7831
|
-
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) {
|
|
7832
7860
|
return ProgressApiFp(this.configuration).listProgress(promotionIDs, periodID, userIDs, clientIDs, interval, nextToken, options).then((request) => request(this.axios, this.basePath));
|
|
7833
7861
|
}
|
|
7834
7862
|
|
|
@@ -7847,16 +7875,6 @@ export class ProgressApi extends BaseAPI {
|
|
|
7847
7875
|
}
|
|
7848
7876
|
}
|
|
7849
7877
|
|
|
7850
|
-
/**
|
|
7851
|
-
* @export
|
|
7852
|
-
*/
|
|
7853
|
-
export const ListProgressIntervalEnum = {
|
|
7854
|
-
_100: '100',
|
|
7855
|
-
_9975: '99-75',
|
|
7856
|
-
_7550: '75-50',
|
|
7857
|
-
_501: '50-1'
|
|
7858
|
-
} as const;
|
|
7859
|
-
export type ListProgressIntervalEnum = typeof ListProgressIntervalEnum[keyof typeof ListProgressIntervalEnum];
|
|
7860
7878
|
|
|
7861
7879
|
|
|
7862
7880
|
/**
|
|
@@ -8223,10 +8241,13 @@ export const PromotionApiAxiosParamCreator = function (configuration?: Configura
|
|
|
8223
8241
|
* @param {string} id Promotion ID
|
|
8224
8242
|
* @param {number} [periodID] Period ID
|
|
8225
8243
|
* @param {boolean} [hasProgress] Beneficiary has progress
|
|
8244
|
+
* @param {string} [nextToken] This is the pagination token
|
|
8245
|
+
* @param {string} [search] search string, searches in client name/referenceID or user name/referenceID
|
|
8246
|
+
* @param {ProgressInterval} [interval] Progress interval to filter by
|
|
8226
8247
|
* @param {*} [options] Override http request option.
|
|
8227
8248
|
* @throws {RequiredError}
|
|
8228
8249
|
*/
|
|
8229
|
-
listPromotionBeneficiaries: async (id: string, periodID?: number, hasProgress?: boolean, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
8250
|
+
listPromotionBeneficiaries: async (id: string, periodID?: number, hasProgress?: boolean, nextToken?: string, search?: string, interval?: ProgressInterval, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
8230
8251
|
// verify required parameter 'id' is not null or undefined
|
|
8231
8252
|
assertParamExists('listPromotionBeneficiaries', 'id', id)
|
|
8232
8253
|
const localVarPath = `/admins/promotions/{id}/beneficiaries`
|
|
@@ -8254,6 +8275,18 @@ export const PromotionApiAxiosParamCreator = function (configuration?: Configura
|
|
|
8254
8275
|
localVarQueryParameter['hasProgress'] = hasProgress;
|
|
8255
8276
|
}
|
|
8256
8277
|
|
|
8278
|
+
if (nextToken !== undefined) {
|
|
8279
|
+
localVarQueryParameter['nextToken'] = nextToken;
|
|
8280
|
+
}
|
|
8281
|
+
|
|
8282
|
+
if (search !== undefined) {
|
|
8283
|
+
localVarQueryParameter['search'] = search;
|
|
8284
|
+
}
|
|
8285
|
+
|
|
8286
|
+
if (interval !== undefined) {
|
|
8287
|
+
localVarQueryParameter['interval'] = interval;
|
|
8288
|
+
}
|
|
8289
|
+
|
|
8257
8290
|
|
|
8258
8291
|
|
|
8259
8292
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -8630,11 +8663,14 @@ export const PromotionApiFp = function(configuration?: Configuration) {
|
|
|
8630
8663
|
* @param {string} id Promotion ID
|
|
8631
8664
|
* @param {number} [periodID] Period ID
|
|
8632
8665
|
* @param {boolean} [hasProgress] Beneficiary has progress
|
|
8666
|
+
* @param {string} [nextToken] This is the pagination token
|
|
8667
|
+
* @param {string} [search] search string, searches in client name/referenceID or user name/referenceID
|
|
8668
|
+
* @param {ProgressInterval} [interval] Progress interval to filter by
|
|
8633
8669
|
* @param {*} [options] Override http request option.
|
|
8634
8670
|
* @throws {RequiredError}
|
|
8635
8671
|
*/
|
|
8636
|
-
async listPromotionBeneficiaries(id: string, periodID?: number, hasProgress?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PromotionBeneficiariesResponse>> {
|
|
8637
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listPromotionBeneficiaries(id, periodID, hasProgress, 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);
|
|
8638
8674
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
8639
8675
|
},
|
|
8640
8676
|
/**
|
|
@@ -8801,11 +8837,14 @@ export const PromotionApiFactory = function (configuration?: Configuration, base
|
|
|
8801
8837
|
* @param {string} id Promotion ID
|
|
8802
8838
|
* @param {number} [periodID] Period ID
|
|
8803
8839
|
* @param {boolean} [hasProgress] Beneficiary has progress
|
|
8840
|
+
* @param {string} [nextToken] This is the pagination token
|
|
8841
|
+
* @param {string} [search] search string, searches in client name/referenceID or user name/referenceID
|
|
8842
|
+
* @param {ProgressInterval} [interval] Progress interval to filter by
|
|
8804
8843
|
* @param {*} [options] Override http request option.
|
|
8805
8844
|
* @throws {RequiredError}
|
|
8806
8845
|
*/
|
|
8807
|
-
listPromotionBeneficiaries(id: string, periodID?: number, hasProgress?: boolean, options?: any): AxiosPromise<PromotionBeneficiariesResponse> {
|
|
8808
|
-
return localVarFp.listPromotionBeneficiaries(id, periodID, hasProgress, 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));
|
|
8809
8848
|
},
|
|
8810
8849
|
/**
|
|
8811
8850
|
* List all promotions
|
|
@@ -8986,12 +9025,15 @@ export class PromotionApi extends BaseAPI {
|
|
|
8986
9025
|
* @param {string} id Promotion ID
|
|
8987
9026
|
* @param {number} [periodID] Period ID
|
|
8988
9027
|
* @param {boolean} [hasProgress] Beneficiary has progress
|
|
9028
|
+
* @param {string} [nextToken] This is the pagination token
|
|
9029
|
+
* @param {string} [search] search string, searches in client name/referenceID or user name/referenceID
|
|
9030
|
+
* @param {ProgressInterval} [interval] Progress interval to filter by
|
|
8989
9031
|
* @param {*} [options] Override http request option.
|
|
8990
9032
|
* @throws {RequiredError}
|
|
8991
9033
|
* @memberof PromotionApi
|
|
8992
9034
|
*/
|
|
8993
|
-
public listPromotionBeneficiaries(id: string, periodID?: number, hasProgress?: boolean, options?: AxiosRequestConfig) {
|
|
8994
|
-
return PromotionApiFp(this.configuration).listPromotionBeneficiaries(id, periodID, hasProgress, 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));
|
|
8995
9037
|
}
|
|
8996
9038
|
|
|
8997
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
|
|
@@ -2030,6 +2042,12 @@ export interface PromotionClientBeneficiaries {
|
|
|
2030
2042
|
* @memberof PromotionClientBeneficiaries
|
|
2031
2043
|
*/
|
|
2032
2044
|
'beneficiaries': Array<Client>;
|
|
2045
|
+
/**
|
|
2046
|
+
* This is the pagination token
|
|
2047
|
+
* @type {string}
|
|
2048
|
+
* @memberof PromotionClientBeneficiaries
|
|
2049
|
+
*/
|
|
2050
|
+
'nextToken'?: string;
|
|
2033
2051
|
}
|
|
2034
2052
|
/**
|
|
2035
2053
|
*
|
|
@@ -2219,6 +2237,12 @@ export interface PromotionUserBeneficiaries {
|
|
|
2219
2237
|
* @memberof PromotionUserBeneficiaries
|
|
2220
2238
|
*/
|
|
2221
2239
|
'beneficiaries': Array<User>;
|
|
2240
|
+
/**
|
|
2241
|
+
* This is the pagination token
|
|
2242
|
+
* @type {string}
|
|
2243
|
+
* @memberof PromotionUserBeneficiaries
|
|
2244
|
+
*/
|
|
2245
|
+
'nextToken'?: string;
|
|
2222
2246
|
}
|
|
2223
2247
|
/**
|
|
2224
2248
|
*
|
|
@@ -5407,12 +5431,12 @@ export declare const ProgressApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
5407
5431
|
* @param {number} [periodID] Period ID
|
|
5408
5432
|
* @param {Array<string>} [userIDs] User IDs to filter by
|
|
5409
5433
|
* @param {Array<string>} [clientIDs] Client IDs to filter by
|
|
5410
|
-
* @param {
|
|
5434
|
+
* @param {ProgressInterval} [interval] Interval
|
|
5411
5435
|
* @param {string} [nextToken] This is the pagination token
|
|
5412
5436
|
* @param {*} [options] Override http request option.
|
|
5413
5437
|
* @throws {RequiredError}
|
|
5414
5438
|
*/
|
|
5415
|
-
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>;
|
|
5416
5440
|
/**
|
|
5417
5441
|
* List users progress
|
|
5418
5442
|
* @summary List progress
|
|
@@ -5436,12 +5460,12 @@ export declare const ProgressApiFp: (configuration?: Configuration) => {
|
|
|
5436
5460
|
* @param {number} [periodID] Period ID
|
|
5437
5461
|
* @param {Array<string>} [userIDs] User IDs to filter by
|
|
5438
5462
|
* @param {Array<string>} [clientIDs] Client IDs to filter by
|
|
5439
|
-
* @param {
|
|
5463
|
+
* @param {ProgressInterval} [interval] Interval
|
|
5440
5464
|
* @param {string} [nextToken] This is the pagination token
|
|
5441
5465
|
* @param {*} [options] Override http request option.
|
|
5442
5466
|
* @throws {RequiredError}
|
|
5443
5467
|
*/
|
|
5444
|
-
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>>;
|
|
5445
5469
|
/**
|
|
5446
5470
|
* List users progress
|
|
5447
5471
|
* @summary List progress
|
|
@@ -5465,12 +5489,12 @@ export declare const ProgressApiFactory: (configuration?: Configuration, basePat
|
|
|
5465
5489
|
* @param {number} [periodID] Period ID
|
|
5466
5490
|
* @param {Array<string>} [userIDs] User IDs to filter by
|
|
5467
5491
|
* @param {Array<string>} [clientIDs] Client IDs to filter by
|
|
5468
|
-
* @param {
|
|
5492
|
+
* @param {ProgressInterval} [interval] Interval
|
|
5469
5493
|
* @param {string} [nextToken] This is the pagination token
|
|
5470
5494
|
* @param {*} [options] Override http request option.
|
|
5471
5495
|
* @throws {RequiredError}
|
|
5472
5496
|
*/
|
|
5473
|
-
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>;
|
|
5474
5498
|
/**
|
|
5475
5499
|
* List users progress
|
|
5476
5500
|
* @summary List progress
|
|
@@ -5496,13 +5520,13 @@ export declare class ProgressApi extends BaseAPI {
|
|
|
5496
5520
|
* @param {number} [periodID] Period ID
|
|
5497
5521
|
* @param {Array<string>} [userIDs] User IDs to filter by
|
|
5498
5522
|
* @param {Array<string>} [clientIDs] Client IDs to filter by
|
|
5499
|
-
* @param {
|
|
5523
|
+
* @param {ProgressInterval} [interval] Interval
|
|
5500
5524
|
* @param {string} [nextToken] This is the pagination token
|
|
5501
5525
|
* @param {*} [options] Override http request option.
|
|
5502
5526
|
* @throws {RequiredError}
|
|
5503
5527
|
* @memberof ProgressApi
|
|
5504
5528
|
*/
|
|
5505
|
-
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>>;
|
|
5506
5530
|
/**
|
|
5507
5531
|
* List users progress
|
|
5508
5532
|
* @summary List progress
|
|
@@ -5515,16 +5539,6 @@ export declare class ProgressApi extends BaseAPI {
|
|
|
5515
5539
|
*/
|
|
5516
5540
|
listUserProgress(promotionIDs: Array<string>, periodID?: number, nextToken?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgressResponse, any>>;
|
|
5517
5541
|
}
|
|
5518
|
-
/**
|
|
5519
|
-
* @export
|
|
5520
|
-
*/
|
|
5521
|
-
export declare const ListProgressIntervalEnum: {
|
|
5522
|
-
readonly _100: "100";
|
|
5523
|
-
readonly _9975: "99-75";
|
|
5524
|
-
readonly _7550: "75-50";
|
|
5525
|
-
readonly _501: "50-1";
|
|
5526
|
-
};
|
|
5527
|
-
export type ListProgressIntervalEnum = typeof ListProgressIntervalEnum[keyof typeof ListProgressIntervalEnum];
|
|
5528
5542
|
/**
|
|
5529
5543
|
* PromotionApi - axios parameter creator
|
|
5530
5544
|
* @export
|
|
@@ -5610,10 +5624,13 @@ export declare const PromotionApiAxiosParamCreator: (configuration?: Configurati
|
|
|
5610
5624
|
* @param {string} id Promotion ID
|
|
5611
5625
|
* @param {number} [periodID] Period ID
|
|
5612
5626
|
* @param {boolean} [hasProgress] Beneficiary has progress
|
|
5627
|
+
* @param {string} [nextToken] This is the pagination token
|
|
5628
|
+
* @param {string} [search] search string, searches in client name/referenceID or user name/referenceID
|
|
5629
|
+
* @param {ProgressInterval} [interval] Progress interval to filter by
|
|
5613
5630
|
* @param {*} [options] Override http request option.
|
|
5614
5631
|
* @throws {RequiredError}
|
|
5615
5632
|
*/
|
|
5616
|
-
listPromotionBeneficiaries: (id: string, periodID?: number, hasProgress?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
5633
|
+
listPromotionBeneficiaries: (id: string, periodID?: number, hasProgress?: boolean, nextToken?: string, search?: string, interval?: ProgressInterval, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
5617
5634
|
/**
|
|
5618
5635
|
* List all promotions
|
|
5619
5636
|
* @summary List promotions
|
|
@@ -5747,10 +5764,13 @@ export declare const PromotionApiFp: (configuration?: Configuration) => {
|
|
|
5747
5764
|
* @param {string} id Promotion ID
|
|
5748
5765
|
* @param {number} [periodID] Period ID
|
|
5749
5766
|
* @param {boolean} [hasProgress] Beneficiary has progress
|
|
5767
|
+
* @param {string} [nextToken] This is the pagination token
|
|
5768
|
+
* @param {string} [search] search string, searches in client name/referenceID or user name/referenceID
|
|
5769
|
+
* @param {ProgressInterval} [interval] Progress interval to filter by
|
|
5750
5770
|
* @param {*} [options] Override http request option.
|
|
5751
5771
|
* @throws {RequiredError}
|
|
5752
5772
|
*/
|
|
5753
|
-
listPromotionBeneficiaries(id: string, periodID?: number, hasProgress?: boolean, 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>>;
|
|
5754
5774
|
/**
|
|
5755
5775
|
* List all promotions
|
|
5756
5776
|
* @summary List promotions
|
|
@@ -5884,10 +5904,13 @@ export declare const PromotionApiFactory: (configuration?: Configuration, basePa
|
|
|
5884
5904
|
* @param {string} id Promotion ID
|
|
5885
5905
|
* @param {number} [periodID] Period ID
|
|
5886
5906
|
* @param {boolean} [hasProgress] Beneficiary has progress
|
|
5907
|
+
* @param {string} [nextToken] This is the pagination token
|
|
5908
|
+
* @param {string} [search] search string, searches in client name/referenceID or user name/referenceID
|
|
5909
|
+
* @param {ProgressInterval} [interval] Progress interval to filter by
|
|
5887
5910
|
* @param {*} [options] Override http request option.
|
|
5888
5911
|
* @throws {RequiredError}
|
|
5889
5912
|
*/
|
|
5890
|
-
listPromotionBeneficiaries(id: string, periodID?: number, hasProgress?: boolean, options?: any): AxiosPromise<PromotionBeneficiariesResponse>;
|
|
5913
|
+
listPromotionBeneficiaries(id: string, periodID?: number, hasProgress?: boolean, nextToken?: string, search?: string, interval?: ProgressInterval, options?: any): AxiosPromise<PromotionBeneficiariesResponse>;
|
|
5891
5914
|
/**
|
|
5892
5915
|
* List all promotions
|
|
5893
5916
|
* @summary List promotions
|
|
@@ -6032,11 +6055,14 @@ export declare class PromotionApi extends BaseAPI {
|
|
|
6032
6055
|
* @param {string} id Promotion ID
|
|
6033
6056
|
* @param {number} [periodID] Period ID
|
|
6034
6057
|
* @param {boolean} [hasProgress] Beneficiary has progress
|
|
6058
|
+
* @param {string} [nextToken] This is the pagination token
|
|
6059
|
+
* @param {string} [search] search string, searches in client name/referenceID or user name/referenceID
|
|
6060
|
+
* @param {ProgressInterval} [interval] Progress interval to filter by
|
|
6035
6061
|
* @param {*} [options] Override http request option.
|
|
6036
6062
|
* @throws {RequiredError}
|
|
6037
6063
|
* @memberof PromotionApi
|
|
6038
6064
|
*/
|
|
6039
|
-
listPromotionBeneficiaries(id: string, periodID?: number, hasProgress?: boolean, 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>>;
|
|
6040
6066
|
/**
|
|
6041
6067
|
* List all promotions
|
|
6042
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
|
|
@@ -4519,10 +4521,13 @@ const PromotionApiAxiosParamCreator = function (configuration) {
|
|
|
4519
4521
|
* @param {string} id Promotion ID
|
|
4520
4522
|
* @param {number} [periodID] Period ID
|
|
4521
4523
|
* @param {boolean} [hasProgress] Beneficiary has progress
|
|
4524
|
+
* @param {string} [nextToken] This is the pagination token
|
|
4525
|
+
* @param {string} [search] search string, searches in client name/referenceID or user name/referenceID
|
|
4526
|
+
* @param {ProgressInterval} [interval] Progress interval to filter by
|
|
4522
4527
|
* @param {*} [options] Override http request option.
|
|
4523
4528
|
* @throws {RequiredError}
|
|
4524
4529
|
*/
|
|
4525
|
-
listPromotionBeneficiaries: (id, periodID, hasProgress, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
4530
|
+
listPromotionBeneficiaries: (id, periodID, hasProgress, nextToken, search, interval, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
4526
4531
|
// verify required parameter 'id' is not null or undefined
|
|
4527
4532
|
(0, common_1.assertParamExists)('listPromotionBeneficiaries', 'id', id);
|
|
4528
4533
|
const localVarPath = `/admins/promotions/{id}/beneficiaries`
|
|
@@ -4545,6 +4550,15 @@ const PromotionApiAxiosParamCreator = function (configuration) {
|
|
|
4545
4550
|
if (hasProgress !== undefined) {
|
|
4546
4551
|
localVarQueryParameter['hasProgress'] = hasProgress;
|
|
4547
4552
|
}
|
|
4553
|
+
if (nextToken !== undefined) {
|
|
4554
|
+
localVarQueryParameter['nextToken'] = nextToken;
|
|
4555
|
+
}
|
|
4556
|
+
if (search !== undefined) {
|
|
4557
|
+
localVarQueryParameter['search'] = search;
|
|
4558
|
+
}
|
|
4559
|
+
if (interval !== undefined) {
|
|
4560
|
+
localVarQueryParameter['interval'] = interval;
|
|
4561
|
+
}
|
|
4548
4562
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
4549
4563
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
4550
4564
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
@@ -4893,12 +4907,15 @@ const PromotionApiFp = function (configuration) {
|
|
|
4893
4907
|
* @param {string} id Promotion ID
|
|
4894
4908
|
* @param {number} [periodID] Period ID
|
|
4895
4909
|
* @param {boolean} [hasProgress] Beneficiary has progress
|
|
4910
|
+
* @param {string} [nextToken] This is the pagination token
|
|
4911
|
+
* @param {string} [search] search string, searches in client name/referenceID or user name/referenceID
|
|
4912
|
+
* @param {ProgressInterval} [interval] Progress interval to filter by
|
|
4896
4913
|
* @param {*} [options] Override http request option.
|
|
4897
4914
|
* @throws {RequiredError}
|
|
4898
4915
|
*/
|
|
4899
|
-
listPromotionBeneficiaries(id, periodID, hasProgress, options) {
|
|
4916
|
+
listPromotionBeneficiaries(id, periodID, hasProgress, nextToken, search, interval, options) {
|
|
4900
4917
|
return __awaiter(this, void 0, void 0, function* () {
|
|
4901
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.listPromotionBeneficiaries(id, periodID, hasProgress, options);
|
|
4918
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.listPromotionBeneficiaries(id, periodID, hasProgress, nextToken, search, interval, options);
|
|
4902
4919
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
4903
4920
|
});
|
|
4904
4921
|
},
|
|
@@ -5072,11 +5089,14 @@ const PromotionApiFactory = function (configuration, basePath, axios) {
|
|
|
5072
5089
|
* @param {string} id Promotion ID
|
|
5073
5090
|
* @param {number} [periodID] Period ID
|
|
5074
5091
|
* @param {boolean} [hasProgress] Beneficiary has progress
|
|
5092
|
+
* @param {string} [nextToken] This is the pagination token
|
|
5093
|
+
* @param {string} [search] search string, searches in client name/referenceID or user name/referenceID
|
|
5094
|
+
* @param {ProgressInterval} [interval] Progress interval to filter by
|
|
5075
5095
|
* @param {*} [options] Override http request option.
|
|
5076
5096
|
* @throws {RequiredError}
|
|
5077
5097
|
*/
|
|
5078
|
-
listPromotionBeneficiaries(id, periodID, hasProgress, options) {
|
|
5079
|
-
return localVarFp.listPromotionBeneficiaries(id, periodID, hasProgress, 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));
|
|
5080
5100
|
},
|
|
5081
5101
|
/**
|
|
5082
5102
|
* List all promotions
|
|
@@ -5248,12 +5268,15 @@ class PromotionApi extends base_1.BaseAPI {
|
|
|
5248
5268
|
* @param {string} id Promotion ID
|
|
5249
5269
|
* @param {number} [periodID] Period ID
|
|
5250
5270
|
* @param {boolean} [hasProgress] Beneficiary has progress
|
|
5271
|
+
* @param {string} [nextToken] This is the pagination token
|
|
5272
|
+
* @param {string} [search] search string, searches in client name/referenceID or user name/referenceID
|
|
5273
|
+
* @param {ProgressInterval} [interval] Progress interval to filter by
|
|
5251
5274
|
* @param {*} [options] Override http request option.
|
|
5252
5275
|
* @throws {RequiredError}
|
|
5253
5276
|
* @memberof PromotionApi
|
|
5254
5277
|
*/
|
|
5255
|
-
listPromotionBeneficiaries(id, periodID, hasProgress, options) {
|
|
5256
|
-
return (0, exports.PromotionApiFp)(this.configuration).listPromotionBeneficiaries(id, periodID, hasProgress, 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));
|
|
5257
5280
|
}
|
|
5258
5281
|
/**
|
|
5259
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
|
|
@@ -2030,6 +2042,12 @@ export interface PromotionClientBeneficiaries {
|
|
|
2030
2042
|
* @memberof PromotionClientBeneficiaries
|
|
2031
2043
|
*/
|
|
2032
2044
|
'beneficiaries': Array<Client>;
|
|
2045
|
+
/**
|
|
2046
|
+
* This is the pagination token
|
|
2047
|
+
* @type {string}
|
|
2048
|
+
* @memberof PromotionClientBeneficiaries
|
|
2049
|
+
*/
|
|
2050
|
+
'nextToken'?: string;
|
|
2033
2051
|
}
|
|
2034
2052
|
/**
|
|
2035
2053
|
*
|
|
@@ -2219,6 +2237,12 @@ export interface PromotionUserBeneficiaries {
|
|
|
2219
2237
|
* @memberof PromotionUserBeneficiaries
|
|
2220
2238
|
*/
|
|
2221
2239
|
'beneficiaries': Array<User>;
|
|
2240
|
+
/**
|
|
2241
|
+
* This is the pagination token
|
|
2242
|
+
* @type {string}
|
|
2243
|
+
* @memberof PromotionUserBeneficiaries
|
|
2244
|
+
*/
|
|
2245
|
+
'nextToken'?: string;
|
|
2222
2246
|
}
|
|
2223
2247
|
/**
|
|
2224
2248
|
*
|
|
@@ -5407,12 +5431,12 @@ export declare const ProgressApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
5407
5431
|
* @param {number} [periodID] Period ID
|
|
5408
5432
|
* @param {Array<string>} [userIDs] User IDs to filter by
|
|
5409
5433
|
* @param {Array<string>} [clientIDs] Client IDs to filter by
|
|
5410
|
-
* @param {
|
|
5434
|
+
* @param {ProgressInterval} [interval] Interval
|
|
5411
5435
|
* @param {string} [nextToken] This is the pagination token
|
|
5412
5436
|
* @param {*} [options] Override http request option.
|
|
5413
5437
|
* @throws {RequiredError}
|
|
5414
5438
|
*/
|
|
5415
|
-
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>;
|
|
5416
5440
|
/**
|
|
5417
5441
|
* List users progress
|
|
5418
5442
|
* @summary List progress
|
|
@@ -5436,12 +5460,12 @@ export declare const ProgressApiFp: (configuration?: Configuration) => {
|
|
|
5436
5460
|
* @param {number} [periodID] Period ID
|
|
5437
5461
|
* @param {Array<string>} [userIDs] User IDs to filter by
|
|
5438
5462
|
* @param {Array<string>} [clientIDs] Client IDs to filter by
|
|
5439
|
-
* @param {
|
|
5463
|
+
* @param {ProgressInterval} [interval] Interval
|
|
5440
5464
|
* @param {string} [nextToken] This is the pagination token
|
|
5441
5465
|
* @param {*} [options] Override http request option.
|
|
5442
5466
|
* @throws {RequiredError}
|
|
5443
5467
|
*/
|
|
5444
|
-
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>>;
|
|
5445
5469
|
/**
|
|
5446
5470
|
* List users progress
|
|
5447
5471
|
* @summary List progress
|
|
@@ -5465,12 +5489,12 @@ export declare const ProgressApiFactory: (configuration?: Configuration, basePat
|
|
|
5465
5489
|
* @param {number} [periodID] Period ID
|
|
5466
5490
|
* @param {Array<string>} [userIDs] User IDs to filter by
|
|
5467
5491
|
* @param {Array<string>} [clientIDs] Client IDs to filter by
|
|
5468
|
-
* @param {
|
|
5492
|
+
* @param {ProgressInterval} [interval] Interval
|
|
5469
5493
|
* @param {string} [nextToken] This is the pagination token
|
|
5470
5494
|
* @param {*} [options] Override http request option.
|
|
5471
5495
|
* @throws {RequiredError}
|
|
5472
5496
|
*/
|
|
5473
|
-
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>;
|
|
5474
5498
|
/**
|
|
5475
5499
|
* List users progress
|
|
5476
5500
|
* @summary List progress
|
|
@@ -5496,13 +5520,13 @@ export declare class ProgressApi extends BaseAPI {
|
|
|
5496
5520
|
* @param {number} [periodID] Period ID
|
|
5497
5521
|
* @param {Array<string>} [userIDs] User IDs to filter by
|
|
5498
5522
|
* @param {Array<string>} [clientIDs] Client IDs to filter by
|
|
5499
|
-
* @param {
|
|
5523
|
+
* @param {ProgressInterval} [interval] Interval
|
|
5500
5524
|
* @param {string} [nextToken] This is the pagination token
|
|
5501
5525
|
* @param {*} [options] Override http request option.
|
|
5502
5526
|
* @throws {RequiredError}
|
|
5503
5527
|
* @memberof ProgressApi
|
|
5504
5528
|
*/
|
|
5505
|
-
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>>;
|
|
5506
5530
|
/**
|
|
5507
5531
|
* List users progress
|
|
5508
5532
|
* @summary List progress
|
|
@@ -5515,16 +5539,6 @@ export declare class ProgressApi extends BaseAPI {
|
|
|
5515
5539
|
*/
|
|
5516
5540
|
listUserProgress(promotionIDs: Array<string>, periodID?: number, nextToken?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ProgressResponse, any>>;
|
|
5517
5541
|
}
|
|
5518
|
-
/**
|
|
5519
|
-
* @export
|
|
5520
|
-
*/
|
|
5521
|
-
export declare const ListProgressIntervalEnum: {
|
|
5522
|
-
readonly _100: "100";
|
|
5523
|
-
readonly _9975: "99-75";
|
|
5524
|
-
readonly _7550: "75-50";
|
|
5525
|
-
readonly _501: "50-1";
|
|
5526
|
-
};
|
|
5527
|
-
export type ListProgressIntervalEnum = typeof ListProgressIntervalEnum[keyof typeof ListProgressIntervalEnum];
|
|
5528
5542
|
/**
|
|
5529
5543
|
* PromotionApi - axios parameter creator
|
|
5530
5544
|
* @export
|
|
@@ -5610,10 +5624,13 @@ export declare const PromotionApiAxiosParamCreator: (configuration?: Configurati
|
|
|
5610
5624
|
* @param {string} id Promotion ID
|
|
5611
5625
|
* @param {number} [periodID] Period ID
|
|
5612
5626
|
* @param {boolean} [hasProgress] Beneficiary has progress
|
|
5627
|
+
* @param {string} [nextToken] This is the pagination token
|
|
5628
|
+
* @param {string} [search] search string, searches in client name/referenceID or user name/referenceID
|
|
5629
|
+
* @param {ProgressInterval} [interval] Progress interval to filter by
|
|
5613
5630
|
* @param {*} [options] Override http request option.
|
|
5614
5631
|
* @throws {RequiredError}
|
|
5615
5632
|
*/
|
|
5616
|
-
listPromotionBeneficiaries: (id: string, periodID?: number, hasProgress?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
5633
|
+
listPromotionBeneficiaries: (id: string, periodID?: number, hasProgress?: boolean, nextToken?: string, search?: string, interval?: ProgressInterval, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
5617
5634
|
/**
|
|
5618
5635
|
* List all promotions
|
|
5619
5636
|
* @summary List promotions
|
|
@@ -5747,10 +5764,13 @@ export declare const PromotionApiFp: (configuration?: Configuration) => {
|
|
|
5747
5764
|
* @param {string} id Promotion ID
|
|
5748
5765
|
* @param {number} [periodID] Period ID
|
|
5749
5766
|
* @param {boolean} [hasProgress] Beneficiary has progress
|
|
5767
|
+
* @param {string} [nextToken] This is the pagination token
|
|
5768
|
+
* @param {string} [search] search string, searches in client name/referenceID or user name/referenceID
|
|
5769
|
+
* @param {ProgressInterval} [interval] Progress interval to filter by
|
|
5750
5770
|
* @param {*} [options] Override http request option.
|
|
5751
5771
|
* @throws {RequiredError}
|
|
5752
5772
|
*/
|
|
5753
|
-
listPromotionBeneficiaries(id: string, periodID?: number, hasProgress?: boolean, 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>>;
|
|
5754
5774
|
/**
|
|
5755
5775
|
* List all promotions
|
|
5756
5776
|
* @summary List promotions
|
|
@@ -5884,10 +5904,13 @@ export declare const PromotionApiFactory: (configuration?: Configuration, basePa
|
|
|
5884
5904
|
* @param {string} id Promotion ID
|
|
5885
5905
|
* @param {number} [periodID] Period ID
|
|
5886
5906
|
* @param {boolean} [hasProgress] Beneficiary has progress
|
|
5907
|
+
* @param {string} [nextToken] This is the pagination token
|
|
5908
|
+
* @param {string} [search] search string, searches in client name/referenceID or user name/referenceID
|
|
5909
|
+
* @param {ProgressInterval} [interval] Progress interval to filter by
|
|
5887
5910
|
* @param {*} [options] Override http request option.
|
|
5888
5911
|
* @throws {RequiredError}
|
|
5889
5912
|
*/
|
|
5890
|
-
listPromotionBeneficiaries(id: string, periodID?: number, hasProgress?: boolean, options?: any): AxiosPromise<PromotionBeneficiariesResponse>;
|
|
5913
|
+
listPromotionBeneficiaries(id: string, periodID?: number, hasProgress?: boolean, nextToken?: string, search?: string, interval?: ProgressInterval, options?: any): AxiosPromise<PromotionBeneficiariesResponse>;
|
|
5891
5914
|
/**
|
|
5892
5915
|
* List all promotions
|
|
5893
5916
|
* @summary List promotions
|
|
@@ -6032,11 +6055,14 @@ export declare class PromotionApi extends BaseAPI {
|
|
|
6032
6055
|
* @param {string} id Promotion ID
|
|
6033
6056
|
* @param {number} [periodID] Period ID
|
|
6034
6057
|
* @param {boolean} [hasProgress] Beneficiary has progress
|
|
6058
|
+
* @param {string} [nextToken] This is the pagination token
|
|
6059
|
+
* @param {string} [search] search string, searches in client name/referenceID or user name/referenceID
|
|
6060
|
+
* @param {ProgressInterval} [interval] Progress interval to filter by
|
|
6035
6061
|
* @param {*} [options] Override http request option.
|
|
6036
6062
|
* @throws {RequiredError}
|
|
6037
6063
|
* @memberof PromotionApi
|
|
6038
6064
|
*/
|
|
6039
|
-
listPromotionBeneficiaries(id: string, periodID?: number, hasProgress?: boolean, 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>>;
|
|
6040
6066
|
/**
|
|
6041
6067
|
* List all promotions
|
|
6042
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
|
|
@@ -4466,10 +4468,13 @@ export const PromotionApiAxiosParamCreator = function (configuration) {
|
|
|
4466
4468
|
* @param {string} id Promotion ID
|
|
4467
4469
|
* @param {number} [periodID] Period ID
|
|
4468
4470
|
* @param {boolean} [hasProgress] Beneficiary has progress
|
|
4471
|
+
* @param {string} [nextToken] This is the pagination token
|
|
4472
|
+
* @param {string} [search] search string, searches in client name/referenceID or user name/referenceID
|
|
4473
|
+
* @param {ProgressInterval} [interval] Progress interval to filter by
|
|
4469
4474
|
* @param {*} [options] Override http request option.
|
|
4470
4475
|
* @throws {RequiredError}
|
|
4471
4476
|
*/
|
|
4472
|
-
listPromotionBeneficiaries: (id, periodID, hasProgress, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
4477
|
+
listPromotionBeneficiaries: (id, periodID, hasProgress, nextToken, search, interval, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
4473
4478
|
// verify required parameter 'id' is not null or undefined
|
|
4474
4479
|
assertParamExists('listPromotionBeneficiaries', 'id', id);
|
|
4475
4480
|
const localVarPath = `/admins/promotions/{id}/beneficiaries`
|
|
@@ -4492,6 +4497,15 @@ export const PromotionApiAxiosParamCreator = function (configuration) {
|
|
|
4492
4497
|
if (hasProgress !== undefined) {
|
|
4493
4498
|
localVarQueryParameter['hasProgress'] = hasProgress;
|
|
4494
4499
|
}
|
|
4500
|
+
if (nextToken !== undefined) {
|
|
4501
|
+
localVarQueryParameter['nextToken'] = nextToken;
|
|
4502
|
+
}
|
|
4503
|
+
if (search !== undefined) {
|
|
4504
|
+
localVarQueryParameter['search'] = search;
|
|
4505
|
+
}
|
|
4506
|
+
if (interval !== undefined) {
|
|
4507
|
+
localVarQueryParameter['interval'] = interval;
|
|
4508
|
+
}
|
|
4495
4509
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4496
4510
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
4497
4511
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
@@ -4839,12 +4853,15 @@ export const PromotionApiFp = function (configuration) {
|
|
|
4839
4853
|
* @param {string} id Promotion ID
|
|
4840
4854
|
* @param {number} [periodID] Period ID
|
|
4841
4855
|
* @param {boolean} [hasProgress] Beneficiary has progress
|
|
4856
|
+
* @param {string} [nextToken] This is the pagination token
|
|
4857
|
+
* @param {string} [search] search string, searches in client name/referenceID or user name/referenceID
|
|
4858
|
+
* @param {ProgressInterval} [interval] Progress interval to filter by
|
|
4842
4859
|
* @param {*} [options] Override http request option.
|
|
4843
4860
|
* @throws {RequiredError}
|
|
4844
4861
|
*/
|
|
4845
|
-
listPromotionBeneficiaries(id, periodID, hasProgress, options) {
|
|
4862
|
+
listPromotionBeneficiaries(id, periodID, hasProgress, nextToken, search, interval, options) {
|
|
4846
4863
|
return __awaiter(this, void 0, void 0, function* () {
|
|
4847
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.listPromotionBeneficiaries(id, periodID, hasProgress, options);
|
|
4864
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.listPromotionBeneficiaries(id, periodID, hasProgress, nextToken, search, interval, options);
|
|
4848
4865
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
4849
4866
|
});
|
|
4850
4867
|
},
|
|
@@ -5017,11 +5034,14 @@ export const PromotionApiFactory = function (configuration, basePath, axios) {
|
|
|
5017
5034
|
* @param {string} id Promotion ID
|
|
5018
5035
|
* @param {number} [periodID] Period ID
|
|
5019
5036
|
* @param {boolean} [hasProgress] Beneficiary has progress
|
|
5037
|
+
* @param {string} [nextToken] This is the pagination token
|
|
5038
|
+
* @param {string} [search] search string, searches in client name/referenceID or user name/referenceID
|
|
5039
|
+
* @param {ProgressInterval} [interval] Progress interval to filter by
|
|
5020
5040
|
* @param {*} [options] Override http request option.
|
|
5021
5041
|
* @throws {RequiredError}
|
|
5022
5042
|
*/
|
|
5023
|
-
listPromotionBeneficiaries(id, periodID, hasProgress, options) {
|
|
5024
|
-
return localVarFp.listPromotionBeneficiaries(id, periodID, hasProgress, 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));
|
|
5025
5045
|
},
|
|
5026
5046
|
/**
|
|
5027
5047
|
* List all promotions
|
|
@@ -5192,12 +5212,15 @@ export class PromotionApi extends BaseAPI {
|
|
|
5192
5212
|
* @param {string} id Promotion ID
|
|
5193
5213
|
* @param {number} [periodID] Period ID
|
|
5194
5214
|
* @param {boolean} [hasProgress] Beneficiary has progress
|
|
5215
|
+
* @param {string} [nextToken] This is the pagination token
|
|
5216
|
+
* @param {string} [search] search string, searches in client name/referenceID or user name/referenceID
|
|
5217
|
+
* @param {ProgressInterval} [interval] Progress interval to filter by
|
|
5195
5218
|
* @param {*} [options] Override http request option.
|
|
5196
5219
|
* @throws {RequiredError}
|
|
5197
5220
|
* @memberof PromotionApi
|
|
5198
5221
|
*/
|
|
5199
|
-
listPromotionBeneficiaries(id, periodID, hasProgress, options) {
|
|
5200
|
-
return PromotionApiFp(this.configuration).listPromotionBeneficiaries(id, periodID, hasProgress, 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));
|
|
5201
5224
|
}
|
|
5202
5225
|
/**
|
|
5203
5226
|
* List all promotions
|