@gofynd/fdk-client-javascript 1.4.8 → 1.4.10-beta.1
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 +1 -1
- package/package.json +1 -1
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +5 -0
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +2 -0
- package/sdk/common/Clickstream.js +117 -24
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +0 -402
- package/sdk/platform/Billing/BillingPlatformClient.js +79 -3301
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +396 -4080
- package/sdk/platform/Billing/BillingPlatformModel.js +253 -2684
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +1 -456
- package/sdk/platform/Billing/BillingPlatformValidator.js +0 -490
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +5 -0
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +2 -0
- package/sdk/public/PublicClient.d.ts +0 -2
- package/sdk/public/PublicClient.js +0 -4
- package/sdk/public/index.d.ts +0 -1
- package/sdk/public/index.js +0 -2
- package/sdk/public/Billing/BillingPublicClient.d.ts +0 -56
- package/sdk/public/Billing/BillingPublicClient.js +0 -349
- package/sdk/public/Billing/BillingPublicModel.d.ts +0 -919
- package/sdk/public/Billing/BillingPublicModel.js +0 -560
- package/sdk/public/Billing/BillingPublicValidator.d.ts +0 -43
- package/sdk/public/Billing/BillingPublicValidator.js +0 -50
|
@@ -1,919 +0,0 @@
|
|
|
1
|
-
export = BillingPublicModel;
|
|
2
|
-
/**
|
|
3
|
-
* @typedef TenureConfig
|
|
4
|
-
* @property {string} [display_name] - Display name for the tenure
|
|
5
|
-
* configuration(like "Monthly", "Half Yearly", "Yearly")
|
|
6
|
-
* @property {string} [description] - Description of the tenure configuration
|
|
7
|
-
* @property {boolean} [is_active] - Indicates whether the tenure configuration is active
|
|
8
|
-
* @property {string} [slug] - Slug identifier that uniquely identifies the
|
|
9
|
-
* tenure configuration
|
|
10
|
-
*/
|
|
11
|
-
/**
|
|
12
|
-
* @typedef TenureConfigData
|
|
13
|
-
* @property {string} [country] - Country associated with the tenure configuration
|
|
14
|
-
* @property {TenureConfig[]} [tenure_config] - Array of tenure configurations
|
|
15
|
-
*/
|
|
16
|
-
/**
|
|
17
|
-
* @typedef TenureConfigResponse
|
|
18
|
-
* @property {boolean} [success] - Indicates whether the request was successful
|
|
19
|
-
* @property {TenureConfigData} [data]
|
|
20
|
-
*/
|
|
21
|
-
/**
|
|
22
|
-
* @typedef ResourceNotFound
|
|
23
|
-
* @property {string} [message] - Resource not found with {id}
|
|
24
|
-
*/
|
|
25
|
-
/**
|
|
26
|
-
* @typedef PlanRecurring
|
|
27
|
-
* @property {string} [interval] - Interval for the recurring plan
|
|
28
|
-
* @property {number} [interval_count] - Number of intervals for the recurring plan
|
|
29
|
-
* @property {string} [aggregate_usage] - Aggregate usage type for the recurring plan
|
|
30
|
-
* @property {string} [usage_type] - Usage type for the recurring plan (like metered etc)
|
|
31
|
-
*/
|
|
32
|
-
/**
|
|
33
|
-
* @typedef PlanTypes
|
|
34
|
-
* @property {PlanDetails[]} [month] - Monthly plan details
|
|
35
|
-
* @property {PlanDetails[]} [quarter] - Quarterly plan details
|
|
36
|
-
* @property {PlanDetails[]} [half_year] - Half-yearly plan details
|
|
37
|
-
* @property {PlanDetails[]} [year] - Yearly plan details
|
|
38
|
-
*/
|
|
39
|
-
/**
|
|
40
|
-
* @typedef DetailList
|
|
41
|
-
* @property {PlanTypes} [plans]
|
|
42
|
-
* @property {TrialPlanDetails} [trial_plan]
|
|
43
|
-
*/
|
|
44
|
-
/**
|
|
45
|
-
* @typedef PlanTaxation
|
|
46
|
-
* @property {number} [gst] - GST percentage applied to the plan
|
|
47
|
-
*/
|
|
48
|
-
/**
|
|
49
|
-
* @typedef CountryRes
|
|
50
|
-
* @property {string} [name] - Name of the country
|
|
51
|
-
* @property {string} [code] - Country code
|
|
52
|
-
*/
|
|
53
|
-
/**
|
|
54
|
-
* @typedef OneTimeFees
|
|
55
|
-
* @property {number} [developement] - One time Development fees
|
|
56
|
-
* @property {number} [marketing] - One time Marketing fees
|
|
57
|
-
*/
|
|
58
|
-
/**
|
|
59
|
-
* @typedef CreditLine
|
|
60
|
-
* @property {boolean} [is_active] - Indicates whether the credit line is active
|
|
61
|
-
*/
|
|
62
|
-
/**
|
|
63
|
-
* @typedef PlanMeta
|
|
64
|
-
* @property {string} [plan_platform_display_name] - Display name for the plan platform
|
|
65
|
-
*/
|
|
66
|
-
/**
|
|
67
|
-
* @typedef FeatureConfig
|
|
68
|
-
* @property {boolean} [enabled] - Indicates whether the feature is enabled
|
|
69
|
-
* @property {number} [limit] - Limit for the feature
|
|
70
|
-
* @property {number} [hard_limit] - Hard limit for the feature
|
|
71
|
-
* @property {number} [soft_limit] - Soft limit for the feature
|
|
72
|
-
*/
|
|
73
|
-
/**
|
|
74
|
-
* @typedef PlanConfig
|
|
75
|
-
* @property {boolean} [is_active] - Indicates whether the plan configuration is active
|
|
76
|
-
* @property {string} [display_text] - Text to display plan configuration
|
|
77
|
-
* @property {boolean} [is_default] - Indicates whether the plan configuration is default
|
|
78
|
-
* @property {string} [processing_type] - Type of processing for the plan configuration
|
|
79
|
-
* @property {string[]} [tags] - Tags associated with the plan configuration
|
|
80
|
-
* @property {FeatureConfig} [feature_config]
|
|
81
|
-
* @property {string} [_id] - Unique identifier for the plan configuration
|
|
82
|
-
* @property {string} [component_id] - Component identifier associated with the
|
|
83
|
-
* plan configuration
|
|
84
|
-
* @property {string} [created_at] - Creation date of the plan configuration
|
|
85
|
-
* @property {string} [modified_at] - Modification date of the plan configuration
|
|
86
|
-
* @property {number} [__v] - Version number of the plan configuration
|
|
87
|
-
* @property {string} [billing_scheme] - Billing scheme for the plan configuration
|
|
88
|
-
* @property {string} [bill_type] - Billing type for the plan configuration
|
|
89
|
-
* @property {string} [price_ui_type] - Price UI type for the plan configuration
|
|
90
|
-
* @property {PlanRecurring} [recurring]
|
|
91
|
-
* @property {TransformQuantity} [transform_quantity]
|
|
92
|
-
* @property {FreeTier} [free_tier]
|
|
93
|
-
* @property {string} [currency] - Currency used in the plan configuration
|
|
94
|
-
* @property {number} [unit_amount] - Unit amount for the plan configuration
|
|
95
|
-
* @property {number} [quantity] - Quantity for the plan configuration
|
|
96
|
-
* @property {string} [price_type] - Price type for the plan configuration
|
|
97
|
-
* @property {Object[]} [tiers] - An array of pricing tiers that apply based on
|
|
98
|
-
* quantity or usage. Each tier can define a maximum limit (`up_to`), an
|
|
99
|
-
* additional flat fee (`flat_amount`), and a price per unit (`unit_amount`)
|
|
100
|
-
*/
|
|
101
|
-
/**
|
|
102
|
-
* @typedef FreeTier
|
|
103
|
-
* @property {string} [type] - Type of the free tier
|
|
104
|
-
* @property {number} [value] - Value of the free tier type
|
|
105
|
-
*/
|
|
106
|
-
/**
|
|
107
|
-
* @typedef TransformQuantity
|
|
108
|
-
* @property {number} [divide_by] - Divide by value for the quantity transformation
|
|
109
|
-
* @property {string} [round] - Rounding method for the quantity transformation
|
|
110
|
-
*/
|
|
111
|
-
/**
|
|
112
|
-
* @typedef ComponentsSchema
|
|
113
|
-
* @property {string} [name] - Name of the component
|
|
114
|
-
* @property {string} [slug] - Slug identifier for the component
|
|
115
|
-
* @property {string} [description] - Description of the component
|
|
116
|
-
* @property {string} [group] - Group to which the component belongs
|
|
117
|
-
* @property {string} [icon] - Icon associated with the component
|
|
118
|
-
* @property {Object} [links] - Links associated with the component
|
|
119
|
-
* @property {PlanConfig} [config]
|
|
120
|
-
* @property {boolean} [is_active] - Indicates whether the component is active
|
|
121
|
-
* @property {string} [display_text] - Display text for the component
|
|
122
|
-
*/
|
|
123
|
-
/**
|
|
124
|
-
* @typedef PlanDetails
|
|
125
|
-
* @property {string} [activated_by] - ID of the user who activated the plan
|
|
126
|
-
* @property {string} [updated_by] - ID of the user who updated the plan
|
|
127
|
-
* @property {PlanRecurring} [recurring]
|
|
128
|
-
* @property {boolean} [is_trial_plan] - Indicates whether the plan is a trial plan
|
|
129
|
-
* @property {string[]} [company_ids] - Company IDs associated with the plan
|
|
130
|
-
* @property {string} [created_by] - ID of the user who created the plan
|
|
131
|
-
* @property {string} [channel_type] - Ordering channel associated with the
|
|
132
|
-
* plan(e.g, ecomm, fynd)
|
|
133
|
-
* @property {string} [platform] - Platform associated with the plan(e.g, web, mobile)
|
|
134
|
-
* @property {string} [plan_group] - Group to which the plan belongs
|
|
135
|
-
* @property {string[]} [tag_lines] - Tag lines associated with the plan
|
|
136
|
-
* @property {string} [currency] - Currency of the plan
|
|
137
|
-
* @property {boolean} [is_active] - Indicates whether the plan is active
|
|
138
|
-
* @property {boolean} [is_visible] - Indicates whether the plan is visible on ui
|
|
139
|
-
* @property {number} [trial_period] - Trial period of the plan
|
|
140
|
-
* @property {string[]} [addons] - Addons associated with the plan
|
|
141
|
-
* @property {string[]} [tags] - Tags associated with the plan
|
|
142
|
-
* @property {string} [type] - Type of the plan
|
|
143
|
-
* @property {CountryRes} [country]
|
|
144
|
-
* @property {string} [_id] - Unique identifier for the plan."
|
|
145
|
-
* @property {string} [name] - Name of the plan
|
|
146
|
-
* @property {string} [description] - Description of the plan
|
|
147
|
-
* @property {number} [amount] - Amount of the plan
|
|
148
|
-
* @property {string} [product_suite_id] - Identifier of the product suite
|
|
149
|
-
* associated with the plan
|
|
150
|
-
* @property {string} [created_at] - Creation date of the plan
|
|
151
|
-
* @property {string} [modified_at] - Modification date of the plan
|
|
152
|
-
* @property {PlanTaxation} [taxation]
|
|
153
|
-
* @property {OneTimeFees} [one_time_fees]
|
|
154
|
-
* @property {CreditLine} [credit_line]
|
|
155
|
-
* @property {string} [current_status] - Current status of the plan
|
|
156
|
-
* @property {string} [approved_by] - Id of the User who has approved the plan
|
|
157
|
-
* @property {PlanMeta} [meta]
|
|
158
|
-
* @property {ComponentsSchema[]} [components] - Components associated with the plan
|
|
159
|
-
*/
|
|
160
|
-
/**
|
|
161
|
-
* @typedef Recurring
|
|
162
|
-
* @property {string} [interval] - Interval for recurring payments
|
|
163
|
-
* @property {number} [interval_count] - Number of intervals
|
|
164
|
-
*/
|
|
165
|
-
/**
|
|
166
|
-
* @typedef Taxation
|
|
167
|
-
* @property {number} [gst] - GST percentage applied to the plan
|
|
168
|
-
*/
|
|
169
|
-
/**
|
|
170
|
-
* @typedef PlanList
|
|
171
|
-
* @property {string} [approved_by] - ID of the user who approved the plan
|
|
172
|
-
* @property {string} [updated_by] - ID of the user who updated the plan
|
|
173
|
-
* @property {Recurring} [recurring]
|
|
174
|
-
* @property {Taxation} [taxation]
|
|
175
|
-
* @property {OneTimeFees} [one_time_fees]
|
|
176
|
-
* @property {CreditLine} [credit_line]
|
|
177
|
-
* @property {string} [_id] - Unique identifier of the plan
|
|
178
|
-
* @property {string} [product_suite_id] - Identifier of the product suite
|
|
179
|
-
* associated with the plan
|
|
180
|
-
* @property {boolean} [is_trial_plan] - Indicates whether the plan is a trial plan
|
|
181
|
-
* @property {string} [name] - Name of the plan
|
|
182
|
-
* @property {string} [description] - Description of the plan
|
|
183
|
-
* @property {string} [plan_group] - Group to which plan belongs
|
|
184
|
-
* @property {string} [plan_group_id] - Group id to which plan belongs
|
|
185
|
-
* @property {string[]} [tag_lines] - Tag lines associated with the plan
|
|
186
|
-
* @property {string} [currency] - Currency of the plan
|
|
187
|
-
* @property {number} [amount] - Amount of the plan
|
|
188
|
-
* @property {boolean} [is_active] - Indicates whether the plan is active
|
|
189
|
-
* @property {boolean} [is_visible] - Indicates whether the plan is visible on ui
|
|
190
|
-
* @property {number} [trial_period] - Trial period of the plan in days
|
|
191
|
-
* @property {Object[]} [addons] - Addons associated with the plan
|
|
192
|
-
* @property {string[]} [tags] - Tags associated with the plan
|
|
193
|
-
* @property {string} [type] - Type of the plan (enterprise or standard)
|
|
194
|
-
* @property {Object} [meta] - Additional metadata associated with the plan
|
|
195
|
-
* @property {CountryRes} [country]
|
|
196
|
-
* @property {string[]} [company_ids] - Company IDs associated with the plan
|
|
197
|
-
* @property {string} [created_by] - ID of the user who created the plan
|
|
198
|
-
* @property {string} [current_status] - Current status of the plan (active, inactive)
|
|
199
|
-
* @property {string} [channel_type] - Ordering channel for which plan is
|
|
200
|
-
* created(fynd, ecomm, uniket etc)
|
|
201
|
-
* @property {string} [platform] - Platform associated with the plan (web, mobile, all)
|
|
202
|
-
* @property {string} [created_at] - Date and time when the plan was created
|
|
203
|
-
* @property {string} [modified_at] - Date and time when the plan was last modified
|
|
204
|
-
*/
|
|
205
|
-
/**
|
|
206
|
-
* @typedef TrialPlanDetails
|
|
207
|
-
* @property {string} [activated_by] - ID of the user who activated the trial plan
|
|
208
|
-
* @property {string} [updated_by] - ID of the user who updated the trial plan
|
|
209
|
-
* @property {PlanRecurring} [recurring]
|
|
210
|
-
* @property {boolean} [is_trial_plan] - Indicates whether the plan is a trial plan
|
|
211
|
-
* @property {string[]} [company_ids] - Company IDs associated with the trial plan
|
|
212
|
-
* @property {string} [created_by] - ID of the user who created the trial plan
|
|
213
|
-
* @property {string} [channel_type] - Ordering channel for which plan is
|
|
214
|
-
* created(ecomm, fynd etc)
|
|
215
|
-
* @property {string} [platform] - Platform associated with the trial plan(web ,
|
|
216
|
-
* mobile, all)
|
|
217
|
-
* @property {string} [plan_group] - Group to which the trial plan belongs
|
|
218
|
-
* @property {string[]} [tag_lines] - Tag lines associated with the trial plan
|
|
219
|
-
* @property {string} [currency] - Currency of the trial plan
|
|
220
|
-
* @property {boolean} [is_active] - Indicates whether the trial plan is active
|
|
221
|
-
* @property {boolean} [is_visible] - Indicates whether the trial plan is visible on ui
|
|
222
|
-
* @property {number} [trial_period] - Trial period of the trial plan in days
|
|
223
|
-
* @property {string[]} [addons] - Addons associated with the trial plan
|
|
224
|
-
* @property {string[]} [tags] - Tags associated with the trial plan
|
|
225
|
-
* @property {string} [type] - Type of the trial plan(public, company_specific)
|
|
226
|
-
* @property {CountryRes} [country]
|
|
227
|
-
* @property {string} [_id] - Unique identifier for the trial plan
|
|
228
|
-
* @property {string} [name] - Name of the trial plan
|
|
229
|
-
* @property {string} [description] - Description of the trial plan
|
|
230
|
-
* @property {number} [amount] - Amount of the trial plan
|
|
231
|
-
* @property {string} [product_suite_id] - Identifier of the product suite
|
|
232
|
-
* associated with the trial plan
|
|
233
|
-
* @property {string} [created_at] - Creation date of the trial plan
|
|
234
|
-
* @property {string} [modified_at] - Modification date of the trial plan
|
|
235
|
-
* @property {PlanTaxation} [taxation]
|
|
236
|
-
* @property {OneTimeFees} [one_time_fees]
|
|
237
|
-
* @property {CreditLine} [credit_line]
|
|
238
|
-
* @property {string} [current_status] - Current status of the trial plan
|
|
239
|
-
* @property {PlanMeta} [meta]
|
|
240
|
-
* @property {ComponentsSchema[]} [components] - Components associated with the trial plan
|
|
241
|
-
*/
|
|
242
|
-
declare class BillingPublicModel {
|
|
243
|
-
}
|
|
244
|
-
declare namespace BillingPublicModel {
|
|
245
|
-
export { TenureConfig, TenureConfigData, TenureConfigResponse, ResourceNotFound, PlanRecurring, PlanTypes, DetailList, PlanTaxation, CountryRes, OneTimeFees, CreditLine, PlanMeta, FeatureConfig, PlanConfig, FreeTier, TransformQuantity, ComponentsSchema, PlanDetails, Recurring, Taxation, PlanList, TrialPlanDetails };
|
|
246
|
-
}
|
|
247
|
-
/** @returns {TenureConfig} */
|
|
248
|
-
declare function TenureConfig(): TenureConfig;
|
|
249
|
-
type TenureConfig = {
|
|
250
|
-
/**
|
|
251
|
-
* - Display name for the tenure
|
|
252
|
-
* configuration(like "Monthly", "Half Yearly", "Yearly")
|
|
253
|
-
*/
|
|
254
|
-
display_name?: string;
|
|
255
|
-
/**
|
|
256
|
-
* - Description of the tenure configuration
|
|
257
|
-
*/
|
|
258
|
-
description?: string;
|
|
259
|
-
/**
|
|
260
|
-
* - Indicates whether the tenure configuration is active
|
|
261
|
-
*/
|
|
262
|
-
is_active?: boolean;
|
|
263
|
-
/**
|
|
264
|
-
* - Slug identifier that uniquely identifies the
|
|
265
|
-
* tenure configuration
|
|
266
|
-
*/
|
|
267
|
-
slug?: string;
|
|
268
|
-
};
|
|
269
|
-
/** @returns {TenureConfigData} */
|
|
270
|
-
declare function TenureConfigData(): TenureConfigData;
|
|
271
|
-
type TenureConfigData = {
|
|
272
|
-
/**
|
|
273
|
-
* - Country associated with the tenure configuration
|
|
274
|
-
*/
|
|
275
|
-
country?: string;
|
|
276
|
-
/**
|
|
277
|
-
* - Array of tenure configurations
|
|
278
|
-
*/
|
|
279
|
-
tenure_config?: TenureConfig[];
|
|
280
|
-
};
|
|
281
|
-
/** @returns {TenureConfigResponse} */
|
|
282
|
-
declare function TenureConfigResponse(): TenureConfigResponse;
|
|
283
|
-
type TenureConfigResponse = {
|
|
284
|
-
/**
|
|
285
|
-
* - Indicates whether the request was successful
|
|
286
|
-
*/
|
|
287
|
-
success?: boolean;
|
|
288
|
-
data?: TenureConfigData;
|
|
289
|
-
};
|
|
290
|
-
/** @returns {ResourceNotFound} */
|
|
291
|
-
declare function ResourceNotFound(): ResourceNotFound;
|
|
292
|
-
type ResourceNotFound = {
|
|
293
|
-
/**
|
|
294
|
-
* - Resource not found with {id}
|
|
295
|
-
*/
|
|
296
|
-
message?: string;
|
|
297
|
-
};
|
|
298
|
-
/** @returns {PlanRecurring} */
|
|
299
|
-
declare function PlanRecurring(): PlanRecurring;
|
|
300
|
-
type PlanRecurring = {
|
|
301
|
-
/**
|
|
302
|
-
* - Interval for the recurring plan
|
|
303
|
-
*/
|
|
304
|
-
interval?: string;
|
|
305
|
-
/**
|
|
306
|
-
* - Number of intervals for the recurring plan
|
|
307
|
-
*/
|
|
308
|
-
interval_count?: number;
|
|
309
|
-
/**
|
|
310
|
-
* - Aggregate usage type for the recurring plan
|
|
311
|
-
*/
|
|
312
|
-
aggregate_usage?: string;
|
|
313
|
-
/**
|
|
314
|
-
* - Usage type for the recurring plan (like metered etc)
|
|
315
|
-
*/
|
|
316
|
-
usage_type?: string;
|
|
317
|
-
};
|
|
318
|
-
/** @returns {PlanTypes} */
|
|
319
|
-
declare function PlanTypes(): PlanTypes;
|
|
320
|
-
type PlanTypes = {
|
|
321
|
-
/**
|
|
322
|
-
* - Monthly plan details
|
|
323
|
-
*/
|
|
324
|
-
month?: PlanDetails[];
|
|
325
|
-
/**
|
|
326
|
-
* - Quarterly plan details
|
|
327
|
-
*/
|
|
328
|
-
quarter?: PlanDetails[];
|
|
329
|
-
/**
|
|
330
|
-
* - Half-yearly plan details
|
|
331
|
-
*/
|
|
332
|
-
half_year?: PlanDetails[];
|
|
333
|
-
/**
|
|
334
|
-
* - Yearly plan details
|
|
335
|
-
*/
|
|
336
|
-
year?: PlanDetails[];
|
|
337
|
-
};
|
|
338
|
-
/** @returns {DetailList} */
|
|
339
|
-
declare function DetailList(): DetailList;
|
|
340
|
-
type DetailList = {
|
|
341
|
-
plans?: PlanTypes;
|
|
342
|
-
trial_plan?: TrialPlanDetails;
|
|
343
|
-
};
|
|
344
|
-
/** @returns {PlanTaxation} */
|
|
345
|
-
declare function PlanTaxation(): PlanTaxation;
|
|
346
|
-
type PlanTaxation = {
|
|
347
|
-
/**
|
|
348
|
-
* - GST percentage applied to the plan
|
|
349
|
-
*/
|
|
350
|
-
gst?: number;
|
|
351
|
-
};
|
|
352
|
-
/** @returns {CountryRes} */
|
|
353
|
-
declare function CountryRes(): CountryRes;
|
|
354
|
-
type CountryRes = {
|
|
355
|
-
/**
|
|
356
|
-
* - Name of the country
|
|
357
|
-
*/
|
|
358
|
-
name?: string;
|
|
359
|
-
/**
|
|
360
|
-
* - Country code
|
|
361
|
-
*/
|
|
362
|
-
code?: string;
|
|
363
|
-
};
|
|
364
|
-
/** @returns {OneTimeFees} */
|
|
365
|
-
declare function OneTimeFees(): OneTimeFees;
|
|
366
|
-
type OneTimeFees = {
|
|
367
|
-
/**
|
|
368
|
-
* - One time Development fees
|
|
369
|
-
*/
|
|
370
|
-
developement?: number;
|
|
371
|
-
/**
|
|
372
|
-
* - One time Marketing fees
|
|
373
|
-
*/
|
|
374
|
-
marketing?: number;
|
|
375
|
-
};
|
|
376
|
-
/** @returns {CreditLine} */
|
|
377
|
-
declare function CreditLine(): CreditLine;
|
|
378
|
-
type CreditLine = {
|
|
379
|
-
/**
|
|
380
|
-
* - Indicates whether the credit line is active
|
|
381
|
-
*/
|
|
382
|
-
is_active?: boolean;
|
|
383
|
-
};
|
|
384
|
-
/** @returns {PlanMeta} */
|
|
385
|
-
declare function PlanMeta(): PlanMeta;
|
|
386
|
-
type PlanMeta = {
|
|
387
|
-
/**
|
|
388
|
-
* - Display name for the plan platform
|
|
389
|
-
*/
|
|
390
|
-
plan_platform_display_name?: string;
|
|
391
|
-
};
|
|
392
|
-
/** @returns {FeatureConfig} */
|
|
393
|
-
declare function FeatureConfig(): FeatureConfig;
|
|
394
|
-
type FeatureConfig = {
|
|
395
|
-
/**
|
|
396
|
-
* - Indicates whether the feature is enabled
|
|
397
|
-
*/
|
|
398
|
-
enabled?: boolean;
|
|
399
|
-
/**
|
|
400
|
-
* - Limit for the feature
|
|
401
|
-
*/
|
|
402
|
-
limit?: number;
|
|
403
|
-
/**
|
|
404
|
-
* - Hard limit for the feature
|
|
405
|
-
*/
|
|
406
|
-
hard_limit?: number;
|
|
407
|
-
/**
|
|
408
|
-
* - Soft limit for the feature
|
|
409
|
-
*/
|
|
410
|
-
soft_limit?: number;
|
|
411
|
-
};
|
|
412
|
-
/** @returns {PlanConfig} */
|
|
413
|
-
declare function PlanConfig(): PlanConfig;
|
|
414
|
-
type PlanConfig = {
|
|
415
|
-
/**
|
|
416
|
-
* - Indicates whether the plan configuration is active
|
|
417
|
-
*/
|
|
418
|
-
is_active?: boolean;
|
|
419
|
-
/**
|
|
420
|
-
* - Text to display plan configuration
|
|
421
|
-
*/
|
|
422
|
-
display_text?: string;
|
|
423
|
-
/**
|
|
424
|
-
* - Indicates whether the plan configuration is default
|
|
425
|
-
*/
|
|
426
|
-
is_default?: boolean;
|
|
427
|
-
/**
|
|
428
|
-
* - Type of processing for the plan configuration
|
|
429
|
-
*/
|
|
430
|
-
processing_type?: string;
|
|
431
|
-
/**
|
|
432
|
-
* - Tags associated with the plan configuration
|
|
433
|
-
*/
|
|
434
|
-
tags?: string[];
|
|
435
|
-
feature_config?: FeatureConfig;
|
|
436
|
-
/**
|
|
437
|
-
* - Unique identifier for the plan configuration
|
|
438
|
-
*/
|
|
439
|
-
_id?: string;
|
|
440
|
-
/**
|
|
441
|
-
* - Component identifier associated with the
|
|
442
|
-
* plan configuration
|
|
443
|
-
*/
|
|
444
|
-
component_id?: string;
|
|
445
|
-
/**
|
|
446
|
-
* - Creation date of the plan configuration
|
|
447
|
-
*/
|
|
448
|
-
created_at?: string;
|
|
449
|
-
/**
|
|
450
|
-
* - Modification date of the plan configuration
|
|
451
|
-
*/
|
|
452
|
-
modified_at?: string;
|
|
453
|
-
/**
|
|
454
|
-
* - Version number of the plan configuration
|
|
455
|
-
*/
|
|
456
|
-
__v?: number;
|
|
457
|
-
/**
|
|
458
|
-
* - Billing scheme for the plan configuration
|
|
459
|
-
*/
|
|
460
|
-
billing_scheme?: string;
|
|
461
|
-
/**
|
|
462
|
-
* - Billing type for the plan configuration
|
|
463
|
-
*/
|
|
464
|
-
bill_type?: string;
|
|
465
|
-
/**
|
|
466
|
-
* - Price UI type for the plan configuration
|
|
467
|
-
*/
|
|
468
|
-
price_ui_type?: string;
|
|
469
|
-
recurring?: PlanRecurring;
|
|
470
|
-
transform_quantity?: TransformQuantity;
|
|
471
|
-
free_tier?: FreeTier;
|
|
472
|
-
/**
|
|
473
|
-
* - Currency used in the plan configuration
|
|
474
|
-
*/
|
|
475
|
-
currency?: string;
|
|
476
|
-
/**
|
|
477
|
-
* - Unit amount for the plan configuration
|
|
478
|
-
*/
|
|
479
|
-
unit_amount?: number;
|
|
480
|
-
/**
|
|
481
|
-
* - Quantity for the plan configuration
|
|
482
|
-
*/
|
|
483
|
-
quantity?: number;
|
|
484
|
-
/**
|
|
485
|
-
* - Price type for the plan configuration
|
|
486
|
-
*/
|
|
487
|
-
price_type?: string;
|
|
488
|
-
/**
|
|
489
|
-
* - An array of pricing tiers that apply based on
|
|
490
|
-
* quantity or usage. Each tier can define a maximum limit (`up_to`), an
|
|
491
|
-
* additional flat fee (`flat_amount`), and a price per unit (`unit_amount`)
|
|
492
|
-
*/
|
|
493
|
-
tiers?: any[];
|
|
494
|
-
};
|
|
495
|
-
/** @returns {FreeTier} */
|
|
496
|
-
declare function FreeTier(): FreeTier;
|
|
497
|
-
type FreeTier = {
|
|
498
|
-
/**
|
|
499
|
-
* - Type of the free tier
|
|
500
|
-
*/
|
|
501
|
-
type?: string;
|
|
502
|
-
/**
|
|
503
|
-
* - Value of the free tier type
|
|
504
|
-
*/
|
|
505
|
-
value?: number;
|
|
506
|
-
};
|
|
507
|
-
/** @returns {TransformQuantity} */
|
|
508
|
-
declare function TransformQuantity(): TransformQuantity;
|
|
509
|
-
type TransformQuantity = {
|
|
510
|
-
/**
|
|
511
|
-
* - Divide by value for the quantity transformation
|
|
512
|
-
*/
|
|
513
|
-
divide_by?: number;
|
|
514
|
-
/**
|
|
515
|
-
* - Rounding method for the quantity transformation
|
|
516
|
-
*/
|
|
517
|
-
round?: string;
|
|
518
|
-
};
|
|
519
|
-
/** @returns {ComponentsSchema} */
|
|
520
|
-
declare function ComponentsSchema(): ComponentsSchema;
|
|
521
|
-
type ComponentsSchema = {
|
|
522
|
-
/**
|
|
523
|
-
* - Name of the component
|
|
524
|
-
*/
|
|
525
|
-
name?: string;
|
|
526
|
-
/**
|
|
527
|
-
* - Slug identifier for the component
|
|
528
|
-
*/
|
|
529
|
-
slug?: string;
|
|
530
|
-
/**
|
|
531
|
-
* - Description of the component
|
|
532
|
-
*/
|
|
533
|
-
description?: string;
|
|
534
|
-
/**
|
|
535
|
-
* - Group to which the component belongs
|
|
536
|
-
*/
|
|
537
|
-
group?: string;
|
|
538
|
-
/**
|
|
539
|
-
* - Icon associated with the component
|
|
540
|
-
*/
|
|
541
|
-
icon?: string;
|
|
542
|
-
/**
|
|
543
|
-
* - Links associated with the component
|
|
544
|
-
*/
|
|
545
|
-
links?: any;
|
|
546
|
-
config?: PlanConfig;
|
|
547
|
-
/**
|
|
548
|
-
* - Indicates whether the component is active
|
|
549
|
-
*/
|
|
550
|
-
is_active?: boolean;
|
|
551
|
-
/**
|
|
552
|
-
* - Display text for the component
|
|
553
|
-
*/
|
|
554
|
-
display_text?: string;
|
|
555
|
-
};
|
|
556
|
-
/** @returns {PlanDetails} */
|
|
557
|
-
declare function PlanDetails(): PlanDetails;
|
|
558
|
-
type PlanDetails = {
|
|
559
|
-
/**
|
|
560
|
-
* - ID of the user who activated the plan
|
|
561
|
-
*/
|
|
562
|
-
activated_by?: string;
|
|
563
|
-
/**
|
|
564
|
-
* - ID of the user who updated the plan
|
|
565
|
-
*/
|
|
566
|
-
updated_by?: string;
|
|
567
|
-
recurring?: PlanRecurring;
|
|
568
|
-
/**
|
|
569
|
-
* - Indicates whether the plan is a trial plan
|
|
570
|
-
*/
|
|
571
|
-
is_trial_plan?: boolean;
|
|
572
|
-
/**
|
|
573
|
-
* - Company IDs associated with the plan
|
|
574
|
-
*/
|
|
575
|
-
company_ids?: string[];
|
|
576
|
-
/**
|
|
577
|
-
* - ID of the user who created the plan
|
|
578
|
-
*/
|
|
579
|
-
created_by?: string;
|
|
580
|
-
/**
|
|
581
|
-
* - Ordering channel associated with the
|
|
582
|
-
* plan(e.g, ecomm, fynd)
|
|
583
|
-
*/
|
|
584
|
-
channel_type?: string;
|
|
585
|
-
/**
|
|
586
|
-
* - Platform associated with the plan(e.g, web, mobile)
|
|
587
|
-
*/
|
|
588
|
-
platform?: string;
|
|
589
|
-
/**
|
|
590
|
-
* - Group to which the plan belongs
|
|
591
|
-
*/
|
|
592
|
-
plan_group?: string;
|
|
593
|
-
/**
|
|
594
|
-
* - Tag lines associated with the plan
|
|
595
|
-
*/
|
|
596
|
-
tag_lines?: string[];
|
|
597
|
-
/**
|
|
598
|
-
* - Currency of the plan
|
|
599
|
-
*/
|
|
600
|
-
currency?: string;
|
|
601
|
-
/**
|
|
602
|
-
* - Indicates whether the plan is active
|
|
603
|
-
*/
|
|
604
|
-
is_active?: boolean;
|
|
605
|
-
/**
|
|
606
|
-
* - Indicates whether the plan is visible on ui
|
|
607
|
-
*/
|
|
608
|
-
is_visible?: boolean;
|
|
609
|
-
/**
|
|
610
|
-
* - Trial period of the plan
|
|
611
|
-
*/
|
|
612
|
-
trial_period?: number;
|
|
613
|
-
/**
|
|
614
|
-
* - Addons associated with the plan
|
|
615
|
-
*/
|
|
616
|
-
addons?: string[];
|
|
617
|
-
/**
|
|
618
|
-
* - Tags associated with the plan
|
|
619
|
-
*/
|
|
620
|
-
tags?: string[];
|
|
621
|
-
/**
|
|
622
|
-
* - Type of the plan
|
|
623
|
-
*/
|
|
624
|
-
type?: string;
|
|
625
|
-
country?: CountryRes;
|
|
626
|
-
/**
|
|
627
|
-
* - Unique identifier for the plan."
|
|
628
|
-
*/
|
|
629
|
-
_id?: string;
|
|
630
|
-
/**
|
|
631
|
-
* - Name of the plan
|
|
632
|
-
*/
|
|
633
|
-
name?: string;
|
|
634
|
-
/**
|
|
635
|
-
* - Description of the plan
|
|
636
|
-
*/
|
|
637
|
-
description?: string;
|
|
638
|
-
/**
|
|
639
|
-
* - Amount of the plan
|
|
640
|
-
*/
|
|
641
|
-
amount?: number;
|
|
642
|
-
/**
|
|
643
|
-
* - Identifier of the product suite
|
|
644
|
-
* associated with the plan
|
|
645
|
-
*/
|
|
646
|
-
product_suite_id?: string;
|
|
647
|
-
/**
|
|
648
|
-
* - Creation date of the plan
|
|
649
|
-
*/
|
|
650
|
-
created_at?: string;
|
|
651
|
-
/**
|
|
652
|
-
* - Modification date of the plan
|
|
653
|
-
*/
|
|
654
|
-
modified_at?: string;
|
|
655
|
-
taxation?: PlanTaxation;
|
|
656
|
-
one_time_fees?: OneTimeFees;
|
|
657
|
-
credit_line?: CreditLine;
|
|
658
|
-
/**
|
|
659
|
-
* - Current status of the plan
|
|
660
|
-
*/
|
|
661
|
-
current_status?: string;
|
|
662
|
-
/**
|
|
663
|
-
* - Id of the User who has approved the plan
|
|
664
|
-
*/
|
|
665
|
-
approved_by?: string;
|
|
666
|
-
meta?: PlanMeta;
|
|
667
|
-
/**
|
|
668
|
-
* - Components associated with the plan
|
|
669
|
-
*/
|
|
670
|
-
components?: ComponentsSchema[];
|
|
671
|
-
};
|
|
672
|
-
/** @returns {Recurring} */
|
|
673
|
-
declare function Recurring(): Recurring;
|
|
674
|
-
type Recurring = {
|
|
675
|
-
/**
|
|
676
|
-
* - Interval for recurring payments
|
|
677
|
-
*/
|
|
678
|
-
interval?: string;
|
|
679
|
-
/**
|
|
680
|
-
* - Number of intervals
|
|
681
|
-
*/
|
|
682
|
-
interval_count?: number;
|
|
683
|
-
};
|
|
684
|
-
/** @returns {Taxation} */
|
|
685
|
-
declare function Taxation(): Taxation;
|
|
686
|
-
type Taxation = {
|
|
687
|
-
/**
|
|
688
|
-
* - GST percentage applied to the plan
|
|
689
|
-
*/
|
|
690
|
-
gst?: number;
|
|
691
|
-
};
|
|
692
|
-
/** @returns {PlanList} */
|
|
693
|
-
declare function PlanList(): PlanList;
|
|
694
|
-
type PlanList = {
|
|
695
|
-
/**
|
|
696
|
-
* - ID of the user who approved the plan
|
|
697
|
-
*/
|
|
698
|
-
approved_by?: string;
|
|
699
|
-
/**
|
|
700
|
-
* - ID of the user who updated the plan
|
|
701
|
-
*/
|
|
702
|
-
updated_by?: string;
|
|
703
|
-
recurring?: Recurring;
|
|
704
|
-
taxation?: Taxation;
|
|
705
|
-
one_time_fees?: OneTimeFees;
|
|
706
|
-
credit_line?: CreditLine;
|
|
707
|
-
/**
|
|
708
|
-
* - Unique identifier of the plan
|
|
709
|
-
*/
|
|
710
|
-
_id?: string;
|
|
711
|
-
/**
|
|
712
|
-
* - Identifier of the product suite
|
|
713
|
-
* associated with the plan
|
|
714
|
-
*/
|
|
715
|
-
product_suite_id?: string;
|
|
716
|
-
/**
|
|
717
|
-
* - Indicates whether the plan is a trial plan
|
|
718
|
-
*/
|
|
719
|
-
is_trial_plan?: boolean;
|
|
720
|
-
/**
|
|
721
|
-
* - Name of the plan
|
|
722
|
-
*/
|
|
723
|
-
name?: string;
|
|
724
|
-
/**
|
|
725
|
-
* - Description of the plan
|
|
726
|
-
*/
|
|
727
|
-
description?: string;
|
|
728
|
-
/**
|
|
729
|
-
* - Group to which plan belongs
|
|
730
|
-
*/
|
|
731
|
-
plan_group?: string;
|
|
732
|
-
/**
|
|
733
|
-
* - Group id to which plan belongs
|
|
734
|
-
*/
|
|
735
|
-
plan_group_id?: string;
|
|
736
|
-
/**
|
|
737
|
-
* - Tag lines associated with the plan
|
|
738
|
-
*/
|
|
739
|
-
tag_lines?: string[];
|
|
740
|
-
/**
|
|
741
|
-
* - Currency of the plan
|
|
742
|
-
*/
|
|
743
|
-
currency?: string;
|
|
744
|
-
/**
|
|
745
|
-
* - Amount of the plan
|
|
746
|
-
*/
|
|
747
|
-
amount?: number;
|
|
748
|
-
/**
|
|
749
|
-
* - Indicates whether the plan is active
|
|
750
|
-
*/
|
|
751
|
-
is_active?: boolean;
|
|
752
|
-
/**
|
|
753
|
-
* - Indicates whether the plan is visible on ui
|
|
754
|
-
*/
|
|
755
|
-
is_visible?: boolean;
|
|
756
|
-
/**
|
|
757
|
-
* - Trial period of the plan in days
|
|
758
|
-
*/
|
|
759
|
-
trial_period?: number;
|
|
760
|
-
/**
|
|
761
|
-
* - Addons associated with the plan
|
|
762
|
-
*/
|
|
763
|
-
addons?: any[];
|
|
764
|
-
/**
|
|
765
|
-
* - Tags associated with the plan
|
|
766
|
-
*/
|
|
767
|
-
tags?: string[];
|
|
768
|
-
/**
|
|
769
|
-
* - Type of the plan (enterprise or standard)
|
|
770
|
-
*/
|
|
771
|
-
type?: string;
|
|
772
|
-
/**
|
|
773
|
-
* - Additional metadata associated with the plan
|
|
774
|
-
*/
|
|
775
|
-
meta?: any;
|
|
776
|
-
country?: CountryRes;
|
|
777
|
-
/**
|
|
778
|
-
* - Company IDs associated with the plan
|
|
779
|
-
*/
|
|
780
|
-
company_ids?: string[];
|
|
781
|
-
/**
|
|
782
|
-
* - ID of the user who created the plan
|
|
783
|
-
*/
|
|
784
|
-
created_by?: string;
|
|
785
|
-
/**
|
|
786
|
-
* - Current status of the plan (active, inactive)
|
|
787
|
-
*/
|
|
788
|
-
current_status?: string;
|
|
789
|
-
/**
|
|
790
|
-
* - Ordering channel for which plan is
|
|
791
|
-
* created(fynd, ecomm, uniket etc)
|
|
792
|
-
*/
|
|
793
|
-
channel_type?: string;
|
|
794
|
-
/**
|
|
795
|
-
* - Platform associated with the plan (web, mobile, all)
|
|
796
|
-
*/
|
|
797
|
-
platform?: string;
|
|
798
|
-
/**
|
|
799
|
-
* - Date and time when the plan was created
|
|
800
|
-
*/
|
|
801
|
-
created_at?: string;
|
|
802
|
-
/**
|
|
803
|
-
* - Date and time when the plan was last modified
|
|
804
|
-
*/
|
|
805
|
-
modified_at?: string;
|
|
806
|
-
};
|
|
807
|
-
/** @returns {TrialPlanDetails} */
|
|
808
|
-
declare function TrialPlanDetails(): TrialPlanDetails;
|
|
809
|
-
type TrialPlanDetails = {
|
|
810
|
-
/**
|
|
811
|
-
* - ID of the user who activated the trial plan
|
|
812
|
-
*/
|
|
813
|
-
activated_by?: string;
|
|
814
|
-
/**
|
|
815
|
-
* - ID of the user who updated the trial plan
|
|
816
|
-
*/
|
|
817
|
-
updated_by?: string;
|
|
818
|
-
recurring?: PlanRecurring;
|
|
819
|
-
/**
|
|
820
|
-
* - Indicates whether the plan is a trial plan
|
|
821
|
-
*/
|
|
822
|
-
is_trial_plan?: boolean;
|
|
823
|
-
/**
|
|
824
|
-
* - Company IDs associated with the trial plan
|
|
825
|
-
*/
|
|
826
|
-
company_ids?: string[];
|
|
827
|
-
/**
|
|
828
|
-
* - ID of the user who created the trial plan
|
|
829
|
-
*/
|
|
830
|
-
created_by?: string;
|
|
831
|
-
/**
|
|
832
|
-
* - Ordering channel for which plan is
|
|
833
|
-
* created(ecomm, fynd etc)
|
|
834
|
-
*/
|
|
835
|
-
channel_type?: string;
|
|
836
|
-
/**
|
|
837
|
-
* - Platform associated with the trial plan(web ,
|
|
838
|
-
* mobile, all)
|
|
839
|
-
*/
|
|
840
|
-
platform?: string;
|
|
841
|
-
/**
|
|
842
|
-
* - Group to which the trial plan belongs
|
|
843
|
-
*/
|
|
844
|
-
plan_group?: string;
|
|
845
|
-
/**
|
|
846
|
-
* - Tag lines associated with the trial plan
|
|
847
|
-
*/
|
|
848
|
-
tag_lines?: string[];
|
|
849
|
-
/**
|
|
850
|
-
* - Currency of the trial plan
|
|
851
|
-
*/
|
|
852
|
-
currency?: string;
|
|
853
|
-
/**
|
|
854
|
-
* - Indicates whether the trial plan is active
|
|
855
|
-
*/
|
|
856
|
-
is_active?: boolean;
|
|
857
|
-
/**
|
|
858
|
-
* - Indicates whether the trial plan is visible on ui
|
|
859
|
-
*/
|
|
860
|
-
is_visible?: boolean;
|
|
861
|
-
/**
|
|
862
|
-
* - Trial period of the trial plan in days
|
|
863
|
-
*/
|
|
864
|
-
trial_period?: number;
|
|
865
|
-
/**
|
|
866
|
-
* - Addons associated with the trial plan
|
|
867
|
-
*/
|
|
868
|
-
addons?: string[];
|
|
869
|
-
/**
|
|
870
|
-
* - Tags associated with the trial plan
|
|
871
|
-
*/
|
|
872
|
-
tags?: string[];
|
|
873
|
-
/**
|
|
874
|
-
* - Type of the trial plan(public, company_specific)
|
|
875
|
-
*/
|
|
876
|
-
type?: string;
|
|
877
|
-
country?: CountryRes;
|
|
878
|
-
/**
|
|
879
|
-
* - Unique identifier for the trial plan
|
|
880
|
-
*/
|
|
881
|
-
_id?: string;
|
|
882
|
-
/**
|
|
883
|
-
* - Name of the trial plan
|
|
884
|
-
*/
|
|
885
|
-
name?: string;
|
|
886
|
-
/**
|
|
887
|
-
* - Description of the trial plan
|
|
888
|
-
*/
|
|
889
|
-
description?: string;
|
|
890
|
-
/**
|
|
891
|
-
* - Amount of the trial plan
|
|
892
|
-
*/
|
|
893
|
-
amount?: number;
|
|
894
|
-
/**
|
|
895
|
-
* - Identifier of the product suite
|
|
896
|
-
* associated with the trial plan
|
|
897
|
-
*/
|
|
898
|
-
product_suite_id?: string;
|
|
899
|
-
/**
|
|
900
|
-
* - Creation date of the trial plan
|
|
901
|
-
*/
|
|
902
|
-
created_at?: string;
|
|
903
|
-
/**
|
|
904
|
-
* - Modification date of the trial plan
|
|
905
|
-
*/
|
|
906
|
-
modified_at?: string;
|
|
907
|
-
taxation?: PlanTaxation;
|
|
908
|
-
one_time_fees?: OneTimeFees;
|
|
909
|
-
credit_line?: CreditLine;
|
|
910
|
-
/**
|
|
911
|
-
* - Current status of the trial plan
|
|
912
|
-
*/
|
|
913
|
-
current_status?: string;
|
|
914
|
-
meta?: PlanMeta;
|
|
915
|
-
/**
|
|
916
|
-
* - Components associated with the trial plan
|
|
917
|
-
*/
|
|
918
|
-
components?: ComponentsSchema[];
|
|
919
|
-
};
|