@inkress/admin-sdk
Version:
Official Inkress Commerce API SDK for JavaScript/TypeScript
106 lines • 6.34 kB
TypeScript
import { InkressConfig } from './types';
import { MerchantsResource } from './resources/merchants';
import { CategoriesResource } from './resources/categories';
import { OrdersResource } from './resources/orders';
import { ProductsResource } from './resources/products';
import { BillingPlansResource } from './resources/billing-plans';
import { SubscriptionsResource } from './resources/subscriptions';
import { UsersResource } from './resources/users';
import { PublicResource } from './resources/public';
import { KycResource } from './resources/kyc';
import { PaymentLinksResource } from './resources/payment-links';
import { FinancialAccountsResource } from './resources/financial-accounts';
import { FinancialRequestsResource } from './resources/financial-requests';
import { WebhookUrlsResource } from './resources/webhook-urls';
import { TokensResource } from './resources/tokens';
import { AddressesResource } from './resources/addresses';
import { CurrenciesResource } from './resources/currencies';
import { ExchangeRatesResource } from './resources/exchange-rates';
import { FeesResource } from './resources/fees';
import { PaymentMethodsResource } from './resources/payment-methods';
import { TransactionEntriesResource } from './resources/transaction-entries';
import { GenericsResource } from './resources/generics';
/**
* Main Inkress Commerce API SDK class
*
* @example
* ```typescript
* import { InkressSDK } from '@inkress/admin-sdk';
*
* const inkress = new InkressSDK({
* accessToken: 'your-jwt-token',
* username: 'merchant-username', // Optional - automatically prepended with 'm-'
* mode: 'live', // Optional - 'live' (default) or 'sandbox'
* apiVersion: 'v1', // Optional, defaults to v1
* });
*
* // List merchants
* const merchants = await inkress.merchants.list();
*
* // Get public merchant information (no auth required)
* const publicMerchant = await inkress.public.getMerchant({ username: 'merchant-username' });
*
* // List categories
* const categories = await inkress.categories.list();
*
* // Create a category
* const category = await inkress.categories.create({
* name: 'Electronics',
* description: 'Electronic devices and accessories',
* kind: 1
* });
*
* // Create an order
* const order = await inkress.orders.create({
* currency_code: 'USD',
* customer: {
* email: 'customer@example.com',
* first_name: 'John',
* last_name: 'Doe'
* },
* total: 29.99,
* reference_id: 'order-123'
* });
* ```
*/
export declare class InkressSDK {
private client;
readonly merchants: MerchantsResource;
readonly categories: CategoriesResource;
readonly orders: OrdersResource;
readonly products: ProductsResource;
readonly billingPlans: BillingPlansResource;
readonly subscriptions: SubscriptionsResource;
readonly users: UsersResource;
readonly public: PublicResource;
readonly kyc: KycResource;
readonly paymentLinks: PaymentLinksResource;
readonly financialAccounts: FinancialAccountsResource;
readonly financialRequests: FinancialRequestsResource;
readonly webhookUrls: WebhookUrlsResource;
readonly tokens: TokensResource;
readonly addresses: AddressesResource;
readonly currencies: CurrenciesResource;
readonly exchangeRates: ExchangeRatesResource;
readonly fees: FeesResource;
readonly paymentMethods: PaymentMethodsResource;
readonly transactionEntries: TransactionEntriesResource;
readonly generics: GenericsResource;
constructor(config: InkressConfig);
/**
* Update the SDK configuration
*/
updateConfig(newConfig: Partial<InkressConfig>): void;
/**
* Get current configuration (without sensitive data)
*/
getConfig(): Omit<InkressConfig, 'accessToken'>;
}
export * from './types';
export * from './client';
export { InkressSDK as default };
export type { OrderQueryParams, ProductQueryParams, UserQueryParams, MerchantQueryParams, CategoryQueryParams, BillingPlanQueryParams, SubscriptionQueryParams, PaymentLinkQueryParams, FinancialAccountQueryParams, FinancialRequestQueryParams, WebhookUrlQueryParams, TokenQueryParams, AddressQueryParams, CurrencyQueryParams, ExchangeRateQueryParams, FeeQueryParams, PaymentMethodQueryParams, TransactionEntryQueryParams, OrderFilterParams, ProductFilterParams, UserFilterParams, MerchantFilterParams, CategoryFilterParams, BillingPlanFilterParams, SubscriptionFilterParams, PaymentLinkFilterParams, FinancialAccountFilterParams, FinancialRequestFilterParams, WebhookUrlFilterParams, TokenFilterParams, AddressFilterParams, CurrencyFilterParams, ExchangeRateFilterParams, FeeFilterParams, PaymentMethodFilterParams, TransactionEntryFilterParams, OrderListResponse, ProductListResponse, UserListResponse, MerchantListResponse, CategoryListResponse, BillingPlanListResponse, SubscriptionListResponse, PaymentLinkListResponse, FinancialAccountListResponse, FinancialRequestListResponse, WebhookUrlListResponse, TokenListResponse, AddressListResponse, CurrencyListResponse, ExchangeRateListResponse, FeeListResponse, PaymentMethodListResponse, TransactionEntryListResponse, PageInfo, } from './types/resources';
export { ORDER_FIELD_TYPES, PRODUCT_FIELD_TYPES, USER_FIELD_TYPES, MERCHANT_FIELD_TYPES, CATEGORY_FIELD_TYPES, BILLING_PLAN_FIELD_TYPES, SUBSCRIPTION_FIELD_TYPES, PAYMENT_LINK_FIELD_TYPES, FINANCIAL_ACCOUNT_FIELD_TYPES, FINANCIAL_REQUEST_FIELD_TYPES, WEBHOOK_URL_FIELD_TYPES, TOKEN_FIELD_TYPES, ADDRESS_FIELD_TYPES, CURRENCY_FIELD_TYPES, EXCHANGE_RATE_FIELD_TYPES, FEE_FIELD_TYPES, PAYMENT_METHOD_FIELD_TYPES, TRANSACTION_ENTRY_FIELD_TYPES, } from './types/resources';
export { processQuery, QueryBuilder, type QueryParams, type RangeQuery, type StringQuery, type DateQuery, type JsonQueryParams, } from './utils/query-transformer';
export { OrderQueryBuilder, ProductQueryBuilder, UserQueryBuilder, MerchantQueryBuilder, CategoryQueryBuilder, BillingPlanQueryBuilder, SubscriptionQueryBuilder, PaymentLinkQueryBuilder, FinancialAccountQueryBuilder, FinancialRequestQueryBuilder, WebhookUrlQueryBuilder, TokenQueryBuilder, AddressQueryBuilder, CurrencyQueryBuilder, ExchangeRateQueryBuilder, FeeQueryBuilder, PaymentMethodQueryBuilder, TransactionEntryQueryBuilder, type Queryable, } from './utils/query-builders';
//# sourceMappingURL=index.d.ts.map