wire4_client 0.0.9.pre.TEST → 1.1.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (328) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +1 -1
  3. data/README.md +34 -29
  4. data/docs/Account.md +11 -11
  5. data/docs/AccountReassigned.md +14 -15
  6. data/docs/AccountRequest.md +3 -3
  7. data/docs/AccountResponse.md +13 -14
  8. data/docs/AccountSpid.md +11 -11
  9. data/docs/AmountRequest.md +5 -5
  10. data/docs/AuthorizationTransactionGroup.md +2 -2
  11. data/docs/AuthorizedBeneficiariesResponse.md +3 -3
  12. data/docs/AutorizacinDeDepsitosApi.md +11 -11
  13. data/docs/Balance.md +3 -3
  14. data/docs/BalanceListResponse.md +1 -1
  15. data/docs/BeneficiariesQueryRegisterStatus.md +2 -2
  16. data/docs/BeneficiariesResponse.md +1 -1
  17. data/docs/CepResponse.md +20 -20
  18. data/docs/CepSearchBanxico.md +8 -8
  19. data/docs/CertificateRequest.md +4 -4
  20. data/docs/CodiCodeQrResponseDTO.md +10 -10
  21. data/docs/CodiOperationResponseDTO.md +7 -7
  22. data/docs/CodiOperationsFiltersRequestDTO.md +8 -8
  23. data/docs/CompanyRegistered.md +6 -6
  24. data/docs/CompanyRequested.md +4 -4
  25. data/docs/ConfigurationsLimits.md +1 -1
  26. data/docs/ContactRequest.md +5 -5
  27. data/docs/CuentasDeBeneficiariosSPEIApi.md +54 -54
  28. data/docs/CuentasDeBeneficiariosSPIDApi.md +24 -22
  29. data/docs/Deposit.md +22 -21
  30. data/docs/DepositAuthorizationRequest.md +2 -2
  31. data/docs/Depositant.md +5 -5
  32. data/docs/DepositantesApi.md +6 -6
  33. data/docs/DepositantsRegister.md +4 -4
  34. data/docs/DepositantsResponse.md +1 -1
  35. data/docs/DepositsAuthorizationResponse.md +3 -3
  36. data/docs/EmpresasCoDiApi.md +8 -8
  37. data/docs/GetDepositants.md +1 -1
  38. data/docs/InstitucionesApi.md +5 -3
  39. data/docs/Institution.md +4 -4
  40. data/docs/InstitutionsList.md +1 -1
  41. data/docs/Item.md +2 -2
  42. data/docs/LmitesDeMontosApi.md +9 -9
  43. data/docs/MessageAccountBeneficiary.md +3 -3
  44. data/docs/MessageCEP.md +19 -19
  45. data/docs/MessageCodiAction.md +12 -12
  46. data/docs/MessageDepositAuthorizationRequest.md +21 -20
  47. data/docs/MessageDepositReceived.md +22 -21
  48. data/docs/MessageInstitution.md +4 -4
  49. data/docs/MessagePayment.md +20 -20
  50. data/docs/MessagePaymentStatePending.md +16 -16
  51. data/docs/MessageRequestChanged.md +2 -2
  52. data/docs/MessageSalesPoint.md +3 -3
  53. data/docs/MessageSubscription.md +6 -6
  54. data/docs/MessageUserAuthorized.md +7 -7
  55. data/docs/MessageWebHook.md +9 -9
  56. data/docs/OperacionesCoDiApi.md +12 -12
  57. data/docs/Operations.md +7 -7
  58. data/docs/PagerResponseDto.md +6 -6
  59. data/docs/Payment.md +19 -19
  60. data/docs/PaymentRequestCodiResponseDTO.md +11 -11
  61. data/docs/PeticionesDePagoPorCoDiApi.md +7 -7
  62. data/docs/PreEnrollmentData.md +2 -2
  63. data/docs/PreEnrollmentResponse.md +2 -2
  64. data/docs/PuntosDeVentaCoDiApi.md +14 -14
  65. data/docs/Relationship.md +2 -2
  66. data/docs/RelationshipsResponse.md +1 -1
  67. data/docs/SaldoApi.md +3 -3
  68. data/docs/SalesPointFound.md +7 -7
  69. data/docs/SalesPointRequest.md +4 -4
  70. data/docs/SalesPointRespose.md +3 -3
  71. data/docs/ServiceBanking.md +9 -0
  72. data/docs/SpidBeneficiariesResponse.md +1 -1
  73. data/docs/SpidBeneficiaryResponse.md +11 -12
  74. data/docs/SpidClassificationDTO.md +2 -2
  75. data/docs/SubscriptionChangeStatusRequest.md +8 -0
  76. data/docs/SuscripcionesApi.md +123 -16
  77. data/docs/TokenRequiredResponse.md +2 -2
  78. data/docs/TransactionOutgoingSpid.md +10 -10
  79. data/docs/TransactionsOutgoingRegister.md +3 -3
  80. data/docs/TransferenciasSPEIApi.md +40 -34
  81. data/docs/TransferenciasSPIDApi.md +12 -12
  82. data/docs/UrlsRedirect.md +2 -2
  83. data/docs/UseServiceBanking.md +9 -0
  84. data/docs/WebHookDepositAuthorizationRequest.md +2 -2
  85. data/docs/WebHookDepositAuthorizationResponse.md +6 -6
  86. data/docs/Webhook.md +6 -6
  87. data/docs/WebhookRequest.md +3 -3
  88. data/docs/WebhookResponse.md +5 -5
  89. data/docs/WebhooksApi.md +10 -10
  90. data/lib/wire4_client.rb +4 -1
  91. data/lib/wire4_client/api/autorizacin_de_depsitos_api.rb +13 -13
  92. data/lib/wire4_client/api/comprobante_electrnico_de_pago_cep_api.rb +1 -1
  93. data/lib/wire4_client/api/contacto_api.rb +1 -1
  94. data/lib/wire4_client/api/contracts_details_api.rb +1 -1
  95. data/lib/wire4_client/api/cuentas_de_beneficiarios_spei_api.rb +57 -57
  96. data/lib/wire4_client/api/cuentas_de_beneficiarios_spid_api.rb +25 -23
  97. data/lib/wire4_client/api/depositantes_api.rb +9 -9
  98. data/lib/wire4_client/api/empresas_co_di_api.rb +9 -9
  99. data/lib/wire4_client/api/facturas_api.rb +1 -1
  100. data/lib/wire4_client/api/instituciones_api.rb +5 -3
  101. data/lib/wire4_client/api/lmites_de_montos_api.rb +9 -9
  102. data/lib/wire4_client/api/operaciones_co_di_api.rb +13 -13
  103. data/lib/wire4_client/api/peticiones_de_pago_por_co_di_api.rb +7 -7
  104. data/lib/wire4_client/api/puntos_de_venta_co_di_api.rb +15 -15
  105. data/lib/wire4_client/api/saldo_api.rb +5 -5
  106. data/lib/wire4_client/api/suscripciones_api.rb +150 -17
  107. data/lib/wire4_client/api/transferencias_spei_api.rb +73 -43
  108. data/lib/wire4_client/api/transferencias_spid_api.rb +13 -13
  109. data/lib/wire4_client/api/webhooks_api.rb +16 -16
  110. data/lib/wire4_client/api_client.rb +1 -1
  111. data/lib/wire4_client/api_error.rb +1 -1
  112. data/lib/wire4_client/configuration.rb +1 -1
  113. data/lib/wire4_client/models/account.rb +12 -12
  114. data/lib/wire4_client/models/account_detail.rb +2 -2
  115. data/lib/wire4_client/models/account_reassigned.rb +17 -27
  116. data/lib/wire4_client/models/account_request.rb +4 -4
  117. data/lib/wire4_client/models/account_response.rb +16 -26
  118. data/lib/wire4_client/models/account_spid.rb +60 -12
  119. data/lib/wire4_client/models/address_company.rb +1 -1
  120. data/lib/wire4_client/models/amount_request.rb +7 -7
  121. data/lib/wire4_client/models/authorization_transaction_group.rb +3 -3
  122. data/lib/wire4_client/models/authorized_beneficiaries_response.rb +4 -4
  123. data/lib/wire4_client/models/authorized_users.rb +1 -1
  124. data/lib/wire4_client/models/balance.rb +5 -5
  125. data/lib/wire4_client/models/balance_list_response.rb +2 -2
  126. data/lib/wire4_client/models/beneficiaries_query_register_status.rb +3 -3
  127. data/lib/wire4_client/models/beneficiaries_response.rb +2 -2
  128. data/lib/wire4_client/models/beneficiary_institution.rb +1 -1
  129. data/lib/wire4_client/models/billing.rb +1 -1
  130. data/lib/wire4_client/models/billing_transaction.rb +1 -1
  131. data/lib/wire4_client/models/cep_response.rb +21 -21
  132. data/lib/wire4_client/models/cep_search_banxico.rb +9 -9
  133. data/lib/wire4_client/models/certificate_request.rb +11 -11
  134. data/lib/wire4_client/models/codi_code_qr_response_dto.rb +11 -11
  135. data/lib/wire4_client/models/codi_code_request_dto.rb +1 -1
  136. data/lib/wire4_client/models/codi_operation_response_dto.rb +8 -8
  137. data/lib/wire4_client/models/codi_operations_filters_request_dto.rb +9 -9
  138. data/lib/wire4_client/models/company_registered.rb +7 -7
  139. data/lib/wire4_client/models/company_requested.rb +6 -6
  140. data/lib/wire4_client/models/compay.rb +1 -1
  141. data/lib/wire4_client/models/configurations_limits.rb +2 -2
  142. data/lib/wire4_client/models/contact_request.rb +7 -7
  143. data/lib/wire4_client/models/contract_detail_request.rb +1 -1
  144. data/lib/wire4_client/models/contract_detail_response.rb +1 -1
  145. data/lib/wire4_client/models/deposit.rb +33 -23
  146. data/lib/wire4_client/models/deposit_authorization_request.rb +3 -3
  147. data/lib/wire4_client/models/depositant.rb +6 -6
  148. data/lib/wire4_client/models/depositants_register.rb +5 -5
  149. data/lib/wire4_client/models/depositants_response.rb +2 -2
  150. data/lib/wire4_client/models/deposits_authorization_response.rb +4 -4
  151. data/lib/wire4_client/models/detailed_error_response.rb +1 -1
  152. data/lib/wire4_client/models/error_response.rb +1 -1
  153. data/lib/wire4_client/models/get_depositants.rb +3 -3
  154. data/lib/wire4_client/models/institution.rb +6 -6
  155. data/lib/wire4_client/models/institutions_list.rb +2 -2
  156. data/lib/wire4_client/models/item.rb +4 -4
  157. data/lib/wire4_client/models/message_account_beneficiary.rb +5 -5
  158. data/lib/wire4_client/models/message_cep.rb +21 -21
  159. data/lib/wire4_client/models/message_codi_action.rb +14 -14
  160. data/lib/wire4_client/models/message_configurations_limits.rb +2 -2
  161. data/lib/wire4_client/models/message_deposit_authorization_request.rb +33 -23
  162. data/lib/wire4_client/models/message_deposit_received.rb +34 -24
  163. data/lib/wire4_client/models/message_institution.rb +6 -6
  164. data/lib/wire4_client/models/message_payment.rb +22 -22
  165. data/lib/wire4_client/models/message_payment_state_pending.rb +18 -18
  166. data/lib/wire4_client/models/message_request_changed.rb +4 -4
  167. data/lib/wire4_client/models/message_sales_point.rb +5 -5
  168. data/lib/wire4_client/models/message_subscription.rb +8 -8
  169. data/lib/wire4_client/models/message_user_authorized.rb +9 -9
  170. data/lib/wire4_client/models/message_web_hook.rb +11 -11
  171. data/lib/wire4_client/models/operations.rb +9 -9
  172. data/lib/wire4_client/models/pager_response_dto.rb +7 -7
  173. data/lib/wire4_client/models/payment.rb +20 -20
  174. data/lib/wire4_client/models/payment_codi.rb +1 -1
  175. data/lib/wire4_client/models/payment_request_codi_response_dto.rb +12 -12
  176. data/lib/wire4_client/models/payments_request_id.rb +1 -1
  177. data/lib/wire4_client/models/person.rb +1 -1
  178. data/lib/wire4_client/models/pre_enrollment_data.rb +21 -3
  179. data/lib/wire4_client/models/pre_enrollment_response.rb +3 -3
  180. data/lib/wire4_client/models/pre_monex_authorization.rb +1 -1
  181. data/lib/wire4_client/models/relationship.rb +3 -3
  182. data/lib/wire4_client/models/relationships_response.rb +2 -2
  183. data/lib/wire4_client/models/sales_point.rb +1 -1
  184. data/lib/wire4_client/models/sales_point_found.rb +9 -9
  185. data/lib/wire4_client/models/sales_point_request.rb +11 -11
  186. data/lib/wire4_client/models/sales_point_respose.rb +5 -5
  187. data/lib/wire4_client/models/service_banking.rb +193 -0
  188. data/lib/wire4_client/models/spid_beneficiaries_response.rb +2 -2
  189. data/lib/wire4_client/models/spid_beneficiary_response.rb +13 -23
  190. data/lib/wire4_client/models/spid_classification_dto.rb +3 -3
  191. data/lib/wire4_client/models/spid_classifications_response_dto.rb +1 -1
  192. data/lib/wire4_client/models/subscription_change_status_request.rb +222 -0
  193. data/lib/wire4_client/models/token_required_response.rb +4 -4
  194. data/lib/wire4_client/models/transaction_error_code.rb +1 -1
  195. data/lib/wire4_client/models/transaction_outgoing.rb +1 -1
  196. data/lib/wire4_client/models/transaction_outgoing_spid.rb +12 -12
  197. data/lib/wire4_client/models/transactions_outgoing_register.rb +5 -5
  198. data/lib/wire4_client/models/update_configurations_request_dto.rb +1 -1
  199. data/lib/wire4_client/models/urls_redirect.rb +60 -4
  200. data/lib/wire4_client/models/use_service_banking.rb +251 -0
  201. data/lib/wire4_client/models/user_company.rb +1 -1
  202. data/lib/wire4_client/models/web_hook_deposit_authorization_request.rb +3 -3
  203. data/lib/wire4_client/models/web_hook_deposit_authorization_response.rb +7 -7
  204. data/lib/wire4_client/models/webhook.rb +8 -8
  205. data/lib/wire4_client/models/webhook_request.rb +4 -4
  206. data/lib/wire4_client/models/webhook_response.rb +6 -6
  207. data/lib/wire4_client/models/webhooks_list.rb +1 -1
  208. data/lib/wire4_client/version.rb +2 -2
  209. data/spec/api/autorizacin_de_depsitos_api_spec.rb +7 -7
  210. data/spec/api/comprobante_electrnico_de_pago_cep_api_spec.rb +1 -1
  211. data/spec/api/contacto_api_spec.rb +1 -1
  212. data/spec/api/contracts_details_api_spec.rb +1 -1
  213. data/spec/api/cuentas_de_beneficiarios_spei_api_spec.rb +29 -29
  214. data/spec/api/cuentas_de_beneficiarios_spid_api_spec.rb +13 -12
  215. data/spec/api/depositantes_api_spec.rb +5 -5
  216. data/spec/api/empresas_co_di_api_spec.rb +5 -5
  217. data/spec/api/facturas_api_spec.rb +1 -1
  218. data/spec/api/instituciones_api_spec.rb +3 -2
  219. data/spec/api/lmites_de_montos_api_spec.rb +5 -5
  220. data/spec/api/operaciones_co_di_api_spec.rb +7 -7
  221. data/spec/api/peticiones_de_pago_por_co_di_api_spec.rb +4 -4
  222. data/spec/api/puntos_de_venta_co_di_api_spec.rb +8 -8
  223. data/spec/api/saldo_api_spec.rb +3 -3
  224. data/spec/api/suscripciones_api_spec.rb +37 -9
  225. data/spec/api/transferencias_spei_api_spec.rb +20 -18
  226. data/spec/api/transferencias_spid_api_spec.rb +7 -7
  227. data/spec/api/webhooks_api_spec.rb +5 -5
  228. data/spec/api_client_spec.rb +1 -1
  229. data/spec/configuration_spec.rb +1 -1
  230. data/spec/models/account_detail_spec.rb +1 -1
  231. data/spec/models/account_reassigned_spec.rb +1 -7
  232. data/spec/models/account_request_spec.rb +1 -1
  233. data/spec/models/account_response_spec.rb +1 -7
  234. data/spec/models/account_spec.rb +1 -1
  235. data/spec/models/account_spid_spec.rb +1 -1
  236. data/spec/models/address_company_spec.rb +1 -1
  237. data/spec/models/amount_request_spec.rb +1 -1
  238. data/spec/models/authorization_transaction_group_spec.rb +1 -1
  239. data/spec/models/authorized_beneficiaries_response_spec.rb +1 -1
  240. data/spec/models/authorized_users_spec.rb +1 -1
  241. data/spec/models/balance_list_response_spec.rb +1 -1
  242. data/spec/models/balance_spec.rb +1 -1
  243. data/spec/models/beneficiaries_query_register_status_spec.rb +1 -1
  244. data/spec/models/beneficiaries_response_spec.rb +1 -1
  245. data/spec/models/beneficiary_institution_spec.rb +1 -1
  246. data/spec/models/billing_spec.rb +1 -1
  247. data/spec/models/billing_transaction_spec.rb +1 -1
  248. data/spec/models/cep_response_spec.rb +1 -1
  249. data/spec/models/cep_search_banxico_spec.rb +1 -1
  250. data/spec/models/certificate_request_spec.rb +1 -1
  251. data/spec/models/codi_code_qr_response_dto_spec.rb +1 -1
  252. data/spec/models/codi_code_request_dto_spec.rb +1 -1
  253. data/spec/models/codi_operation_response_dto_spec.rb +1 -1
  254. data/spec/models/codi_operations_filters_request_dto_spec.rb +1 -1
  255. data/spec/models/company_registered_spec.rb +1 -1
  256. data/spec/models/company_requested_spec.rb +1 -1
  257. data/spec/models/compay_spec.rb +1 -1
  258. data/spec/models/configurations_limits_spec.rb +1 -1
  259. data/spec/models/contact_request_spec.rb +1 -1
  260. data/spec/models/contract_detail_request_spec.rb +1 -1
  261. data/spec/models/contract_detail_response_spec.rb +1 -1
  262. data/spec/models/deposit_authorization_request_spec.rb +1 -1
  263. data/spec/models/deposit_spec.rb +7 -1
  264. data/spec/models/depositant_spec.rb +1 -1
  265. data/spec/models/depositants_register_spec.rb +1 -1
  266. data/spec/models/depositants_response_spec.rb +1 -1
  267. data/spec/models/deposits_authorization_response_spec.rb +1 -1
  268. data/spec/models/detailed_error_response_spec.rb +1 -1
  269. data/spec/models/error_response_spec.rb +1 -1
  270. data/spec/models/get_depositants_spec.rb +1 -1
  271. data/spec/models/institution_spec.rb +1 -1
  272. data/spec/models/institutions_list_spec.rb +1 -1
  273. data/spec/models/item_spec.rb +1 -1
  274. data/spec/models/message_account_beneficiary_spec.rb +1 -1
  275. data/spec/models/message_cep_spec.rb +1 -1
  276. data/spec/models/message_codi_action_spec.rb +1 -1
  277. data/spec/models/message_configurations_limits_spec.rb +1 -1
  278. data/spec/models/message_deposit_authorization_request_spec.rb +7 -1
  279. data/spec/models/message_deposit_received_spec.rb +7 -1
  280. data/spec/models/message_institution_spec.rb +1 -1
  281. data/spec/models/message_payment_spec.rb +1 -1
  282. data/spec/models/message_payment_state_pending_spec.rb +1 -1
  283. data/spec/models/message_request_changed_spec.rb +1 -1
  284. data/spec/models/message_sales_point_spec.rb +1 -1
  285. data/spec/models/message_subscription_spec.rb +1 -1
  286. data/spec/models/message_user_authorized_spec.rb +1 -1
  287. data/spec/models/message_web_hook_spec.rb +1 -1
  288. data/spec/models/operations_spec.rb +1 -1
  289. data/spec/models/pager_response_dto_spec.rb +1 -1
  290. data/spec/models/payment_codi_spec.rb +1 -1
  291. data/spec/models/payment_request_codi_response_dto_spec.rb +1 -1
  292. data/spec/models/payment_spec.rb +1 -1
  293. data/spec/models/payments_request_id_spec.rb +1 -1
  294. data/spec/models/person_spec.rb +1 -1
  295. data/spec/models/pre_enrollment_data_spec.rb +1 -1
  296. data/spec/models/pre_enrollment_response_spec.rb +1 -1
  297. data/spec/models/pre_monex_authorization_spec.rb +1 -1
  298. data/spec/models/relationship_spec.rb +1 -1
  299. data/spec/models/relationships_response_spec.rb +1 -1
  300. data/spec/models/sales_point_found_spec.rb +1 -1
  301. data/spec/models/sales_point_request_spec.rb +1 -1
  302. data/spec/models/sales_point_respose_spec.rb +1 -1
  303. data/spec/models/sales_point_spec.rb +1 -1
  304. data/spec/models/service_banking_spec.rb +47 -0
  305. data/spec/models/spid_beneficiaries_response_spec.rb +1 -1
  306. data/spec/models/spid_beneficiary_response_spec.rb +1 -7
  307. data/spec/models/spid_classification_dto_spec.rb +1 -1
  308. data/spec/models/spid_classifications_response_dto_spec.rb +1 -1
  309. data/spec/models/subscription_change_status_request_spec.rb +45 -0
  310. data/spec/models/token_required_response_spec.rb +1 -1
  311. data/spec/models/transaction_error_code_spec.rb +1 -1
  312. data/spec/models/transaction_outgoing_spec.rb +1 -1
  313. data/spec/models/transaction_outgoing_spid_spec.rb +1 -1
  314. data/spec/models/transactions_outgoing_register_spec.rb +1 -1
  315. data/spec/models/update_configurations_request_dto_spec.rb +1 -1
  316. data/spec/models/urls_redirect_spec.rb +1 -1
  317. data/spec/models/use_service_banking_spec.rb +55 -0
  318. data/spec/models/user_company_spec.rb +1 -1
  319. data/spec/models/web_hook_deposit_authorization_request_spec.rb +1 -1
  320. data/spec/models/web_hook_deposit_authorization_response_spec.rb +1 -1
  321. data/spec/models/webhook_request_spec.rb +1 -1
  322. data/spec/models/webhook_response_spec.rb +1 -1
  323. data/spec/models/webhook_spec.rb +1 -1
  324. data/spec/models/webhooks_list_spec.rb +1 -1
  325. data/spec/spec_helper.rb +1 -1
  326. data/wire4_client.gemspec +2 -2
  327. metadata +17 -6
  328. data/wire4_client-1.0.9.gem +0 -0
