flexinet-api 0.0.429-prerelease0 → 0.0.444-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/dist/api.d.ts CHANGED
@@ -159,6 +159,19 @@ export interface BalanceUpdateRequest {
159
159
  */
160
160
  'beneficiaryKind': BeneficiaryKind;
161
161
  }
162
+ /**
163
+ *
164
+ * @export
165
+ * @interface BalancesResponse
166
+ */
167
+ export interface BalancesResponse {
168
+ /**
169
+ *
170
+ * @type {Array<Balance>}
171
+ * @memberof BalancesResponse
172
+ */
173
+ 'balances': Array<Balance>;
174
+ }
162
175
  /**
163
176
  *
164
177
  * @export
@@ -2548,6 +2561,14 @@ export interface TransactionEventDetails {
2548
2561
  * @memberof TransactionEventDetails
2549
2562
  */
2550
2563
  'originalTimestamp'?: string;
2564
+ /**
2565
+ *
2566
+ * @type {{ [key: string]: string; }}
2567
+ * @memberof TransactionEventDetails
2568
+ */
2569
+ 'metadata'?: {
2570
+ [key: string]: string;
2571
+ };
2551
2572
  }
2552
2573
  /**
2553
2574
  *
@@ -3114,12 +3135,12 @@ export declare const BalanceApiAxiosParamCreator: (configuration?: Configuration
3114
3135
  /**
3115
3136
  * Get balance
3116
3137
  * @summary Get balance
3117
- * @param {string} beneficiaryValue This is the beneficiary value
3138
+ * @param {Array<string>} beneficiaryValues Beneficiary values to filter by
3118
3139
  * @param {BeneficiaryKind} kind This is the beneficiary kind
3119
3140
  * @param {*} [options] Override http request option.
3120
3141
  * @throws {RequiredError}
3121
3142
  */
