Skip to content

Commit

Permalink
Generated Xendit node SDK
Browse files Browse the repository at this point in the history
  • Loading branch information
xendit-devx-bot committed Nov 6, 2023
1 parent a59b03c commit 1c908ce
Show file tree
Hide file tree
Showing 396 changed files with 3,505 additions and 9,628 deletions.
124 changes: 62 additions & 62 deletions .openapi-generator/FILES
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,68 +3,68 @@
.npmignore
README.md
docs/PaymentRequest.md
docs/payment_request/models/Capture.md
docs/payment_request/models/CaptureListResponse.md
docs/payment_request/models/CaptureParameters.md
docs/payment_request/models/Card.md
docs/payment_request/models/CardChannelProperties.md
docs/payment_request/models/CardInformation.md
docs/payment_request/models/CardVerificationResults.md
docs/payment_request/models/CardVerificationResultsThreeDSecure.md
docs/payment_request/models/DirectDebit.md
docs/payment_request/models/DirectDebitAllOf.md
docs/payment_request/models/DirectDebitBankAccount.md
docs/payment_request/models/DirectDebitChannelCode.md
docs/payment_request/models/DirectDebitChannelProperties.md
docs/payment_request/models/DirectDebitChannelPropertiesBankAccount.md
docs/payment_request/models/DirectDebitChannelPropertiesBankRedirect.md
docs/payment_request/models/DirectDebitChannelPropertiesDebitCard.md
docs/payment_request/models/DirectDebitDebitCard.md
docs/payment_request/models/DirectDebitParameters.md
docs/payment_request/models/DirectDebitType.md
docs/payment_request/models/EWallet.md
docs/payment_request/models/EWalletAccount.md
docs/payment_request/models/EWalletAllOf.md
docs/payment_request/models/EWalletChannelCode.md
docs/payment_request/models/EWalletChannelProperties.md
docs/payment_request/models/EWalletParameters.md
docs/payment_request/models/Error.md
docs/payment_request/models/OverTheCounter.md
docs/payment_request/models/OverTheCounterChannelCode.md
docs/payment_request/models/OverTheCounterChannelProperties.md
docs/payment_request/models/OverTheCounterParameters.md
docs/payment_request/models/PaymentMethod.md
docs/payment_request/models/PaymentMethodParameters.md
docs/payment_request/models/PaymentMethodReusability.md
docs/payment_request/models/PaymentMethodStatus.md
docs/payment_request/models/PaymentMethodType.md
docs/payment_request/models/PaymentRequest.md
docs/payment_request/models/PaymentRequestAction.md
docs/payment_request/models/PaymentRequestAuthParameters.md
docs/payment_request/models/PaymentRequestBasketItem.md
docs/payment_request/models/PaymentRequestCaptureMethod.md
docs/payment_request/models/PaymentRequestCardVerificationResults.md
docs/payment_request/models/PaymentRequestCardVerificationResultsThreeDeeSecure.md
docs/payment_request/models/PaymentRequestChannelProperties.md
docs/payment_request/models/PaymentRequestCountry.md
docs/payment_request/models/PaymentRequestCurrency.md
docs/payment_request/models/PaymentRequestInitiator.md
docs/payment_request/models/PaymentRequestListResponse.md
docs/payment_request/models/PaymentRequestParameters.md
docs/payment_request/models/PaymentRequestParametersChannelProperties.md
docs/payment_request/models/PaymentRequestParametersChannelPropertiesAllOf.md
docs/payment_request/models/PaymentRequestShippingInformation.md
docs/payment_request/models/PaymentRequestStatus.md
docs/payment_request/models/QrCode.md
docs/payment_request/models/QrCodeChannelCode.md
docs/payment_request/models/QrCodeChannelProperties.md
docs/payment_request/models/QrCodeParameters.md
docs/payment_request/models/VirtualAccount.md
docs/payment_request/models/VirtualAccountAllOf.md
docs/payment_request/models/VirtualAccountAlternativeDisplay.md
docs/payment_request/models/VirtualAccountChannelCode.md
docs/payment_request/models/VirtualAccountChannelProperties.md
docs/payment_request/models/VirtualAccountParameters.md
docs/payment_request/Capture.md
docs/payment_request/CaptureListResponse.md
docs/payment_request/CaptureParameters.md
docs/payment_request/Card.md
docs/payment_request/CardChannelProperties.md
docs/payment_request/CardInformation.md
docs/payment_request/CardVerificationResults.md
docs/payment_request/CardVerificationResultsThreeDSecure.md
docs/payment_request/DirectDebit.md
docs/payment_request/DirectDebitAllOf.md
docs/payment_request/DirectDebitBankAccount.md
docs/payment_request/DirectDebitChannelCode.md
docs/payment_request/DirectDebitChannelProperties.md
docs/payment_request/DirectDebitChannelPropertiesBankAccount.md
docs/payment_request/DirectDebitChannelPropertiesBankRedirect.md
docs/payment_request/DirectDebitChannelPropertiesDebitCard.md
docs/payment_request/DirectDebitDebitCard.md
docs/payment_request/DirectDebitParameters.md
docs/payment_request/DirectDebitType.md
docs/payment_request/EWallet.md
docs/payment_request/EWalletAccount.md
docs/payment_request/EWalletAllOf.md
docs/payment_request/EWalletChannelCode.md
docs/payment_request/EWalletChannelProperties.md
docs/payment_request/EWalletParameters.md
docs/payment_request/Error.md
docs/payment_request/OverTheCounter.md
docs/payment_request/OverTheCounterChannelCode.md
docs/payment_request/OverTheCounterChannelProperties.md
docs/payment_request/OverTheCounterParameters.md
docs/payment_request/PaymentMethod.md
docs/payment_request/PaymentMethodParameters.md
docs/payment_request/PaymentMethodReusability.md
docs/payment_request/PaymentMethodStatus.md
docs/payment_request/PaymentMethodType.md
docs/payment_request/PaymentRequest.md
docs/payment_request/PaymentRequestAction.md
docs/payment_request/PaymentRequestAuthParameters.md
docs/payment_request/PaymentRequestBasketItem.md
docs/payment_request/PaymentRequestCaptureMethod.md
docs/payment_request/PaymentRequestCardVerificationResults.md
docs/payment_request/PaymentRequestCardVerificationResultsThreeDeeSecure.md
docs/payment_request/PaymentRequestChannelProperties.md
docs/payment_request/PaymentRequestCountry.md
docs/payment_request/PaymentRequestCurrency.md
docs/payment_request/PaymentRequestInitiator.md
docs/payment_request/PaymentRequestListResponse.md
docs/payment_request/PaymentRequestParameters.md
docs/payment_request/PaymentRequestParametersChannelProperties.md
docs/payment_request/PaymentRequestParametersChannelPropertiesAllOf.md
docs/payment_request/PaymentRequestShippingInformation.md
docs/payment_request/PaymentRequestStatus.md
docs/payment_request/QrCode.md
docs/payment_request/QrCodeChannelCode.md
docs/payment_request/QrCodeChannelProperties.md
docs/payment_request/QrCodeParameters.md
docs/payment_request/VirtualAccount.md
docs/payment_request/VirtualAccountAllOf.md
docs/payment_request/VirtualAccountAlternativeDisplay.md
docs/payment_request/VirtualAccountChannelCode.md
docs/payment_request/VirtualAccountChannelProperties.md
docs/payment_request/VirtualAccountParameters.md
images/header.jpg
index.ts
index.ts
Expand Down
4 changes: 2 additions & 2 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
The official Xendit Node SDK provides a simple and convenient way to call Xendit's REST API
in applications written in Node.