data/docs/PagerResponseDto.md CHANGED
@@ -3,11 +3,11 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **content** | [**Array<Operations>**](Operations.md) | Contenido de la respuesta paginada | [optional]
7
- **number_of_elements** | **Integer** | Numero de elementos en la pagina | [optional]
8
- **page** | **Integer** | Número de pagina | [optional]
9
- **size** | **Integer** | Tamaño de la pagina | [optional]
10
- **total_items** | **Integer** | Numero total de elementos de la consulta | [optional]
11
- **total_pages** | **Integer** | Numero total de paginas | [optional]
6
+ **content** | [**Array<Operations>**](Operations.md) | Es el contenido de la respuesta paginada. | [optional]
7
+ **number_of_elements** | **Integer** | Es el número de elementos en la página actual. | [optional]
8
+ **page** | **Integer** | Es el número de página. | [optional]
9
+ **size** | **Integer** | Es el tamaño de la página, por ejemplo puede ser 20, que significa que son 20 registros por página. | [optional]
10
+ **total_items** | **Integer** | Es el número total de elementos de la consulta. | [optional]
11
+ **total_pages** | **Integer** | Es el número total de paginas. | [optional]
12
12
 
13
13
 
data/docs/Payment.md CHANGED
@@ -3,24 +3,24 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **account** | **String** | Cuenta emisora | [optional]
7
- **amount** | **Float** | Monto de la transferencia | [optional]
8
- **beneficiary_account** | **String** | Cuenta del beneficiario | [optional]
9
- **beneficiary_bank** | [**Institution**](Institution.md) | Información del banco beneficiario | [optional]
10
- **beneficiary_name** | **String** | Nombre del Beneficiario | [optional]
11
- **cep** | [**MessageCEP**](MessageCEP.md) | CEP emitido por Banxico de la transferencia, sólo en caso de que este disponible en Banxico, posteriomente podrá usar la consulta de CEP del API | [optional]
12
- **clave_rastreo** | **String** | Clave de rastreo de la transferencia | [optional]
13
- **concept** | **String** | Concepto de pago | [optional]
14
- **confirm_date** | **DateTime** | Fecha de aplicación de la transferencia | [optional]
15
- **currency_code** | **String** | Código de moneda de la transferencia | [optional]
16
- **detention_message** | **String** | Mensaje proporcionado por Monex para la transferencia | [optional]
17
- **error_message** | **String** | Mensaje de error, en caso de algún error se informará aquí | [optional]
18
- **monex_description** | **String** | Descripción | [optional]
19
- **order_id** | **String** | Identificador asignado por la aplciación a la transferencia | [optional]
20
- **payment_order_id** | **Integer** | Identificador de la orden de pago en Monex | [optional]
21
- **pending_reason** | **String** | Razón de porque esta pendiente aun cuando se autorizó la transferencia | [optional]
22
- **reference** | **Integer** | Referencia numérica | [optional]
23
- **status_code** | **String** | Estado de la transferencia de la transferencia, los posibles valores son: PENDING, COMPLETED, FAILED, CANCELLED | [optional]
24
- **transaction_id** | **Integer** | Identificador de la transferencia asignado por Monex | [optional]
6
+ **account** | **String** | Es la cuenta emisora. | [optional]
7
+ **amount** | **Float** | Es el monto de la transferencia. | [optional]
8
+ **beneficiary_account** | **String** | Es la cuenta del beneficiario. | [optional]
9
+ **beneficiary_bank** | [**Institution**](Institution.md) | Es la información del banco beneficiario. | [optional]
10
+ **beneficiary_name** | **String** | Es el nombre del Beneficiario. | [optional]
11
+ **cep** | [**MessageCEP**](MessageCEP.md) | Es el Comprobante Electrónico de Pago (CEP) emitido por Banxico de la transferencia. Sólo en caso de que este disponible en Banxico, posteriomente podrá usar la <a href=\"#operation/obtainTransactionCepUsingPOST\">Consulta de CEP</a> que ésta misma API ofrece. | [optional]
12
+ **clave_rastreo** | **String** | Es la clave de rastreo de la transferencia. | [optional]
13
+ **concept** | **String** | Es el concepto de pago. | [optional]
14
+ **confirm_date** | **DateTime** | Es la fecha de aplicación de la transferencia. Ésta fecha viene en formato ISO 8601 con zona horaria, ejemplo: <strong>2020-10-27T11:03:15.000-06:00</strong>. | [optional]
15
+ **currency_code** | **String** | Es el código de divisa de la transferencia. Es en el formato estándar de 3 dígitos. Ejemplo del peso mexicano: <b>MXP</b>, ejemplo del dólar estadounidense: <b>USD</b>. | [optional]
16
+ **detention_message** | **String** | Es el mensaje proporcionado por Monex para la transferencia. | [optional]
17
+ **error_message** | **String** | Es el mensaje de error, en caso de algún error se informará aquí. | [optional]
18
+ **monex_description** | **String** | Es la descripción de Monex. | [optional]
19
+ **order_id** | **String** | Es el identificador asignado por la aplciación a la transferencia. | [optional]
20
+ **payment_order_id** | **Integer** | Es el identificador de la orden de pago en Monex. | [optional]
21
+ **pending_reason** | **String** | Es la razón de porque esta pendiente aún cuando se autorizó la transferencia. | [optional]
22
+ **reference** | **Integer** | Es la referencia numérica. | [optional]
23
+ **status_code** | **String** | Es el estado de la transferencia de la transferencia, los posibles valores son: <b>PENDING, COMPLETED, FAILED, CANCELLED</b> | [optional]
24
+ **transaction_id** | **Integer** | Es el identificador de la transferencia asignado por Monex. | [optional]
25
25
 
