conekta 7.0.0 → 7.0.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.
- checksums.yaml +4 -4
- data/README.md +16 -8
- data/VERSION +1 -1
- data/config-ruby.json +1 -1
- data/docs/ChargesApi.md +2 -2
- data/docs/CheckoutOrderTemplate.md +2 -0
- data/docs/CheckoutRequest.md +3 -1
- data/docs/CheckoutResponse.md +2 -0
- data/docs/CompaniesApi.md +296 -0
- data/docs/CompanyDocumentRequest.md +26 -0
- data/docs/CompanyDocumentResponse.md +22 -0
- data/docs/CompanyResponse.md +18 -16
- data/docs/CompanyResponseDocumentsInner.md +22 -0
- data/docs/CreateCompanyRequest.md +26 -0
- data/docs/CreateCompanyRequestBankAccountInfo.md +18 -0
- data/docs/CreateCompanyRequestComercialInfo.md +24 -0
- data/docs/CreateCompanyRequestFiscalInfo.md +20 -0
- data/docs/PaymentMethodBnplRequest.md +1 -1
- data/docs/PaymentMethodSpeiRecurrent.md +2 -0
- data/examples/README.md +15 -0
- data/examples/one_time_charge_bnpl.rb +46 -0
- data/lib/conekta/api/companies_api.rb +300 -0
- data/lib/conekta/models/checkout_order_template.rb +13 -1
- data/lib/conekta/models/checkout_request.rb +36 -2
- data/lib/conekta/models/checkout_response.rb +13 -1
- data/lib/conekta/models/company_document_request.rb +318 -0
- data/lib/conekta/models/company_document_response.rb +291 -0
- data/lib/conekta/models/company_response.rb +110 -74
- data/lib/conekta/models/company_response_documents_inner.rb +270 -0
- data/lib/conekta/models/create_company_request.rb +252 -0
- data/lib/conekta/models/create_company_request_bank_account_info.rb +216 -0
- data/lib/conekta/models/create_company_request_comercial_info.rb +246 -0
- data/lib/conekta/models/create_company_request_fiscal_info.rb +226 -0
- data/lib/conekta/models/payment_method_bnpl_request.rb +2 -2
- data/lib/conekta/models/payment_method_spei_recurrent.rb +11 -1
- data/lib/conekta/version.rb +1 -1
- data/lib/conekta.rb +7 -3
- data/spec/api/companies_api_spec.rb +53 -0
- metadata +35 -22
- data/docs/CompanyFiscalInfoAddressResponse.md +0 -34
- data/docs/CompanyFiscalInfoResponse.md +0 -30
- data/docs/CompanyPayoutDestinationResponse.md +0 -28
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: ff083736647e4a2a1bbddcf3e5d57e81403f7ee9a82f9dacb294b155bd5396a2
|
4
|
+
data.tar.gz: 5a03cd892d7372cba452deb3528016e9690d73fa94e6d9c5ab0bbfea109e1147
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 54ece98b573205a219b1c02457464c5ec77a40d1586a98822e7f45fc2a4358906c7cd4e63e01c5cfdac5fb9f1d6a2069dae32590eb3c22a1536a2bf5b8c0b2e7
|
7
|
+
data.tar.gz: 94424e23797677a0f0751c7b53aafede9ea3c7c2e6c63311b0bed9471cd758faf9949bb7992a4501a3056d93f94a8c13e8f5931761de5d516660e9320f1370f1
|
data/README.md
CHANGED
@@ -7,8 +7,8 @@ Conekta sdk
|
|
7
7
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
8
8
|
|
9
9
|
- API version: 2.2.0
|
10
|
-
- Package version: 7.0.
|
11
|
-
- Build date: 2025-
|
10
|
+
- Package version: 7.0.2
|
11
|
+
- Build date: 2025-08-11T14:08:22.258333756Z[Etc/UTC]
|
12
12
|
- Generator version: 7.5.0
|
13
13
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
14
14
|
For more information, please visit [https://github.com/conekta/openapi/issues](https://github.com/conekta/openapi/issues)
|
@@ -26,16 +26,16 @@ gem build conekta.gemspec
|
|
26
26
|
Then either install the gem locally:
|
27
27
|
|
28
28
|
```shell
|
29
|
-
gem install ./conekta-7.0.
|
29
|
+
gem install ./conekta-7.0.2.gem
|
30
30
|
```
|
31
31
|
|
32
|
-
(for development, run `gem install --dev ./conekta-7.0.
|
32
|
+
(for development, run `gem install --dev ./conekta-7.0.2.gem` to install the development dependencies)
|
33
33
|
|
34
34
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
35
35
|
|
36
36
|
Finally add this to the Gemfile:
|
37
37
|
|
38
|
-
gem 'conekta', '~> 7.0.
|
38
|
+
gem 'conekta', '~> 7.0.2'
|
39
39
|
|
40
40
|
### Install from Git
|
41
41
|
|
@@ -107,8 +107,12 @@ Class | Method | HTTP request | Description
|
|
107
107
|
*Conekta::ChargesApi* | [**orders_create_charge**](docs/ChargesApi.md#orders_create_charge) | **POST** /orders/{id}/charges | Create charge
|
108
108
|
*Conekta::ChargesApi* | [**orders_create_charges**](docs/ChargesApi.md#orders_create_charges) | **POST** /orders/{id}/add_charges | Create charges
|
109
109
|
*Conekta::ChargesApi* | [**update_charge**](docs/ChargesApi.md#update_charge) | **PUT** /charges/{id} | Update a charge
|
110
|
+
*Conekta::CompaniesApi* | [**create_company**](docs/CompaniesApi.md#create_company) | **POST** /companies | Create Company
|
110
111
|
*Conekta::CompaniesApi* | [**get_companies**](docs/CompaniesApi.md#get_companies) | **GET** /companies | Get List of Companies
|
111
112
|
*Conekta::CompaniesApi* | [**get_company**](docs/CompaniesApi.md#get_company) | **GET** /companies/{id} | Get Company
|
113
|
+
*Conekta::CompaniesApi* | [**get_company_documents**](docs/CompaniesApi.md#get_company_documents) | **GET** /companies/{company_id}/documents | Get Company Documents
|
114
|
+
*Conekta::CompaniesApi* | [**update_company_document**](docs/CompaniesApi.md#update_company_document) | **PATCH** /companies/{company_id}/document | Update Company Document
|
115
|
+
*Conekta::CompaniesApi* | [**upload_company_document**](docs/CompaniesApi.md#upload_company_document) | **POST** /companies/{company_id}/document | Upload Company Document
|
112
116
|
*Conekta::CustomersApi* | [**create_customer**](docs/CustomersApi.md#create_customer) | **POST** /customers | Create customer
|
113
117
|
*Conekta::CustomersApi* | [**create_customer_fiscal_entities**](docs/CustomersApi.md#create_customer_fiscal_entities) | **POST** /customers/{id}/fiscal_entities | Create Fiscal Entity
|
114
118
|
*Conekta::CustomersApi* | [**delete_customer_by_id**](docs/CustomersApi.md#delete_customer_by_id) | **DELETE** /customers/{id} | Delete Customer
|
@@ -228,10 +232,14 @@ Class | Method | HTTP request | Description
|
|
228
232
|
- [Conekta::CheckoutRequest](docs/CheckoutRequest.md)
|
229
233
|
- [Conekta::CheckoutResponse](docs/CheckoutResponse.md)
|
230
234
|
- [Conekta::CheckoutsResponse](docs/CheckoutsResponse.md)
|
231
|
-
- [Conekta::
|
232
|
-
- [Conekta::
|
233
|
-
- [Conekta::CompanyPayoutDestinationResponse](docs/CompanyPayoutDestinationResponse.md)
|
235
|
+
- [Conekta::CompanyDocumentRequest](docs/CompanyDocumentRequest.md)
|
236
|
+
- [Conekta::CompanyDocumentResponse](docs/CompanyDocumentResponse.md)
|
234
237
|
- [Conekta::CompanyResponse](docs/CompanyResponse.md)
|
238
|
+
- [Conekta::CompanyResponseDocumentsInner](docs/CompanyResponseDocumentsInner.md)
|
239
|
+
- [Conekta::CreateCompanyRequest](docs/CreateCompanyRequest.md)
|
240
|
+
- [Conekta::CreateCompanyRequestBankAccountInfo](docs/CreateCompanyRequestBankAccountInfo.md)
|
241
|
+
- [Conekta::CreateCompanyRequestComercialInfo](docs/CreateCompanyRequestComercialInfo.md)
|
242
|
+
- [Conekta::CreateCompanyRequestFiscalInfo](docs/CreateCompanyRequestFiscalInfo.md)
|
235
243
|
- [Conekta::CreateCustomerFiscalEntitiesResponse](docs/CreateCustomerFiscalEntitiesResponse.md)
|
236
244
|
- [Conekta::CreateCustomerPaymentMethodsRequest](docs/CreateCustomerPaymentMethodsRequest.md)
|
237
245
|
- [Conekta::CreateCustomerPaymentMethodsResponse](docs/CreateCustomerPaymentMethodsResponse.md)
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
7.0.
|
1
|
+
7.0.2
|
data/config-ruby.json
CHANGED
data/docs/ChargesApi.md
CHANGED
@@ -110,7 +110,7 @@ end
|
|
110
110
|
|
111
111
|
api_instance = Conekta::ChargesApi.new
|
112
112
|
id = '6307a60c41de27127515a575' # String | Identifier of the resource
|
113
|
-
charge_request = Conekta::ChargeRequest.new({payment_method: Conekta::PaymentMethodBnplRequest.new({type: 'bnpl', cancel_url: 'https://example.com/cancel', can_not_expire: true, failure_url: 'https://example.com/failure', product_type: '
|
113
|
+
charge_request = Conekta::ChargeRequest.new({payment_method: Conekta::PaymentMethodBnplRequest.new({type: 'bnpl', cancel_url: 'https://example.com/cancel', can_not_expire: true, failure_url: 'https://example.com/failure', product_type: 'aplazo_bnpl', success_url: 'https://example.com/success'})}) # ChargeRequest | requested field for a charge
|
114
114
|
opts = {
|
115
115
|
accept_language: 'es', # String | Use for knowing which language to use
|
116
116
|
x_child_company_id: '6441b6376b60c3a638da80af' # String | In the case of a holding company, the company id of the child company to which will process the request.
|
@@ -187,7 +187,7 @@ end
|
|
187
187
|
|
188
188
|
api_instance = Conekta::ChargesApi.new
|
189
189
|
id = '6307a60c41de27127515a575' # String | Identifier of the resource
|
190
|
-
charge_request = Conekta::ChargeRequest.new({payment_method: Conekta::PaymentMethodBnplRequest.new({type: 'bnpl', cancel_url: 'https://example.com/cancel', can_not_expire: true, failure_url: 'https://example.com/failure', product_type: '
|
190
|
+
charge_request = Conekta::ChargeRequest.new({payment_method: Conekta::PaymentMethodBnplRequest.new({type: 'bnpl', cancel_url: 'https://example.com/cancel', can_not_expire: true, failure_url: 'https://example.com/failure', product_type: 'aplazo_bnpl', success_url: 'https://example.com/success'})}) # ChargeRequest | requested field for a charge
|
191
191
|
opts = {
|
192
192
|
accept_language: 'es', # String | Use for knowing which language to use
|
193
193
|
x_child_company_id: '6441b6376b60c3a638da80af' # String | In the case of a holding company, the company id of the child company to which will process the request.
|
@@ -7,6 +7,7 @@
|
|
7
7
|
| **currency** | **String** | It is the currency in which the order will be created. It must be a valid ISO 4217 currency code. | |
|
8
8
|
| **customer_info** | [**CheckoutOrderTemplateCustomerInfo**](CheckoutOrderTemplateCustomerInfo.md) | | [optional] |
|
9
9
|
| **line_items** | [**Array<Product>**](Product.md) | They are the products to buy. Each contains the \"unit price\" and \"quantity\" parameters that are used to calculate the total amount of the order. | |
|
10
|
+
| **plan_ids** | **Array<String>** | It is a list of plan IDs that will be associated with the order. | [optional] |
|
10
11
|
| **metadata** | **Hash<String, Object>** | It is a set of key-value pairs that you can attach to the order. It can be used to store additional information about the order in a structured format. | [optional] |
|
11
12
|
|
12
13
|
## Example
|
@@ -18,6 +19,7 @@ instance = Conekta::CheckoutOrderTemplate.new(
|
|
18
19
|
currency: MXN,
|
19
20
|
customer_info: null,
|
20
21
|
line_items: null,
|
22
|
+
plan_ids: ["plan_123","plan_456"],
|
21
23
|
metadata: {"key":"value"}
|
22
24
|
)
|
23
25
|
```
|
data/docs/CheckoutRequest.md
CHANGED
@@ -4,7 +4,8 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **allowed_payment_methods** | **Array<String>** | Are the payment methods available for this link | |
|
7
|
+
| **allowed_payment_methods** | **Array<String>** | Are the payment methods available for this link. For subscriptions, only 'card' is allowed due to the recurring nature of the payments. | |
|
8
|
+
| **plan_ids** | **Array<String>** | List of plan IDs that will be available for subscription. This field is required for subscription payments. | [optional] |
|
8
9
|
| **expires_at** | **Integer** | Unix timestamp of checkout expiration | [optional] |
|
9
10
|
| **failure_url** | **String** | Redirection url back to the site in case of failed payment, applies only to HostedPayment. | [optional] |
|
10
11
|
| **monthly_installments_enabled** | **Boolean** | | [optional] |
|
@@ -23,6 +24,7 @@ require 'conekta'
|
|
23
24
|
|
24
25
|
instance = Conekta::CheckoutRequest.new(
|
25
26
|
allowed_payment_methods: ["cash","card","bank_transfer","bnpl"],
|
27
|
+
plan_ids: ["plan_123","plan_456"],
|
26
28
|
expires_at: null,
|
27
29
|
failure_url: null,
|
28
30
|
monthly_installments_enabled: false,
|
data/docs/CheckoutResponse.md
CHANGED
@@ -5,6 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **allowed_payment_methods** | **Array<String>** | Are the payment methods available for this link | [optional] |
|
8
|
+
| **plan_ids** | **Array<String>** | List of plan IDs that are available for subscription | [optional] |
|
8
9
|
| **can_not_expire** | **Boolean** | | [optional] |
|
9
10
|
| **emails_sent** | **Integer** | | [optional] |
|
10
11
|
| **exclude_card_networks** | **Array<Object>** | | [optional] |
|
@@ -37,6 +38,7 @@ require 'conekta'
|
|
37
38
|
|
38
39
|
instance = Conekta::CheckoutResponse.new(
|
39
40
|
allowed_payment_methods: ["cash","card","bank_transfer","bnpl"],
|
41
|
+
plan_ids: ["plan_123","plan_456"],
|
40
42
|
can_not_expire: false,
|
41
43
|
emails_sent: 0,
|
42
44
|
exclude_card_networks: null,
|
data/docs/CompaniesApi.md
CHANGED
@@ -4,8 +4,81 @@ All URIs are relative to *https://api.conekta.io*
|
|
4
4
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
|
+
| [**create_company**](CompaniesApi.md#create_company) | **POST** /companies | Create Company |
|
7
8
|
| [**get_companies**](CompaniesApi.md#get_companies) | **GET** /companies | Get List of Companies |
|
8
9
|
| [**get_company**](CompaniesApi.md#get_company) | **GET** /companies/{id} | Get Company |
|
10
|
+
| [**get_company_documents**](CompaniesApi.md#get_company_documents) | **GET** /companies/{company_id}/documents | Get Company Documents |
|
11
|
+
| [**update_company_document**](CompaniesApi.md#update_company_document) | **PATCH** /companies/{company_id}/document | Update Company Document |
|
12
|
+
| [**upload_company_document**](CompaniesApi.md#upload_company_document) | **POST** /companies/{company_id}/document | Upload Company Document |
|
13
|
+
|
14
|
+
|
15
|
+
## create_company
|
16
|
+
|
17
|
+
> <CompanyResponse> create_company(create_company_request)
|
18
|
+
|
19
|
+
Create Company
|
20
|
+
|
21
|
+
Create a new company.
|
22
|
+
|
23
|
+
### Examples
|
24
|
+
|
25
|
+
```ruby
|
26
|
+
require 'time'
|
27
|
+
require 'conekta'
|
28
|
+
# setup authorization
|
29
|
+
Conekta.configure do |config|
|
30
|
+
# Configure Bearer authorization: bearerAuth
|
31
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
32
|
+
end
|
33
|
+
|
34
|
+
api_instance = Conekta::CompaniesApi.new
|
35
|
+
create_company_request = Conekta::CreateCompanyRequest.new # CreateCompanyRequest | Company data
|
36
|
+
|
37
|
+
begin
|
38
|
+
# Create Company
|
39
|
+
result = api_instance.create_company(create_company_request)
|
40
|
+
p result
|
41
|
+
rescue Conekta::ApiError => e
|
42
|
+
puts "Error when calling CompaniesApi->create_company: #{e}"
|
43
|
+
end
|
44
|
+
```
|
45
|
+
|
46
|
+
#### Using the create_company_with_http_info variant
|
47
|
+
|
48
|
+
This returns an Array which contains the response data, status code and headers.
|
49
|
+
|
50
|
+
> <Array(<CompanyResponse>, Integer, Hash)> create_company_with_http_info(create_company_request)
|
51
|
+
|
52
|
+
```ruby
|
53
|
+
begin
|
54
|
+
# Create Company
|
55
|
+
data, status_code, headers = api_instance.create_company_with_http_info(create_company_request)
|
56
|
+
p status_code # => 2xx
|
57
|
+
p headers # => { ... }
|
58
|
+
p data # => <CompanyResponse>
|
59
|
+
rescue Conekta::ApiError => e
|
60
|
+
puts "Error when calling CompaniesApi->create_company_with_http_info: #{e}"
|
61
|
+
end
|
62
|
+
```
|
63
|
+
|
64
|
+
### Parameters
|
65
|
+
|
66
|
+
| Name | Type | Description | Notes |
|
67
|
+
| ---- | ---- | ----------- | ----- |
|
68
|
+
| **create_company_request** | [**CreateCompanyRequest**](CreateCompanyRequest.md) | Company data | |
|
69
|
+
|
70
|
+
### Return type
|
71
|
+
|
72
|
+
[**CompanyResponse**](CompanyResponse.md)
|
73
|
+
|
74
|
+
### Authorization
|
75
|
+
|
76
|
+
[bearerAuth](../README.md#bearerAuth)
|
77
|
+
|
78
|
+
### HTTP request headers
|
79
|
+
|
80
|
+
- **Content-Type**: application/json
|
81
|
+
- **Accept**: application/vnd.conekta-v2.2.0+json
|
9
82
|
|
10
83
|
|
11
84
|
## get_companies
|
@@ -157,3 +230,226 @@ end
|
|
157
230
|
- **Content-Type**: Not defined
|
158
231
|
- **Accept**: application/vnd.conekta-v2.2.0+json
|
159
232
|
|
233
|
+
|
234
|
+
## get_company_documents
|
235
|
+
|
236
|
+
> <Array<CompanyDocumentResponse>> get_company_documents(company_id, opts)
|
237
|
+
|
238
|
+
Get Company Documents
|
239
|
+
|
240
|
+
Retrieve a list of documents associated with a specific company.
|
241
|
+
|
242
|
+
### Examples
|
243
|
+
|
244
|
+
```ruby
|
245
|
+
require 'time'
|
246
|
+
require 'conekta'
|
247
|
+
# setup authorization
|
248
|
+
Conekta.configure do |config|
|
249
|
+
# Configure Bearer authorization: bearerAuth
|
250
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
251
|
+
end
|
252
|
+
|
253
|
+
api_instance = Conekta::CompaniesApi.new
|
254
|
+
company_id = '6307a60c41de27127515a575' # String | The unique identifier of the company.
|
255
|
+
opts = {
|
256
|
+
accept_language: 'es' # String | Use for knowing which language to use
|
257
|
+
}
|
258
|
+
|
259
|
+
begin
|
260
|
+
# Get Company Documents
|
261
|
+
result = api_instance.get_company_documents(company_id, opts)
|
262
|
+
p result
|
263
|
+
rescue Conekta::ApiError => e
|
264
|
+
puts "Error when calling CompaniesApi->get_company_documents: #{e}"
|
265
|
+
end
|
266
|
+
```
|
267
|
+
|
268
|
+
#### Using the get_company_documents_with_http_info variant
|
269
|
+
|
270
|
+
This returns an Array which contains the response data, status code and headers.
|
271
|
+
|
272
|
+
> <Array(<Array<CompanyDocumentResponse>>, Integer, Hash)> get_company_documents_with_http_info(company_id, opts)
|
273
|
+
|
274
|
+
```ruby
|
275
|
+
begin
|
276
|
+
# Get Company Documents
|
277
|
+
data, status_code, headers = api_instance.get_company_documents_with_http_info(company_id, opts)
|
278
|
+
p status_code # => 2xx
|
279
|
+
p headers # => { ... }
|
280
|
+
p data # => <Array<CompanyDocumentResponse>>
|
281
|
+
rescue Conekta::ApiError => e
|
282
|
+
puts "Error when calling CompaniesApi->get_company_documents_with_http_info: #{e}"
|
283
|
+
end
|
284
|
+
```
|
285
|
+
|
286
|
+
### Parameters
|
287
|
+
|
288
|
+
| Name | Type | Description | Notes |
|
289
|
+
| ---- | ---- | ----------- | ----- |
|
290
|
+
| **company_id** | **String** | The unique identifier of the company. | |
|
291
|
+
| **accept_language** | **String** | Use for knowing which language to use | [optional][default to 'es'] |
|
292
|
+
|
293
|
+
### Return type
|
294
|
+
|
295
|
+
[**Array<CompanyDocumentResponse>**](CompanyDocumentResponse.md)
|
296
|
+
|
297
|
+
### Authorization
|
298
|
+
|
299
|
+
[bearerAuth](../README.md#bearerAuth)
|
300
|
+
|
301
|
+
### HTTP request headers
|
302
|
+
|
303
|
+
- **Content-Type**: Not defined
|
304
|
+
- **Accept**: application/vnd.conekta-v2.2.0+json
|
305
|
+
|
306
|
+
|
307
|
+
## update_company_document
|
308
|
+
|
309
|
+
> <CompanyDocumentResponse> update_company_document(company_id, company_document_request, opts)
|
310
|
+
|
311
|
+
Update Company Document
|
312
|
+
|
313
|
+
Updates an existing document associated with a specific company.
|
314
|
+
|
315
|
+
### Examples
|
316
|
+
|
317
|
+
```ruby
|
318
|
+
require 'time'
|
319
|
+
require 'conekta'
|
320
|
+
# setup authorization
|
321
|
+
Conekta.configure do |config|
|
322
|
+
# Configure Bearer authorization: bearerAuth
|
323
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
324
|
+
end
|
325
|
+
|
326
|
+
api_instance = Conekta::CompaniesApi.new
|
327
|
+
company_id = '6827206b1ec60400015eb09a' # String | The unique identifier of the company.
|
328
|
+
company_document_request = Conekta::CompanyDocumentRequest.new({file_classification: 'id_legal_representative', content_type: 'application/pdf', file_name: 'example_document.pdf', file_data: '[B@1dc7173'}) # CompanyDocumentRequest | Document information to update.
|
329
|
+
opts = {
|
330
|
+
accept_language: 'es' # String | Use for knowing which language to use
|
331
|
+
}
|
332
|
+
|
333
|
+
begin
|
334
|
+
# Update Company Document
|
335
|
+
result = api_instance.update_company_document(company_id, company_document_request, opts)
|
336
|
+
p result
|
337
|
+
rescue Conekta::ApiError => e
|
338
|
+
puts "Error when calling CompaniesApi->update_company_document: #{e}"
|
339
|
+
end
|
340
|
+
```
|
341
|
+
|
342
|
+
#### Using the update_company_document_with_http_info variant
|
343
|
+
|
344
|
+
This returns an Array which contains the response data, status code and headers.
|
345
|
+
|
346
|
+
> <Array(<CompanyDocumentResponse>, Integer, Hash)> update_company_document_with_http_info(company_id, company_document_request, opts)
|
347
|
+
|
348
|
+
```ruby
|
349
|
+
begin
|
350
|
+
# Update Company Document
|
351
|
+
data, status_code, headers = api_instance.update_company_document_with_http_info(company_id, company_document_request, opts)
|
352
|
+
p status_code # => 2xx
|
353
|
+
p headers # => { ... }
|
354
|
+
p data # => <CompanyDocumentResponse>
|
355
|
+
rescue Conekta::ApiError => e
|
356
|
+
puts "Error when calling CompaniesApi->update_company_document_with_http_info: #{e}"
|
357
|
+
end
|
358
|
+
```
|
359
|
+
|
360
|
+
### Parameters
|
361
|
+
|
362
|
+
| Name | Type | Description | Notes |
|
363
|
+
| ---- | ---- | ----------- | ----- |
|
364
|
+
| **company_id** | **String** | The unique identifier of the company. | |
|
365
|
+
| **company_document_request** | [**CompanyDocumentRequest**](CompanyDocumentRequest.md) | Document information to update. | |
|
366
|
+
| **accept_language** | **String** | Use for knowing which language to use | [optional][default to 'es'] |
|
367
|
+
|
368
|
+
### Return type
|
369
|
+
|
370
|
+
[**CompanyDocumentResponse**](CompanyDocumentResponse.md)
|
371
|
+
|
372
|
+
### Authorization
|
373
|
+
|
374
|
+
[bearerAuth](../README.md#bearerAuth)
|
375
|
+
|
376
|
+
### HTTP request headers
|
377
|
+
|
378
|
+
- **Content-Type**: application/json
|
379
|
+
- **Accept**: application/vnd.conekta-v2.2.0+json
|
380
|
+
|
381
|
+
|
382
|
+
## upload_company_document
|
383
|
+
|
384
|
+
> <CompanyDocumentResponse> upload_company_document(company_id, company_document_request, opts)
|
385
|
+
|
386
|
+
Upload Company Document
|
387
|
+
|
388
|
+
Uploads a document associated with a specific company.
|
389
|
+
|
390
|
+
### Examples
|
391
|
+
|
392
|
+
```ruby
|
393
|
+
require 'time'
|
394
|
+
require 'conekta'
|
395
|
+
# setup authorization
|
396
|
+
Conekta.configure do |config|
|
397
|
+
# Configure Bearer authorization: bearerAuth
|
398
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
399
|
+
end
|
400
|
+
|
401
|
+
api_instance = Conekta::CompaniesApi.new
|
402
|
+
company_id = '6827206b1ec60400015eb09a' # String | The unique identifier of the company.
|
403
|
+
company_document_request = Conekta::CompanyDocumentRequest.new({file_classification: 'id_legal_representative', content_type: 'application/pdf', file_name: 'example_document.pdf', file_data: '[B@1dc7173'}) # CompanyDocumentRequest | Document information to upload.
|
404
|
+
opts = {
|
405
|
+
accept_language: 'es' # String | Use for knowing which language to use
|
406
|
+
}
|
407
|
+
|
408
|
+
begin
|
409
|
+
# Upload Company Document
|
410
|
+
result = api_instance.upload_company_document(company_id, company_document_request, opts)
|
411
|
+
p result
|
412
|
+
rescue Conekta::ApiError => e
|
413
|
+
puts "Error when calling CompaniesApi->upload_company_document: #{e}"
|
414
|
+
end
|
415
|
+
```
|
416
|
+
|
417
|
+
#### Using the upload_company_document_with_http_info variant
|
418
|
+
|
419
|
+
This returns an Array which contains the response data, status code and headers.
|
420
|
+
|
421
|
+
> <Array(<CompanyDocumentResponse>, Integer, Hash)> upload_company_document_with_http_info(company_id, company_document_request, opts)
|
422
|
+
|
423
|
+
```ruby
|
424
|
+
begin
|
425
|
+
# Upload Company Document
|
426
|
+
data, status_code, headers = api_instance.upload_company_document_with_http_info(company_id, company_document_request, opts)
|
427
|
+
p status_code # => 2xx
|
428
|
+
p headers # => { ... }
|
429
|
+
p data # => <CompanyDocumentResponse>
|
430
|
+
rescue Conekta::ApiError => e
|
431
|
+
puts "Error when calling CompaniesApi->upload_company_document_with_http_info: #{e}"
|
432
|
+
end
|
433
|
+
```
|
434
|
+
|
435
|
+
### Parameters
|
436
|
+
|
437
|
+
| Name | Type | Description | Notes |
|
438
|
+
| ---- | ---- | ----------- | ----- |
|
439
|
+
| **company_id** | **String** | The unique identifier of the company. | |
|
440
|
+
| **company_document_request** | [**CompanyDocumentRequest**](CompanyDocumentRequest.md) | Document information to upload. | |
|
441
|
+
| **accept_language** | **String** | Use for knowing which language to use | [optional][default to 'es'] |
|
442
|
+
|
443
|
+
### Return type
|
444
|
+
|
445
|
+
[**CompanyDocumentResponse**](CompanyDocumentResponse.md)
|
446
|
+
|
447
|
+
### Authorization
|
448
|
+
|
449
|
+
[bearerAuth](../README.md#bearerAuth)
|
450
|
+
|
451
|
+
### HTTP request headers
|
452
|
+
|
453
|
+
- **Content-Type**: application/json
|
454
|
+
- **Accept**: application/vnd.conekta-v2.2.0+json
|
455
|
+
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# Conekta::CompanyDocumentRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **file_classification** | **String** | Classification of the document. | Tipo de archivo | Descripción | | :--------------------------- | :-------------------------------------------------------- | | `id_legal_representative` | identificación oficial frente | | `id_legal_representative_back` | identificación oficial atrás | | `cfdi` | Prueba de situación fiscal | | `constitutive_act_basic` | Acta constitutiva | | `proof_of_address` | Comprobante de domicilio del negocio | | `power_of_attonery` | Poderes de representación | | `deposit_account_cover` | Carátula de la cuenta de depósito | | `permit_casino` | Permiso ante SEGOB | | `license_sanitation` | Licencia sanitaria de COFEPRIS | | `registration_tourism` | Inscripción ante el Registro Nacional de Turismo (SECTUR) | | |
|
8
|
+
| **content_type** | **String** | MIME type of the file. Allowed values depend on the `file_classification`. - `image/jpeg` - `image/png` - `application/pdf` | |
|
9
|
+
| **international** | **Boolean** | Indicates if the document is international. Defaults to false. | [optional] |
|
10
|
+
| **file_name** | **String** | Name of the file being uploaded. | |
|
11
|
+
| **file_data** | **String** | Base64 encoded content of the file. | |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'conekta'
|
17
|
+
|
18
|
+
instance = Conekta::CompanyDocumentRequest.new(
|
19
|
+
file_classification: id_legal_representative,
|
20
|
+
content_type: application/pdf,
|
21
|
+
international: false,
|
22
|
+
file_name: example_document.pdf,
|
23
|
+
file_data: [B@1dc7173
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# Conekta::CompanyDocumentResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **file_classification** | **String** | Classification of the document. | Tipo de archivo | Descripción | | :--------------------------- | :-------------------------------------------------------- | | `id_legal_representative` | identificación oficial frente | | `id_legal_representative_back` | identificación oficial atrás | | `cfdi` | Prueba de situación fiscal | | `constitutive_act_basic` | Acta constitutiva | | `proof_of_address` | Comprobante de domicilio del negocio | | `power_of_attonery` | Poderes de representación | | `deposit_account_cover` | Carátula de la cuenta de depósito | | `permit_casino` | Permiso ante SEGOB | | `license_sanitation` | Licencia sanitaria de COFEPRIS | | `registration_tourism` | Inscripción ante el Registro Nacional de Turismo (SECTUR) | | |
|
8
|
+
| **file_name** | **String** | Name of the file as stored or processed. | |
|
9
|
+
| **status** | **String** | Current status of the document. | |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'conekta'
|
15
|
+
|
16
|
+
instance = Conekta::CompanyDocumentResponse.new(
|
17
|
+
file_classification: id_legal_representative,
|
18
|
+
file_name: prueba3.pdf,
|
19
|
+
status: uploaded
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
data/docs/CompanyResponse.md
CHANGED
@@ -4,14 +4,15 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **id** | **String** | The
|
8
|
-
| **
|
9
|
-
| **
|
10
|
-
| **
|
11
|
-
| **parent_company_id** | **String** |
|
12
|
-
| **
|
13
|
-
| **
|
14
|
-
| **
|
7
|
+
| **id** | **String** | The unique identifier for the company. | |
|
8
|
+
| **name** | **String** | The name of the company. | |
|
9
|
+
| **active** | **Boolean** | Indicates if the company is active. | |
|
10
|
+
| **account_status** | **String** | The current status of the company's account. | |
|
11
|
+
| **parent_company_id** | **String** | The identifier of the parent company, if any. | [optional] |
|
12
|
+
| **onboarding_status** | **String** | The current status of the company's onboarding process. | |
|
13
|
+
| **documents** | [**Array<CompanyResponseDocumentsInner>**](CompanyResponseDocumentsInner.md) | A list of documents related to the company. | |
|
14
|
+
| **created_at** | **Integer** | Timestamp of when the company was created. | |
|
15
|
+
| **object** | **String** | The type of object, typically \"company\". | |
|
15
16
|
|
16
17
|
## Example
|
17
18
|
|
@@ -19,14 +20,15 @@
|
|
19
20
|
require 'conekta'
|
20
21
|
|
21
22
|
instance = Conekta::CompanyResponse.new(
|
22
|
-
id:
|
23
|
-
|
24
|
-
|
25
|
-
|
26
|
-
parent_company_id:
|
27
|
-
|
28
|
-
|
29
|
-
|
23
|
+
id: 6827305a1ec60400015eb116,
|
24
|
+
name: test,
|
25
|
+
active: false,
|
26
|
+
account_status: signed_up,
|
27
|
+
parent_company_id: 680bf1da38716d00013543bc,
|
28
|
+
onboarding_status: pending,
|
29
|
+
documents: null,
|
30
|
+
created_at: 1748968241,
|
31
|
+
object: company
|
30
32
|
)
|
31
33
|
```
|
32
34
|
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# Conekta::CompanyResponseDocumentsInner
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **file_classification** | **String** | Classification of the document. | Tipo de archivo | Descripción | | :--------------------------- | :-------------------------------------------------------- | | `id_legal_representative` | identificación oficial frente | | `id_legal_representative_back` | identificación oficial atrás | | `cfdi` | Prueba de situación fiscal | | `constitutive_act_basic` | Acta constitutiva | | `proof_of_address` | Comprobante de domicilio del negocio | | `power_of_attonery` | Poderes de representación | | `deposit_account_cover` | Carátula de la cuenta de depósito | | `permit_casino` | Permiso ante SEGOB | | `license_sanitation` | Licencia sanitaria de COFEPRIS | | `registration_tourism` | Inscripción ante el Registro Nacional de Turismo (SECTUR) | | [optional] |
|
8
|
+
| **status** | **String** | The status of the document. | [optional] |
|
9
|
+
| **file_name** | **String** | The name of the file. | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'conekta'
|
15
|
+
|
16
|
+
instance = Conekta::CompanyResponseDocumentsInner.new(
|
17
|
+
file_classification: deposit_account_cover,
|
18
|
+
status: pending,
|
19
|
+
file_name: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# Conekta::CreateCompanyRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **name** | **String** | The name of the company. | [optional] |
|
8
|
+
| **type_company** | **String** | The type of company, 'owner' | [optional] |
|
9
|
+
| **comercial_info** | [**CreateCompanyRequestComercialInfo**](CreateCompanyRequestComercialInfo.md) | | [optional] |
|
10
|
+
| **fiscal_info** | [**CreateCompanyRequestFiscalInfo**](CreateCompanyRequestFiscalInfo.md) | | [optional] |
|
11
|
+
| **bank_account_info** | [**CreateCompanyRequestBankAccountInfo**](CreateCompanyRequestBankAccountInfo.md) | | [optional] |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'conekta'
|
17
|
+
|
18
|
+
instance = Conekta::CreateCompanyRequest.new(
|
19
|
+
name: test,
|
20
|
+
type_company: owner,
|
21
|
+
comercial_info: null,
|
22
|
+
fiscal_info: null,
|
23
|
+
bank_account_info: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# Conekta::CreateCompanyRequestBankAccountInfo
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **clabe** | **String** | The 18-digit CLABE for the bank account. | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'conekta'
|
13
|
+
|
14
|
+
instance = Conekta::CreateCompanyRequestBankAccountInfo.new(
|
15
|
+
clabe: 002010077777777771
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|