* Package version: 3.4.0
* Package version: 3.6.0

# Getting Started

Expand Down Expand Up @@ -53,8 +53,8 @@ Find detailed API information and examples for each of our product’s by clicki
* [PaymentRequest](docs/PaymentRequest.md)
* [PaymentMethod](docs/PaymentMethod.md)
* [Refund](docs/Refund.md)
* [Transaction](docs/Transaction.md)
* [Balance](docs/Balance.md)
* [Transaction](docs/Transaction.md)
* [Customer](docs/Customer.md)
* [Payout](docs/Payout.md)

Expand Down
29 changes: 19 additions & 10 deletions docs/Balance.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,27 +15,36 @@ const xenditBalanceClient = new BalanceClient({secretKey: YOUR_SECRET_KEY})
// or
// xenditBalanceClient.
```
## Retrieves balances for a business, default to CASH type

All URIs are relative to https://api.xendit.co, except if the operation defines another base path.

| Method | HTTP request | Description |
| ------------- | ------------- | ------------- |
| [**getBalance()**](Balance.md#getbalance-function) | **GET** /balance | Retrieves balances for a business, default to CASH type |


## `getBalance()` Function


### Function Signature
| Name | Value |
|--------------------|:-------------:|
| Function Name | `getBalance` |
| Request Parameters | [GetBalanceRequest](#request-parameters--GetBalanceRequest) |
| Return Type | [Balance](balance_and_transaction/models/Balance.md) |
| Return Type | [Balance](balance_and_transaction/Balance.md) |

### Request Parameters — `GetBalanceRequest`
| Field Name | Required | Type |
|-----------|:----------:|:----------:|
| accountType| | 'CASH' | 'HOLDING' | 'TAX' |
| currency| | string |
| forUserId| | string |
### Request Parameters - GetBalanceRequest
| Field Name | Type | Required | Default |
|-----------|:----------:|:----------:|-----------|
| **accountType** | [CASH, HOLDING, TAX] | | ['CASH'] |
| **currency** | **string** | | |
| **forUserId** | **string** | | |

### Usage Examples
#### Minimum API Usage
### Usage Example
```typescript
import { Balance } from 'xendit-node/balance_and_transaction/models'