26
26
 
data/docs/PaymentRequestCodiResponseDTO.md CHANGED
@@ -3,16 +3,16 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **amount** | **Float** | Monto del pago. | [optional]
7
- **barcode_base64** | **String** | Imagen QR en formato Base64 para el CODI®. | [optional]
8
- **barcode_url** | **String** | URL de la imagen QR para el CODI®. | [optional]
9
- **concept** | **String** | Concepto de pago. | [optional]
10
- **creation_date** | **DateTime** | Fecha de creación. | [optional]
11
- **due_date** | **DateTime** | Fecha de vencimiento. | [optional]
12
- **operations** | [**Array<CodiOperationResponseDTO>**](CodiOperationResponseDTO.md) | Listado de pagos realizados sobre la petición. | [optional]
13
- **order_id** | **String** | OrderId asignada a la solicitud. | [optional]
14
- **phone_number** | **String** | Numero de teléfono. | [optional]
15
- **status** | **String** | Estatus de la orden de pago. | [optional]
16
- **type** | **String** | Tipo de petición. | [optional]
6
+ **amount** | **Float** | Es el Monto del pago. Ejemplo 1000.00 | [optional]
7
+ **barcode_base64** | **String** | Es la imagen QR en formato Base64 para el CODI®. | [optional]
8
+ **barcode_url** | **String** | Es la dirección URL de la imagen QR para el CODI®. | [optional]
9
+ **concept** | **String** | Es el concepto de pago. | [optional]
10
+ **creation_date** | **DateTime** | Es la fecha de creación. Ésta fecha viene en formato ISO 8601 con zona horaria, ejemplo: <strong>2020-10-27T11:03:15.000-06:00</strong>. | [optional]
11
+ **due_date** | **DateTime** | Es la fecha de vencimiento. Ésta fecha viene en formato ISO 8601 con zona horaria, ejemplo: <strong>2020-10-27T11:03:15.000-06:00</strong>. | [optional]
12
+ **operations** | [**Array<CodiOperationResponseDTO>**](CodiOperationResponseDTO.md) | Es el listado de pagos realizados sobre la petición. | [optional]
13
+ **order_id** | **String** | Es el orderId asignado a la solicitud. | [optional]
14
+ **phone_number** | **String** | Es el número de teléfono. | [optional]
15
+ **status** | **String** | Es el estado (estatus) de la orden de pago. Los valores pueden ser: <b>RECEIVED, COMPLETED Y CANCELLED</b> | [optional]
16
+ **type** | **String** | Es el tipo de petición. Los valores pueden ser: <b>QR_CODE o PUSH_NOTIFICATION</b> | [optional]
17
17
 
