@tapsilat/tapsilat-js 2025.12.19 → 2026.4.2

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/index.d.ts CHANGED
@@ -94,11 +94,11 @@ interface Customer {
94
94
  * @interface Address
95
95
  */
96
96
  interface Address {
97
- address: string;
98
- city: string;
99
- contact_name: string;
100
- country: string;
101
- zip_code: string;
97
+ address?: string;
98
+ city?: string;
99
+ contact_name?: string;
100
+ country?: string;
101
+ zip_code?: string;
102
102
  district?: string;
103
103
  contact_phone?: string;
104
104
  }
@@ -121,13 +121,13 @@ interface BillingAddress extends Address {
121
121
  * @interface BasketItem
122
122
  */
123
123
  interface BasketItem {
124
- id: string;
125
- name: string;
126
- category1: string;
124
+ id?: string;
125
+ name?: string;
126
+ category1?: string;
127
127
  category2?: string;
128
- item_type: string;
129
- price: number;
130
- quantity: number;
128
+ item_type?: string;
129
+ price?: number;
130
+ quantity?: number;
131
131
  coupon_discount?: number;
132
132
  data?: string;
133
133
  quantity_unit?: string;
@@ -276,9 +276,10 @@ interface OrderCreateRequest {
276
276
  three_d_force?: boolean;
277
277
  currency: Currency;
278
278
  shipping_address?: Address;
279
- basket_items: BasketItem[];
280
- billing_address: BillingAddress;
279
+ basket_items?: BasketItem[];
280
+ billing_address?: BillingAddress;
281
281
  buyer: Buyer;
282
+ consents?: OrderConsent[];
282
283
  conversation_id?: string;
283
284
  partial_payment?: boolean;
284
285
  payment_methods?: boolean;
@@ -287,6 +288,7 @@ interface OrderCreateRequest {
287
288
  payment_failure_url?: string;
288
289
  enabled_installments?: number[];
289
290
  metadata?: OrderMetadata[];
291
+ sub_organization?: SubOrganizationDTO;
290
292
  }
291
293
  /**
292
294
  * @category Order Management
@@ -584,6 +586,16 @@ interface SubmerchantDTO {
584
586
  merchant_reference_id?: string;
585
587
  order_basket_item_id?: string;
586
588
  }
589
+ /**
590
+ * @category Order Management
591
+ * @summary Order consent information
592
+ * @description Title and URL for legal consents required during order creation
593
+ * @interface OrderConsent
594
+ */
595
+ interface OrderConsent {
596
+ title?: string;
597
+ url?: string;
598
+ }
587
599
  /**
588
600
  * @category API DTOs
589
601
  * @summary Comprehensive order creation request
@@ -592,12 +604,13 @@ interface SubmerchantDTO {
592
604
  */
593
605
  interface OrderCreateDTO {
594
606
  amount: number;
595
- currency: string;
596
- locale: string;
607
+ currency: Currency;
608
+ locale: Locale;
597
609
  buyer: BuyerDTO;
598
610
  basket_items?: BasketItemDTO[];
599
611
  billing_address?: BillingAddressDTO;
600
612
  checkout_design?: CheckoutDesignDTO;
613
+ consents?: OrderConsent[];
601
614
  conversation_id?: string;
602
615
  enabled_installments?: number[];
603
616
  external_reference_id?: string;
@@ -823,6 +836,11 @@ interface SubscriptionCreateRequest {
823
836
  success_url?: string;
824
837
  title?: string;
825
838
  user?: SubscriptionUser;
839
+ price_option?: SubscriptionPriceOption;
840
+ }
841
+ interface SubscriptionPriceOption {
842
+ count: number;
843
+ price: number;
826
844
  }
827
845
  interface SubscriptionRedirectRequest {
828
846
  subscription_id?: string;
@@ -888,6 +906,140 @@ interface OrderSubmerchant {
888
906
  interface OrderAccountingRequest {
889
907
  order_reference_id: string;
890
908
  }
909
+ /**
910
+ * @category Order Management
911
+ * @summary Request to add an item to the basket
912
+ * @description Data required to add a new item to an existing order basket
913
+ * @interface AddBasketItemRequest
914
+ */
915
+ interface AddBasketItemRequest {
916
+ order_reference_id: string;
917
+ basket_item: BasketItemDTO;
918
+ }
919
+ /**
920
+ * @category Order Management
921
+ * @summary Request to remove an item from the basket
922
+ * @description Data required to remove an item from an existing order basket
923
+ * @interface RemoveBasketItemRequest
924
+ */
925
+ interface RemoveBasketItemRequest {
926
+ order_reference_id: string;
927
+ basket_item_id: string;
928
+ }
929
+ /**
930
+ * @category Order Management
931
+ * @summary Request to update a basket item
932
+ * @description Data required to update an existing item in an order basket
933
+ * @interface UpdateBasketItemRequest
934
+ */
935
+ interface UpdateBasketItemRequest {
936
+ order_reference_id: string;
937
+ basket_item: BasketItemDTO;
938
+ }
939
+ /**
940
+ * @category Organization
941
+ * @summary Webhook callback URL configuration
942
+ * @description Configuration for various webhook callback endpoints
943
+ * @interface CallbackURLDTO
944
+ */
945
+ interface CallbackURLDTO {
946
+ callback_url?: string;
947
+ cancel_callback_url?: string;
948
+ fail_callback_url?: string;
949
+ refund_callback_url?: string;
950
+ }
951
+ /**
952
+ * @category Organization
953
+ * @summary Organization business types
954
+ * @enum {number}
955
+ */
956
+ declare enum BusinessType {
957
+ INDIVIDUAL = 0,
958
+ CORPORATE = 1
959
+ }
960
+ /**
961
+ * @category Organization
962
+ * @summary Request to create a business entity
963
+ * @description Comprehensive data for creating a new business entity in an organization
964
+ * @interface OrgCreateBusinessRequest
965
+ */
966
+ interface OrgCreateBusinessRequest {
967
+ address: string;
968
+ business_name: string;
969
+ business_type: BusinessType;
970
+ email: string;
971
+ first_name: string;
972
+ identity_number: string;
973
+ last_name: string;
974
+ phone: string;
975
+ tax_number: string;
976
+ tax_office: string;
977
+ zip_code: string;
978
+ }
979
+ /**
980
+ * @category Organization
981
+ * @summary Request for user limit information
982
+ * @description Data required to fetch limits for a specific user
983
+ * @interface GetUserLimitRequest
984
+ */
985
+ interface GetUserLimitRequest {
986
+ user_id: string;
987
+ [key: string]: unknown;
988
+ }
989
+ /**
990
+ * @category Organization
991
+ * @summary Request to set user limits
992
+ * @description Data required to set a specific limit for a user
993
+ * @interface SetLimitUserRequest
994
+ */
995
+ interface SetLimitUserRequest {
996
+ limit_id: string;
997
+ user_id: string;
998
+ }
999
+ /**
1000
+ * @category Organization
1001
+ * @summary Request for VPOS list
1002
+ * @description Parameters for filtering and retrieving virtual POS terminals
1003
+ * @interface GetVposRequest
1004
+ */
1005
+ interface GetVposRequest {
1006
+ currency_id: string;
1007
+ [key: string]: unknown;
1008
+ }
1009
+ /**
1010
+ * @category Organization
1011
+ * @summary Request to create an organization user
1012
+ * @description Comprehensive data for creating a new user within an organization
1013
+ * @interface OrgCreateUserReq
1014
+ */
1015
+ interface OrgCreateUserReq {
1016
+ conversation_id: string;
1017
+ email: string;
1018
+ first_name: string;
1019
+ identity_number: string;
1020
+ is_mail_verified: boolean;
1021
+ last_name: string;
1022
+ phone: string;
1023
+ reference_id: string;
1024
+ }
1025
+ /**
1026
+ * @category Organization
1027
+ * @summary Request to verify a user
1028
+ * @description Data required to verify a user's account
1029
+ * @interface OrgUserVerifyReq
1030
+ */
1031
+ interface OrgUserVerifyReq {
1032
+ user_id: string;
1033
+ }
1034
+ /**
1035
+ * @category Organization
1036
+ * @summary Request to verify user's mobile number
1037
+ * @description Data required to initiate or complete mobile number verification
1038
+ * @interface OrgUserMobileVerifyReq
1039
+ */
1040
+ interface OrgUserMobileVerifyReq {
1041
+ user_id: string;
1042
+ }
891
1043
  /**
892
1044
  * @category Order Management
893
1045
  * @summary Request for order post-authorization
@@ -1021,6 +1173,22 @@ declare class TapsilatSDK {
1021
1173
  * @throws {TypeError} When config parameter is not an object or missing required fields
1022
1174
  */
1023
1175
  constructor(config: TapsilatConfig);
1176
+ /**
1177
+ * Access to order operations
1178
+ */
1179
+ get orders(): any;
1180
+ /**
1181
+ * Access to subscription operations
1182
+ */
1183
+ get subscriptions(): any;
1184
+ /**
1185
+ * Access to organization operations
1186
+ */
1187
+ get organization(): any;
1188
+ /**
1189
+ * Access to webhook operations
1190
+ */
1191
+ get webhooks(): any;
1024
1192
  /**
1025
1193
  * Creates a new order and returns a checkout URL
1026
1194
  *
@@ -1451,6 +1619,74 @@ declare class TapsilatSDK {
1451
1619
  orderRelatedUpdate(referenceId: string, relatedReferenceId: string): Promise<APIResponse<unknown>>;
1452
1620
  getOrganizationSettings(): Promise<OrganizationSettings>;
1453
1621
  getOrderTerm(termReferenceId: string): Promise<PaymentTermResponse>;
1622
+ /**
1623
+ * Add a new item to an existing order basket
1624
+ */
1625
+ addBasketItem(request: AddBasketItemRequest): Promise<APIResponse<unknown>>;
1626
+ /**
1627
+ * Remove an item from an existing order basket
1628
+ */
1629
+ removeBasketItem(request: RemoveBasketItemRequest): Promise<APIResponse<unknown>>;
1630
+ /**
1631
+ * Update an existing item in an order basket
1632
+ */
1633
+ updateBasketItem(request: UpdateBasketItemRequest): Promise<APIResponse<unknown>>;
1634
+ /**
1635
+ * Retrieve organization callback (webhook) settings
1636
+ */
1637
+ getOrganizationCallback(): Promise<APIResponse<CallbackURLDTO>>;
1638
+ /**
1639
+ * Update organization callback (webhook) settings
1640
+ */
1641
+ updateOrganizationCallback(request: CallbackURLDTO): Promise<APIResponse<unknown>>;
1642
+ /**
1643
+ * Create a new business entity within the organization
1644
+ */
1645
+ createOrganizationBusiness(request: OrgCreateBusinessRequest): Promise<APIResponse<unknown>>;
1646
+ /**
1647
+ * Retrieve supported currencies for the organization
1648
+ */
1649
+ getOrganizationCurrencies(): Promise<APIResponse<unknown>>;
1650
+ /**
1651
+ * Retrieve limit information for a specific organization user
1652
+ */
1653
+ getOrganizationLimitUser(request: GetUserLimitRequest): Promise<APIResponse<unknown>>;
1654
+ /**
1655
+ * Set limit for a specific organization user
1656
+ */
1657
+ setOrganizationLimitUser(request: SetLimitUserRequest): Promise<APIResponse<unknown>>;
1658
+ /**
1659
+ * Retrieve organization overall limits
1660
+ */
1661
+ getOrganizationLimits(): Promise<APIResponse<unknown>>;
1662
+ /**
1663
+ * Retrieve meta information for the organization
1664
+ */
1665
+ getOrganizationMeta(): Promise<APIResponse<unknown>>;
1666
+ /**
1667
+ * Retrieve supported scopes for the organization
1668
+ */
1669
+ getOrganizationScopes(): Promise<APIResponse<unknown>>;
1670
+ /**
1671
+ * Retrieve list of sub-organizations
1672
+ */
1673
+ getOrganizationSuborganizations(): Promise<APIResponse<unknown>>;
1674
+ /**
1675
+ * Create a new user within the organization
1676
+ */
1677
+ createOrganizationUser(request: OrgCreateUserReq): Promise<APIResponse<unknown>>;
1678
+ /**
1679
+ * Verify an organization user
1680
+ */
1681
+ verifyOrganizationUser(request: OrgUserVerifyReq): Promise<APIResponse<unknown>>;
1682
+ /**
1683
+ * Verify an organization user via mobile
1684
+ */
1685
+ verifyOrganizationUserMobile(request: OrgUserMobileVerifyReq): Promise<APIResponse<unknown>>;
1686
+ /**
1687
+ * List virtual POS terminals for the organization
1688
+ */
1689
+ listOrganizationVpos(request: GetVposRequest): Promise<APIResponse<unknown>>;
1454
1690
  createSubscription(request: SubscriptionCreateRequest): Promise<SubscriptionCreateResponse>;
1455
1691
  getSubscription(request: SubscriptionGetRequest): Promise<SubscriptionDetail>;
1456
1692
  listSubscriptions(params?: {
@@ -1666,4 +1902,4 @@ declare function validateGsmNumber(gsmNumber: string | number): GsmValidationRes
1666
1902
  declare function validateInstallments(installments: string | number | number[]): InstallmentsValidationResult;
1667
1903
 
1668
1904
  export { ConfigManager, TapsilatAuthenticationError, TapsilatError, TapsilatNetworkError, TapsilatRateLimitError, TapsilatSDK, TapsilatValidationError, isValidCurrency, isValidPaymentMethod, isValidUrl, sanitizeMetadata, validateEmail, validateGsmNumber, validateInstallments, validatePaymentRequest };
1669
- export type { APIError, APIResponse, Address, BasketItem, BasketItemDTO, BasketItemPayerDTO, BillingAddress, BillingAddressDTO, Buyer, BuyerDTO, CheckoutDesignDTO, Currency, Customer, GsmValidationResult, InstallmentsValidationResult, Locale, MetadataDTO, Order, OrderAccountingRequest, OrderCardDTO, OrderCreateDTO, OrderCreateRequest, OrderCreateResponse, OrderPFSubMerchantDTO, OrderPaymentDetail, OrderPaymentTermCreateDTO, OrderPaymentTermUpdateDTO, OrderPostAuthRequest, OrderRefundRequest, OrderRefundResponse, OrderResponse, OrderStatusResponse, OrderSubmerchant, OrderTermRefundRequest, OrderTerminateRequest, OrderTerminateResponse, OrderTransaction, OrganizationSettings, PaginatedResponse, PaginationParams, PaymentMethod, PaymentOption, PaymentRequest, PaymentResponse, PaymentStatus, PaymentTermDTO, PaymentTermDeleteRequest, PaymentTermRefundResponse, PaymentTermResponse, PaymentTermTerminateRequest, RefundOrderDTO, RefundRequest, RefundResponse, ShippingAddressDTO, SubOrganizationDTO, SubmerchantDTO, SubscriptionBilling, SubscriptionCancelRequest, SubscriptionCreateRequest, SubscriptionCreateResponse, SubscriptionDetail, SubscriptionGetRequest, SubscriptionOrder, SubscriptionRedirectRequest, SubscriptionRedirectResponse, SubscriptionUser, TapsilatConfig, WebhookEvent };
1905
+ export type { APIError, APIResponse, AddBasketItemRequest, Address, BasketItem, BasketItemDTO, BasketItemPayerDTO, BillingAddress, BillingAddressDTO, Buyer, BuyerDTO, CallbackURLDTO, CheckoutDesignDTO, Currency, Customer, GetUserLimitRequest, GetVposRequest, GsmValidationResult, InstallmentsValidationResult, Locale, MetadataDTO, Order, OrderAccountingRequest, OrderCardDTO, OrderCreateDTO, OrderCreateRequest, OrderCreateResponse, OrderPFSubMerchantDTO, OrderPaymentDetail, OrderPaymentTermCreateDTO, OrderPaymentTermUpdateDTO, OrderPostAuthRequest, OrderRefundRequest, OrderRefundResponse, OrderResponse, OrderStatusResponse, OrderSubmerchant, OrderTermRefundRequest, OrderTerminateRequest, OrderTerminateResponse, OrderTransaction, OrgCreateBusinessRequest, OrgCreateUserReq, OrgUserMobileVerifyReq, OrgUserVerifyReq, OrganizationSettings, PaginatedResponse, PaginationParams, PaymentMethod, PaymentOption, PaymentRequest, PaymentResponse, PaymentStatus, PaymentTermDTO, PaymentTermDeleteRequest, PaymentTermRefundResponse, PaymentTermResponse, PaymentTermTerminateRequest, RefundOrderDTO, RefundRequest, RefundResponse, RemoveBasketItemRequest, SetLimitUserRequest, ShippingAddressDTO, SubOrganizationDTO, SubmerchantDTO, SubscriptionBilling, SubscriptionCancelRequest, SubscriptionCreateRequest, SubscriptionCreateResponse, SubscriptionDetail, SubscriptionGetRequest, SubscriptionOrder, SubscriptionRedirectRequest, SubscriptionRedirectResponse, SubscriptionUser, TapsilatConfig, UpdateBasketItemRequest, WebhookEvent };
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAG5C,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAGvD,YAAY,EACV,cAAc,EACd,aAAa,EACb,aAAa,EACb,QAAQ,EACR,cAAc,EACd,eAAe,EACf,QAAQ,EACR,OAAO,EACP,cAAc,EACd,UAAU,EACV,aAAa,EACb,aAAa,EACb,cAAc,EACd,YAAY,EACZ,QAAQ,EACR,WAAW,EACX,gBAAgB,EAChB,iBAAiB,EACjB,MAAM,EACN,KAAK,EACL,kBAAkB,EAClB,mBAAmB,EACnB,KAAK,EACL,kBAAkB,EAClB,mBAAmB,EACnB,mBAAmB,EACnB,kBAAkB,EAClB,QAAQ,EACR,kBAAkB,EAClB,aAAa,EACb,iBAAiB,EACjB,iBAAiB,EACjB,WAAW,EACX,YAAY,EACZ,cAAc,EACd,qBAAqB,EACrB,kBAAkB,EAClB,kBAAkB,EAClB,cAAc,EACd,cAAc,EACd,cAAc,EACd,yBAAyB,EACzB,yBAAyB,EACzB,sBAAsB,EACtB,aAAa,EACb,mBAAmB,EACnB,wBAAwB,EACxB,yBAAyB,EACzB,2BAA2B,EAC3B,qBAAqB,EACrB,sBAAsB,EACtB,mBAAmB,EACnB,4BAA4B,EAC5B,gBAAgB,EAChB,gBAAgB,EAChB,sBAAsB,EACtB,yBAAyB,EACzB,mBAAmB,EACnB,gBAAgB,EAChB,yBAAyB,EACzB,2BAA2B,EAC3B,iBAAiB,EACjB,kBAAkB,EAClB,0BAA0B,EAC1B,4BAA4B,EAC5B,oBAAoB,EACpB,sBAAsB,EACtB,oBAAoB,GACrB,MAAM,eAAe,CAAC;AAGvB,OAAO,EACL,aAAa,EACb,oBAAoB,EACpB,uBAAuB,EACvB,2BAA2B,EAC3B,sBAAsB,GACvB,MAAM,wBAAwB,CAAC;AAGhC,OAAO,EACL,sBAAsB,EACtB,aAAa,EACb,eAAe,EACf,oBAAoB,EACpB,UAAU,EACV,gBAAgB,EAChB,iBAAiB,EACjB,oBAAoB,GACrB,MAAM,oBAAoB,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAG5C,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAGvD,YAAY,EACV,cAAc,EACd,aAAa,EACb,aAAa,EACb,QAAQ,EACR,cAAc,EACd,eAAe,EACf,QAAQ,EACR,OAAO,EACP,cAAc,EACd,UAAU,EACV,aAAa,EACb,aAAa,EACb,cAAc,EACd,YAAY,EACZ,QAAQ,EACR,WAAW,EACX,gBAAgB,EAChB,iBAAiB,EACjB,MAAM,EACN,KAAK,EACL,kBAAkB,EAClB,mBAAmB,EACnB,KAAK,EACL,kBAAkB,EAClB,mBAAmB,EACnB,mBAAmB,EACnB,kBAAkB,EAClB,QAAQ,EACR,kBAAkB,EAClB,aAAa,EACb,iBAAiB,EACjB,iBAAiB,EACjB,WAAW,EACX,YAAY,EACZ,cAAc,EACd,qBAAqB,EACrB,kBAAkB,EAClB,kBAAkB,EAClB,cAAc,EACd,cAAc,EACd,cAAc,EACd,yBAAyB,EACzB,yBAAyB,EACzB,sBAAsB,EACtB,aAAa,EACb,mBAAmB,EACnB,wBAAwB,EACxB,yBAAyB,EACzB,2BAA2B,EAC3B,qBAAqB,EACrB,sBAAsB,EACtB,mBAAmB,EACnB,4BAA4B,EAC5B,gBAAgB,EAChB,gBAAgB,EAChB,sBAAsB,EACtB,yBAAyB,EACzB,mBAAmB,EACnB,gBAAgB,EAChB,yBAAyB,EACzB,2BAA2B,EAC3B,iBAAiB,EACjB,kBAAkB,EAClB,0BAA0B,EAC1B,4BAA4B,EAC5B,oBAAoB,EACpB,sBAAsB,EACtB,oBAAoB,EACpB,oBAAoB,EACpB,uBAAuB,EACvB,uBAAuB,EACvB,wBAAwB,EACxB,mBAAmB,EACnB,mBAAmB,EACnB,cAAc,EACd,gBAAgB,EAChB,gBAAgB,EAChB,sBAAsB,EACtB,cAAc,GACf,MAAM,eAAe,CAAC;AAGvB,OAAO,EACL,aAAa,EACb,oBAAoB,EACpB,uBAAuB,EACvB,2BAA2B,EAC3B,sBAAsB,GACvB,MAAM,wBAAwB,CAAC;AAGhC,OAAO,EACL,sBAAsB,EACtB,aAAa,EACb,eAAe,EACf,oBAAoB,EACpB,UAAU,EACV,gBAAgB,EAChB,iBAAiB,EACjB,oBAAoB,GACrB,MAAM,oBAAoB,CAAC"}