const response: Balance = await xenditBalanceClient.getBalance({ })
```

[[Back to README]](../README.md)
85 changes: 47 additions & 38 deletions docs/Customer.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,103 +15,112 @@ const xenditCustomerClient = new CustomerClient({secretKey: YOUR_SECRET_KEY})
// or
// xenditCustomerClient.
```
## Create Customer

All URIs are relative to https://api.xendit.co, except if the operation defines another base path.

| Method | HTTP request | Description |
| ------------- | ------------- | ------------- |
| [**createCustomer()**](Customer.md#createcustomer-function) | **POST** /customers | Create Customer |
| [**getCustomer()**](Customer.md#getcustomer-function) | **GET** /customers/{id} | Get Customer By ID |
| [**getCustomerByReferenceID()**](Customer.md#getcustomerbyreferenceid-function) | **GET** /customers | GET customers by reference id |
| [**updateCustomer()**](Customer.md#updatecustomer-function) | **PATCH** /customers/{id} | Update End Customer Resource |


## `createCustomer()` Function


### Function Signature
| Name | Value |
|--------------------|:-------------:|
| Function Name | `createCustomer` |
| Request Parameters | [CreateCustomerRequest](#request-parameters--CreateCustomerRequest) |
| Return Type | [Customer](customer/models/Customer.md) |
| Return Type | [Customer](customer/Customer.md) |

### Request Parameters — `CreateCustomerRequest`
| Field Name | Required | Type |
|-----------|:----------:|:----------:|
| idempotencyKey| | string |
| forUserId| | string |
| data| | [CustomerRequest](customer/models/CustomerRequest.md) |
### Request Parameters - CreateCustomerRequest
| Field Name | Type | Required | Default |
|-----------|:----------:|:----------:|-----------|
| **idempotencyKey** | **string** | | |
| **forUserId** | **string** | | |
| **data** | [**CustomerRequest**](customer/CustomerRequest.md) | | |

### Usage Examples
#### Minimum API Usage
### Usage Example
```typescript
import { Customer } from 'xendit-node/customer/models'

const response: Customer = await xenditCustomerClient.createCustomer({ })
```
## Get Customer By ID
## `getCustomer()` Function


### Function Signature
| Name | Value |
|--------------------|:-------------:|
| Function Name | `getCustomer` |
| Request Parameters | [GetCustomerRequest](#request-parameters--GetCustomerRequest) |
| Return Type | [Customer](customer/models/Customer.md) |
| Return Type | [Customer](customer/Customer.md) |

### Request Parameters — `GetCustomerRequest`
| Field Name | Required | Type |
|-----------|:----------:|:----------:|
| id| ✅ | string |
| forUserId| | string |
### Request Parameters - GetCustomerRequest
| Field Name | Type | Required | Default |
|-----------|:----------:|:----------:|-----------|
| **id** | **string** | ☑️ | |
| **forUserId** | **string** | | |

### Usage Examples
#### Minimum API Usage
### Usage Example
```typescript
import { Customer } from 'xendit-node/customer/models'

const response: Customer = await xenditCustomerClient.getCustomer({
id: "d290f1ee-6c54-4b01-90e6-d701748f0851",
})
```
## GET customers by reference id
## `getCustomerByReferenceID()` Function


### Function Signature
| Name | Value |
|--------------------|:-------------:|
| Function Name | `getCustomerByReferenceID` |
| Request Parameters | [GetCustomerByReferenceIDRequest](#request-parameters--GetCustomerByReferenceIDRequest) |
| Return Type | [GetCustomerByReferenceID200Response](customer/models/GetCustomerByReferenceID200Response.md) |
| Return Type | [GetCustomerByReferenceID200Response](customer/GetCustomerByReferenceID200Response.md) |

### Request Parameters — `GetCustomerByReferenceIDRequest`
| Field Name | Required | Type |
|-----------|:----------:|:----------:|
| referenceId| ✅ | string |
| forUserId| | string |
### Request Parameters - GetCustomerByReferenceIDRequest
| Field Name | Type | Required | Default |
|-----------|:----------:|:----------:|-----------|
| **referenceId** | **string** | ☑️ | |
| **forUserId** | **string** | | |

### Usage Examples
#### Minimum API Usage
### Usage Example
```typescript
import { GetCustomerByReferenceID200Response } from 'xendit-node/customer/models'

const response: GetCustomerByReferenceID200Response = await xenditCustomerClient.getCustomerByReferenceID({
referenceId: "referenceId_example",
})
```
## Update End Customer Resource
## `updateCustomer()` Function


### Function Signature
| Name | Value |
|--------------------|:-------------:|
| Function Name | `updateCustomer` |
| Request Parameters | [UpdateCustomerRequest](#request-parameters--UpdateCustomerRequest) |
| Return Type | [Customer](customer/models/Customer.md) |
| Return Type | [Customer](customer/Customer.md) |

### Request Parameters — `UpdateCustomerRequest`
| Field Name | Required | Type |
|-----------|:----------:|:----------:|
| id| ✅ | string |
| forUserId| | string |
| data| | [PatchCustomer](customer/models/PatchCustomer.md) |
### Request Parameters - UpdateCustomerRequest
| Field Name | Type | Required | Default |
|-----------|:----------:|:----------:|-----------|
| **id** | **string** | ☑️ | |
| **forUserId** | **string** | | |
| **data** | [**PatchCustomer**](customer/PatchCustomer.md) | | |

### Usage Examples
#### Minimum API Usage
### Usage Example
```typescript
import { Customer } from 'xendit-node/customer/models'

const response: Customer = await xenditCustomerClient.updateCustomer({
id: "d290f1ee-6c54-4b01-90e6-d701748f0851",
})
```

[[Back to README]](../README.md)
Loading

0 comments on commit 1c908ce

Please sign in to comment.