@tapsilat/tapsilat-js 1.0.2 → 1.0.4
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/CHANGELOG.md +14 -0
- package/README.md +6 -12
- package/dist/TapsilatSDK.d.ts +202 -173
- package/dist/TapsilatSDK.d.ts.map +1 -1
- package/dist/config/ConfigManager.d.ts +77 -0
- package/dist/config/ConfigManager.d.ts.map +1 -0
- package/dist/errors/TapsilatError.d.ts +84 -1
- package/dist/errors/TapsilatError.d.ts.map +1 -1
- package/dist/http/HttpClient.d.ts +126 -27
- package/dist/http/HttpClient.d.ts.map +1 -1
- package/dist/http/interceptors.d.ts +117 -1
- package/dist/http/interceptors.d.ts.map +1 -1
- package/dist/index.d.ts +880 -228
- package/dist/index.d.ts.map +1 -1
- package/dist/index.esm.js +948 -294
- package/dist/index.esm.js.map +1 -1
- package/dist/index.js +948 -293
- package/dist/index.js.map +1 -1
- package/dist/types/index.d.ts +545 -10
- package/dist/types/index.d.ts.map +1 -1
- package/dist/utils/index.d.ts +47 -0
- package/dist/utils/index.d.ts.map +1 -0
- package/dist/utils/validators.d.ts +74 -1
- package/dist/utils/validators.d.ts.map +1 -1
- package/package.json +2 -2
- package/dist/types.d.ts +0 -401
- package/dist/types.d.ts.map +0 -1
package/dist/types/index.d.ts
CHANGED
|
@@ -1,13 +1,49 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @module Types
|
|
3
|
+
* @description Tapsilat SDK type definitions, interfaces, and API data structures
|
|
4
|
+
*/
|
|
5
|
+
/**
|
|
6
|
+
* @category Configuration
|
|
7
|
+
* @summary Core configuration options for the Tapsilat SDK
|
|
8
|
+
* @description Defines the settings used to initialize and configure SDK behavior including API connection parameters and retry logic
|
|
9
|
+
* @interface TapsilatConfig
|
|
10
|
+
*/
|
|
1
11
|
export interface TapsilatConfig {
|
|
2
|
-
|
|
3
|
-
apiKey: string;
|
|
12
|
+
bearerToken: string;
|
|
4
13
|
baseURL?: string;
|
|
5
14
|
timeout?: number;
|
|
6
|
-
|
|
15
|
+
maxRetries?: number;
|
|
16
|
+
retryDelay?: number;
|
|
17
|
+
version?: string;
|
|
18
|
+
debug?: boolean;
|
|
7
19
|
}
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
20
|
+
/**
|
|
21
|
+
* @category Payment Processing
|
|
22
|
+
* @summary Supported payment method types in the Tapsilat system
|
|
23
|
+
* @description Defines all available payment options that customers can use during checkout
|
|
24
|
+
* @typedef {string} PaymentMethod
|
|
25
|
+
*/
|
|
26
|
+
export type PaymentMethod = "credit_card" | "debit_card" | "bank_transfer" | "digital_wallet" | "crypto";
|
|
27
|
+
/**
|
|
28
|
+
* @category Payment Processing
|
|
29
|
+
* @summary Possible states of a payment throughout its lifecycle
|
|
30
|
+
* @description Defines all states a payment can be in from creation to completion or failure
|
|
31
|
+
* @typedef {string} PaymentStatus
|
|
32
|
+
*/
|
|
33
|
+
export type PaymentStatus = "pending" | "processing" | "completed" | "failed" | "cancelled" | "refunded";
|
|
34
|
+
/**
|
|
35
|
+
* @category Payment Processing
|
|
36
|
+
* @summary Supported currency codes for transactions
|
|
37
|
+
* @description ISO currency codes supported by the payment processing system
|
|
38
|
+
* @typedef {string} Currency
|
|
39
|
+
*/
|
|
40
|
+
export type Currency = "TRY" | "USD" | "EUR" | "GBP";
|
|
41
|
+
/**
|
|
42
|
+
* @category Payment Processing
|
|
43
|
+
* @summary Data required to initiate a payment transaction
|
|
44
|
+
* @description Contains required and optional fields for creating a new payment request including amount, currency, and payment method
|
|
45
|
+
* @interface PaymentRequest
|
|
46
|
+
*/
|
|
11
47
|
export interface PaymentRequest {
|
|
12
48
|
amount: number;
|
|
13
49
|
currency: Currency;
|
|
@@ -18,6 +54,12 @@ export interface PaymentRequest {
|
|
|
18
54
|
webhookUrl?: string;
|
|
19
55
|
customerId?: string;
|
|
20
56
|
}
|
|
57
|
+
/**
|
|
58
|
+
* @category Payment Processing
|
|
59
|
+
* @summary Data returned after processing a payment request
|
|
60
|
+
* @description Contains payment details, status, transaction identifiers, timestamps, and payment URLs
|
|
61
|
+
* @interface PaymentResponse
|
|
62
|
+
*/
|
|
21
63
|
export interface PaymentResponse {
|
|
22
64
|
id: string;
|
|
23
65
|
status: PaymentStatus;
|
|
@@ -32,6 +74,12 @@ export interface PaymentResponse {
|
|
|
32
74
|
transactionId?: string;
|
|
33
75
|
errorMessage?: string;
|
|
34
76
|
}
|
|
77
|
+
/**
|
|
78
|
+
* @category Customer Data
|
|
79
|
+
* @summary Customer identification and contact details
|
|
80
|
+
* @description Essential information about a customer for payment processing, KYC, and communications
|
|
81
|
+
* @interface Customer
|
|
82
|
+
*/
|
|
35
83
|
export interface Customer {
|
|
36
84
|
id?: string;
|
|
37
85
|
email: string;
|
|
@@ -39,6 +87,12 @@ export interface Customer {
|
|
|
39
87
|
phone?: string;
|
|
40
88
|
address?: Address;
|
|
41
89
|
}
|
|
90
|
+
/**
|
|
91
|
+
* @category Customer Data
|
|
92
|
+
* @summary Physical address structure for shipping and billing
|
|
93
|
+
* @description Standardized address format for customer locations with required and optional fields
|
|
94
|
+
* @interface Address
|
|
95
|
+
*/
|
|
42
96
|
export interface Address {
|
|
43
97
|
street: string;
|
|
44
98
|
city: string;
|
|
@@ -46,41 +100,89 @@ export interface Address {
|
|
|
46
100
|
postalCode: string;
|
|
47
101
|
country: string;
|
|
48
102
|
}
|
|
103
|
+
/**
|
|
104
|
+
* @category Refunds
|
|
105
|
+
* @summary Information needed to process a refund
|
|
106
|
+
* @description Data required to initiate full or partial refunds for completed payments
|
|
107
|
+
* @interface RefundRequest
|
|
108
|
+
*/
|
|
49
109
|
export interface RefundRequest {
|
|
50
110
|
paymentId: string;
|
|
51
111
|
amount?: number;
|
|
52
112
|
reason?: string;
|
|
53
113
|
}
|
|
114
|
+
/**
|
|
115
|
+
* @category Refunds
|
|
116
|
+
* @summary Data returned after processing a refund request
|
|
117
|
+
* @description Contains refund details, status, amount, and related transaction identifiers
|
|
118
|
+
* @interface RefundResponse
|
|
119
|
+
*/
|
|
54
120
|
export interface RefundResponse {
|
|
55
121
|
id: string;
|
|
56
122
|
paymentId: string;
|
|
57
123
|
amount: number;
|
|
58
|
-
status:
|
|
124
|
+
status: "pending" | "completed" | "failed";
|
|
59
125
|
reason?: string;
|
|
60
126
|
createdAt: string;
|
|
61
127
|
}
|
|
128
|
+
/**
|
|
129
|
+
* @category Webhooks
|
|
130
|
+
* @summary Notification data structure for system events
|
|
131
|
+
* @description Event payload sent to webhook endpoints when important events occur in the payment lifecycle
|
|
132
|
+
* @interface WebhookEvent
|
|
133
|
+
*/
|
|
62
134
|
export interface WebhookEvent {
|
|
63
135
|
id: string;
|
|
64
|
-
type:
|
|
136
|
+
type: "payment.completed" | "payment.failed" | "refund.completed";
|
|
65
137
|
data: PaymentResponse | RefundResponse;
|
|
66
138
|
createdAt: string;
|
|
67
139
|
}
|
|
140
|
+
/**
|
|
141
|
+
* @category Error Handling
|
|
142
|
+
* @summary Standardized error format returned by the API
|
|
143
|
+
* @description Structured error information with code, message and optional additional details
|
|
144
|
+
* @interface APIError
|
|
145
|
+
*/
|
|
68
146
|
export interface APIError {
|
|
69
147
|
code: string;
|
|
70
148
|
message: string;
|
|
71
149
|
details?: Record<string, any>;
|
|
72
150
|
}
|
|
151
|
+
/**
|
|
152
|
+
* @category HTTP
|
|
153
|
+
* @summary Generic API response wrapper for all endpoints
|
|
154
|
+
* @description Standard structure containing success status, data payload, and error information
|
|
155
|
+
* @interface APIResponse
|
|
156
|
+
*/
|
|
73
157
|
export interface APIResponse<T> {
|
|
74
158
|
success: boolean;
|
|
75
159
|
data?: T;
|
|
76
|
-
error?:
|
|
160
|
+
error?: {
|
|
161
|
+
message: string;
|
|
162
|
+
code: string;
|
|
163
|
+
details?: any;
|
|
164
|
+
};
|
|
165
|
+
status?: number;
|
|
166
|
+
headers?: Record<string, string>;
|
|
77
167
|
}
|
|
168
|
+
/**
|
|
169
|
+
* @category HTTP
|
|
170
|
+
* @summary Query parameters for paginated API requests
|
|
171
|
+
* @description Controls paging behavior and sorting of list results with page numbers, limits, and sorting options
|
|
172
|
+
* @interface PaginationParams
|
|
173
|
+
*/
|
|
78
174
|
export interface PaginationParams {
|
|
79
175
|
page?: number;
|
|
80
176
|
limit?: number;
|
|
81
177
|
sortBy?: string;
|
|
82
|
-
sortOrder?:
|
|
178
|
+
sortOrder?: "asc" | "desc";
|
|
83
179
|
}
|
|
180
|
+
/**
|
|
181
|
+
* @category HTTP
|
|
182
|
+
* @summary Standardized response format for paginated list operations
|
|
183
|
+
* @description Contains both the requested data items and pagination metadata for navigation
|
|
184
|
+
* @interface PaginatedResponse
|
|
185
|
+
*/
|
|
84
186
|
export interface PaginatedResponse<T> {
|
|
85
187
|
data: T[];
|
|
86
188
|
pagination: {
|
|
@@ -90,4 +192,437 @@ export interface PaginatedResponse<T> {
|
|
|
90
192
|
pages: number;
|
|
91
193
|
};
|
|
92
194
|
}
|
|
195
|
+
/**
|
|
196
|
+
* @category Localization
|
|
197
|
+
* @summary Supported language codes for the API interface
|
|
198
|
+
* @description Language preferences that determine text content in API responses and UI elements
|
|
199
|
+
* @typedef {string} Locale
|
|
200
|
+
*/
|
|
201
|
+
export type Locale = "tr" | "en";
|
|
202
|
+
/**
|
|
203
|
+
* @category Order Management
|
|
204
|
+
* @summary Customer details required for order processing
|
|
205
|
+
* @description Comprehensive identification and contact information about the buyer including name, contact details, and addresses
|
|
206
|
+
* @interface Buyer
|
|
207
|
+
*/
|
|
208
|
+
export interface Buyer {
|
|
209
|
+
name: string;
|
|
210
|
+
surname: string;
|
|
211
|
+
email: string;
|
|
212
|
+
phone?: string;
|
|
213
|
+
identityNumber?: string;
|
|
214
|
+
shippingAddress?: Address;
|
|
215
|
+
billingAddress?: Address;
|
|
216
|
+
}
|
|
217
|
+
/**
|
|
218
|
+
* @category Order Management
|
|
219
|
+
* @summary Data structure for creating a new payment order
|
|
220
|
+
* @description Contains all required and optional fields to initiate an order including amount, currency, customer information, and callback URLs
|
|
221
|
+
* @interface OrderCreateRequest
|
|
222
|
+
*/
|
|
223
|
+
export interface OrderCreateRequest {
|
|
224
|
+
amount: number;
|
|
225
|
+
currency: Currency;
|
|
226
|
+
locale: Locale;
|
|
227
|
+
buyer: Buyer;
|
|
228
|
+
description?: string;
|
|
229
|
+
callbackUrl?: string;
|
|
230
|
+
conversationId?: string;
|
|
231
|
+
metadata?: Record<string, unknown>;
|
|
232
|
+
}
|
|
233
|
+
/**
|
|
234
|
+
* @category Order Management
|
|
235
|
+
* @summary Data returned after successful order creation
|
|
236
|
+
* @description Contains order identifiers, tracking references, checkout URLs, and status information
|
|
237
|
+
* @interface OrderCreateResponse
|
|
238
|
+
*/
|
|
239
|
+
export interface OrderCreateResponse {
|
|
240
|
+
referenceId: string;
|
|
241
|
+
conversationId: string;
|
|
242
|
+
checkoutUrl: string;
|
|
243
|
+
status: string;
|
|
244
|
+
qrCodeUrl?: string;
|
|
245
|
+
}
|
|
246
|
+
/**
|
|
247
|
+
* @category Order Management
|
|
248
|
+
* @summary Complete order information including buyer, payment, and status details
|
|
249
|
+
* @description Contains all information related to an order including creation and update timestamps
|
|
250
|
+
* @interface Order
|
|
251
|
+
*/
|
|
252
|
+
export interface Order extends OrderCreateResponse {
|
|
253
|
+
amount: number | string;
|
|
254
|
+
currency: Currency;
|
|
255
|
+
buyer?: Buyer;
|
|
256
|
+
description?: string;
|
|
257
|
+
createdAt?: string;
|
|
258
|
+
updatedAt?: string;
|
|
259
|
+
metadata?: Record<string, unknown>;
|
|
260
|
+
id?: string;
|
|
261
|
+
name?: string;
|
|
262
|
+
email?: string;
|
|
263
|
+
total?: string;
|
|
264
|
+
checkout_url?: string;
|
|
265
|
+
organization?: string;
|
|
266
|
+
unpaid_amount?: number;
|
|
267
|
+
}
|
|
268
|
+
/**
|
|
269
|
+
* @category Refunds
|
|
270
|
+
* @summary Refund request information for an order
|
|
271
|
+
* @description Contains the data needed to process a refund for a specific order
|
|
272
|
+
* @interface OrderRefundRequest
|
|
273
|
+
*/
|
|
274
|
+
export interface OrderRefundRequest {
|
|
275
|
+
reference_id: string;
|
|
276
|
+
amount: number;
|
|
277
|
+
}
|
|
278
|
+
/**
|
|
279
|
+
* @category Refunds
|
|
280
|
+
* @summary Response data after processing a refund request
|
|
281
|
+
* @description Contains information about the processed refund including status and amount
|
|
282
|
+
* @interface OrderRefundResponse
|
|
283
|
+
*/
|
|
284
|
+
export interface OrderRefundResponse {
|
|
285
|
+
refundId: string;
|
|
286
|
+
referenceId: string;
|
|
287
|
+
status: string;
|
|
288
|
+
amount: number;
|
|
289
|
+
currency: Currency;
|
|
290
|
+
createdAt: string;
|
|
291
|
+
}
|
|
292
|
+
/**
|
|
293
|
+
* @category Order Management
|
|
294
|
+
* @summary Order status information
|
|
295
|
+
* @description Provides the current status of an order and when it was last updated
|
|
296
|
+
* @interface OrderStatusResponse
|
|
297
|
+
*/
|
|
298
|
+
export interface OrderStatusResponse {
|
|
299
|
+
referenceId: string;
|
|
300
|
+
status: string;
|
|
301
|
+
lastUpdatedAt: string;
|
|
302
|
+
}
|
|
303
|
+
/**
|
|
304
|
+
* @category Payment Processing
|
|
305
|
+
* @summary Payment transaction details
|
|
306
|
+
* @description Contains information about a payment transaction including method, amount, and card details
|
|
307
|
+
* @interface OrderPaymentDetail
|
|
308
|
+
*/
|
|
309
|
+
export interface OrderPaymentDetail {
|
|
310
|
+
transactionId: string;
|
|
311
|
+
paymentMethod: string;
|
|
312
|
+
amount: number;
|
|
313
|
+
currency: Currency;
|
|
314
|
+
status: string;
|
|
315
|
+
paidAt: string;
|
|
316
|
+
cardInfo?: {
|
|
317
|
+
binNumber: string;
|
|
318
|
+
lastFourDigits: string;
|
|
319
|
+
cardAssociation: string;
|
|
320
|
+
};
|
|
321
|
+
}
|
|
322
|
+
/**
|
|
323
|
+
* @category API DTOs
|
|
324
|
+
* @summary API representation of buyer information
|
|
325
|
+
* @description Contains buyer details as formatted in the API responses
|
|
326
|
+
* @interface BuyerDTO
|
|
327
|
+
*/
|
|
328
|
+
export interface BuyerDTO {
|
|
329
|
+
name: string;
|
|
330
|
+
surname: string;
|
|
331
|
+
birth_date?: string;
|
|
332
|
+
city?: string;
|
|
333
|
+
country?: string;
|
|
334
|
+
email?: string;
|
|
335
|
+
gsm_number?: string;
|
|
336
|
+
id?: string;
|
|
337
|
+
identity_number?: string;
|
|
338
|
+
ip?: string;
|
|
339
|
+
last_login_date?: string;
|
|
340
|
+
registration_address?: string;
|
|
341
|
+
registration_date?: string;
|
|
342
|
+
title?: string;
|
|
343
|
+
zip_code?: string;
|
|
344
|
+
}
|
|
345
|
+
/**
|
|
346
|
+
* @category API DTOs
|
|
347
|
+
* @summary Payment responsibility information for basket items
|
|
348
|
+
* @description Details of the entity responsible for paying a specific basket item
|
|
349
|
+
* @interface BasketItemPayerDTO
|
|
350
|
+
*/
|
|
351
|
+
export interface BasketItemPayerDTO {
|
|
352
|
+
address?: string;
|
|
353
|
+
reference_id?: string;
|
|
354
|
+
tax_office?: string;
|
|
355
|
+
title?: string;
|
|
356
|
+
type?: string;
|
|
357
|
+
vat?: string;
|
|
358
|
+
}
|
|
359
|
+
/**
|
|
360
|
+
* @category API DTOs
|
|
361
|
+
* @summary Individual item in an order basket
|
|
362
|
+
* @description Details about a product or service being purchased including price and quantity
|
|
363
|
+
* @interface BasketItemDTO
|
|
364
|
+
*/
|
|
365
|
+
export interface BasketItemDTO {
|
|
366
|
+
category1?: string;
|
|
367
|
+
category2?: string;
|
|
368
|
+
commission_amount?: number;
|
|
369
|
+
coupon?: string;
|
|
370
|
+
coupon_discount?: number;
|
|
371
|
+
data?: string;
|
|
372
|
+
id?: string;
|
|
373
|
+
item_type?: string;
|
|
374
|
+
name?: string;
|
|
375
|
+
paid_amount?: number;
|
|
376
|
+
payer?: BasketItemPayerDTO;
|
|
377
|
+
price?: number;
|
|
378
|
+
quantity?: number;
|
|
379
|
+
quantity_float?: number;
|
|
380
|
+
quantity_unit?: string;
|
|
381
|
+
sub_merchant_key?: string;
|
|
382
|
+
sub_merchant_price?: string;
|
|
383
|
+
}
|
|
384
|
+
/**
|
|
385
|
+
* @category API DTOs
|
|
386
|
+
* @summary Address information for billing purposes
|
|
387
|
+
* @description Complete billing address information including tax details
|
|
388
|
+
* @interface BillingAddressDTO
|
|
389
|
+
*/
|
|
390
|
+
export interface BillingAddressDTO {
|
|
391
|
+
address?: string;
|
|
392
|
+
billing_type?: string;
|
|
393
|
+
citizenship?: string;
|
|
394
|
+
city?: string;
|
|
395
|
+
contact_name?: string;
|
|
396
|
+
contact_phone?: string;
|
|
397
|
+
country?: string;
|
|
398
|
+
district?: string;
|
|
399
|
+
tax_office?: string;
|
|
400
|
+
title?: string;
|
|
401
|
+
vat_number?: string;
|
|
402
|
+
zip_code?: string;
|
|
403
|
+
}
|
|
404
|
+
/**
|
|
405
|
+
* @category UI Customization
|
|
406
|
+
* @summary Customization options for the checkout page
|
|
407
|
+
* @description Visual design parameters for customizing the checkout experience
|
|
408
|
+
* @interface CheckoutDesignDTO
|
|
409
|
+
*/
|
|
410
|
+
export interface CheckoutDesignDTO {
|
|
411
|
+
input_background_color?: string;
|
|
412
|
+
input_text_color?: string;
|
|
413
|
+
label_text_color?: string;
|
|
414
|
+
left_background_color?: string;
|
|
415
|
+
logo?: string;
|
|
416
|
+
order_detail_html?: string;
|
|
417
|
+
pay_button_color?: string;
|
|
418
|
+
redirect_url?: string;
|
|
419
|
+
right_background_color?: string;
|
|
420
|
+
text_color?: string;
|
|
421
|
+
}
|
|
422
|
+
/**
|
|
423
|
+
* @category API DTOs
|
|
424
|
+
* @summary Custom metadata for orders and transactions
|
|
425
|
+
* @description Key-value pairs for storing additional information with orders
|
|
426
|
+
* @interface MetadataDTO
|
|
427
|
+
*/
|
|
428
|
+
export interface MetadataDTO {
|
|
429
|
+
key: string;
|
|
430
|
+
value: string;
|
|
431
|
+
}
|
|
432
|
+
/**
|
|
433
|
+
* @category Payment Processing
|
|
434
|
+
* @summary Card information for processing an order
|
|
435
|
+
* @description Identifies a saved card to use for payment
|
|
436
|
+
* @interface OrderCardDTO
|
|
437
|
+
*/
|
|
438
|
+
export interface OrderCardDTO {
|
|
439
|
+
card_id: string;
|
|
440
|
+
card_sequence: number;
|
|
441
|
+
}
|
|
442
|
+
/**
|
|
443
|
+
* @category Payment Processing
|
|
444
|
+
* @summary Individual payment term for an order
|
|
445
|
+
* @description Details for installment or partial payments with due dates and status
|
|
446
|
+
* @interface PaymentTermDTO
|
|
447
|
+
*/
|
|
448
|
+
export interface PaymentTermDTO {
|
|
449
|
+
amount?: number;
|
|
450
|
+
data?: string;
|
|
451
|
+
due_date?: string;
|
|
452
|
+
paid_date?: string;
|
|
453
|
+
required?: boolean;
|
|
454
|
+
status?: string;
|
|
455
|
+
term_reference_id?: string;
|
|
456
|
+
term_sequence?: number;
|
|
457
|
+
}
|
|
458
|
+
/**
|
|
459
|
+
* @category Submerchant
|
|
460
|
+
* @summary Payment facilitation submerchant details
|
|
461
|
+
* @description Information about a submerchant in a payment facilitation flow
|
|
462
|
+
* @interface OrderPFSubMerchantDTO
|
|
463
|
+
*/
|
|
464
|
+
export interface OrderPFSubMerchantDTO {
|
|
465
|
+
address?: string;
|
|
466
|
+
city?: string;
|
|
467
|
+
country?: string;
|
|
468
|
+
country_iso_code?: string;
|
|
469
|
+
id?: string;
|
|
470
|
+
mcc?: string;
|
|
471
|
+
name?: string;
|
|
472
|
+
org_id?: string;
|
|
473
|
+
postal_code?: string;
|
|
474
|
+
submerchant_nin?: string;
|
|
475
|
+
submerchant_url?: string;
|
|
476
|
+
terminal_no?: string;
|
|
477
|
+
}
|
|
478
|
+
/**
|
|
479
|
+
* @category API DTOs
|
|
480
|
+
* @summary Address information for shipping
|
|
481
|
+
* @description Complete shipping address information including tracking details
|
|
482
|
+
* @interface ShippingAddressDTO
|
|
483
|
+
*/
|
|
484
|
+
export interface ShippingAddressDTO {
|
|
485
|
+
address?: string;
|
|
486
|
+
city?: string;
|
|
487
|
+
contact_name?: string;
|
|
488
|
+
country?: string;
|
|
489
|
+
shipping_date?: string;
|
|
490
|
+
tracking_code?: string;
|
|
491
|
+
zip_code?: string;
|
|
492
|
+
}
|
|
493
|
+
/**
|
|
494
|
+
* @category Submerchant
|
|
495
|
+
* @summary Details for sub-organization relationships
|
|
496
|
+
* @description Information about a subsidiary organization for payment processing
|
|
497
|
+
* @interface SubOrganizationDTO
|
|
498
|
+
*/
|
|
499
|
+
export interface SubOrganizationDTO {
|
|
500
|
+
acquirer?: string;
|
|
501
|
+
address?: string;
|
|
502
|
+
contact_first_name?: string;
|
|
503
|
+
contact_last_name?: string;
|
|
504
|
+
currency?: string;
|
|
505
|
+
email?: string;
|
|
506
|
+
gsm_number?: string;
|
|
507
|
+
iban?: string;
|
|
508
|
+
identity_number?: string;
|
|
509
|
+
legal_company_title?: string;
|
|
510
|
+
organization_name?: string;
|
|
511
|
+
sub_merchant_external_id?: string;
|
|
512
|
+
sub_merchant_key?: string;
|
|
513
|
+
sub_merchant_type?: string;
|
|
514
|
+
tax_number?: string;
|
|
515
|
+
tax_office?: string;
|
|
516
|
+
}
|
|
517
|
+
/**
|
|
518
|
+
* @category Submerchant
|
|
519
|
+
* @summary Payment information for submerchants
|
|
520
|
+
* @description Defines how payments are split with submerchants
|
|
521
|
+
* @interface SubmerchantDTO
|
|
522
|
+
*/
|
|
523
|
+
export interface SubmerchantDTO {
|
|
524
|
+
amount?: number;
|
|
525
|
+
merchant_reference_id?: string;
|
|
526
|
+
order_basket_item_id?: string;
|
|
527
|
+
}
|
|
528
|
+
/**
|
|
529
|
+
* @category API DTOs
|
|
530
|
+
* @summary Comprehensive order creation request
|
|
531
|
+
* @description Full API request structure for creating an order with all possible options
|
|
532
|
+
* @interface OrderCreateDTO
|
|
533
|
+
*/
|
|
534
|
+
export interface OrderCreateDTO {
|
|
535
|
+
amount: number;
|
|
536
|
+
currency: string;
|
|
537
|
+
locale: string;
|
|
538
|
+
buyer: BuyerDTO;
|
|
539
|
+
basket_items?: BasketItemDTO[];
|
|
540
|
+
billing_address?: BillingAddressDTO;
|
|
541
|
+
checkout_design?: CheckoutDesignDTO;
|
|
542
|
+
conversation_id?: string;
|
|
543
|
+
enabled_installments?: number[];
|
|
544
|
+
external_reference_id?: string;
|
|
545
|
+
metadata?: MetadataDTO[];
|
|
546
|
+
order_cards?: OrderCardDTO;
|
|
547
|
+
paid_amount?: number;
|
|
548
|
+
partial_payment?: boolean;
|
|
549
|
+
payment_failure_url?: string;
|
|
550
|
+
payment_methods?: boolean;
|
|
551
|
+
payment_options?: string[];
|
|
552
|
+
payment_success_url?: string;
|
|
553
|
+
payment_terms?: PaymentTermDTO[];
|
|
554
|
+
pf_sub_merchant?: OrderPFSubMerchantDTO;
|
|
555
|
+
shipping_address?: ShippingAddressDTO;
|
|
556
|
+
sub_organization?: SubOrganizationDTO;
|
|
557
|
+
submerchants?: SubmerchantDTO[];
|
|
558
|
+
tax_amount?: number;
|
|
559
|
+
three_d_force?: boolean;
|
|
560
|
+
}
|
|
561
|
+
/**
|
|
562
|
+
* @category Refunds
|
|
563
|
+
* @summary Data structure for requesting a refund
|
|
564
|
+
* @description Contains the necessary information to process a refund for an order
|
|
565
|
+
* @interface RefundOrderDTO
|
|
566
|
+
*/
|
|
567
|
+
export interface RefundOrderDTO {
|
|
568
|
+
amount: number;
|
|
569
|
+
reference_id: string;
|
|
570
|
+
order_item_id?: string;
|
|
571
|
+
order_item_payment_id?: string;
|
|
572
|
+
}
|
|
573
|
+
/**
|
|
574
|
+
* @category Payment Terms
|
|
575
|
+
* @summary Data for creating a payment term
|
|
576
|
+
* @description Structure for creating a new payment term for an existing order
|
|
577
|
+
* @interface OrderPaymentTermCreateDTO
|
|
578
|
+
*/
|
|
579
|
+
export interface OrderPaymentTermCreateDTO {
|
|
580
|
+
order_id: string;
|
|
581
|
+
term_reference_id: string;
|
|
582
|
+
amount: number;
|
|
583
|
+
due_date: string;
|
|
584
|
+
term_sequence: number;
|
|
585
|
+
required: boolean;
|
|
586
|
+
status: string;
|
|
587
|
+
data?: string;
|
|
588
|
+
paid_date?: string;
|
|
589
|
+
}
|
|
590
|
+
/**
|
|
591
|
+
* @category Payment Terms
|
|
592
|
+
* @summary Data for updating a payment term
|
|
593
|
+
* @description Structure for updating an existing payment term
|
|
594
|
+
* @interface OrderPaymentTermUpdateDTO
|
|
595
|
+
*/
|
|
596
|
+
export interface OrderPaymentTermUpdateDTO {
|
|
597
|
+
term_reference_id: string;
|
|
598
|
+
amount?: number;
|
|
599
|
+
due_date?: string;
|
|
600
|
+
paid_date?: string;
|
|
601
|
+
required?: boolean;
|
|
602
|
+
status?: string;
|
|
603
|
+
term_sequence?: number;
|
|
604
|
+
}
|
|
605
|
+
/**
|
|
606
|
+
* @category Refunds
|
|
607
|
+
* @summary Request to refund a specific payment term
|
|
608
|
+
* @description Data required to process a refund for a specific payment term
|
|
609
|
+
* @interface OrderTermRefundRequest
|
|
610
|
+
*/
|
|
611
|
+
export interface OrderTermRefundRequest {
|
|
612
|
+
term_id: string;
|
|
613
|
+
amount: number;
|
|
614
|
+
reference_id?: string;
|
|
615
|
+
term_payment_id?: string;
|
|
616
|
+
}
|
|
617
|
+
/**
|
|
618
|
+
* @category Order Management
|
|
619
|
+
* @summary Basic order creation response
|
|
620
|
+
* @description Minimal response information after order creation
|
|
621
|
+
* @interface OrderResponse
|
|
622
|
+
*/
|
|
623
|
+
export interface OrderResponse {
|
|
624
|
+
reference_id: string;
|
|
625
|
+
checkout_url: string;
|
|
626
|
+
order_id?: string;
|
|
627
|
+
}
|
|
93
628
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AACA,MAAM,WAAW,cAAc;IAC7B,UAAU,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAGD,MAAM,MAAM,aAAa,GACrB,aAAa,GACb,YAAY,GACZ,eAAe,GACf,gBAAgB,GAChB,QAAQ,CAAC;AAGb,MAAM,MAAM,aAAa,GACrB,SAAS,GACT,YAAY,GACZ,WAAW,GACX,QAAQ,GACR,WAAW,GACX,UAAU,CAAC;AAGf,MAAM,MAAM,QAAQ,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAC;AAGrD,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,QAAQ,CAAC;IACnB,aAAa,EAAE,aAAa,CAAC;IAC7B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC/B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAGD,MAAM,WAAW,eAAe;IAC9B,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,aAAa,CAAC;IACtB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,QAAQ,CAAC;IACnB,aAAa,EAAE,aAAa,CAAC;IAC7B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC/B,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAGD,MAAM,WAAW,QAAQ;IACvB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAGD,MAAM,WAAW,OAAO;IACtB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;CACjB;AAGD,MAAM,WAAW,aAAa;IAC5B,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAGD,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,SAAS,GAAG,WAAW,GAAG,QAAQ,CAAC;IAC3C,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;CACnB;AAGD,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,mBAAmB,GAAG,gBAAgB,GAAG,kBAAkB,CAAC;IAClE,IAAI,EAAE,eAAe,GAAG,cAAc,CAAC;IACvC,SAAS,EAAE,MAAM,CAAC;CACnB;AAGD,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC/B;AAGD,MAAM,WAAW,WAAW,CAAC,CAAC;IAC5B,OAAO,EAAE,OAAO,CAAC;IACjB,IAAI,CAAC,EAAE,CAAC,CAAC;IACT,KAAK,CAAC,EAAE,QAAQ,CAAC;CAClB;AAGD,MAAM,WAAW,gBAAgB;IAC/B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,iBAAiB,CAAC,CAAC;IAClC,IAAI,EAAE,CAAC,EAAE,CAAC;IACV,UAAU,EAAE;QACV,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,CAAC;QACd,KAAK,EAAE,MAAM,CAAC;QACd,KAAK,EAAE,MAAM,CAAC;KACf,CAAC;CACH"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAKH;;;;;GAKG;AACH,MAAM,WAAW,cAAc;IAC7B,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAKD;;;;;GAKG;AACH,MAAM,MAAM,aAAa,GACrB,aAAa,GACb,YAAY,GACZ,eAAe,GACf,gBAAgB,GAChB,QAAQ,CAAC;AAKb;;;;;GAKG;AACH,MAAM,MAAM,aAAa,GACrB,SAAS,GACT,YAAY,GACZ,WAAW,GACX,QAAQ,GACR,WAAW,GACX,UAAU,CAAC;AAKf;;;;;GAKG;AACH,MAAM,MAAM,QAAQ,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,KAAK,CAAC;AAKrD;;;;;GAKG;AACH,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,QAAQ,CAAC;IACnB,aAAa,EAAE,aAAa,CAAC;IAC7B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC/B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAKD;;;;;GAKG;AACH,MAAM,WAAW,eAAe;IAC9B,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,aAAa,CAAC;IACtB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,QAAQ,CAAC;IACnB,aAAa,EAAE,aAAa,CAAC;IAC7B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC/B,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAKD;;;;;GAKG;AACH,MAAM,WAAW,QAAQ;IACvB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAKD;;;;;GAKG;AACH,MAAM,WAAW,OAAO;IACtB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;CACjB;AAKD;;;;;GAKG;AACH,MAAM,WAAW,aAAa;IAC5B,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAKD;;;;;GAKG;AACH,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,SAAS,GAAG,WAAW,GAAG,QAAQ,CAAC;IAC3C,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;CACnB;AAKD;;;;;GAKG;AACH,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,mBAAmB,GAAG,gBAAgB,GAAG,kBAAkB,CAAC;IAClE,IAAI,EAAE,eAAe,GAAG,cAAc,CAAC;IACvC,SAAS,EAAE,MAAM,CAAC;CACnB;AAKD;;;;;GAKG;AACH,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC/B;AAKD;;;;;GAKG;AACH,MAAM,WAAW,WAAW,CAAC,CAAC;IAC5B,OAAO,EAAE,OAAO,CAAC;IACjB,IAAI,CAAC,EAAE,CAAC,CAAC;IACT,KAAK,CAAC,EAAE;QACN,OAAO,EAAE,MAAM,CAAC;QAChB,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,CAAC,EAAE,GAAG,CAAC;KACf,CAAC;IACF,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAClC;AAKD;;;;;GAKG;AACH,MAAM,WAAW,gBAAgB;IAC/B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;CAC5B;AAKD;;;;;GAKG;AACH,MAAM,WAAW,iBAAiB,CAAC,CAAC;IAClC,IAAI,EAAE,CAAC,EAAE,CAAC;IACV,UAAU,EAAE;QACV,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,CAAC;QACd,KAAK,EAAE,MAAM,CAAC;QACd,KAAK,EAAE,MAAM,CAAC;KACf,CAAC;CACH;AAOD;;;;;GAKG;AACH,MAAM,MAAM,MAAM,GAAG,IAAI,GAAG,IAAI,CAAC;AAKjC;;;;;GAKG;AACH,MAAM,WAAW,KAAK;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B;AAKD;;;;;GAKG;AACH,MAAM,WAAW,kBAAkB;IACjC,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,QAAQ,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,KAAK,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC;AAKD;;;;;GAKG;AACH,MAAM,WAAW,mBAAmB;IAClC,WAAW,EAAE,MAAM,CAAC;IACpB,cAAc,EAAE,MAAM,CAAC;IACvB,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;;GAKG;AACH,MAAM,WAAW,KAAM,SAAQ,mBAAmB;IAChD,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC;IACxB,QAAQ,EAAE,QAAQ,CAAC;IACnB,KAAK,CAAC,EAAE,KAAK,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEnC,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;;;;GAKG;AACH,MAAM,WAAW,kBAAkB;IACjC,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;CAEhB;AAED;;;;;GAKG;AACH,MAAM,WAAW,mBAAmB;IAClC,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,QAAQ,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;;;;GAKG;AACH,MAAM,WAAW,mBAAmB;IAClC,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,aAAa,EAAE,MAAM,CAAC;CACvB;AAED;;;;;GAKG;AACH,MAAM,WAAW,kBAAkB;IACjC,aAAa,EAAE,MAAM,CAAC;IACtB,aAAa,EAAE,MAAM,CAAC;IACtB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,QAAQ,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE;QACT,SAAS,EAAE,MAAM,CAAC;QAClB,cAAc,EAAE,MAAM,CAAC;QACvB,eAAe,EAAE,MAAM,CAAC;KACzB,CAAC;CACH;AAED;;;;;GAKG;AACH,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;;;GAKG;AACH,MAAM,WAAW,kBAAkB;IACjC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED;;;;;GAKG;AACH,MAAM,WAAW,aAAa;IAC5B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,kBAAkB,CAAC;IAC3B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED;;;;;GAKG;AACH,MAAM,WAAW,iBAAiB;IAChC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;;;GAKG;AACH,MAAM,WAAW,iBAAiB;IAChC,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;;;GAKG;AACH,MAAM,WAAW,WAAW;IAC1B,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;;GAKG;AACH,MAAM,WAAW,YAAY;IAC3B,OAAO,EAAE,MAAM,CAAC;IAChB,aAAa,EAAE,MAAM,CAAC;CACvB;AAED;;;;;GAKG;AACH,MAAM,WAAW,cAAc;IAC7B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;;;;GAKG;AACH,MAAM,WAAW,qBAAqB;IACpC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;;GAKG;AACH,MAAM,WAAW,kBAAkB;IACjC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;;;GAKG;AACH,MAAM,WAAW,kBAAkB;IACjC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAClC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;;;GAKG;AACH,MAAM,WAAW,cAAc;IAC7B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED;;;;;GAKG;AACH,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,QAAQ,CAAC;IAChB,YAAY,CAAC,EAAE,aAAa,EAAE,CAAC;IAC/B,eAAe,CAAC,EAAE,iBAAiB,CAAC;IACpC,eAAe,CAAC,EAAE,iBAAiB,CAAC;IACpC,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC;IAChC,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,QAAQ,CAAC,EAAE,WAAW,EAAE,CAAC;IACzB,WAAW,CAAC,EAAE,YAAY,CAAC;IAC3B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAC3B,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,aAAa,CAAC,EAAE,cAAc,EAAE,CAAC;IACjC,eAAe,CAAC,EAAE,qBAAqB,CAAC;IACxC,gBAAgB,CAAC,EAAE,kBAAkB,CAAC;IACtC,gBAAgB,CAAC,EAAE,kBAAkB,CAAC;IACtC,YAAY,CAAC,EAAE,cAAc,EAAE,CAAC;IAChC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED;;;;;GAKG;AACH,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,EAAE,MAAM,CAAC;IACrB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC;AAED;;;;;GAKG;AACH,MAAM,WAAW,yBAAyB;IACxC,QAAQ,EAAE,MAAM,CAAC;IACjB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa,EAAE,MAAM,CAAC;IACtB,QAAQ,EAAE,OAAO,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;;GAKG;AACH,MAAM,WAAW,yBAAyB;IACxC,iBAAiB,EAAE,MAAM,CAAC;IAC1B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;;;;GAKG;AACH,MAAM,WAAW,sBAAsB;IACrC,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED;;;;;GAKG;AACH,MAAM,WAAW,aAAa;IAC5B,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB"}
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
import { APIResponse } from "../types/index";
|
|
2
|
+
/**
|
|
3
|
+
* Validates email format using basic regex pattern
|
|
4
|
+
*
|
|
5
|
+
* @summary Validates email format using basic regex pattern
|
|
6
|
+
* @description Ensures email addresses conform to standard format with username, @ symbol, and domain
|
|
7
|
+
*
|
|
8
|
+
* @param email - Email address to validate
|
|
9
|
+
* @returns True if email matches required format, false otherwise
|
|
10
|
+
*/
|
|
11
|
+
export declare const isValidEmail: (email: string) => boolean;
|
|
12
|
+
/**
|
|
13
|
+
* Generic response handler - consistent way to handle API responses
|
|
14
|
+
*
|
|
15
|
+
* @summary Process API responses consistently across the SDK
|
|
16
|
+
* @description Validates response structure, extracts data or converts API errors to domain errors
|
|
17
|
+
*
|
|
18
|
+
* @param response - The API response to process
|
|
19
|
+
* @param errorContext - Descriptive context for error messages
|
|
20
|
+
* @returns The data from a successful response
|
|
21
|
+
* @throws {TapsilatError} On any response error
|
|
22
|
+
*/
|
|
23
|
+
export declare const handleResponse: <T>(response: APIResponse<T>, errorContext: string) => T;
|
|
24
|
+
/**
|
|
25
|
+
* Generic error handler - consistent way to handle errors
|
|
26
|
+
*
|
|
27
|
+
* @summary Centralized error handling for consistent error reporting
|
|
28
|
+
* @description Processes caught errors and ensures they are properly converted to TapsilatError types
|
|
29
|
+
*
|
|
30
|
+
* @param error - The caught error to process
|
|
31
|
+
* @param errorContext - Descriptive context for error messages
|
|
32
|
+
* @throws {TapsilatError} Always throws an appropriate error type
|
|
33
|
+
*/
|
|
34
|
+
export declare const handleError: (error: unknown, errorContext: string) => never;
|
|
35
|
+
/**
|
|
36
|
+
* Verifies HMAC-SHA256 signature for webhook security
|
|
37
|
+
*
|
|
38
|
+
* @summary Security verification of webhook payloads using HMAC-SHA256
|
|
39
|
+
* @description Computes expected signature from payload and secret, compares with provided signature
|
|
40
|
+
*
|
|
41
|
+
* @param payload - Raw webhook payload string
|
|
42
|
+
* @param signature - Webhook signature from headers (should include "sha256=" prefix)
|
|
43
|
+
* @param secret - Your webhook secret key
|
|
44
|
+
* @returns true if signature is valid, false otherwise
|
|
45
|
+
*/
|
|
46
|
+
export declare const verifyHmacSignature: (payload: string, signature: string, secret: string) => boolean;
|
|
47
|
+
//# sourceMappingURL=index.d.ts.map
|