wire4_client 0.0.1.pre.SNAPSHOT

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.
Files changed (187) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +7 -0
  3. data/Gemfile.lock +69 -0
  4. data/README.md +188 -0
  5. data/Rakefile +8 -0
  6. data/docs/Account.md +18 -0
  7. data/docs/AccountRequest.md +10 -0
  8. data/docs/AccountResponse.md +18 -0
  9. data/docs/AccountSpid.md +19 -0
  10. data/docs/AmountRequest.md +10 -0
  11. data/docs/Balance.md +10 -0
  12. data/docs/BalanceListResponse.md +8 -0
  13. data/docs/BeneficiariesResponse.md +8 -0
  14. data/docs/BeneficiaryInstitution.md +8 -0
  15. data/docs/Billing.md +16 -0
  16. data/docs/BillingTransaction.md +15 -0
  17. data/docs/CepResponse.md +28 -0
  18. data/docs/CepSearchBanxico.md +15 -0
  19. data/docs/ComprobanteElectrnicoDePagoCEPApi.md +61 -0
  20. data/docs/ContactRequest.md +12 -0
  21. data/docs/ContactoApi.md +60 -0
  22. data/docs/CuentasDeBeneficiariosSPEIApi.md +342 -0
  23. data/docs/CuentasDeBeneficiariosSPIDApi.md +62 -0
  24. data/docs/Deposit.md +27 -0
  25. data/docs/Depositant.md +12 -0
  26. data/docs/DepositantesApi.md +117 -0
  27. data/docs/DepositantsRegister.md +11 -0
  28. data/docs/DepositantsResponse.md +8 -0
  29. data/docs/ErrorResponse.md +9 -0
  30. data/docs/FacturasApi.md +115 -0
  31. data/docs/GetDepositants.md +8 -0
  32. data/docs/InstitucionesApi.md +53 -0
  33. data/docs/Institution.md +11 -0
  34. data/docs/InstitutionsList.md +8 -0
  35. data/docs/MessageAccountBeneficiary.md +10 -0
  36. data/docs/MessageCEP.md +28 -0
  37. data/docs/MessageDepositReceived.md +27 -0
  38. data/docs/MessageInstitution.md +11 -0
  39. data/docs/MessagePayment.md +25 -0
  40. data/docs/MessageSubscription.md +12 -0
  41. data/docs/MessageWebHook.md +16 -0
  42. data/docs/Payment.md +24 -0
  43. data/docs/Person.md +10 -0
  44. data/docs/PreEnrollmentData.md +9 -0
  45. data/docs/PreEnrollmentResponse.md +9 -0
  46. data/docs/Relationship.md +9 -0
  47. data/docs/RelationshipsResponse.md +8 -0
  48. data/docs/SaldoApi.md +61 -0
  49. data/docs/SpidClassificationDTO.md +9 -0
  50. data/docs/SpidClassificationsResponseDTO.md +8 -0
  51. data/docs/SuscripcionesApi.md +165 -0
  52. data/docs/Timestamp.md +17 -0
  53. data/docs/TokenRequiredResponse.md +9 -0
  54. data/docs/TransactionOutgoing.md +14 -0
  55. data/docs/TransactionOutgoingSpid.md +17 -0
  56. data/docs/TransactionsOutgoingRegister.md +10 -0
  57. data/docs/TransferenciasSPEIApi.md +229 -0
  58. data/docs/TransferenciasSPIDApi.md +117 -0
  59. data/docs/WebhookRequest.md +10 -0
  60. data/docs/WebhookResponse.md +13 -0
  61. data/docs/WebhooksApi.md +161 -0
  62. data/docs/WebhooksList.md +8 -0
  63. data/git_push.sh +55 -0
  64. data/lib/wire4_client.rb +96 -0
  65. data/lib/wire4_client/api/comprobante_electrnico_de_pago_cep_api.rb +77 -0
  66. data/lib/wire4_client/api/contacto_api.rb +76 -0
  67. data/lib/wire4_client/api/cuentas_de_beneficiarios_spei_api.rb +453 -0
  68. data/lib/wire4_client/api/cuentas_de_beneficiarios_spid_api.rb +93 -0
  69. data/lib/wire4_client/api/depositantes_api.rb +159 -0
  70. data/lib/wire4_client/api/facturas_api.rb +124 -0
  71. data/lib/wire4_client/api/instituciones_api.rb +67 -0
  72. data/lib/wire4_client/api/saldo_api.rb +87 -0
  73. data/lib/wire4_client/api/suscripciones_api.rb +203 -0
  74. data/lib/wire4_client/api/transferencias_spei_api.rb +307 -0
  75. data/lib/wire4_client/api/transferencias_spid_api.rb +155 -0
  76. data/lib/wire4_client/api/webhooks_api.rb +175 -0
  77. data/lib/wire4_client/api_client.rb +389 -0
  78. data/lib/wire4_client/api_error.rb +38 -0
  79. data/lib/wire4_client/configuration.rb +223 -0
  80. data/lib/wire4_client/models/account.rb +345 -0
  81. data/lib/wire4_client/models/account_request.rb +217 -0
  82. data/lib/wire4_client/models/account_response.rb +345 -0
  83. data/lib/wire4_client/models/account_spid.rb +388 -0
  84. data/lib/wire4_client/models/amount_request.rb +258 -0
  85. data/lib/wire4_client/models/balance.rb +205 -0
  86. data/lib/wire4_client/models/balance_list_response.rb +187 -0
  87. data/lib/wire4_client/models/beneficiaries_response.rb +186 -0
  88. data/lib/wire4_client/models/beneficiary_institution.rb +185 -0
  89. data/lib/wire4_client/models/billing.rb +300 -0
  90. data/lib/wire4_client/models/billing_transaction.rb +289 -0
  91. data/lib/wire4_client/models/cep_response.rb +384 -0
  92. data/lib/wire4_client/models/cep_search_banxico.rb +373 -0
  93. data/lib/wire4_client/models/contact_request.rb +272 -0
  94. data/lib/wire4_client/models/deposit.rb +374 -0
  95. data/lib/wire4_client/models/depositant.rb +227 -0
  96. data/lib/wire4_client/models/depositants_register.rb +315 -0
  97. data/lib/wire4_client/models/depositants_response.rb +184 -0
  98. data/lib/wire4_client/models/error_response.rb +192 -0
  99. data/lib/wire4_client/models/get_depositants.rb +192 -0
  100. data/lib/wire4_client/models/institution.rb +215 -0
  101. data/lib/wire4_client/models/institutions_list.rb +186 -0
  102. data/lib/wire4_client/models/message_account_beneficiary.rb +205 -0
  103. data/lib/wire4_client/models/message_cep.rb +385 -0
  104. data/lib/wire4_client/models/message_deposit_received.rb +375 -0
  105. data/lib/wire4_client/models/message_institution.rb +215 -0
  106. data/lib/wire4_client/models/message_payment.rb +354 -0
  107. data/lib/wire4_client/models/message_subscription.rb +225 -0
  108. data/lib/wire4_client/models/message_web_hook.rb +265 -0
  109. data/lib/wire4_client/models/payment.rb +344 -0
  110. data/lib/wire4_client/models/person.rb +220 -0
  111. data/lib/wire4_client/models/pre_enrollment_data.rb +260 -0
  112. data/lib/wire4_client/models/pre_enrollment_response.rb +194 -0
  113. data/lib/wire4_client/models/relationship.rb +194 -0
  114. data/lib/wire4_client/models/relationships_response.rb +186 -0
  115. data/lib/wire4_client/models/spid_classification_dto.rb +195 -0
  116. data/lib/wire4_client/models/spid_classifications_response_dto.rb +186 -0
  117. data/lib/wire4_client/models/timestamp.rb +264 -0
  118. data/lib/wire4_client/models/token_required_response.rb +195 -0
  119. data/lib/wire4_client/models/transaction_outgoing.rb +380 -0
  120. data/lib/wire4_client/models/transaction_outgoing_spid.rb +425 -0
  121. data/lib/wire4_client/models/transactions_outgoing_register.rb +222 -0
  122. data/lib/wire4_client/models/webhook_request.rb +222 -0
  123. data/lib/wire4_client/models/webhook_response.rb +271 -0
  124. data/lib/wire4_client/models/webhooks_list.rb +186 -0
  125. data/lib/wire4_client/version.rb +15 -0
  126. data/spec/api/comprobante_electrnico_de_pago_cep_api_spec.rb +47 -0
  127. data/spec/api/contacto_api_spec.rb +47 -0
  128. data/spec/api/cuentas_de_beneficiarios_spei_api_spec.rb +113 -0
  129. data/spec/api/cuentas_de_beneficiarios_spid_api_spec.rb +47 -0
  130. data/spec/api/depositantes_api_spec.rb +60 -0
  131. data/spec/api/facturas_api_spec.rb +59 -0
  132. data/spec/api/instituciones_api_spec.rb +45 -0
  133. data/spec/api/saldo_api_spec.rb +47 -0
  134. data/spec/api/suscripciones_api_spec.rb +71 -0
  135. data/spec/api/transferencias_spei_api_spec.rb +86 -0
  136. data/spec/api/transferencias_spid_api_spec.rb +60 -0
  137. data/spec/api/webhooks_api_spec.rb +70 -0
  138. data/spec/api_client_spec.rb +226 -0
  139. data/spec/configuration_spec.rb +42 -0
  140. data/spec/models/account_request_spec.rb +53 -0
  141. data/spec/models/account_response_spec.rb +101 -0
  142. data/spec/models/account_spec.rb +101 -0
  143. data/spec/models/account_spid_spec.rb +107 -0
  144. data/spec/models/amount_request_spec.rb +53 -0
  145. data/spec/models/balance_list_response_spec.rb +41 -0
  146. data/spec/models/balance_spec.rb +53 -0
  147. data/spec/models/beneficiaries_response_spec.rb +41 -0
  148. data/spec/models/beneficiary_institution_spec.rb +41 -0
  149. data/spec/models/billing_spec.rb +93 -0
  150. data/spec/models/billing_transaction_spec.rb +87 -0
  151. data/spec/models/cep_response_spec.rb +161 -0
  152. data/spec/models/cep_search_banxico_spec.rb +83 -0
  153. data/spec/models/contact_request_spec.rb +65 -0
  154. data/spec/models/deposit_spec.rb +155 -0
  155. data/spec/models/depositant_spec.rb +65 -0
  156. data/spec/models/depositants_register_spec.rb +59 -0
  157. data/spec/models/depositants_response_spec.rb +41 -0
  158. data/spec/models/error_response_spec.rb +47 -0
  159. data/spec/models/get_depositants_spec.rb +41 -0
  160. data/spec/models/institution_spec.rb +59 -0
  161. data/spec/models/institutions_list_spec.rb +41 -0
  162. data/spec/models/message_account_beneficiary_spec.rb +53 -0
  163. data/spec/models/message_cep_spec.rb +161 -0
  164. data/spec/models/message_deposit_received_spec.rb +155 -0
  165. data/spec/models/message_institution_spec.rb +59 -0
  166. data/spec/models/message_payment_spec.rb +143 -0
  167. data/spec/models/message_subscription_spec.rb +65 -0
  168. data/spec/models/message_web_hook_spec.rb +89 -0
  169. data/spec/models/payment_spec.rb +137 -0
  170. data/spec/models/person_spec.rb +53 -0
  171. data/spec/models/pre_enrollment_data_spec.rb +47 -0
  172. data/spec/models/pre_enrollment_response_spec.rb +47 -0
  173. data/spec/models/relationship_spec.rb +47 -0
  174. data/spec/models/relationships_response_spec.rb +41 -0
  175. data/spec/models/spid_classification_dto_spec.rb +47 -0
  176. data/spec/models/spid_classifications_response_dto_spec.rb +41 -0
  177. data/spec/models/timestamp_spec.rb +95 -0
  178. data/spec/models/token_required_response_spec.rb +47 -0
  179. data/spec/models/transaction_outgoing_spec.rb +77 -0
  180. data/spec/models/transaction_outgoing_spid_spec.rb +95 -0
  181. data/spec/models/transactions_outgoing_register_spec.rb +53 -0
  182. data/spec/models/webhook_request_spec.rb +53 -0
  183. data/spec/models/webhook_response_spec.rb +75 -0
  184. data/spec/models/webhooks_list_spec.rb +41 -0
  185. data/spec/spec_helper.rb +111 -0
  186. data/wire4_client.gemspec +45 -0
  187. metadata +468 -0