3122
- getBalance: (beneficiaryValue: string, kind: BeneficiaryKind, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3143
+ getBalance: (beneficiaryValues: Array<string>, kind: BeneficiaryKind, options?: AxiosRequestConfig) => Promise<RequestArgs>;
3123
3144
  /**
3124
3145
  * Get balance for the user
3125
3146
  * @summary Get balance
@@ -3154,12 +3175,12 @@ export declare const BalanceApiFp: (configuration?: Configuration) => {
3154
3175
  /**
3155
3176
  * Get balance
3156
3177
  * @summary Get balance
3157
- * @param {string} beneficiaryValue This is the beneficiary value
3178
+ * @param {Array<string>} beneficiaryValues Beneficiary values to filter by
3158
3179
  * @param {BeneficiaryKind} kind This is the beneficiary kind
3159
3180
  * @param {*} [options] Override http request option.
3160
3181
  * @throws {RequiredError}
3161
3182
  */
3162
- getBalance(beneficiaryValue: string, kind: BeneficiaryKind, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Balance>>;
3183
+ getBalance(beneficiaryValues: Array<string>, kind: BeneficiaryKind, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BalancesResponse>>;
3163
3184
  /**
3164
3185
  * Get balance for the user
3165
3186
  * @summary Get balance
@@ -3194,12 +3215,12 @@ export declare const BalanceApiFactory: (configuration?: Configuration, basePath
3194
3215
  /**
3195
3216
  * Get balance
3196
3217
  * @summary Get balance
3197
- * @param {string} beneficiaryValue This is the beneficiary value
3218
+ * @param {Array<string>} beneficiaryValues Beneficiary values to filter by
3198
3219
  * @param {BeneficiaryKind} kind This is the beneficiary kind
3199
3220
  * @param {*} [options] Override http request option.
3200
3221
  * @throws {RequiredError}
3201
3222
  */
3202
- getBalance(beneficiaryValue: string, kind: BeneficiaryKind, options?: any): AxiosPromise<Balance>;
3223
+ getBalance(beneficiaryValues: Array<string>, kind: BeneficiaryKind, options?: any): AxiosPromise<BalancesResponse>;
3203
3224
  /**
3204
3225
  * Get balance for the user
3205
3226
  * @summary Get balance
@@ -3236,13 +3257,13 @@ export declare class BalanceApi extends BaseAPI {
3236
3257
  /**
3237
3258
  * Get balance
3238
3259
  * @summary Get balance
3239
- * @param {string} beneficiaryValue This is the beneficiary value
3260
+ * @param {Array<string>} beneficiaryValues Beneficiary values to filter by
3240
3261
  * @param {BeneficiaryKind} kind This is the beneficiary kind
3241
3262
  * @param {*} [options] Override http request option.
3242
3263
  * @throws {RequiredError}
3243
3264
  * @memberof BalanceApi
3244
3265
  */
3245
- getBalance(beneficiaryValue: string, kind: BeneficiaryKind, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Balance, any>>;
3266
+ getBalance(beneficiaryValues: Array<string>, kind: BeneficiaryKind, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<BalancesResponse, any>>;
3246
3267
  /**
3247
3268
  * Get balance for the user
3248
3269
  * @summary Get balance
@@ -4042,26 +4063,26 @@ export declare const OrderApiAxiosParamCreator: (configuration?: Configuration)
4042
4063
  * @param {string} [paginationToken] This is the pagination token
4043
4064
  * @param {string} [search] Search for product or order
4044
4065
  * @param {string} [productId] Filter by token
4045
- * @param {string} [balanceId] Filter by balance
4066
+ * @param {Array<string>} [balanceIDs] Filter by balance ids
4046
4067
  * @param {string} [createdAfter] Filter orders created after the specified date
4047
4068
  * @param {string} [createdBefore] Filter orders created before the specified date
4048
4069
  * @param {*} [options] Override http request option.
4049
4070
  * @throws {RequiredError}
4050
4071
  */
4051
- listOrders: (paginationToken?: string, search?: string, productId?: string, balanceId?: string, createdAfter?: string, createdBefore?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
4072
+ listOrders: (paginationToken?: string, search?: string, productId?: string, balanceIDs?: Array<string>, createdAfter?: string, createdBefore?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
4052
4073
  /**
4053
4074
  * List existing orders
4054
4075
  * @summary List existing orders
4055
4076
  * @param {string} [paginationToken] This is the pagination token
4056
4077
  * @param {string} [search] Search for product or order
4057
- * @param {string} [productId] Filter by token
4058
- * @param {string} [balanceId] Filter by balance
4078
+ * @param {string} [productID] Filter by token
4079
+ * @param {Array<string>} [balanceIDs] Filter by balance ids
4059
4080
  * @param {string} [createdAfter] Filter orders created after the specified date
4060
4081
  * @param {string} [createdBefore] Filter orders created before the specified date
4061
4082
  * @param {*} [options] Override http request option.
4062
4083
  * @throws {RequiredError}
4063
4084
  */
4064
- listOrdersUser: (paginationToken?: string, search?: string, productId?: string, balanceId?: string, createdAfter?: string, createdBefore?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
4085
+ listOrdersUser: (paginationToken?: string, search?: string, productID?: string, balanceIDs?: Array<string>, createdAfter?: string, createdBefore?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
4065
4086
  };
4066
4087
  /**
4067
4088
  * OrderApi - functional programming interface
@@ -4090,26 +4111,26 @@ export declare const OrderApiFp: (configuration?: Configuration) => {
4090
4111
  * @param {string} [paginationToken] This is the pagination token
4091
4112
  * @param {string} [search] Search for product or order
4092
4113
  * @param {string} [productId] Filter by token
4093
- * @param {string} [balanceId] Filter by balance
4114
+ * @param {Array<string>} [balanceIDs] Filter by balance ids
4094
4115
  * @param {string} [createdAfter] Filter orders created after the specified date
4095
4116
  * @param {string} [createdBefore] Filter orders created before the specified date
4096
4117
  * @param {*} [options] Override http request option.
4097
4118
  * @throws {RequiredError}
4098
4119
  */
4099
- listOrders(paginationToken?: string, search?: string, productId?: string, balanceId?: string, createdAfter?: string, createdBefore?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrderListResponse>>;
4120
+ listOrders(paginationToken?: string, search?: string, productId?: string, balanceIDs?: Array<string>, createdAfter?: string, createdBefore?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrderListResponse>>;
4100
4121
  /**
4101
4122
  * List existing orders
4102
4123
  * @summary List existing orders
4103
4124
  * @param {string} [paginationToken] This is the pagination token
4104
4125
  * @param {string} [search] Search for product or order
4105
- * @param {string} [productId] Filter by token
4106
- * @param {string} [balanceId] Filter by balance
4126
+ * @param {string} [productID] Filter by token
4127
+ * @param {Array<string>} [balanceIDs] Filter by balance ids
4107
4128
  * @param {string} [createdAfter] Filter orders created after the specified date
4108
4129
  * @param {string} [createdBefore] Filter orders created before the specified date
4109
4130
  * @param {*} [options] Override http request option.
4110
4131
  * @throws {RequiredError}
4111
4132
  */
4112
- listOrdersUser(paginationToken?: string, search?: string, productId?: string, balanceId?: string, createdAfter?: string, createdBefore?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrderListResponse>>;
4133
+ listOrdersUser(paginationToken?: string, search?: string, productID?: string, balanceIDs?: Array<string>, createdAfter?: string, createdBefore?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrderListResponse>>;
4113
4134
  };
4114
4135
  /**
4115
4136
  * OrderApi - factory interface
@@ -4138,26 +4159,26 @@ export declare const OrderApiFactory: (configuration?: Configuration, basePath?:
4138
4159
  * @param {string} [paginationToken] This is the pagination token
4139
4160
  * @param {string} [search] Search for product or order
4140
4161
  * @param {string} [productId] Filter by token
4141
- * @param {string} [balanceId] Filter by balance
4162
+ * @param {Array<string>} [balanceIDs] Filter by balance ids
4142
4163
  * @param {string} [createdAfter] Filter orders created after the specified date
4143
4164
  * @param {string} [createdBefore] Filter orders created before the specified date
4144
4165
  * @param {*} [options] Override http request option.
4145
4166
  * @throws {RequiredError}
4146
4167
  */
4147
- listOrders(paginationToken?: string, search?: string, productId?: string, balanceId?: string, createdAfter?: string, createdBefore?: string, options?: any): AxiosPromise<OrderListResponse>;
4168
+ listOrders(paginationToken?: string, search?: string, productId?: string, balanceIDs?: Array<string>, createdAfter?: string, createdBefore?: string, options?: any): AxiosPromise<OrderListResponse>;
4148
4169
  /**
4149
4170
  * List existing orders
4150
4171
  * @summary List existing orders
4151
4172
  * @param {string} [paginationToken] This is the pagination token
4152
4173
  * @param {string} [search] Search for product or order
4153
- * @param {string} [productId] Filter by token
4154
- * @param {string} [balanceId] Filter by balance
4174
+ * @param {string} [productID] Filter by token
4175
+ * @param {Array<string>} [balanceIDs] Filter by balance ids
4155
4176
  * @param {string} [createdAfter] Filter orders created after the specified date
4156
4177
  * @param {string} [createdBefore] Filter orders created before the specified date
4157
4178
  * @param {*} [options] Override http request option.
4158
4179
  * @throws {RequiredError}
4159
4180
  */
4160
- listOrdersUser(paginationToken?: string, search?: string, productId?: string, balanceId?: string, createdAfter?: string, createdBefore?: string, options?: any): AxiosPromise<OrderListResponse>;
4181
+ listOrdersUser(paginationToken?: string, search?: string, productID?: string, balanceIDs?: Array<string>, createdAfter?: string, createdBefore?: string, options?: any): AxiosPromise<OrderListResponse>;
4161
4182
  };
4162
4183
  /**
4163
4184
  * OrderApi - object-oriented interface
@@ -4190,28 +4211,28 @@ export declare class OrderApi extends BaseAPI {
4190
4211
  * @param {string} [paginationToken] This is the pagination token
4191
4212
  * @param {string} [search] Search for product or order
4192
4213
  * @param {string} [productId] Filter by token
4193
- * @param {string} [balanceId] Filter by balance
4214
+ * @param {Array<string>} [balanceIDs] Filter by balance ids
4194
4215
  * @param {string} [createdAfter] Filter orders created after the specified date
4195
4216
  * @param {string} [createdBefore] Filter orders created before the specified date
4196
4217
  * @param {*} [options] Override http request option.
4197
4218
  * @throws {RequiredError}
4198
4219
  * @memberof OrderApi
4199
4220
  */
4200
- listOrders(paginationToken?: string, search?: string, productId?: string, balanceId?: string, createdAfter?: string, createdBefore?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderListResponse, any>>;
4221
+ listOrders(paginationToken?: string, search?: string, productId?: string, balanceIDs?: Array<string>, createdAfter?: string, createdBefore?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderListResponse, any>>;
4201
4222
  /**
4202
4223
  * List existing orders
4203
4224
  * @summary List existing orders
4204
4225
  * @param {string} [paginationToken] This is the pagination token
4205
4226
  * @param {string} [search] Search for product or order
4206
- * @param {string} [productId] Filter by token
4207
- * @param {string} [balanceId] Filter by balance
4227
+ * @param {string} [productID] Filter by token
4228
+ * @param {Array<string>} [balanceIDs] Filter by balance ids
4208
4229
  * @param {string} [createdAfter] Filter orders created after the specified date
4209
4230
  * @param {string} [createdBefore] Filter orders created before the specified date
4210
4231
  * @param {*} [options] Override http request option.
4211
4232
  * @throws {RequiredError}
4212
4233
  * @memberof OrderApi
4213
4234
  */
4214
- listOrdersUser(paginationToken?: string, search?: string, productId?: string, balanceId?: string, createdAfter?: string, createdBefore?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderListResponse, any>>;
4235
+ listOrdersUser(paginationToken?: string, search?: string, productID?: string, balanceIDs?: Array<string>, createdAfter?: string, createdBefore?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderListResponse, any>>;
4215
4236
  }
4216
4237
  /**
4217
4238
  * ProductApi - axios parameter creator
@@ -4699,10 +4720,10 @@ export declare const ProgressApiAxiosParamCreator: (configuration?: Configuratio
4699
4720
  /**
4700
4721
  * List progress
4701
4722
  * @summary List progress
4702
- * @param {Array<string>} promotionIDs Promotion ID to filter by
4723
+ * @param {Array<string>} promotionIDs Promotion IDs to filter by
4703
4724
  * @param {number} [periodID] Period ID
4704
- * @param {Array<string>} [userIDs] User ID to filter by
4705
- * @param {Array<string>} [clientIDs] Client ID to filter by
4725
+ * @param {Array<string>} [userIDs] User IDs to filter by
4726
+ * @param {Array<string>} [clientIDs] Client IDs to filter by
4706
4727
  * @param {ListProgressIntervalEnum} [interval] Interval
4707
4728
  * @param {string} [nextToken] This is the pagination token
4708
4729
  * @param {*} [options] Override http request option.
@@ -4728,10 +4749,10 @@ export declare const ProgressApiFp: (configuration?: Configuration) => {
4728
4749
  /**
4729
4750
  * List progress
4730
4751
  * @summary List progress
4731
- * @param {Array<string>} promotionIDs Promotion ID to filter by
4752
+ * @param {Array<string>} promotionIDs Promotion IDs to filter by
4732
4753
  * @param {number} [periodID] Period ID
4733
- * @param {Array<string>} [userIDs] User ID to filter by
4734
- * @param {Array<string>} [clientIDs] Client ID to filter by
4754
+ * @param {Array<string>} [userIDs] User IDs to filter by
4755
+ * @param {Array<string>} [clientIDs] Client IDs to filter by
4735
4756
  * @param {ListProgressIntervalEnum} [interval] Interval
4736
4757
  * @param {string} [nextToken] This is the pagination token
4737
4758
  * @param {*} [options] Override http request option.
@@ -4757,10 +4778,10 @@ export declare const ProgressApiFactory: (configuration?: Configuration, basePat
4757
4778
  /**
4758
4779
  * List progress
4759
4780
  * @summary List progress
4760
- * @param {Array<string>} promotionIDs Promotion ID to filter by
4781
+ * @param {Array<string>} promotionIDs Promotion IDs to filter by
4761
4782
  * @param {number} [periodID] Period ID
4762
- * @param {Array<string>} [userIDs] User ID to filter by
4763
- * @param {Array<string>} [clientIDs] Client ID to filter by
4783
+ * @param {Array<string>} [userIDs] User IDs to filter by
4784
+ * @param {Array<string>} [clientIDs] Client IDs to filter by
4764
4785
  * @param {ListProgressIntervalEnum} [interval] Interval
4765
4786
  * @param {string} [nextToken] This is the pagination token
4766
4787
  * @param {*} [options] Override http request option.
@@ -4788,10 +4809,10 @@ export declare class ProgressApi extends BaseAPI {
4788
4809
  /**
4789
4810
  * List progress
4790
4811
  * @summary List progress
4791
- * @param {Array<string>} promotionIDs Promotion ID to filter by
4812
+ * @param {Array<string>} promotionIDs Promotion IDs to filter by
4792
4813
  * @param {number} [periodID] Period ID
4793
- * @param {Array<string>} [userIDs] User ID to filter by
4794
- * @param {Array<string>} [clientIDs] Client ID to filter by
4814
+ * @param {Array<string>} [userIDs] User IDs to filter by
4815
+ * @param {Array<string>} [clientIDs] Client IDs to filter by
4795
4816
  * @param {ListProgressIntervalEnum} [interval] Interval
4796
4817
  * @param {string} [nextToken] This is the pagination token
4797
4818
  * @param {*} [options] Override http request option.
@@ -4912,14 +4933,15 @@ export declare const PromotionApiAxiosParamCreator: (configuration?: Configurati
4912
4933
  * @param {string} [endingBefore] end time before time
4913
4934
  * @param {string} [startingBefore] start time before time
4914
4935
  * @param {string} [endingAfter] end time after time
4915
- * @param {Array<string>} [clientIDs] client ID to filter by
4936
+ * @param {Array<string>} [clientIDs] client IDs to filter by
4916
4937
  * @param {string} [search] search by name or description
4917
4938
  * @param {PromotionSortByField} [sortBy] sort by field
4918
4939
  * @param {SortDirection} [sortDirection] sort direction
4940
+ * @param {boolean} [onlyClaimable] only claimable promotions
4919
4941
  * @param {*} [options] Override http request option.
4920
4942
  * @throws {RequiredError}
4921
4943
  */
4922
- listPromotions: (nextToken?: string, tags?: string, segmentId?: string, ownerID?: string, type?: PromotionType, startingAfter?: string, endingBefore?: string, startingBefore?: string, endingAfter?: string, clientIDs?: Array<string>, search?: string, sortBy?: PromotionSortByField, sortDirection?: SortDirection, options?: AxiosRequestConfig) => Promise<RequestArgs>;
4944
+ listPromotions: (nextToken?: string, tags?: string, segmentId?: string, ownerID?: string, type?: PromotionType, startingAfter?: string, endingBefore?: string, startingBefore?: string, endingAfter?: string, clientIDs?: Array<string>, search?: string, sortBy?: PromotionSortByField, sortDirection?: SortDirection, onlyClaimable?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
4923
4945
  /**
4924
4946
  * List users promotions
4925
4947
  * @summary List promotions
@@ -4932,10 +4954,11 @@ export declare const PromotionApiAxiosParamCreator: (configuration?: Configurati
4932
4954
  * @param {string} [search] search by name or description
4933
4955
  * @param {PromotionSortByField} [sortBy] sort by field
4934
4956
  * @param {SortDirection} [sortDirection] sort direction
4957
+ * @param {boolean} [onlyClaimable] only claimable promotions
4935
4958
  * @param {*} [options] Override http request option.
4936
4959
  * @throws {RequiredError}
4937
4960
  */
4938
- listUserPromotions: (nextToken?: string, tags?: string, startingAfter?: string, endingBefore?: string, startingBefore?: string, endingAfter?: string, search?: string, sortBy?: PromotionSortByField, sortDirection?: SortDirection, options?: AxiosRequestConfig) => Promise<RequestArgs>;
4961
+ listUserPromotions: (nextToken?: string, tags?: string, startingAfter?: string, endingBefore?: string, startingBefore?: string, endingAfter?: string, search?: string, sortBy?: PromotionSortByField, sortDirection?: SortDirection, onlyClaimable?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
4939
4962
  /**
4940
4963
  * Update promotion by id
4941
4964
  * @summary Update promotion
@@ -5037,14 +5060,15 @@ export declare const PromotionApiFp: (configuration?: Configuration) => {
5037
5060
  * @param {string} [endingBefore] end time before time
5038
5061
  * @param {string} [startingBefore] start time before time
5039
5062
  * @param {string} [endingAfter] end time after time
5040
- * @param {Array<string>} [clientIDs] client ID to filter by
5063
+ * @param {Array<string>} [clientIDs] client IDs to filter by
5041
5064
  * @param {string} [search] search by name or description
5042
5065
  * @param {PromotionSortByField} [sortBy] sort by field
5043
5066
  * @param {SortDirection} [sortDirection] sort direction
5067
+ * @param {boolean} [onlyClaimable] only claimable promotions
5044
5068
  * @param {*} [options] Override http request option.
5045
5069
  * @throws {RequiredError}
5046
5070
  */
5047
- listPromotions(nextToken?: string, tags?: string, segmentId?: string, ownerID?: string, type?: PromotionType, startingAfter?: string, endingBefore?: string, startingBefore?: string, endingAfter?: string, clientIDs?: Array<string>, search?: string, sortBy?: PromotionSortByField, sortDirection?: SortDirection, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PromotionsResponse>>;
5071
+ listPromotions(nextToken?: string, tags?: string, segmentId?: string, ownerID?: string, type?: PromotionType, startingAfter?: string, endingBefore?: string, startingBefore?: string, endingAfter?: string, clientIDs?: Array<string>, search?: string, sortBy?: PromotionSortByField, sortDirection?: SortDirection, onlyClaimable?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PromotionsResponse>>;
5048
5072
  /**
5049
5073
  * List users promotions
5050
5074
  * @summary List promotions
@@ -5057,10 +5081,11 @@ export declare const PromotionApiFp: (configuration?: Configuration) => {
5057
5081
  * @param {string} [search] search by name or description
5058
5082
  * @param {PromotionSortByField} [sortBy] sort by field
5059
5083
  * @param {SortDirection} [sortDirection] sort direction
5084
+ * @param {boolean} [onlyClaimable] only claimable promotions
5060
5085
  * @param {*} [options] Override http request option.
5061
5086
  * @throws {RequiredError}
5062
5087
  */
5063
- listUserPromotions(nextToken?: string, tags?: string, startingAfter?: string, endingBefore?: string, startingBefore?: string, endingAfter?: string, search?: string, sortBy?: PromotionSortByField, sortDirection?: SortDirection, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PromotionsResponse>>;
5088
+ listUserPromotions(nextToken?: string, tags?: string, startingAfter?: string, endingBefore?: string, startingBefore?: string, endingAfter?: string, search?: string, sortBy?: PromotionSortByField, sortDirection?: SortDirection, onlyClaimable?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PromotionsResponse>>;
5064
5089
  /**
5065
5090
  * Update promotion by id
5066
5091
  * @summary Update promotion
@@ -5162,14 +5187,15 @@ export declare const PromotionApiFactory: (configuration?: Configuration, basePa
5162
5187
  * @param {string} [endingBefore] end time before time
5163
5188
  * @param {string} [startingBefore] start time before time
5164
5189
  * @param {string} [endingAfter] end time after time
5165
- * @param {Array<string>} [clientIDs] client ID to filter by
5190
+ * @param {Array<string>} [clientIDs] client IDs to filter by
5166
5191
  * @param {string} [search] search by name or description
5167
5192
  * @param {PromotionSortByField} [sortBy] sort by field
5168
5193
  * @param {SortDirection} [sortDirection] sort direction
5194
+ * @param {boolean} [onlyClaimable] only claimable promotions
5169
5195
  * @param {*} [options] Override http request option.
5170
5196
  * @throws {RequiredError}
5171
5197
  */
5172
- listPromotions(nextToken?: string, tags?: string, segmentId?: string, ownerID?: string, type?: PromotionType, startingAfter?: string, endingBefore?: string, startingBefore?: string, endingAfter?: string, clientIDs?: Array<string>, search?: string, sortBy?: PromotionSortByField, sortDirection?: SortDirection, options?: any): AxiosPromise<PromotionsResponse>;
5198
+ listPromotions(nextToken?: string, tags?: string, segmentId?: string, ownerID?: string, type?: PromotionType, startingAfter?: string, endingBefore?: string, startingBefore?: string, endingAfter?: string, clientIDs?: Array<string>, search?: string, sortBy?: PromotionSortByField, sortDirection?: SortDirection, onlyClaimable?: boolean, options?: any): AxiosPromise<PromotionsResponse>;
5173
5199
  /**
5174
5200
  * List users promotions
5175
5201
  * @summary List promotions
@@ -5182,10 +5208,11 @@ export declare const PromotionApiFactory: (configuration?: Configuration, basePa
5182
5208
  * @param {string} [search] search by name or description
5183
5209
  * @param {PromotionSortByField} [sortBy] sort by field
5184
5210
  * @param {SortDirection} [sortDirection] sort direction
5211
+ * @param {boolean} [onlyClaimable] only claimable promotions
5185
5212
  * @param {*} [options] Override http request option.
5186
5213
  * @throws {RequiredError}
5187
5214
  */
5188
- listUserPromotions(nextToken?: string, tags?: string, startingAfter?: string, endingBefore?: string, startingBefore?: string, endingAfter?: string, search?: string, sortBy?: PromotionSortByField, sortDirection?: SortDirection, options?: any): AxiosPromise<PromotionsResponse>;
5215
+ listUserPromotions(nextToken?: string, tags?: string, startingAfter?: string, endingBefore?: string, startingBefore?: string, endingAfter?: string, search?: string, sortBy?: PromotionSortByField, sortDirection?: SortDirection, onlyClaimable?: boolean, options?: any): AxiosPromise<PromotionsResponse>;
5189
5216
  /**
5190
5217
  * Update promotion by id
5191
5218
  * @summary Update promotion
@@ -5298,15 +5325,16 @@ export declare class PromotionApi extends BaseAPI {
5298
5325
  * @param {string} [endingBefore] end time before time
5299
5326
  * @param {string} [startingBefore] start time before time
5300
5327
  * @param {string} [endingAfter] end time after time
5301
- * @param {Array<string>} [clientIDs] client ID to filter by
5328
+ * @param {Array<string>} [clientIDs] client IDs to filter by
5302
5329
  * @param {string} [search] search by name or description
5303
5330
  * @param {PromotionSortByField} [sortBy] sort by field
5304
5331
  * @param {SortDirection} [sortDirection] sort direction
5332
+ * @param {boolean} [onlyClaimable] only claimable promotions
5305
5333
  * @param {*} [options] Override http request option.
5306
5334
  * @throws {RequiredError}
5307
5335
  * @memberof PromotionApi
5308
5336
  */
5309
- listPromotions(nextToken?: string, tags?: string, segmentId?: string, ownerID?: string, type?: PromotionType, startingAfter?: string, endingBefore?: string, startingBefore?: string, endingAfter?: string, clientIDs?: Array<string>, search?: string, sortBy?: PromotionSortByField, sortDirection?: SortDirection, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PromotionsResponse, any>>;
5337
+ listPromotions(nextToken?: string, tags?: string, segmentId?: string, ownerID?: string, type?: PromotionType, startingAfter?: string, endingBefore?: string, startingBefore?: string, endingAfter?: string, clientIDs?: Array<string>, search?: string, sortBy?: PromotionSortByField, sortDirection?: SortDirection, onlyClaimable?: boolean, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PromotionsResponse, any>>;
5310
5338
  /**
5311
5339
  * List users promotions
5312
5340
  * @summary List promotions
@@ -5319,11 +5347,12 @@ export declare class PromotionApi extends BaseAPI {
5319
5347
  * @param {string} [search] search by name or description
5320
5348
  * @param {PromotionSortByField} [sortBy] sort by field
5321
5349
  * @param {SortDirection} [sortDirection] sort direction
5350
+ * @param {boolean} [onlyClaimable] only claimable promotions
5322
5351
  * @param {*} [options] Override http request option.
5323
5352
  * @throws {RequiredError}
5324
5353
  * @memberof PromotionApi
5325
5354
  */
5326
- listUserPromotions(nextToken?: string, tags?: string, startingAfter?: string, endingBefore?: string, startingBefore?: string, endingAfter?: string, search?: string, sortBy?: PromotionSortByField, sortDirection?: SortDirection, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PromotionsResponse, any>>;
5355
+ listUserPromotions(nextToken?: string, tags?: string, startingAfter?: string, endingBefore?: string, startingBefore?: string, endingAfter?: string, search?: string, sortBy?: PromotionSortByField, sortDirection?: SortDirection, onlyClaimable?: boolean, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PromotionsResponse, any>>;
5327
5356
  /**
5328
5357
  * Update promotion by id
5329
5358
  * @summary Update promotion
@@ -5668,11 +5697,12 @@ export declare const TransactionApiAxiosParamCreator: (configuration?: Configura
5668
5697
  * List existing transactions
5669
5698
  * @summary List existing transactions
5670
5699
  * @param {string} [paginationToken] This is the pagination token
5671
- * @param {string} [clientID] This is the client ID
5700
+ * @param {Array<string>} [clientIDs] This is the client IDs to filter by
5701
+ * @param {Array<string>} [userIDs] This is the user ID
5672
5702
  * @param {*} [options] Override http request option.
5673
5703
  * @throws {RequiredError}
5674
5704
  */
5675
- listTransactions: (paginationToken?: string, clientID?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
5705
+ listTransactions: (paginationToken?: string, clientIDs?: Array<string>, userIDs?: Array<string>, options?: AxiosRequestConfig) => Promise<RequestArgs>;
5676
5706
  };
5677
5707
  /**
5678
5708
  * TransactionApi - functional programming interface
@@ -5683,11 +5713,12 @@ export declare const TransactionApiFp: (configuration?: Configuration) => {
5683
5713
  * List existing transactions
5684
5714
  * @summary List existing transactions
5685
5715
  * @param {string} [paginationToken] This is the pagination token
5686
- * @param {string} [clientID] This is the client ID
5716
+ * @param {Array<string>} [clientIDs] This is the client IDs to filter by
5717
+ * @param {Array<string>} [userIDs] This is the user ID
5687
5718
  * @param {*} [options] Override http request option.
5688
5719
  * @throws {RequiredError}
5689
5720
  */
5690
- listTransactions(paginationToken?: string, clientID?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TransactionsResponse>>;
5721
+ listTransactions(paginationToken?: string, clientIDs?: Array<string>, userIDs?: Array<string>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TransactionsResponse>>;
5691
5722
  };
5692
5723
  /**
5693
5724
  * TransactionApi - factory interface
@@ -5698,11 +5729,12 @@ export declare const TransactionApiFactory: (configuration?: Configuration, base
5698
5729
  * List existing transactions
5699
5730
  * @summary List existing transactions
5700
5731
  * @param {string} [paginationToken] This is the pagination token
5701
- * @param {string} [clientID] This is the client ID
5732
+ * @param {Array<string>} [clientIDs] This is the client IDs to filter by
5733
+ * @param {Array<string>} [userIDs] This is the user ID
5702
5734
  * @param {*} [options] Override http request option.
5703
5735
  * @throws {RequiredError}
5704
5736
  */
5705
- listTransactions(paginationToken?: string, clientID?: string, options?: any): AxiosPromise<TransactionsResponse>;
5737
+ listTransactions(paginationToken?: string, clientIDs?: Array<string>, userIDs?: Array<string>, options?: any): AxiosPromise<TransactionsResponse>;
5706
5738
  };
5707
5739
  /**
5708
5740
  * TransactionApi - object-oriented interface
@@ -5715,12 +5747,13 @@ export declare class TransactionApi extends BaseAPI {
5715
5747
  * List existing transactions
5716
5748
  * @summary List existing transactions
5717
5749
  * @param {string} [paginationToken] This is the pagination token
5718
- * @param {string} [clientID] This is the client ID
5750
+ * @param {Array<string>} [clientIDs] This is the client IDs to filter by
5751
+ * @param {Array<string>} [userIDs] This is the user ID
5719
5752
  * @param {*} [options] Override http request option.
5720
5753
  * @throws {RequiredError}
5721
5754
  * @memberof TransactionApi
5722
5755
  */
5723
- listTransactions(paginationToken?: string, clientID?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TransactionsResponse, any>>;
5756
+ listTransactions(paginationToken?: string, clientIDs?: Array<string>, userIDs?: Array<string>, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TransactionsResponse, any>>;
5724
5757
  }
5725
5758
  /**
5726
5759
  * UserApi - axios parameter creator
@@ -5749,13 +5782,13 @@ export declare const UserApiAxiosParamCreator: (configuration?: Configuration) =
5749
5782
  * @param {string} [nextToken] This is the pagination token
5750
5783
  * @param {UserRole} [role] role to filter by
5751
5784
  * @param {string} [search] search string
5752
- * @param {string} [clientID] client ID to filter by
5753
- * @param {string} [userIds] user ids to filter by, list of ids separated by commas.
5785
+ * @param {Array<string>} [clientIDs] client IDs to filter by
5786
+ * @param {Array<string>} [userIDs] user ids to filter by
5754
5787
  * @param {UserSource} [source] source to filter by
5755
5788
  * @param {*} [options] Override http request option.
5756
5789
  * @throws {RequiredError}
5757
5790
  */
5758
- listUsers: (nextToken?: string, role?: UserRole, search?: string, clientID?: string, userIds?: string, source?: UserSource, options?: AxiosRequestConfig) => Promise<RequestArgs>;
5791
+ listUsers: (nextToken?: string, role?: UserRole, search?: string, clientIDs?: Array<string>, userIDs?: Array<string>, source?: UserSource, options?: AxiosRequestConfig) => Promise<RequestArgs>;
5759
5792
  };
5760
5793
  /**
5761
5794
  * UserApi - functional programming interface
@@ -5784,13 +5817,13 @@ export declare const UserApiFp: (configuration?: Configuration) => {
5784
5817
  * @param {string} [nextToken] This is the pagination token
5785
5818
  * @param {UserRole} [role] role to filter by
5786
5819
  * @param {string} [search] search string
5787
- * @param {string} [clientID] client ID to filter by
5788
- * @param {string} [userIds] user ids to filter by, list of ids separated by commas.
5820
+ * @param {Array<string>} [clientIDs] client IDs to filter by
5821
+ * @param {Array<string>} [userIDs] user ids to filter by
5789
5822
  * @param {UserSource} [source] source to filter by
5790
5823
  * @param {*} [options] Override http request option.
5791
5824
  * @throws {RequiredError}
5792
5825
  */
5793
- listUsers(nextToken?: string, role?: UserRole, search?: string, clientID?: string, userIds?: string, source?: UserSource, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserListResponse>>;
5826
+ listUsers(nextToken?: string, role?: UserRole, search?: string, clientIDs?: Array<string>, userIDs?: Array<string>, source?: UserSource, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserListResponse>>;
5794
5827
  };
5795
5828
  /**
5796
5829
  * UserApi - factory interface
@@ -5819,13 +5852,13 @@ export declare const UserApiFactory: (configuration?: Configuration, basePath?:
5819
5852
  * @param {string} [nextToken] This is the pagination token
5820
5853
  * @param {UserRole} [role] role to filter by
5821
5854
  * @param {string} [search] search string
5822
- * @param {string} [clientID] client ID to filter by
5823
- * @param {string} [userIds] user ids to filter by, list of ids separated by commas.
5855
+ * @param {Array<string>} [clientIDs] client IDs to filter by
5856
+ * @param {Array<string>} [userIDs] user ids to filter by
5824
5857
  * @param {UserSource} [source] source to filter by
5825
5858
  * @param {*} [options] Override http request option.
5826
5859
  * @throws {RequiredError}
5827
5860
  */
5828
- listUsers(nextToken?: string, role?: UserRole, search?: string, clientID?: string, userIds?: string, source?: UserSource, options?: any): AxiosPromise<UserListResponse>;
5861
+ listUsers(nextToken?: string, role?: UserRole, search?: string, clientIDs?: Array<string>, userIDs?: Array<string>, source?: UserSource, options?: any): AxiosPromise<UserListResponse>;
5829
5862
  };
5830
5863
  /**
5831
5864
  * UserApi - object-oriented interface
@@ -5858,12 +5891,12 @@ export declare class UserApi extends BaseAPI {
5858
5891
  * @param {string} [nextToken] This is the pagination token
5859
5892
  * @param {UserRole} [role] role to filter by
5860
5893
  * @param {string} [search] search string
5861
- * @param {string} [clientID] client ID to filter by
5862
- * @param {string} [userIds] user ids to filter by, list of ids separated by commas.
5894
+ * @param {Array<string>} [clientIDs] client IDs to filter by
5895
+ * @param {Array<string>} [userIDs] user ids to filter by
5863
5896
  * @param {UserSource} [source] source to filter by
5864
5897
  * @param {*} [options] Override http request option.
5865
5898
  * @throws {RequiredError}
5866
5899
  * @memberof UserApi
5867
5900
  */
5868
- listUsers(nextToken?: string, role?: UserRole, search?: string, clientID?: string, userIds?: string, source?: UserSource, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UserListResponse, any>>;
5901
+ listUsers(nextToken?: string, role?: UserRole, search?: string, clientIDs?: Array<string>, userIDs?: Array<string>, source?: UserSource, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UserListResponse, any>>;
5869
5902
  }