devdraft 1.0.0
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.
- checksums.yaml +7 -0
- data/Gemfile +9 -0
- data/README.md +1246 -0
- data/Rakefile +8 -0
- data/devdraft_ai_sdk.gemspec +38 -0
- data/docs/APIHealthApi.md +87 -0
- data/docs/AggregatedBalanceResponse.md +9 -0
- data/docs/AllBalancesResponse.md +9 -0
- data/docs/AllOfAllBalancesResponseEurc.md +9 -0
- data/docs/AllOfAllBalancesResponseUsdc.md +9 -0
- data/docs/AllOfCreateBankPaymentIntentDtoDestinationCurrency.md +6 -0
- data/docs/AllOfCreateBankPaymentIntentDtoDestinationNetwork.md +6 -0
- data/docs/AllOfCreateBankPaymentIntentDtoSourceCurrency.md +6 -0
- data/docs/AllOfCreateBankPaymentIntentDtoSourcePaymentRail.md +6 -0
- data/docs/AllOfCreateCustomerDtoStatus.md +6 -0
- data/docs/AllOfCreateLiquidationAddressDtoDestinationCurrency.md +6 -0
- data/docs/AllOfCreateLiquidationAddressDtoDestinationPaymentRail.md +6 -0
- data/docs/AllOfCreateStablePaymentIntentDtoDestinationCurrency.md +6 -0
- data/docs/AllOfCreateStablePaymentIntentDtoDestinationNetwork.md +6 -0
- data/docs/AllOfCreateStablePaymentIntentDtoSourceCurrency.md +6 -0
- data/docs/AllOfCreateStablePaymentIntentDtoSourceNetwork.md +6 -0
- data/docs/AllOfUpdateCustomerDtoStatus.md +6 -0
- data/docs/AppBalancesApi.md +169 -0
- data/docs/BridgePaymentRail.md +6 -0
- data/docs/CreateBankPaymentIntentDto.md +24 -0
- data/docs/CreateCustomerDto.md +12 -0
- data/docs/CreateDirectBankTransferDto.md +14 -0
- data/docs/CreateDirectWalletTransferDto.md +10 -0
- data/docs/CreateInvoiceDto.md +22 -0
- data/docs/CreateLiquidationAddressDto.md +21 -0
- data/docs/CreatePaymentLinkDto.md +31 -0
- data/docs/CreateProductDto.md +18 -0
- data/docs/CreateStablePaymentIntentDto.md +21 -0
- data/docs/CreateStablecoinConversionDto.md +11 -0
- data/docs/CreateTaxInput.md +6 -0
- data/docs/CreateWebhookDto.md +11 -0
- data/docs/CustomerStatus.md +6 -0
- data/docs/CustomersApi.md +250 -0
- data/docs/DestinationCurrency.md +6 -0
- data/docs/ExchangeRateResponseDto.md +12 -0
- data/docs/ExchangeRatesApi.md +176 -0
- data/docs/FiatCurrency.md +6 -0
- data/docs/HealthResponseDto.md +12 -0
- data/docs/InvoiceProductDto.md +8 -0
- data/docs/InvoicesApi.md +236 -0
- data/docs/LiquidationAddressResponseDto.md +20 -0
- data/docs/LiquidationAddressesApi.md +152 -0
- data/docs/PaymentIntentsApi.md +127 -0
- data/docs/PaymentLinkProductDto.md +8 -0
- data/docs/PaymentLinksApi.md +238 -0
- data/docs/PaymentRequestDto.md +10 -0
- data/docs/PaymentResponseDto.md +11 -0
- data/docs/ProductsApi.md +404 -0
- data/docs/PublicHealthResponseDto.md +9 -0
- data/docs/RefundResponseDto.md +11 -0
- data/docs/StableCoinCurrency.md +6 -0
- data/docs/TaxesApi.md +292 -0
- data/docs/TestPaymentsApi.md +150 -0
- data/docs/TransfersApi.md +175 -0
- data/docs/UpdateCustomerDto.md +12 -0
- data/docs/UpdatePaymentLinkDto.md +6 -0
- data/docs/UpdatePreferenceInput.md +6 -0
- data/docs/UpdateProductDto.md +18 -0
- data/docs/UpdateTaxInput.md +6 -0
- data/docs/UpdateWebhookDto.md +11 -0
- data/docs/WalletsApi.md +58 -0
- data/docs/WebhookResponseDto.md +14 -0
- data/docs/WebhooksApi.md +307 -0
- data/git_push.sh +44 -0
- data/lib/devdraft/api/api_health_api.rb +116 -0
- data/lib/devdraft/api/app_balances_api.rb +170 -0
- data/lib/devdraft/api/customers_api.rb +258 -0
- data/lib/devdraft/api/exchange_rates_api.rb +184 -0
- data/lib/devdraft/api/invoices_api.rb +238 -0
- data/lib/devdraft/api/liquidation_addresses_api.rb +202 -0
- data/lib/devdraft/api/payment_intents_api.rb +150 -0
- data/lib/devdraft/api/payment_links_api.rb +240 -0
- data/lib/devdraft/api/products_api.rb +518 -0
- data/lib/devdraft/api/taxes_api.rb +290 -0
- data/lib/devdraft/api/test_payments_api.rb +202 -0
- data/lib/devdraft/api/transfers_api.rb +182 -0
- data/lib/devdraft/api/wallets_api.rb +66 -0
- data/lib/devdraft/api/webhooks_api.rb +310 -0
- data/lib/devdraft/api_client.rb +388 -0
- data/lib/devdraft/api_error.rb +57 -0
- data/lib/devdraft/configuration.rb +219 -0
- data/lib/devdraft/models/aggregated_balance_response.rb +278 -0
- data/lib/devdraft/models/all_balances_response.rb +242 -0
- data/lib/devdraft/models/all_of_all_balances_response_eurc.rb +283 -0
- data/lib/devdraft/models/all_of_all_balances_response_usdc.rb +283 -0
- data/lib/devdraft/models/all_of_create_bank_payment_intent_dto_destination_currency.rb +202 -0
- data/lib/devdraft/models/all_of_create_bank_payment_intent_dto_destination_network.rb +202 -0
- data/lib/devdraft/models/all_of_create_bank_payment_intent_dto_source_currency.rb +202 -0
- data/lib/devdraft/models/all_of_create_bank_payment_intent_dto_source_payment_rail.rb +202 -0
- data/lib/devdraft/models/all_of_create_customer_dto_status.rb +202 -0
- data/lib/devdraft/models/all_of_create_liquidation_address_dto_destination_currency.rb +202 -0
- data/lib/devdraft/models/all_of_create_liquidation_address_dto_destination_payment_rail.rb +202 -0
- data/lib/devdraft/models/all_of_create_stable_payment_intent_dto_destination_currency.rb +202 -0
- data/lib/devdraft/models/all_of_create_stable_payment_intent_dto_destination_network.rb +202 -0
- data/lib/devdraft/models/all_of_create_stable_payment_intent_dto_source_currency.rb +202 -0
- data/lib/devdraft/models/all_of_create_stable_payment_intent_dto_source_network.rb +202 -0
- data/lib/devdraft/models/all_of_update_customer_dto_status.rb +202 -0
- data/lib/devdraft/models/bridge_payment_rail.rb +43 -0
- data/lib/devdraft/models/create_bank_payment_intent_dto.rb +397 -0
- data/lib/devdraft/models/create_customer_dto.rb +308 -0
- data/lib/devdraft/models/create_direct_bank_transfer_dto.rb +302 -0
- data/lib/devdraft/models/create_direct_wallet_transfer_dto.rb +257 -0
- data/lib/devdraft/models/create_invoice_dto.rb +474 -0
- data/lib/devdraft/models/create_liquidation_address_dto.rb +408 -0
- data/lib/devdraft/models/create_payment_link_dto.rb +603 -0
- data/lib/devdraft/models/create_product_dto.rb +370 -0
- data/lib/devdraft/models/create_stable_payment_intent_dto.rb +362 -0
- data/lib/devdraft/models/create_stablecoin_conversion_dto.rb +272 -0
- data/lib/devdraft/models/create_tax_input.rb +197 -0
- data/lib/devdraft/models/create_webhook_dto.rb +271 -0
- data/lib/devdraft/models/customer_status.rb +29 -0
- data/lib/devdraft/models/destination_currency.rb +34 -0
- data/lib/devdraft/models/exchange_rate_response_dto.rb +282 -0
- data/lib/devdraft/models/fiat_currency.rb +29 -0
- data/lib/devdraft/models/health_response_dto.rb +333 -0
- data/lib/devdraft/models/invoice_product_dto.rb +227 -0
- data/lib/devdraft/models/liquidation_address_response_dto.rb +377 -0
- data/lib/devdraft/models/payment_link_product_dto.rb +229 -0
- data/lib/devdraft/models/payment_request_dto.rb +252 -0
- data/lib/devdraft/models/payment_response_dto.rb +272 -0
- data/lib/devdraft/models/public_health_response_dto.rb +276 -0
- data/lib/devdraft/models/refund_response_dto.rb +272 -0
- data/lib/devdraft/models/stable_coin_currency.rb +28 -0
- data/lib/devdraft/models/update_customer_dto.rb +293 -0
- data/lib/devdraft/models/update_payment_link_dto.rb +197 -0
- data/lib/devdraft/models/update_preference_input.rb +197 -0
- data/lib/devdraft/models/update_product_dto.rb +355 -0
- data/lib/devdraft/models/update_tax_input.rb +197 -0
- data/lib/devdraft/models/update_webhook_dto.rb +251 -0
- data/lib/devdraft/models/webhook_response_dto.rb +317 -0
- data/lib/devdraft/version.rb +14 -0
- data/lib/devdraft.rb +101 -0
- data/spec/api/api_health_api_spec.rb +54 -0
- data/spec/api/app_balances_api_spec.rb +67 -0
- data/spec/api/customers_api_spec.rb +87 -0
- data/spec/api/exchange_rates_api_spec.rb +69 -0
- data/spec/api/invoices_api_spec.rb +80 -0
- data/spec/api/liquidation_addresses_api_spec.rb +72 -0
- data/spec/api/payment_intents_api_spec.rb +60 -0
- data/spec/api/payment_links_api_spec.rb +81 -0
- data/spec/api/products_api_spec.rb +130 -0
- data/spec/api/taxes_api_spec.rb +91 -0
- data/spec/api/test_payments_api_spec.rb +71 -0
- data/spec/api/transfers_api_spec.rb +67 -0
- data/spec/api/wallets_api_spec.rb +44 -0
- data/spec/api/webhooks_api_spec.rb +96 -0
- data/spec/api_client_spec.rb +225 -0
- data/spec/base_object_spec.rb +109 -0
- data/spec/configuration_spec.rb +41 -0
- data/spec/models/aggregated_balance_response_spec.rb +56 -0
- data/spec/models/all_balances_response_spec.rb +52 -0
- data/spec/models/all_of_all_balances_response_eurc_spec.rb +56 -0
- data/spec/models/all_of_all_balances_response_usdc_spec.rb +56 -0
- data/spec/models/all_of_create_bank_payment_intent_dto_destination_currency_spec.rb +34 -0
- data/spec/models/all_of_create_bank_payment_intent_dto_destination_network_spec.rb +34 -0
- data/spec/models/all_of_create_bank_payment_intent_dto_source_currency_spec.rb +34 -0
- data/spec/models/all_of_create_bank_payment_intent_dto_source_payment_rail_spec.rb +34 -0
- data/spec/models/all_of_create_customer_dto_status_spec.rb +34 -0
- data/spec/models/all_of_create_liquidation_address_dto_destination_currency_spec.rb +34 -0
- data/spec/models/all_of_create_liquidation_address_dto_destination_payment_rail_spec.rb +34 -0
- data/spec/models/all_of_create_stable_payment_intent_dto_destination_currency_spec.rb +34 -0
- data/spec/models/all_of_create_stable_payment_intent_dto_destination_network_spec.rb +34 -0
- data/spec/models/all_of_create_stable_payment_intent_dto_source_currency_spec.rb +34 -0
- data/spec/models/all_of_create_stable_payment_intent_dto_source_network_spec.rb +34 -0
- data/spec/models/all_of_update_customer_dto_status_spec.rb +34 -0
- data/spec/models/bridge_payment_rail_spec.rb +34 -0
- data/spec/models/create_bank_payment_intent_dto_spec.rb +142 -0
- data/spec/models/create_customer_dto_spec.rb +74 -0
- data/spec/models/create_direct_bank_transfer_dto_spec.rb +82 -0
- data/spec/models/create_direct_wallet_transfer_dto_spec.rb +58 -0
- data/spec/models/create_invoice_dto_spec.rb +146 -0
- data/spec/models/create_liquidation_address_dto_spec.rb +132 -0
- data/spec/models/create_payment_link_dto_spec.rb +200 -0
- data/spec/models/create_product_dto_spec.rb +110 -0
- data/spec/models/create_stable_payment_intent_dto_spec.rb +124 -0
- data/spec/models/create_stablecoin_conversion_dto_spec.rb +64 -0
- data/spec/models/create_tax_input_spec.rb +34 -0
- data/spec/models/create_webhook_dto_spec.rb +64 -0
- data/spec/models/customer_status_spec.rb +34 -0
- data/spec/models/destination_currency_spec.rb +34 -0
- data/spec/models/exchange_rate_response_dto_spec.rb +70 -0
- data/spec/models/fiat_currency_spec.rb +34 -0
- data/spec/models/health_response_dto_spec.rb +78 -0
- data/spec/models/invoice_product_dto_spec.rb +46 -0
- data/spec/models/liquidation_address_response_dto_spec.rb +118 -0
- data/spec/models/payment_link_product_dto_spec.rb +46 -0
- data/spec/models/payment_request_dto_spec.rb +58 -0
- data/spec/models/payment_response_dto_spec.rb +64 -0
- data/spec/models/public_health_response_dto_spec.rb +56 -0
- data/spec/models/refund_response_dto_spec.rb +64 -0
- data/spec/models/stable_coin_currency_spec.rb +34 -0
- data/spec/models/update_customer_dto_spec.rb +74 -0
- data/spec/models/update_payment_link_dto_spec.rb +34 -0
- data/spec/models/update_preference_input_spec.rb +34 -0
- data/spec/models/update_product_dto_spec.rb +110 -0
- data/spec/models/update_tax_input_spec.rb +34 -0
- data/spec/models/update_webhook_dto_spec.rb +64 -0
- data/spec/models/webhook_response_dto_spec.rb +82 -0
- data/spec/spec_helper.rb +110 -0
- metadata +375 -0
@@ -0,0 +1,11 @@
|
|
1
|
+
# DevDraftAI::CreateWebhookDto
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**name** | **String** | Name of the webhook for identification purposes |
|
7
|
+
**url** | **String** | URL where webhook events will be sent |
|
8
|
+
**is_active** | **BOOLEAN** | Whether the webhook is active and will receive events | [default to true]
|
9
|
+
**signing_secret** | **String** | Secret key used to sign webhook payloads for verification | [optional]
|
10
|
+
**encrypted** | **BOOLEAN** | Whether webhook payloads should be encrypted | [default to false]
|
11
|
+
|
@@ -0,0 +1,250 @@
|
|
1
|
+
# DevDraftAI::CustomersApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.devdraft.ai*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**customer_controller_create**](CustomersApi.md#customer_controller_create) | **POST** /api/v0/customers | Create a new customer
|
8
|
+
[**customer_controller_find_all**](CustomersApi.md#customer_controller_find_all) | **GET** /api/v0/customers | Get all customers with filters
|
9
|
+
[**customer_controller_find_one**](CustomersApi.md#customer_controller_find_one) | **GET** /api/v0/customers/{id} | Get a customer by ID
|
10
|
+
[**customer_controller_update**](CustomersApi.md#customer_controller_update) | **PATCH** /api/v0/customers/{id} | Update a customer
|
11
|
+
|
12
|
+
# **customer_controller_create**
|
13
|
+
> customer_controller_create(body)
|
14
|
+
|
15
|
+
Create a new customer
|
16
|
+
|
17
|
+
Creates a new customer in the system with their personal and contact information. This endpoint allows you to register new customers and store their details for future transactions. ## Use Cases - Register new customers for payment processing - Store customer information for recurring payments - Maintain customer profiles for transaction history ## Example: Create New Customer ```json { \"firstName\": \"John\", \"lastName\": \"Doe\", \"email\": \"john.doe@example.com\", \"phone\": \"+1234567890\", \"address\": { \"street\": \"123 Main St\", \"city\": \"New York\", \"state\": \"NY\", \"zipCode\": \"10001\", \"country\": \"USA\" } } ``` ## Required Fields - `firstName`: Customer's first name - `lastName`: Customer's last name - `email`: Valid email address (must be unique) ## Optional Fields - `phone`: Contact phone number - `address`: Complete address information - `street`: Street address - `city`: City name - `state`: State/province - `zipCode`: Postal/ZIP code - `country`: Country name
|
18
|
+
|
19
|
+
### Example
|
20
|
+
```ruby
|
21
|
+
# load the gem
|
22
|
+
require 'devdraft_ai_sdk'
|
23
|
+
# setup authorization
|
24
|
+
DevDraftAI.configure do |config|
|
25
|
+
# Configure API key authorization: x-client-key
|
26
|
+
config.api_key['x-client-key'] = 'YOUR API KEY'
|
27
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
28
|
+
#config.api_key_prefix['x-client-key'] = 'Bearer'
|
29
|
+
|
30
|
+
# Configure API key authorization: x-client-secret
|
31
|
+
config.api_key['x-client-secret'] = 'YOUR API KEY'
|
32
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
33
|
+
#config.api_key_prefix['x-client-secret'] = 'Bearer'
|
34
|
+
end
|
35
|
+
|
36
|
+
api_instance = DevDraftAI::CustomersApi.new
|
37
|
+
body = DevDraftAI::CreateCustomerDto.new # CreateCustomerDto | Customer creation data
|
38
|
+
|
39
|
+
|
40
|
+
begin
|
41
|
+
#Create a new customer
|
42
|
+
api_instance.customer_controller_create(body)
|
43
|
+
rescue DevDraftAI::ApiError => e
|
44
|
+
puts "Exception when calling CustomersApi->customer_controller_create: #{e}"
|
45
|
+
end
|
46
|
+
```
|
47
|
+
|
48
|
+
### Parameters
|
49
|
+
|
50
|
+
Name | Type | Description | Notes
|
51
|
+
------------- | ------------- | ------------- | -------------
|
52
|
+
**body** | [**CreateCustomerDto**](CreateCustomerDto.md)| Customer creation data |
|
53
|
+
|
54
|
+
### Return type
|
55
|
+
|
56
|
+
nil (empty response body)
|
57
|
+
|
58
|
+
### Authorization
|
59
|
+
|
60
|
+
[x-client-key](../README.md#x-client-key), [x-client-secret](../README.md#x-client-secret)
|
61
|
+
|
62
|
+
### HTTP request headers
|
63
|
+
|
64
|
+
- **Content-Type**: application/json
|
65
|
+
- **Accept**: Not defined
|
66
|
+
|
67
|
+
|
68
|
+
|
69
|
+
# **customer_controller_find_all**
|
70
|
+
> customer_controller_find_all(opts)
|
71
|
+
|
72
|
+
Get all customers with filters
|
73
|
+
|
74
|
+
Retrieves a list of customers with optional filtering and pagination. This endpoint allows you to search and filter customers based on various criteria. ## Use Cases - List all customers with pagination - Search customers by name or email - Filter customers by status - Export customer data ## Query Parameters - `skip`: Number of records to skip (default: 0) - `take`: Number of records to take (default: 10) - `status`: Filter by customer status (ACTIVE, INACTIVE, SUSPENDED) - `name`: Filter by customer name (partial match) - `email`: Filter by customer email (exact match) ## Example Response ```json { \"data\": [ { \"id\": \"cust_123456\", \"firstName\": \"John\", \"lastName\": \"Doe\", \"email\": \"john.doe@example.com\", \"status\": \"ACTIVE\", \"createdAt\": \"2024-03-20T10:00:00Z\" } ], \"total\": 100, \"skip\": 0, \"take\": 10 } ```
|
75
|
+
|
76
|
+
### Example
|
77
|
+
```ruby
|
78
|
+
# load the gem
|
79
|
+
require 'devdraft_ai_sdk'
|
80
|
+
# setup authorization
|
81
|
+
DevDraftAI.configure do |config|
|
82
|
+
# Configure API key authorization: x-client-key
|
83
|
+
config.api_key['x-client-key'] = 'YOUR API KEY'
|
84
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
85
|
+
#config.api_key_prefix['x-client-key'] = 'Bearer'
|
86
|
+
|
87
|
+
# Configure API key authorization: x-client-secret
|
88
|
+
config.api_key['x-client-secret'] = 'YOUR API KEY'
|
89
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
90
|
+
#config.api_key_prefix['x-client-secret'] = 'Bearer'
|
91
|
+
end
|
92
|
+
|
93
|
+
api_instance = DevDraftAI::CustomersApi.new
|
94
|
+
opts = {
|
95
|
+
status: 'status_example', # String | Filter by customer status
|
96
|
+
name: 'name_example', # String | Filter by customer name
|
97
|
+
email: 'email_example', # String | Filter by customer email
|
98
|
+
take: DevDraftAI::BigDecimal.new, # BigDecimal | Number of records to take
|
99
|
+
skip: DevDraftAI::BigDecimal.new # BigDecimal | Number of records to skip
|
100
|
+
}
|
101
|
+
|
102
|
+
begin
|
103
|
+
#Get all customers with filters
|
104
|
+
api_instance.customer_controller_find_all(opts)
|
105
|
+
rescue DevDraftAI::ApiError => e
|
106
|
+
puts "Exception when calling CustomersApi->customer_controller_find_all: #{e}"
|
107
|
+
end
|
108
|
+
```
|
109
|
+
|
110
|
+
### Parameters
|
111
|
+
|
112
|
+
Name | Type | Description | Notes
|
113
|
+
------------- | ------------- | ------------- | -------------
|
114
|
+
**status** | **String**| Filter by customer status | [optional]
|
115
|
+
**name** | **String**| Filter by customer name | [optional]
|
116
|
+
**email** | **String**| Filter by customer email | [optional]
|
117
|
+
**take** | **BigDecimal**| Number of records to take | [optional]
|
118
|
+
**skip** | **BigDecimal**| Number of records to skip | [optional]
|
119
|
+
|
120
|
+
### Return type
|
121
|
+
|
122
|
+
nil (empty response body)
|
123
|
+
|
124
|
+
### Authorization
|
125
|
+
|
126
|
+
[x-client-key](../README.md#x-client-key), [x-client-secret](../README.md#x-client-secret)
|
127
|
+
|
128
|
+
### HTTP request headers
|
129
|
+
|
130
|
+
- **Content-Type**: Not defined
|
131
|
+
- **Accept**: Not defined
|
132
|
+
|
133
|
+
|
134
|
+
|
135
|
+
# **customer_controller_find_one**
|
136
|
+
> customer_controller_find_one(id)
|
137
|
+
|
138
|
+
Get a customer by ID
|
139
|
+
|
140
|
+
Retrieves detailed information about a specific customer. This endpoint allows you to fetch complete customer details including their address and contact information. ## Use Cases - View customer details - Verify customer information - Update customer records ## Example Response ```json { \"id\": \"cust_123456\", \"firstName\": \"John\", \"lastName\": \"Doe\", \"email\": \"john.doe@example.com\", \"phone\": \"+1234567890\", \"status\": \"ACTIVE\", \"address\": { \"street\": \"123 Main St\", \"city\": \"New York\", \"state\": \"NY\", \"zipCode\": \"10001\", \"country\": \"USA\" }, \"createdAt\": \"2024-03-20T10:00:00Z\", \"updatedAt\": \"2024-03-20T10:00:00Z\" } ```
|
141
|
+
|
142
|
+
### Example
|
143
|
+
```ruby
|
144
|
+
# load the gem
|
145
|
+
require 'devdraft_ai_sdk'
|
146
|
+
# setup authorization
|
147
|
+
DevDraftAI.configure do |config|
|
148
|
+
# Configure API key authorization: x-client-key
|
149
|
+
config.api_key['x-client-key'] = 'YOUR API KEY'
|
150
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
151
|
+
#config.api_key_prefix['x-client-key'] = 'Bearer'
|
152
|
+
|
153
|
+
# Configure API key authorization: x-client-secret
|
154
|
+
config.api_key['x-client-secret'] = 'YOUR API KEY'
|
155
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
156
|
+
#config.api_key_prefix['x-client-secret'] = 'Bearer'
|
157
|
+
end
|
158
|
+
|
159
|
+
api_instance = DevDraftAI::CustomersApi.new
|
160
|
+
id = 'id_example' # String |
|
161
|
+
|
162
|
+
|
163
|
+
begin
|
164
|
+
#Get a customer by ID
|
165
|
+
api_instance.customer_controller_find_one(id)
|
166
|
+
rescue DevDraftAI::ApiError => e
|
167
|
+
puts "Exception when calling CustomersApi->customer_controller_find_one: #{e}"
|
168
|
+
end
|
169
|
+
```
|
170
|
+
|
171
|
+
### Parameters
|
172
|
+
|
173
|
+
Name | Type | Description | Notes
|
174
|
+
------------- | ------------- | ------------- | -------------
|
175
|
+
**id** | **String**| |
|
176
|
+
|
177
|
+
### Return type
|
178
|
+
|
179
|
+
nil (empty response body)
|
180
|
+
|
181
|
+
### Authorization
|
182
|
+
|
183
|
+
[x-client-key](../README.md#x-client-key), [x-client-secret](../README.md#x-client-secret)
|
184
|
+
|
185
|
+
### HTTP request headers
|
186
|
+
|
187
|
+
- **Content-Type**: Not defined
|
188
|
+
- **Accept**: Not defined
|
189
|
+
|
190
|
+
|
191
|
+
|
192
|
+
# **customer_controller_update**
|
193
|
+
> customer_controller_update(bodyid)
|
194
|
+
|
195
|
+
Update a customer
|
196
|
+
|
197
|
+
Updates an existing customer's information. This endpoint allows you to modify customer details while preserving their core information. ## Use Cases - Update customer contact information - Change customer address - Modify customer status ## Example Request ```json { \"firstName\": \"John\", \"lastName\": \"Smith\", \"phone\": \"+1987654321\", \"address\": { \"street\": \"456 Oak St\", \"city\": \"Los Angeles\", \"state\": \"CA\", \"zipCode\": \"90001\", \"country\": \"USA\" } } ``` ## Notes - Only include fields that need to be updated - Email address cannot be changed - Status changes may require additional verification
|
198
|
+
|
199
|
+
### Example
|
200
|
+
```ruby
|
201
|
+
# load the gem
|
202
|
+
require 'devdraft_ai_sdk'
|
203
|
+
# setup authorization
|
204
|
+
DevDraftAI.configure do |config|
|
205
|
+
# Configure API key authorization: x-client-key
|
206
|
+
config.api_key['x-client-key'] = 'YOUR API KEY'
|
207
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
208
|
+
#config.api_key_prefix['x-client-key'] = 'Bearer'
|
209
|
+
|
210
|
+
# Configure API key authorization: x-client-secret
|
211
|
+
config.api_key['x-client-secret'] = 'YOUR API KEY'
|
212
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
213
|
+
#config.api_key_prefix['x-client-secret'] = 'Bearer'
|
214
|
+
end
|
215
|
+
|
216
|
+
api_instance = DevDraftAI::CustomersApi.new
|
217
|
+
body = DevDraftAI::UpdateCustomerDto.new # UpdateCustomerDto | Customer update data
|
218
|
+
id = 'id_example' # String |
|
219
|
+
|
220
|
+
|
221
|
+
begin
|
222
|
+
#Update a customer
|
223
|
+
api_instance.customer_controller_update(bodyid)
|
224
|
+
rescue DevDraftAI::ApiError => e
|
225
|
+
puts "Exception when calling CustomersApi->customer_controller_update: #{e}"
|
226
|
+
end
|
227
|
+
```
|
228
|
+
|
229
|
+
### Parameters
|
230
|
+
|
231
|
+
Name | Type | Description | Notes
|
232
|
+
------------- | ------------- | ------------- | -------------
|
233
|
+
**body** | [**UpdateCustomerDto**](UpdateCustomerDto.md)| Customer update data |
|
234
|
+
**id** | **String**| |
|
235
|
+
|
236
|
+
### Return type
|
237
|
+
|
238
|
+
nil (empty response body)
|
239
|
+
|
240
|
+
### Authorization
|
241
|
+
|
242
|
+
[x-client-key](../README.md#x-client-key), [x-client-secret](../README.md#x-client-secret)
|
243
|
+
|
244
|
+
### HTTP request headers
|
245
|
+
|
246
|
+
- **Content-Type**: application/json
|
247
|
+
- **Accept**: Not defined
|
248
|
+
|
249
|
+
|
250
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# DevDraftAI::ExchangeRateResponseDto
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**from** | **String** | Source currency code (USD for USDC) |
|
7
|
+
**to** | **String** | Target currency code (EUR for EURC) |
|
8
|
+
**midmarket_rate** | **String** | Mid-market exchange rate from source to target currency |
|
9
|
+
**buy_rate** | **String** | Rate for buying target currency (what you get when converting from source to target) |
|
10
|
+
**sell_rate** | **String** | Rate for selling target currency (what you pay when converting from target to source) |
|
11
|
+
**timestamp** | **String** | Timestamp when the exchange rate was last updated | [optional]
|
12
|
+
|
@@ -0,0 +1,176 @@
|
|
1
|
+
# DevDraftAI::ExchangeRatesApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.devdraft.ai*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**exchange_rate_controller_get_eurto_usd_rate**](ExchangeRatesApi.md#exchange_rate_controller_get_eurto_usd_rate) | **GET** /api/v0/exchange-rate/eur-to-usd | Get EUR to USD exchange rate
|
8
|
+
[**exchange_rate_controller_get_exchange_rate**](ExchangeRatesApi.md#exchange_rate_controller_get_exchange_rate) | **GET** /api/v0/exchange-rate | Get exchange rate between specified currencies
|
9
|
+
[**exchange_rate_controller_get_usdto_eur_rate**](ExchangeRatesApi.md#exchange_rate_controller_get_usdto_eur_rate) | **GET** /api/v0/exchange-rate/usd-to-eur | Get USD to EUR exchange rate
|
10
|
+
|
11
|
+
# **exchange_rate_controller_get_eurto_usd_rate**
|
12
|
+
> ExchangeRateResponseDto exchange_rate_controller_get_eurto_usd_rate
|
13
|
+
|
14
|
+
Get EUR to USD exchange rate
|
15
|
+
|
16
|
+
Retrieves the current exchange rate for converting EUR to USD (EURC to USDC). This endpoint provides real-time exchange rate information for stablecoin conversions: - Mid-market rate for reference pricing - Buy rate for actual conversion calculations - Sell rate for reverse conversion scenarios ## Use Cases - Display current exchange rates in dashboards - Calculate conversion amounts for EURC to USDC transfers - Financial reporting and analytics - Real-time pricing for multi-currency operations ## Rate Information - **Mid-market rate**: The theoretical middle rate between buy and sell - **Buy rate**: Rate used when converting FROM EUR TO USD (what you get) - **Sell rate**: Rate used when converting FROM USD TO EUR (what you pay) The rates are updated in real-time and reflect current market conditions.
|
17
|
+
|
18
|
+
### Example
|
19
|
+
```ruby
|
20
|
+
# load the gem
|
21
|
+
require 'devdraft_ai_sdk'
|
22
|
+
# setup authorization
|
23
|
+
DevDraftAI.configure do |config|
|
24
|
+
# Configure API key authorization: x-client-key
|
25
|
+
config.api_key['x-client-key'] = 'YOUR API KEY'
|
26
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
27
|
+
#config.api_key_prefix['x-client-key'] = 'Bearer'
|
28
|
+
|
29
|
+
# Configure API key authorization: x-client-secret
|
30
|
+
config.api_key['x-client-secret'] = 'YOUR API KEY'
|
31
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
32
|
+
#config.api_key_prefix['x-client-secret'] = 'Bearer'
|
33
|
+
end
|
34
|
+
|
35
|
+
api_instance = DevDraftAI::ExchangeRatesApi.new
|
36
|
+
|
37
|
+
begin
|
38
|
+
#Get EUR to USD exchange rate
|
39
|
+
result = api_instance.exchange_rate_controller_get_eurto_usd_rate
|
40
|
+
p result
|
41
|
+
rescue DevDraftAI::ApiError => e
|
42
|
+
puts "Exception when calling ExchangeRatesApi->exchange_rate_controller_get_eurto_usd_rate: #{e}"
|
43
|
+
end
|
44
|
+
```
|
45
|
+
|
46
|
+
### Parameters
|
47
|
+
This endpoint does not need any parameter.
|
48
|
+
|
49
|
+
### Return type
|
50
|
+
|
51
|
+
[**ExchangeRateResponseDto**](ExchangeRateResponseDto.md)
|
52
|
+
|
53
|
+
### Authorization
|
54
|
+
|
55
|
+
[x-client-key](../README.md#x-client-key), [x-client-secret](../README.md#x-client-secret)
|
56
|
+
|
57
|
+
### HTTP request headers
|
58
|
+
|
59
|
+
- **Content-Type**: Not defined
|
60
|
+
- **Accept**: application/json
|
61
|
+
|
62
|
+
|
63
|
+
|
64
|
+
# **exchange_rate_controller_get_exchange_rate**
|
65
|
+
> ExchangeRateResponseDto exchange_rate_controller_get_exchange_rate(from, to)
|
66
|
+
|
67
|
+
Get exchange rate between specified currencies
|
68
|
+
|
69
|
+
Retrieves the current exchange rate between two specified currencies. This flexible endpoint allows you to get exchange rates for any supported currency pair: - Supports USD and EUR currency codes - Provides comprehensive rate information - Real-time market data ## Supported Currency Pairs - USD to EUR (USDC to EURC) - EUR to USD (EURC to USDC) ## Query Parameters - **from**: Source currency code (usd, eur) - **to**: Target currency code (usd, eur) ## Use Cases - Flexible exchange rate queries - Multi-currency application support - Dynamic currency conversion calculations - Financial analytics and reporting ## Rate Information All rates are provided with full market context including mid-market, buy, and sell rates.
|
70
|
+
|
71
|
+
### Example
|
72
|
+
```ruby
|
73
|
+
# load the gem
|
74
|
+
require 'devdraft_ai_sdk'
|
75
|
+
# setup authorization
|
76
|
+
DevDraftAI.configure do |config|
|
77
|
+
# Configure API key authorization: x-client-key
|
78
|
+
config.api_key['x-client-key'] = 'YOUR API KEY'
|
79
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
80
|
+
#config.api_key_prefix['x-client-key'] = 'Bearer'
|
81
|
+
|
82
|
+
# Configure API key authorization: x-client-secret
|
83
|
+
config.api_key['x-client-secret'] = 'YOUR API KEY'
|
84
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
85
|
+
#config.api_key_prefix['x-client-secret'] = 'Bearer'
|
86
|
+
end
|
87
|
+
|
88
|
+
api_instance = DevDraftAI::ExchangeRatesApi.new
|
89
|
+
from = 'from_example' # String | Source currency code (e.g., usd)
|
90
|
+
to = 'to_example' # String | Target currency code (e.g., eur)
|
91
|
+
|
92
|
+
|
93
|
+
begin
|
94
|
+
#Get exchange rate between specified currencies
|
95
|
+
result = api_instance.exchange_rate_controller_get_exchange_rate(from, to)
|
96
|
+
p result
|
97
|
+
rescue DevDraftAI::ApiError => e
|
98
|
+
puts "Exception when calling ExchangeRatesApi->exchange_rate_controller_get_exchange_rate: #{e}"
|
99
|
+
end
|
100
|
+
```
|
101
|
+
|
102
|
+
### Parameters
|
103
|
+
|
104
|
+
Name | Type | Description | Notes
|
105
|
+
------------- | ------------- | ------------- | -------------
|
106
|
+
**from** | **String**| Source currency code (e.g., usd) |
|
107
|
+
**to** | **String**| Target currency code (e.g., eur) |
|
108
|
+
|
109
|
+
### Return type
|
110
|
+
|
111
|
+
[**ExchangeRateResponseDto**](ExchangeRateResponseDto.md)
|
112
|
+
|
113
|
+
### Authorization
|
114
|
+
|
115
|
+
[x-client-key](../README.md#x-client-key), [x-client-secret](../README.md#x-client-secret)
|
116
|
+
|
117
|
+
### HTTP request headers
|
118
|
+
|
119
|
+
- **Content-Type**: Not defined
|
120
|
+
- **Accept**: application/json
|
121
|
+
|
122
|
+
|
123
|
+
|
124
|
+
# **exchange_rate_controller_get_usdto_eur_rate**
|
125
|
+
> ExchangeRateResponseDto exchange_rate_controller_get_usdto_eur_rate
|
126
|
+
|
127
|
+
Get USD to EUR exchange rate
|
128
|
+
|
129
|
+
Retrieves the current exchange rate for converting USD to EUR (USDC to EURC). This endpoint provides real-time exchange rate information for stablecoin conversions: - Mid-market rate for reference pricing - Buy rate for actual conversion calculations - Sell rate for reverse conversion scenarios ## Use Cases - Display current exchange rates in dashboards - Calculate conversion amounts for USDC to EURC transfers - Financial reporting and analytics - Real-time pricing for multi-currency operations ## Rate Information - **Mid-market rate**: The theoretical middle rate between buy and sell - **Buy rate**: Rate used when converting FROM USD TO EUR (what you get) - **Sell rate**: Rate used when converting FROM EUR TO USD (what you pay) The rates are updated in real-time and reflect current market conditions.
|
130
|
+
|
131
|
+
### Example
|
132
|
+
```ruby
|
133
|
+
# load the gem
|
134
|
+
require 'devdraft_ai_sdk'
|
135
|
+
# setup authorization
|
136
|
+
DevDraftAI.configure do |config|
|
137
|
+
# Configure API key authorization: x-client-key
|
138
|
+
config.api_key['x-client-key'] = 'YOUR API KEY'
|
139
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
140
|
+
#config.api_key_prefix['x-client-key'] = 'Bearer'
|
141
|
+
|
142
|
+
# Configure API key authorization: x-client-secret
|
143
|
+
config.api_key['x-client-secret'] = 'YOUR API KEY'
|
144
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
145
|
+
#config.api_key_prefix['x-client-secret'] = 'Bearer'
|
146
|
+
end
|
147
|
+
|
148
|
+
api_instance = DevDraftAI::ExchangeRatesApi.new
|
149
|
+
|
150
|
+
begin
|
151
|
+
#Get USD to EUR exchange rate
|
152
|
+
result = api_instance.exchange_rate_controller_get_usdto_eur_rate
|
153
|
+
p result
|
154
|
+
rescue DevDraftAI::ApiError => e
|
155
|
+
puts "Exception when calling ExchangeRatesApi->exchange_rate_controller_get_usdto_eur_rate: #{e}"
|
156
|
+
end
|
157
|
+
```
|
158
|
+
|
159
|
+
### Parameters
|
160
|
+
This endpoint does not need any parameter.
|
161
|
+
|
162
|
+
### Return type
|
163
|
+
|
164
|
+
[**ExchangeRateResponseDto**](ExchangeRateResponseDto.md)
|
165
|
+
|
166
|
+
### Authorization
|
167
|
+
|
168
|
+
[x-client-key](../README.md#x-client-key), [x-client-secret](../README.md#x-client-secret)
|
169
|
+
|
170
|
+
### HTTP request headers
|
171
|
+
|
172
|
+
- **Content-Type**: Not defined
|
173
|
+
- **Accept**: application/json
|
174
|
+
|
175
|
+
|
176
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# DevDraftAI::HealthResponseDto
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**status** | **String** | Overall health status of the service. Returns \"ok\" when healthy, \"error\" when issues detected. |
|
7
|
+
**timestamp** | **DateTime** | ISO 8601 timestamp when the health check was performed. |
|
8
|
+
**version** | **String** | Current version of the API service. Useful for debugging and compatibility checks. |
|
9
|
+
**database** | **String** | Database connectivity status. Shows \"connected\" when database is accessible, \"error\" when connection fails. |
|
10
|
+
**message** | **String** | Human-readable message describing the current health status and any issues. |
|
11
|
+
**authenticated** | **BOOLEAN** | Indicates whether the request was properly authenticated. Always true for this endpoint since authentication is required. |
|
12
|
+
|
@@ -0,0 +1,8 @@
|
|
1
|
+
# DevDraftAI::InvoiceProductDto
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**product_id** | **String** | Product ID |
|
7
|
+
**quantity** | [**BigDecimal**](BigDecimal.md) | Quantity of the product |
|
8
|
+
|