@@ -0,0 +1,17 @@
1
+ # Wire4Client::Timestamp
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **date** | **Integer** | | [optional]
7
+ **day** | **Integer** | | [optional]
8
+ **hours** | **Integer** | | [optional]
9
+ **minutes** | **Integer** | | [optional]
10
+ **month** | **Integer** | | [optional]
11
+ **nanos** | **Integer** | | [optional]
12
+ **seconds** | **Integer** | | [optional]
13
+ **time** | **Integer** | | [optional]
14
+ **timezone_offset** | **Integer** | | [optional]
15
+ **year** | **Integer** | | [optional]
16
+
17
+
@@ -0,0 +1,9 @@
1
+ # Wire4Client::TokenRequiredResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **request_id** | **String** | Identificador público generado para la petición | [optional]
7
+ **url** | **String** | La url generada para confirmación de la operación | [optional]
8
+
9
+
@@ -0,0 +1,14 @@
1
+ # Wire4Client::TransactionOutgoing
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **amount** | **Float** | Monto de la transferencia |
7
+ **beneficiary_account** | **String** | Cuenta del beneficiario, podría ser un numero celular, TDD o Cuenta CLABE interbancaria |
8
+ **concept** | **String** | Concepto de la transferencia |
9
+ **currency_code** | **String** | Código de moneda en la que opera la cuenta |
10
+ **email** | **Array<String>** | Lista de email del beneficiario,es opcional | [optional]
11
+ **order_id** | **String** | Referencia de la transferencia asignada por el cliente |
12
+ **reference** | **Integer** | Referencia numérica de la transferencia |
13
+
14
+
@@ -0,0 +1,17 @@
1
+ # Wire4Client::TransactionOutgoingSpid
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **amount** | **Float** | Monto de la transferencia |
7
+ **beneficiary_account** | **String** | Cuenta del beneficiario, podría ser un numero celular, TDD o Cuenta CLABE interbancaria |
8
+ **cancel_return_url** | **String** | Url a la que se redirigirá en caso de error |
9
+ **classification_id** | **String** | El identificador de la clasificación de la transferencia SPID |
10
+ **currency_code** | **String** | Código de moneda en la que opera la cuenta |
11
+ **email** | **Array<String>** | Lista de email del beneficiario,es opcional | [optional]
12
+ **numeric_reference_spid** | **Integer** | Referencia numérica de la transferencia |
13
+ **order_id** | **String** | Referencia de la transferencia asignada por el cliente |
14
+ **payment_concept_spid** | **String** | Concepto de la transferencia |
15
+ **return_url** | **String** | Url a la que se redirigirá en caso de exito |
16
+
17
+
@@ -0,0 +1,10 @@
1
+ # Wire4Client::TransactionsOutgoingRegister
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **cancel_return_url** | **String** | Url a la que se redirigirá en caso de error |
7
+ **return_url** | **String** | Url a la que se redirigirá en caso de exito |
8
+ **transactions** | [**Array<TransactionOutgoing>**](TransactionOutgoing.md) | Lista de transferencias de salida que se enviarán a Monex |
9
+
10
+
@@ -0,0 +1,229 @@
1
+ # Wire4Client::TransferenciasSPEIApi
2
+
3
+ All URIs are relative to *https://sandbox-api.wire4.mx/wire4/1.0.0*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**drop_transactions_pending_using_delete**](TransferenciasSPEIApi.md#drop_transactions_pending_using_delete) | **DELETE** /subscriptions/{subscription}/transactions/outcoming/spei/request/{requestId} | Eliminación de transferencias SPEI® pendientes
8
+ [**incoming_spei_transactions_report_using_get**](TransferenciasSPEIApi.md#incoming_spei_transactions_report_using_get) | **GET** /subscriptions/{subscription}/transactions/incoming/spei | Consulta de transferencias recibidas
9
+ [**outgoing_spei_transactions_report_using_get**](TransferenciasSPEIApi.md#outgoing_spei_transactions_report_using_get) | **GET** /subscriptions/{subscription}/transactions/outcoming/spei | Consulta de transferencias realizadas
10
+ [**register_outgoing_spei_transaction_using_post**](TransferenciasSPEIApi.md#register_outgoing_spei_transaction_using_post) | **POST** /subscriptions/{subscription}/transactions/outcoming/spei | Registro de transferencias
11
+
12
+
13
+ # **drop_transactions_pending_using_delete**
14
+ > drop_transactions_pending_using_delete(request_id, subscription)
15
+
16
+ Eliminación de transferencias SPEI® pendientes
17
+
18
+ Elimina un conjunto de transferencias a realizar en la cuenta del cliente Monex relacionada a la suscripción, las transferencias no deben haber sido confirmadas por el cliente.
19
+
20
+ ### Example
21
+ ```ruby
22
+ # load the gem
23
+ require 'wire4_client'
24
+ # setup authorization
25
+ Wire4Client.configure do |config|
26
+ # Configure OAuth2 access token for authorization: wire4_aut_app_user_spei
27
+ config.access_token = 'YOUR ACCESS TOKEN'
28
+ end
29
+
30
+ api_instance = Wire4Client::TransferenciasSPEIApi.new
31
+
32
+ request_id = 'request_id_example' # String | Identificador de las transferencias a eliminar
33
+
34
+ subscription = 'subscription_example' # String | El identificador de la suscripción a esta API
35
+
36
+
37
+ begin
38
+ #Eliminación de transferencias SPEI® pendientes
39
+ api_instance.drop_transactions_pending_using_delete(request_id, subscription)
40
+ rescue Wire4Client::ApiError => e
41
+ puts "Exception when calling TransferenciasSPEIApi->drop_transactions_pending_using_delete: #{e}"
42
+ end
43
+ ```
44
+
45
+ ### Parameters
46
+
47
+ Name | Type | Description | Notes
48
+ ------------- | ------------- | ------------- | -------------
49
+ **request_id** | **String**| Identificador de las transferencias a eliminar |
50
+ **subscription** | **String**| El identificador de la suscripción a esta API |
51
+
52
+ ### Return type
53
+
54
+ nil (empty response body)
55
+
56
+ ### Authorization
57
+
58
+ [wire4_aut_app_user_spei](../README.md#wire4_aut_app_user_spei)
59
+
60
+ ### HTTP request headers
61
+
62
+ - **Content-Type**: Not defined
63
+ - **Accept**: application/json
64
+
65
+
66
+
67
+ # **incoming_spei_transactions_report_using_get**
68
+ > Array<Deposit> incoming_spei_transactions_report_using_get(subscription)
69
+
70
+ Consulta de transferencias recibidas
71
+
72
+ Realiza una consulta de las transferencias recibidas (depósitos) en la cuenta del cliente Monex relacionada a la suscripción, las transferencias que regresa este recuso son únicamente las transferencias recibidas durante el día en el que se realiza la consulta.
73
+
74
+ ### Example
75
+ ```ruby
76
+ # load the gem
77
+ require 'wire4_client'
78
+ # setup authorization
79
+ Wire4Client.configure do |config|
80
+ # Configure OAuth2 access token for authorization: wire4_aut_app_user_spei
81
+ config.access_token = 'YOUR ACCESS TOKEN'
82
+ end
83
+
84
+ api_instance = Wire4Client::TransferenciasSPEIApi.new
85
+
86
+ subscription = 'subscription_example' # String | El identificador de la suscripción a esta API
87
+
88
+
89
+ begin
90
+ #Consulta de transferencias recibidas
91
+ result = api_instance.incoming_spei_transactions_report_using_get(subscription)
92
+ p result
93
+ rescue Wire4Client::ApiError => e
94
+ puts "Exception when calling TransferenciasSPEIApi->incoming_spei_transactions_report_using_get: #{e}"
95
+ end
96
+ ```
97
+
98
+ ### Parameters
99
+
100
+ Name | Type | Description | Notes
101
+ ------------- | ------------- | ------------- | -------------
102
+ **subscription** | **String**| El identificador de la suscripción a esta API |
103
+
104
+ ### Return type
105
+
106
+ [**Array<Deposit>**](Deposit.md)
107
+
108
+ ### Authorization
109
+
110
+ [wire4_aut_app_user_spei](../README.md#wire4_aut_app_user_spei)
111
+
112
+ ### HTTP request headers
113
+
114
+ - **Content-Type**: Not defined
115
+ - **Accept**: application/json
116
+
117
+
118
+
119
+ # **outgoing_spei_transactions_report_using_get**
120
+ > Array<Payment> outgoing_spei_transactions_report_using_get(subscription, opts)
121
+
122
+ Consulta de transferencias realizadas
123
+
124
+ Consulta las transferencias realizadas en la cuenta del cliente Monex relacionada a la suscripción, las transferencias que regresa este recuso son únicamente las transferencias recibidas en el día en el que se realiza la consulta.<br>Se pueden realizar consultas por <strong>order_id</strong> al realizar este tipo de consultas no importa el día en el que se realizó la transferencia
125
+
126
+ ### Example
127
+ ```ruby
128
+ # load the gem
129
+ require 'wire4_client'
130
+ # setup authorization
131
+ Wire4Client.configure do |config|
132
+ # Configure OAuth2 access token for authorization: wire4_aut_app_user_spei
133
+ config.access_token = 'YOUR ACCESS TOKEN'
134
+ end
135
+
136
+ api_instance = Wire4Client::TransferenciasSPEIApi.new
137
+
138
+ subscription = 'subscription_example' # String | El identificador de la suscripción a esta API
139
+
140
+ opts = {
141
+ order_id: 'order_id_example' # String | Identificador de la orden a buscar
142
+ }
143
+
144
+ begin
145
+ #Consulta de transferencias realizadas
146
+ result = api_instance.outgoing_spei_transactions_report_using_get(subscription, opts)
147
+ p result
148
+ rescue Wire4Client::ApiError => e
149
+ puts "Exception when calling TransferenciasSPEIApi->outgoing_spei_transactions_report_using_get: #{e}"
150
+ end
151
+ ```
152
+
153
+ ### Parameters
154
+
155
+ Name | Type | Description | Notes
156
+ ------------- | ------------- | ------------- | -------------
157
+ **subscription** | **String**| El identificador de la suscripción a esta API |
158
+ **order_id** | **String**| Identificador de la orden a buscar | [optional]
159
+
160
+ ### Return type
161
+
162
+ [**Array&lt;Payment&gt;**](Payment.md)
163
+
164
+ ### Authorization
165
+
166
+ [wire4_aut_app_user_spei](../README.md#wire4_aut_app_user_spei)
167
+
168
+ ### HTTP request headers
169
+
170
+ - **Content-Type**: Not defined
171
+ - **Accept**: application/json
172
+
173
+
174
+
175
+ # **register_outgoing_spei_transaction_using_post**
176
+ > TokenRequiredResponse register_outgoing_spei_transaction_using_post(subscription, transactions)
177
+
178
+ Registro de transferencias
179
+
180
+ Registra un conjunto de transferencias a realizar en la cuenta del cliente Monex relacionada a la suscripción, las transferencias deben ser confirmadas por el cliente para que se efectuen.
181
+
182
+ ### Example
183
+ ```ruby
184
+ # load the gem
185
+ require 'wire4_client'
186
+ # setup authorization
187
+ Wire4Client.configure do |config|
188
+ # Configure OAuth2 access token for authorization: wire4_aut_app_user_spei
189
+ config.access_token = 'YOUR ACCESS TOKEN'
190
+ end
191
+
192
+ api_instance = Wire4Client::TransferenciasSPEIApi.new
193
+
194
+ subscription = 'subscription_example' # String | El identificador de la suscripción a esta API
195
+
196
+ transactions = Wire4Client::TransactionsOutgoingRegister.new # TransactionsOutgoingRegister | Información de las transferencias SPEI de salida
197
+
198
+
199
+ begin
200
+ #Registro de transferencias
201
+ result = api_instance.register_outgoing_spei_transaction_using_post(subscription, transactions)
202
+ p result
203
+ rescue Wire4Client::ApiError => e
204
+ puts "Exception when calling TransferenciasSPEIApi->register_outgoing_spei_transaction_using_post: #{e}"
205
+ end
206
+ ```
207
+
208
+ ### Parameters
209
+
210
+ Name | Type | Description | Notes
211
+ ------------- | ------------- | ------------- | -------------
212
+ **subscription** | **String**| El identificador de la suscripción a esta API |
213
+ **transactions** | [**TransactionsOutgoingRegister**](TransactionsOutgoingRegister.md)| Información de las transferencias SPEI de salida |
214
+
215
+ ### Return type
216
+
217
+ [**TokenRequiredResponse**](TokenRequiredResponse.md)
218
+
219
+ ### Authorization
220
+
221
+ [wire4_aut_app_user_spei](../README.md#wire4_aut_app_user_spei)
222
+
223
+ ### HTTP request headers
224
+
225
+ - **Content-Type**: application/json
226
+ - **Accept**: application/json
227
+
228
+
229
+
@@ -0,0 +1,117 @@
1
+ # Wire4Client::TransferenciasSPIDApi
2
+
3
+ All URIs are relative to *https://sandbox-api.wire4.mx/wire4/1.0.0*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**get_spid_classifications_using_get**](TransferenciasSPIDApi.md#get_spid_classifications_using_get) | **GET** /subscriptions/{subscription}/beneficiaries/spid/classifications | Consulta las clasificaciones para operaciones con SPID
8
+ [**register_outgoing_spid_transaction_using_post**](TransferenciasSPIDApi.md#register_outgoing_spid_transaction_using_post) | **POST** /subscriptions/{subscription}/transactions/outcoming/spid | Registro de transferencias SPID
9
+
10
+
11
+ # **get_spid_classifications_using_get**
12
+ > SpidClassificationsResponseDTO get_spid_classifications_using_get(subscription)
13
+
14
+ Consulta las clasificaciones para operaciones con SPID
15
+
16
+ Obtiene las clasificaciones para operaciones con dólares (SPID) de Monex.<br/>Este recurso se debe invocar previo al realizar una operación SPID.<br/>Se requiere que el token de autenticación se genere con scope spid_admin.
17
+
18
+ ### Example
19
+ ```ruby
20
+ # load the gem
21
+ require 'wire4_client'
22
+ # setup authorization
23
+ Wire4Client.configure do |config|
24
+ # Configure OAuth2 access token for authorization: wire4_aut_app_user_spid
25
+ config.access_token = 'YOUR ACCESS TOKEN'
26
+ end
27
+
28
+ api_instance = Wire4Client::TransferenciasSPIDApi.new
29
+
30
+ subscription = 'subscription_example' # String | El identificador de la suscripción a esta API
31
+
32
+
33
+ begin
34
+ #Consulta las clasificaciones para operaciones con SPID
35
+ result = api_instance.get_spid_classifications_using_get(subscription)
36
+ p result
37
+ rescue Wire4Client::ApiError => e
38
+ puts "Exception when calling TransferenciasSPIDApi->get_spid_classifications_using_get: #{e}"
39
+ end
40
+ ```
41
+
42
+ ### Parameters
43
+
44
+ Name | Type | Description | Notes
45
+ ------------- | ------------- | ------------- | -------------
46
+ **subscription** | **String**| El identificador de la suscripción a esta API |
47
+
48
+ ### Return type
49
+
50
+ [**SpidClassificationsResponseDTO**](SpidClassificationsResponseDTO.md)
51
+
52
+ ### Authorization
53
+
54
+ [wire4_aut_app_user_spid](../README.md#wire4_aut_app_user_spid)
55
+
56
+ ### HTTP request headers
57
+
58
+ - **Content-Type**: Not defined
59
+ - **Accept**: application/json
60
+
61
+
62
+
63
+ # **register_outgoing_spid_transaction_using_post**
64
+ > TokenRequiredResponse register_outgoing_spid_transaction_using_post(subscription, transactions)
65
+
66
+ Registro de transferencias SPID
67
+
68
+ Registra un conjunto de transferencias a realizar en la cuenta del cliente Monex relacionada a la suscripción, las transferencias deben ser confirmadas por el cliente para que se efectuen.
69
+
70
+ ### Example
71
+ ```ruby
72
+ # load the gem
73
+ require 'wire4_client'
74
+ # setup authorization
75
+ Wire4Client.configure do |config|
76
+ # Configure OAuth2 access token for authorization: wire4_aut_app_user_spid
77
+ config.access_token = 'YOUR ACCESS TOKEN'
78
+ end
79
+
80
+ api_instance = Wire4Client::TransferenciasSPIDApi.new
81
+
82
+ subscription = 'subscription_example' # String | El identificador de la suscripción a esta API
83
+
84
+ transactions = Wire4Client::TransactionOutgoingSpid.new # TransactionOutgoingSpid | Información de las transferencias SPID de salida
85
+
86
+
87
+ begin
88
+ #Registro de transferencias SPID
89
+ result = api_instance.register_outgoing_spid_transaction_using_post(subscription, transactions)
90
+ p result
91
+ rescue Wire4Client::ApiError => e
92
+ puts "Exception when calling TransferenciasSPIDApi->register_outgoing_spid_transaction_using_post: #{e}"
93
+ end
94
+ ```
95
+
96
+ ### Parameters
97
+
98
+ Name | Type | Description | Notes
99
+ ------------- | ------------- | ------------- | -------------
100
+ **subscription** | **String**| El identificador de la suscripción a esta API |
101
+ **transactions** | [**TransactionOutgoingSpid**](TransactionOutgoingSpid.md)| Información de las transferencias SPID de salida |
102
+
103
+ ### Return type
104
+
105
+ [**TokenRequiredResponse**](TokenRequiredResponse.md)
106
+
107
+ ### Authorization
108
+
109
+ [wire4_aut_app_user_spid](../README.md#wire4_aut_app_user_spid)
110
+
111
+ ### HTTP request headers
112
+
113
+ - **Content-Type**: application/json
114
+ - **Accept**: application/json
115
+
116
+
117
+
@@ -0,0 +1,10 @@
1
+ # Wire4Client::WebhookRequest
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **events** | **Array&lt;String&gt;** | Tipos de eventos de los cuales Wire4 te enviará información, para mas referencia sobre los tipos de eventos soportados, revise la siguiente liga: https://developers.wire4.mx/#section/Eventos . |
7
+ **name** | **String** | Nombre del webhook. |
8
+ **url** | **String** | URL a la cual Wire4 enviará las notificaciones cuando un evento ocurra. |
9
+
10
+
@@ -0,0 +1,13 @@
1
+ # Wire4Client::WebhookResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **events** | **Array&lt;String&gt;** | Tipos de eventos de los cuales Wire4 te enviará información. | [optional]
7
+ **name** | **String** | Nombre del webhook. | [optional]
8
+ **secret** | **String** | Llave con la cual se debe de identificar que el webhook fue enviado por Wire4, para mayor información revisar la guía de notificaciones (https://wire4.mx/#/guides/notificaciones), en la sección de \&quot;Comprobación de firmas de Webhook\&quot;. | [optional]
9
+ **status** | **String** | Estatus en el que se encuentra el webhook | [optional]
10
+ **url** | **String** | URL a la cual Wire4 enviará las notificaciones cuando un evento ocurra. | [optional]
11
+ **wh_uuid** | **String** | Identificador del webhook. | [optional]
12
+
13
+