Class KiotVietClient

Index

Constructors

Methods

delete get post put refreshToken

Constructors

constructor

new KiotVietClient(config: KiotVietClientConfig): KiotVietClient
Parameters
- config: KiotVietClientConfig
Returns KiotVietClient
- Defined in src/client.ts:54

Properties

`Readonly`apiClient

apiClient: AxiosInstance

`Readonly`bankAccounts

bankAccounts: BankAccountHandler

`Readonly`branches

branches: BranchHandler

`Readonly`cashFlow

cashFlow: CashFlowHandler

`Readonly`categories

categories: CategoryHandler

`Readonly`customers

customers: CustomerHandler

`Readonly`invoices

invoices: InvoiceHandler

`Readonly`orders

orders: OrderHandler

`Readonly`priceBooks

priceBooks: PriceBookHandler

`Readonly`products

products: ProductHandler

`Readonly`purchaseOrders

purchaseOrders: PurchaseOrderHandler

`Readonly`returns

returns: ReturnsHandler

`Readonly`salesChannels

salesChannels: SalesChannelsHandler

`Readonly`settings

settings: SettingsHandler

`Readonly`suppliers

suppliers: SupplierHandler

`Readonly`surcharges

surcharges: SurchargeHandler

`Readonly`trademarks

trademarks: TrademarksHandler

`Readonly`transfers

transfers: TransferHandler

`Readonly`users

users: UserHandler

`Readonly`vouchers

vouchers: VouchersHandler

`Readonly`webhooks

webhooks: WebhookHandler

Methods

delete

delete<T>(url: string, config?: AxiosRequestConfig<any>): Promise<T>
Make a DELETE request
Type Parameters
- T
Parameters
- url: string
  The URL to make the request to
- Optionalconfig: AxiosRequestConfig<any>
  Optional axios request configuration
Returns Promise<T>
Promise with the response data
- Defined in src/client.ts:146

get

get<T>(url: string, config?: AxiosRequestConfig<any>): Promise<T>
Make a GET request
Type Parameters
- T
Parameters
- url: string
  The URL to make the request to
- Optionalconfig: AxiosRequestConfig<any>
  Optional axios request configuration
Returns Promise<T>
Promise with the response data
- Defined in src/client.ts:123

post

post<T>(
    url: string,
    data?: unknown,
    config?: AxiosRequestConfig<any>,
): Promise<T>
Make a POST request
Type Parameters
- T
Parameters
- url: string
  The URL to make the request to
- Optionaldata: unknown
  The data to send in the request body
- Optionalconfig: AxiosRequestConfig<any>
  Optional axios request configuration
Returns Promise<T>
Promise with the response data
- Defined in src/client.ts:135

put

put<T>(url: string, data?: any, config?: AxiosRequestConfig<any>): Promise<T>
Make a PUT request
Type Parameters
- T
Parameters
- url: string
  The URL to make the request to
- Optionaldata: any
  The data to send in the request body
- Optionalconfig: AxiosRequestConfig<any>
  Optional axios request configuration
Returns Promise<T>
Promise with the response data
- Defined in src/client.ts:158

refreshToken

refreshToken(): Promise<string>
Manually trigger a token refresh

Returns Promise<string>
Promise The new access token
- Defined in src/client.ts:113