18
18
 
data/docs/PeticionesDePagoPorCoDiApi.md CHANGED
@@ -4,16 +4,16 @@ All URIs are relative to *https://sandbox-api.wire4.mx/wire4/1.0.0*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
- [**consult_codi_request_by_order_id**](PeticionesDePagoPorCoDiApi.md#consult_codi_request_by_order_id) | **GET** /codi/sales-point/charges | Obtiene la información de una petición de pago CODI® por orderId para un punto de venta
8
- [**generate_codi_code_qr**](PeticionesDePagoPorCoDiApi.md#generate_codi_code_qr) | **POST** /codi/sales-point/charges | Genera un código QR para un pago mediante CODI®
7
+ [**consult_codi_request_by_order_id**](PeticionesDePagoPorCoDiApi.md#consult_codi_request_by_order_id) | **GET** /codi/sales-point/charges | Consulta información de petición por orderId
8
+ [**generate_codi_code_qr**](PeticionesDePagoPorCoDiApi.md#generate_codi_code_qr) | **POST** /codi/sales-point/charges | Genera código QR
9
9
 
10
10
 
11
11
  # **consult_codi_request_by_order_id**
12
12
  > PaymentRequestCodiResponseDTO consult_codi_request_by_order_id(authorization, order_id, sales_point_id)
13
13
 
14
- Obtiene la información de una petición de pago CODI® por orderId para un punto de venta
14
+ Consulta información de petición por orderId
15
15
 
16
- Obtiene la información de una petición de pago CODI® por orderId para un punto de venta
16
+ Obtiene la información de una petición de pago CODI® por orderId para un punto de venta.
17
17
 
18
18
  ### Example
19
19
  ```ruby
@@ -30,7 +30,7 @@ sales_point_id = 'sales_point_id_example' # String | Identificador del punto de
30
30
 
31
31
 
32
32
  begin
33
- #Obtiene la información de una petición de pago CODI® por orderId para un punto de venta
33
+ #Consulta información de petición por orderId
34
34
  result = api_instance.consult_codi_request_by_order_id(authorization, order_id, sales_point_id)
35
35
  p result
36
36
  rescue Wire4Client::ApiError => e
@@ -64,7 +64,7 @@ No authorization required
64
64
  # **generate_codi_code_qr**
65
65
  > CodiCodeQrResponseDTO generate_codi_code_qr(authorization, codi_info, sales_point_id)
66
66
 
67
- Genera un código QR para un pago mediante CODI®
67
+ Genera código QR
68
68
 
69
69
  Genera un código QR solicitado por un punto de venta para un pago mediante CODI®
70
70
 
@@ -83,7 +83,7 @@ sales_point_id = 'sales_point_id_example' # String | Identificador del punto de
83
83
 
84
84
 
85
85
  begin
86
- #Genera un código QR para un pago mediante CODI®
86
+ #Genera código QR
87
87
  result = api_instance.generate_codi_code_qr(authorization, codi_info, sales_point_id)
88
88
  p result
89
89
  rescue Wire4Client::ApiError => e
data/docs/PreEnrollmentData.md CHANGED
@@ -3,7 +3,7 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **cancel_return_url** | **String** | Url a la que se redirigirá en caso de un error |
7
- **return_url** | **String** | Url a la que se redirigirá en caso de exito |
6
+ **cancel_return_url** | **String** | Es la dirección URL a la que se redirigirá en caso de que el cliente cancele el registro. Se valida una longitud de 512 caracteres y que la URL sea por ejemplo: http://mysite.com/return. |
7
+ **return_url** | **String** | Es la dirección URL a la que se redirigirá en caso de exito. Se valida una longitud de 512 caracteres y que la URL sea por ejemplo: http://mysite.com/cancel. |
8
8
 
9
9
 
data/docs/PreEnrollmentResponse.md CHANGED
@@ -3,7 +3,7 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **subscription_id** | **String** | Identificador público generado | [optional]
7
- **url** | **String** | Url para confirmación de enrolamiento | [optional]
6
+ **subscription_id** | **String** | Es el identificador público generado para la suscripción. | [optional]
7
+ **url** | **String** | Es la dirección URL del centro de autorizción para confirmación del alta de la suscripción. | [optional]
8
8
 
9
9
 
data/docs/PuntosDeVentaCoDiApi.md CHANGED
@@ -4,16 +4,16 @@ All URIs are relative to *https://sandbox-api.wire4.mx/wire4/1.0.0*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
- [**create_sales_point**](PuntosDeVentaCoDiApi.md#create_sales_point) | **POST** /codi/companies/salespoint | Registra un punto de venta asociado a una empresa
8
- [**obtain_sale_points**](PuntosDeVentaCoDiApi.md#obtain_sale_points) | **GET** /codi/companies/salespoint | Obtiene los puntos de venta asociados a una empresa
7
+ [**create_sales_point**](PuntosDeVentaCoDiApi.md#create_sales_point) | **POST** /codi/companies/salespoint | Registro de punto de venta.
8
+ [**obtain_sale_points**](PuntosDeVentaCoDiApi.md#obtain_sale_points) | **GET** /codi/companies/salespoint | Consulta de puntos de venta
9
9
 
10
10
 
11
11
  # **create_sales_point**
12
12
  > SalesPointRespose create_sales_point(authorization, company_id, sales_point_info)
13
13
 
14
- Registra un punto de venta asociado a una empresa
14
+ Registro de punto de venta.
15
15
 
16
- Registra un punto de venta desde donde se emitaran los cobros CODI®, el punto de venta se debe asociar a un cuenta cableregistrada previamente ante Banxico para realizar cobros con CODI®
16
+ Se registra un punto de venta (TPV) desde donde se emitarán los cobros CODI®. El punto de venta se debe asociar a un cuenta CLABE registrada previamente ante Banxico para realizar cobros con CODI®.
17
17
 
18
18
  ### Example
19
19
  ```ruby
@@ -24,13 +24,13 @@ api_instance = Wire4Client::PuntosDeVentaCoDiApi.new
24
24
 
25
25
  authorization = 'authorization_example' # String | Header para token
26
26
 
27
- company_id = 'company_id_example' # String | El identificador de la empresa
27
+ company_id = 'company_id_example' # String | Es el identificador de la empresa.
28
28
 
29
- sales_point_info = Wire4Client::SalesPointRequest.new # SalesPointRequest | Información del punto de venta CODI®
29
+ sales_point_info = Wire4Client::SalesPointRequest.new # SalesPointRequest | Es el objeto que contiene información del punto de venta CODI®.
30
30
 
31
31
 
32
32
  begin
33
- #Registra un punto de venta asociado a una empresa
33
+ #Registro de punto de venta.
34
34
  result = api_instance.create_sales_point(authorization, company_id, sales_point_info)
35
35
  p result
36
36
  rescue Wire4Client::ApiError => e
@@ -43,8 +43,8 @@ end
43
43
  Name | Type | Description | Notes
44
44
  ------------- | ------------- | ------------- | -------------
45
45
  **authorization** | **String**| Header para token |
46
- **company_id** | **String**| El identificador de la empresa |
47
- **sales_point_info** | [**SalesPointRequest**](SalesPointRequest.md)| Información del punto de venta CODI® |
46
+ **company_id** | **String**| Es el identificador de la empresa. |
47
+ **sales_point_info** | [**SalesPointRequest**](SalesPointRequest.md)| Es el objeto que contiene información del punto de venta CODI®. |
48
48
 
49
49
  ### Return type
50
50
 
@@ -64,9 +64,9 @@ No authorization required
64
64
  # **obtain_sale_points**
65
65
  > Array<SalesPointFound> obtain_sale_points(authorization, company_id)
66
66
 
67
- Obtiene los puntos de venta asociados a una empresa
67
+ Consulta de puntos de venta
68
68
 
69
- Obtiene los puntos de venta asociados a una empresa en las cuales se hacen operaciones CODI®
69
+ Obtiene los puntos de venta asociados a una empresa en las cuales se hacen operaciones CODI®.
70
70
 
71
71
  ### Example
72
72
  ```ruby
@@ -77,11 +77,11 @@ api_instance = Wire4Client::PuntosDeVentaCoDiApi.new
77
77
 
78
78
  authorization = 'authorization_example' # String | Header para token
79
79
 
80
- company_id = 'company_id_example' # String | El identificador de la empresa
80
+ company_id = 'company_id_example' # String | Es el identificador de la empresa. Ejemplo: 8838d513-5916-4662-bb30-2448f0f543ed
81
81
 
82
82
 
83
83
  begin
84
- #Obtiene los puntos de venta asociados a una empresa
84
+ #Consulta de puntos de venta
85
85
  result = api_instance.obtain_sale_points(authorization, company_id)
86
86
  p result
87
87
  rescue Wire4Client::ApiError => e
@@ -94,7 +94,7 @@ end
94
94
  Name | Type | Description | Notes
95
95
  ------------- | ------------- | ------------- | -------------
96
96
  **authorization** | **String**| Header para token |
97
- **company_id** | **String**| El identificador de la empresa |
97
+ **company_id** | **String**| Es el identificador de la empresa. Ejemplo: 8838d513-5916-4662-bb30-2448f0f543ed |
98
98
 
99
99
  ### Return type
100
100
 
data/docs/Relationship.md CHANGED
@@ -3,7 +3,7 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **kind_of_relationship** | **String** | Tipo de relación | [optional]
7
- **relationship** | **String** | Nombre de la relación | [optional]
6
+ **kind_of_relationship** | **String** | Es el tipo de relación. | [optional]
7
+ **relationship** | **String** | Es el mombre de la relación. | [optional]
8
8
 
9
9
 
data/docs/RelationshipsResponse.md CHANGED
@@ -3,6 +3,6 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **relationships** | [**Array<Relationship>**](Relationship.md) | Lista de relaciones del beneficiario | [optional]
6
+ **relationships** | [**Array<Relationship>**](Relationship.md) | Es una lista de relaciones del beneficiario. | [optional]
7
7
 
8
8
 
data/docs/SaldoApi.md CHANGED
@@ -12,7 +12,7 @@ Method | HTTP request | Description
12
12
 
13
13
  Consulta los saldo de una cuenta
14
14
 
15
- Obtiene el de las divisas que se manejen en el contrato.
15
+ Obtiene el saldo de un contrato, según las divisas que se manejen en dicho contrato, ya sea peso mexicano (MXP) o dólar estadounidense (USD).
16
16
 
17
17
  ### Example
18
18
  ```ruby
@@ -23,7 +23,7 @@ api_instance = Wire4Client::SaldoApi.new
23
23
 
24
24
  authorization = 'authorization_example' # String | Header para token
25
25
 
26
- subscription = 'subscription_example' # String | El identificador de la suscripción a esta API
26
+ subscription = 'subscription_example' # String | Es el identificador de la suscripción a esta API.
27
27
 
28
28
 
29
29
  begin
@@ -40,7 +40,7 @@ end
40
40
  Name | Type | Description | Notes
41
41
  ------------- | ------------- | ------------- | -------------
42
42
  **authorization** | **String**| Header para token |
43
- **subscription** | **String**| El identificador de la suscripción a esta API |
43
+ **subscription** | **String**| Es el identificador de la suscripción a esta API. |
44
44
 
45
45
  ### Return type
46
46
 
data/docs/SalesPointFound.md CHANGED
@@ -3,12 +3,12 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **access_ip** | **String** | Ip desde la que accede el punto de venta a wire4 y a la que se devuelven las notificaciones | [optional]
7
- **account** | **String** | Cuenta registra para el punto de venta | [optional]
8
- **created_at** | **DateTime** | Fecha en la que se creó el punto de venta | [optional]
9
- **name** | **String** | Nombre del punto de venta | [optional]
10
- **public_id** | **String** | Identificador del punto de venta | [optional]
11
- **status** | **String** | Estatus ACTIVO/INACTIVO el punto de venta | [optional]
12
- **updated_at** | **DateTime** | Fecha en la que se actualizó el punto de venta | [optional]
6
+ **access_ip** | **String** | Es la dirección IP desde la que accede el punto de venta a wire4 y a la que se devuelven las notificaciones. | [optional]
7
+ **account** | **String** | Es la cuenta registra para el punto de venta. | [optional]
8
+ **created_at** | **DateTime** | Es la fecha en la que se creó el punto de venta. Ésta fecha viene en formato ISO 8601 con zona horaria, ejemplo: <strong>2020-10-27T11:03:15.000-06:00</strong>. | [optional]
9
+ **name** | **String** | Es el nombre del punto de venta. | [optional]
10
+ **public_id** | **String** | Es el identificador del punto de venta. | [optional]
11
+ **status** | **String** | Es el estado (estatus) del punto de venta. Puede ser \"ACTIVE\" o \"INACTIVO\". | [optional]
12
+ **updated_at** | **DateTime** | Es la fecha en la que se actualizó el punto de venta. Ésta fecha viene en formato ISO 8601 con zona horaria, ejemplo: <strong>2020-10-27T11:03:15.000-06:00</strong>. | [optional]
13
13
 
14
14
 
data/docs/SalesPointRequest.md CHANGED
@@ -3,9 +3,9 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **access_ip** | **String** | IP desde donde se recibiran las peticiones de este punto de venta |
7
- **account** | **String** | Número de cuenta CLABE donde se realizará el deposito del cobro CoDi |
8
- **name** | **String** | Nombre del punto de venta |
9
- **notifications_url** | **String** | URL para envíar notificaciones CoDi al punto de venta |
6
+ **access_ip** | **String** | Es la dirección IP desde donde se recibirán las peticiones de este punto de venta |
7
+ **account** | **String** | Es el número de cuenta CLABE donde se realizará el deposito del cobro CODI®. |
8
+ **name** | **String** | Es el nombre del punto de venta. |
9
+ **notifications_url** | **String** | Es la dirección URL para envíar notificaciones CODI® al punto de venta. |
10
10
 
11
11
 
data/docs/SalesPointRespose.md CHANGED
@@ -3,9 +3,9 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **sales_point_id** | **String** | Identificador del punto de venta | [optional]
7
- **user_key** | **String** | Llave de usuario para el API Wire4 | [optional]
8
- **user_secret** | **String** | Contraseña para el API Wire4 | [optional]
6
+ **sales_point_id** | **String** | Es el identificador del punto de venta. | [optional]
7
+ **user_key** | **String** | Es la llave de usuario para el API Wire4. Sólo para el uso de CODI®. | [optional]
8
+ **user_secret** | **String** | Es la contraseña para el API Wire4. Sólo para el uso de CODI®. | [optional]
9
9
  **webhook** | [**Webhook**](Webhook.md) | codiWebhook | [optional]
10
10
 
11
11
 
data/docs/ServiceBanking.md ADDED
@@ -0,0 +1,9 @@
1
+ # Wire4Client::ServiceBanking
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **spei** | [**UseServiceBanking**](UseServiceBanking.md) | | [optional]
7
+ **spid** | [**UseServiceBanking**](UseServiceBanking.md) | | [optional]
8
+
9
+
data/docs/SpidBeneficiariesResponse.md CHANGED
@@ -3,6 +3,6 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **beneficiaries** | [**Array<SpidBeneficiaryResponse>**](SpidBeneficiaryResponse.md) | Lista de beneficiarios obtenidos | [optional]
6
+ **beneficiaries** | [**Array<SpidBeneficiaryResponse>**](SpidBeneficiaryResponse.md) | Es una lista de beneficiarios obtenidos. | [optional]
7
7
 
8
8
 
data/docs/SpidBeneficiaryResponse.md CHANGED
@@ -3,18 +3,17 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **amount_limit** | **Float** | Monto límite permitido para la cuenta |
7
- **authorization_date** | **DateTime** | La fecha/hora en la que se autorizo el registro del beneficiario desde el centro de autorización | [optional]
8
- **bank** | [**Institution**](Institution.md) | El banco al cual pertenece la cuenta | [optional]
9
- **beneficiary_account** | **String** | Cuenta del beneficiario debe ser una cuenta CLABE |
10
- **email** | **Array<String>** | Lista de email's, este dato es opcional | [optional]
6
+ **amount_limit** | **Float** | Monto límite permitido para la cuenta. Ejemplo: 1000.00 |
7
+ **bank** | [**Institution**](Institution.md) | El banco al cual pertenece la cuenta. | [optional]
8
+ **beneficiary_account** | **String** | Cuenta del beneficiario debe ser una cuenta CLABE. Ejemplo: 032180000118359719. |
9
+ **email** | **Array<String>** | Lista de correos electrónicos (emails), este dato es opcional. | [optional]
11
10
  **institution** | [**BeneficiaryInstitution**](BeneficiaryInstitution.md) | Objeto que contiene el nombre de la institución, es mutuamente exclusivo con el objeto Person |
12
- **kind_of_relationship** | **String** | Tipo de relación de la cuenta, este valor debe ser igual a uno de los obtenidos del recurso de consulta de relationships |
13
- **numeric_reference_spid** | **String** | Referencia numérica | [optional]
14
- **payment_concept_spid** | **String** | Concepto de pago | [optional]
15
- **register_date** | **DateTime** | La fecha en la que se registro el beneficiario | [optional]
16
- **relationship** | **String** | Código de relación de la cuenta, este valor debe ser igual a uno de los obtenidos del recurso de consulta de relationship |
17
- **rfc** | **String** | Registro federal de contribuyentes | [optional]
18
- **status** | **String** | El estado en el que se encuentra el registo del beneficiario | [optional]
11
+ **kind_of_relationship** | **String** | Es el tipo de relación que se tiene con el propietario de la cuenta. Para registrar una cuenta, este valor se debe obtener del recurso <a href=\"#operation/getAvailableRelationshipsMonexUsingGET\"> relationships.</a> <br /><br /><b>Nota:</b> <em>Si en la respuesta de Monex esta propiedad es nula, tampoco estará presente en esta respuesta.</em> |
12
+ **numeric_reference_spid** | **String** | Referencia numérica. | [optional]
13
+ **payment_concept_spid** | **String** | Concepto de pago. | [optional]
14
+ **register_date** | **DateTime** | La fecha en la que se registro el beneficiario. | [optional]
15
+ **relationship** | **String** | Es la relación con el propietario de la cuenta, para registrar este valor se debe obtener del recurso <a href=\"#operation/getAvailableRelationshipsMonexUsingGET\">relationships.</a> <br/> <br/> <b>Nota:</b> Si en la respuesta de Monex, sta propiedad es nula, tampoco estará presente en esta respuesta. |
16
+ **rfc** | **String** | Es el Registro federal de contribuyentes (RFC) de la persona o institución propietaria de la cuenta. <br/> <br/><b>Nota:</b> Se valida el formato de RFC. | [optional]
17
+ **status** | **String** | El estado en el que se encuentra el registo del beneficiario.<br><br> Los valores pueden ser: <b>\"RECEIVED\", \"DELETED\", \"REQUEST_ERROR_BY_MONEX\", \"REQUESTED_TO_MONEX\", \"NOTIFIED_BY_MONEX\", \"NOTIFIED_BY_SPEIOK\", \"NOTIFIED_WITH_ERROR_BY_SPEIOK\" y \"PENDING\"</b> | [optional]
19
18
 
20
19
 
data/docs/SpidClassificationDTO.md CHANGED
@@ -3,7 +3,7 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **classification_id** | **String** | El identificador de la clasificación | [optional]
7
- **description** | **String** | Las descripción de la clasificación de la operación | [optional]
6
+ **classification_id** | **String** | Es el identificador de la clasificación. | [optional]
7
+ **description** | **String** | Es la descripción de la clasificación de la operación. | [optional]
8
8
 
9
9
 
data/docs/SubscriptionChangeStatusRequest.md ADDED
@@ -0,0 +1,8 @@
1
+ # Wire4Client::SubscriptionChangeStatusRequest
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **status** | **String** | |
7
+
8
+
data/docs/SuscripcionesApi.md CHANGED
@@ -4,17 +4,124 @@ All URIs are relative to *https://sandbox-api.wire4.mx/wire4/1.0.0*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
- [**pre_enrollment_monex_user_using_post**](SuscripcionesApi.md#pre_enrollment_monex_user_using_post) | **POST** /subscriptions/pre-subscription | Registra una pre-suscripción
8
- [**remove_enrollment_user_using_delete**](SuscripcionesApi.md#remove_enrollment_user_using_delete) | **DELETE** /subscriptions/{subscription} | Elimina una suscripción por el identificador de la suscripción
9
- [**remove_subscription_pending_status_using_delete**](SuscripcionesApi.md#remove_subscription_pending_status_using_delete) | **DELETE** /subscriptions/pre-subscription/{subscription} | Elimina una pre-suscripción
7
+ [**change_subscription_status_using_put**](SuscripcionesApi.md#change_subscription_status_using_put) | **PUT** /subscriptions/{subscription}/status | Cambia el estatus de la suscripción
8
+ [**change_subscription_use_using_patch**](SuscripcionesApi.md#change_subscription_use_using_patch) | **PATCH** /subscriptions/{subscription} | Cambia el uso de la suscripción
9
+ [**pre_enrollment_monex_user_using_post**](SuscripcionesApi.md#pre_enrollment_monex_user_using_post) | **POST** /subscriptions/pre-subscription | Pre-registro de una suscripción
10
+ [**remove_enrollment_user_using_delete**](SuscripcionesApi.md#remove_enrollment_user_using_delete) | **DELETE** /subscriptions/{subscription} | Elimina suscripción por su identificador.
11
+ [**remove_subscription_pending_status_using_delete**](SuscripcionesApi.md#remove_subscription_pending_status_using_delete) | **DELETE** /subscriptions/pre-subscription/{subscription} | Elimina pre-registro de suscripción
12
+
13
+
14
+ # **change_subscription_status_using_put**
15
+ > change_subscription_status_using_put(authorization, request, subscription)
16
+
17
+ Cambia el estatus de la suscripción
18
+
19
+ Se cambia el estado o estatus de la suscripción a los posibles valores que son: ACTIVE o INACTIVE
20
+
21
+ ### Example
22
+ ```ruby
23
+ # load the gem
24
+ require 'wire4_client'
25
+
26
+ api_instance = Wire4Client::SuscripcionesApi.new
27
+
28
+ authorization = 'authorization_example' # String | Header para token
29
+
30
+ request = Wire4Client::SubscriptionChangeStatusRequest.new # SubscriptionChangeStatusRequest | request
31
+
32
+ subscription = 'subscription_example' # String | subscription
33
+
34
+
35
+ begin
36
+ #Cambia el estatus de la suscripción
37
+ api_instance.change_subscription_status_using_put(authorization, request, subscription)
38
+ rescue Wire4Client::ApiError => e
39
+ puts "Exception when calling SuscripcionesApi->change_subscription_status_using_put: #{e}"
40
+ end
41
+ ```
42
+
43
+ ### Parameters
44
+
45
+ Name | Type | Description | Notes
46
+ ------------- | ------------- | ------------- | -------------
47
+ **authorization** | **String**| Header para token |
48
+ **request** | [**SubscriptionChangeStatusRequest**](SubscriptionChangeStatusRequest.md)| request |
49
+ **subscription** | **String**| subscription |
50
+
51
+ ### Return type
52
+
53
+ nil (empty response body)
54
+
55
+ ### Authorization
56
+
57
+ No authorization required
58
+
59
+ ### HTTP request headers
60
+
61
+ - **Content-Type**: application/json
62
+ - **Accept**: */*
63
+
64
+
65
+
66
+ # **change_subscription_use_using_patch**
67
+ > ServiceBanking change_subscription_use_using_patch(authorization, request, subscription)
68
+
69
+ Cambia el uso de la suscripción
70
+
71
+ Se asigna o cambia el uso y el estatus que se le dará a la subscripción para los servicios SPEI y SPID en el manejo de Cobros y Pagos El status puede tener los posibles valores: ACTIVE o INACTIVE. El uso puede tener los posibles valores: WITHDRAWAL_DEPOSIT o WITHDRAWAL o DEPOSIT
72
+
73
+ ### Example
74
+ ```ruby
75
+ # load the gem
76
+ require 'wire4_client'
77
+
78
+ api_instance = Wire4Client::SuscripcionesApi.new
79
+
80
+ authorization = 'authorization_example' # String | Header para token
81
+
82
+ request = Wire4Client::ServiceBanking.new # ServiceBanking | request
83
+
84
+ subscription = 'subscription_example' # String | subscription
85
+
86
+
87
+ begin
88
+ #Cambia el uso de la suscripción
89
+ result = api_instance.change_subscription_use_using_patch(authorization, request, subscription)
90
+ p result
91
+ rescue Wire4Client::ApiError => e
92
+ puts "Exception when calling SuscripcionesApi->change_subscription_use_using_patch: #{e}"
93
+ end
94
+ ```
95
+
96
+ ### Parameters
97
+
98
+ Name | Type | Description | Notes
99
+ ------------- | ------------- | ------------- | -------------
100
+ **authorization** | **String**| Header para token |
101
+ **request** | [**ServiceBanking**](ServiceBanking.md)| request |
102
+ **subscription** | **String**| subscription |
103
+
104
+ ### Return type
105
+
106
+ [**ServiceBanking**](ServiceBanking.md)
107
+
108
+ ### Authorization
109
+
110
+ No authorization required
111
+
112
+ ### HTTP request headers
113
+
114
+ - **Content-Type**: application/json
115
+ - **Accept**: */*
116
+
10
117
 
11
118
 
12
119
  # **pre_enrollment_monex_user_using_post**
13
120
  > PreEnrollmentResponse pre_enrollment_monex_user_using_post(authorization, pre_enrollment_data)
14
121
 
15
- Registra una pre-suscripción
122
+ Pre-registro de una suscripción
16
123
 
17
- Registra una pre-suscripción para operar un contrato a través de un aplicación socio de la plataforma, proporcionando una URL donde el cliente Monex debe autorizar el acceso a los datos de su cuenta a el socio.<br/>Una vez que el cuentahabiente autorice el acceso, se envía un mensaje webhook con el evento 'ENROLLMENT.CREATED', el cuál contiene los datos de acceso a esta API.
124
+ Pre-registra una suscripción para operar un contrato a través de un aplicación socio de la plataforma. Se retorna una dirección URL hacia el centro de autorización donde el cliente Monex debe autorizar el acceso a los datos de su cuenta a el socio.<br/><br/>Una vez que el cuentahabiente autorice el acceso, se envía una notificación (webhook configurado) con el evento 'ENROLLMENT.CREATED', el cuál contiene los datos de acceso a esta API.
18
125
 
19
126
  ### Example
20
127
  ```ruby
@@ -29,7 +136,7 @@ pre_enrollment_data = Wire4Client::PreEnrollmentData.new # PreEnrollmentData | I
29
136
 
30
137
 
31
138
  begin
32
- #Registra una pre-suscripción
139
+ #Pre-registro de una suscripción
33
140
  result = api_instance.pre_enrollment_monex_user_using_post(authorization, pre_enrollment_data)
34
141
  p result
35
142
  rescue Wire4Client::ApiError => e
@@ -62,9 +169,9 @@ No authorization required
62
169
  # **remove_enrollment_user_using_delete**
63
170
  > remove_enrollment_user_using_delete(authorization, subscription)
64
171
 
65
- Elimina una suscripción por el identificador de la suscripción
172
+ Elimina suscripción por su identificador.
66
173
 
67
- Elimina una suscripción, una vez eliminada ya no se podrán realizar operacions en el API utilizando esta suscripción
174
+ Elimina una suscripción mediante su identificador. Una vez eliminada dicha suscripción, ya no se podrán realizar operaciones en el API utilizando sus credenciales
68
175
 
69
176
  ### Example
70
177
  ```ruby
@@ -75,11 +182,11 @@ api_instance = Wire4Client::SuscripcionesApi.new
75
182
 
76
183
  authorization = 'authorization_example' # String | Header para token
77
184
 
78
- subscription = 'subscription_example' # String | El identificador de la suscripción a esta API
185
+ subscription = 'subscription_example' # String | El identificador de la suscripción a ésta API
79
186
 
80
187
 
81
188
  begin
82
- #Elimina una suscripción por el identificador de la suscripción
189
+ #Elimina suscripción por su identificador.
83
190
  api_instance.remove_enrollment_user_using_delete(authorization, subscription)
84
191
  rescue Wire4Client::ApiError => e
85
192
  puts "Exception when calling SuscripcionesApi->remove_enrollment_user_using_delete: #{e}"
@@ -91,7 +198,7 @@ end
91
198
  Name | Type | Description | Notes
92
199
  ------------- | ------------- | ------------- | -------------
93
200
  **authorization** | **String**| Header para token |
94
- **subscription** | **String**| El identificador de la suscripción a esta API |
201
+ **subscription** | **String**| El identificador de la suscripción a ésta API |
95
202
 
96
203
  ### Return type
97
204
 
@@ -111,9 +218,9 @@ No authorization required
111
218
  # **remove_subscription_pending_status_using_delete**
112
219
  > remove_subscription_pending_status_using_delete(authorization, subscription)
113
220
 
114
- Elimina una pre-suscripción
221
+ Elimina pre-registro de suscripción
115
222
 
116
- Se elimina una pre-suscripción, sólo se elimina en caso de que el cliente Monex no haya concedido su autorización de acceso (token), es decir que la pre-suscripcion este pendiente.
223
+ Se elimina el pre-registro de suscripción. Sólo se elimina en caso de que el cliente Monex no haya concedido su autorización de acceso (token), es decir que la suscripcion esté pendiente.
117
224
 
118
225
  ### Example
119
226
  ```ruby
@@ -124,11 +231,11 @@ api_instance = Wire4Client::SuscripcionesApi.new
124
231
 
125
232
  authorization = 'authorization_example' # String | Header para token
126
233
 
127
- subscription = 'subscription_example' # String | El identificador de la suscripción a esta API
234
+ subscription = 'subscription_example' # String | Es el identificador de la suscripción a esta API.
128
235
 
129
236
 
130
237
  begin
131
- #Elimina una pre-suscripción
238
+ #Elimina pre-registro de suscripción
132
239
  api_instance.remove_subscription_pending_status_using_delete(authorization, subscription)
133
240
  rescue Wire4Client::ApiError => e
134
241
  puts "Exception when calling SuscripcionesApi->remove_subscription_pending_status_using_delete: #{e}"
@@ -140,7 +247,7 @@ end
140
247
  Name | Type | Description | Notes
141
248
  ------------- | ------------- | ------------- | -------------
142
249
  **authorization** | **String**| Header para token |
143
- **subscription** | **String**| El identificador de la suscripción a esta API |
250
+ **subscription** | **String**| Es el identificador de la suscripción a esta API. |
144
251
 
145
252
  ### Return type
146
253