wire4_client 1.0.5 → 1.1.3

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 (229) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +1 -1
  3. data/README.md +51 -30
  4. data/docs/Account.md +11 -11
  5. data/docs/AccountReassigned.md +14 -14
  6. data/docs/AccountRequest.md +3 -3
  7. data/docs/AccountResponse.md +13 -13
  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 +113 -0
  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/BillingTransaction.md +1 -1
  18. data/docs/CepResponse.md +20 -20
  19. data/docs/CepSearchBanxico.md +8 -8
  20. data/docs/CertificateRequest.md +4 -4
  21. data/docs/CodiCodeQrResponseDTO.md +10 -10
  22. data/docs/CodiOperationResponseDTO.md +7 -7
  23. data/docs/CodiOperationsFiltersRequestDTO.md +8 -8
  24. data/docs/CompanyRegistered.md +6 -6
  25. data/docs/CompanyRequested.md +4 -4
  26. data/docs/ConfigurationsLimits.md +9 -0
  27. data/docs/ContactRequest.md +5 -5
  28. data/docs/ContractsDetailsApi.md +55 -0
  29. data/docs/CuentasDeBeneficiariosSPEIApi.md +54 -54
  30. data/docs/CuentasDeBeneficiariosSPIDApi.md +24 -22
  31. data/docs/Deposit.md +22 -21
  32. data/docs/DepositAuthorizationRequest.md +10 -0
  33. data/docs/Depositant.md +5 -5
  34. data/docs/DepositantesApi.md +6 -6
  35. data/docs/DepositantsRegister.md +4 -4
  36. data/docs/DepositantsResponse.md +1 -1
  37. data/docs/DepositsAuthorizationResponse.md +10 -0
  38. data/docs/DetailedErrorResponse.md +10 -0
  39. data/docs/EmpresasCoDiApi.md +8 -8
  40. data/docs/GetDepositants.md +1 -1
  41. data/docs/InstitucionesApi.md +5 -3
  42. data/docs/Institution.md +4 -4
  43. data/docs/InstitutionsList.md +1 -1
  44. data/docs/Item.md +10 -0
  45. data/docs/LmitesDeMontosApi.md +112 -0
  46. data/docs/MessageAccountBeneficiary.md +3 -3
  47. data/docs/MessageCEP.md +19 -19
  48. data/docs/MessageCodiAction.md +12 -12
  49. data/docs/MessageConfigurationsLimits.md +8 -0
  50. data/docs/MessageDepositAuthorizationRequest.md +28 -0
  51. data/docs/MessageDepositReceived.md +22 -21
  52. data/docs/MessageInstitution.md +4 -4
  53. data/docs/MessagePayment.md +20 -20
  54. data/docs/MessagePaymentStatePending.md +16 -16
  55. data/docs/MessageRequestChanged.md +2 -2
  56. data/docs/MessageSalesPoint.md +3 -3
  57. data/docs/MessageSubscription.md +6 -6
  58. data/docs/MessageUserAuthorized.md +7 -6
  59. data/docs/MessageWebHook.md +9 -9
  60. data/docs/OperacionesCoDiApi.md +12 -12
  61. data/docs/Operations.md +8 -8
  62. data/docs/PagerResponseDto.md +6 -6
  63. data/docs/Payment.md +19 -19
  64. data/docs/PaymentCODI.md +13 -0
  65. data/docs/PaymentRequestCodiResponseDTO.md +11 -11
  66. data/docs/PeticionesDePagoPorCoDiApi.md +7 -7
  67. data/docs/PreEnrollmentData.md +2 -2
  68. data/docs/PreEnrollmentResponse.md +2 -2
  69. data/docs/PuntosDeVentaCoDiApi.md +14 -14
  70. data/docs/Relationship.md +2 -2
  71. data/docs/RelationshipsResponse.md +1 -1
  72. data/docs/SaldoApi.md +3 -3
  73. data/docs/SalesPointFound.md +7 -7
  74. data/docs/SalesPointRequest.md +4 -4
  75. data/docs/SalesPointRespose.md +4 -4
  76. data/docs/ServiceBanking.md +9 -0
  77. data/docs/SpidBeneficiariesResponse.md +1 -1
  78. data/docs/SpidBeneficiaryResponse.md +11 -11
  79. data/docs/SpidClassificationDTO.md +2 -2
  80. data/docs/SubscriptionChangeStatusRequest.md +8 -0
  81. data/docs/SuscripcionesApi.md +123 -16
  82. data/docs/TokenRequiredResponse.md +2 -2
  83. data/docs/TransactionErrorCode.md +10 -0
  84. data/docs/TransactionOutgoingSpid.md +10 -10
  85. data/docs/TransactionsOutgoingRegister.md +3 -3
  86. data/docs/TransferenciasSPEIApi.md +40 -34
  87. data/docs/TransferenciasSPIDApi.md +12 -12
  88. data/docs/UpdateConfigurationsRequestDTO.md +8 -0
  89. data/docs/UrlsRedirect.md +2 -2
  90. data/docs/UseServiceBanking.md +9 -0
  91. data/docs/WebHookDepositAuthorizationRequest.md +9 -0
  92. data/docs/WebHookDepositAuthorizationResponse.md +13 -0
  93. data/docs/Webhook.md +6 -6
  94. data/docs/WebhookRequest.md +3 -3
  95. data/docs/WebhookResponse.md +5 -5
  96. data/docs/WebhooksApi.md +10 -10
  97. data/lib/wire4_client/api/autorizacin_de_depsitos_api.rb +173 -0
  98. data/lib/wire4_client/api/contracts_details_api.rb +71 -0
  99. data/lib/wire4_client/api/cuentas_de_beneficiarios_spei_api.rb +56 -56
  100. data/lib/wire4_client/api/cuentas_de_beneficiarios_spid_api.rb +24 -22
  101. data/lib/wire4_client/api/depositantes_api.rb +79 -8
  102. data/lib/wire4_client/api/empresas_co_di_api.rb +8 -8
  103. data/lib/wire4_client/api/instituciones_api.rb +4 -2
  104. data/lib/wire4_client/api/lmites_de_montos_api.rb +160 -0
  105. data/lib/wire4_client/api/operaciones_co_di_api.rb +12 -12
  106. data/lib/wire4_client/api/peticiones_de_pago_por_co_di_api.rb +6 -6
  107. data/lib/wire4_client/api/puntos_de_venta_co_di_api.rb +14 -14
  108. data/lib/wire4_client/api/saldo_api.rb +4 -4
  109. data/lib/wire4_client/api/suscripciones_api.rb +149 -16
  110. data/lib/wire4_client/api/transferencias_spei_api.rb +72 -42
  111. data/lib/wire4_client/api/transferencias_spid_api.rb +12 -12
  112. data/lib/wire4_client/api/webhooks_api.rb +15 -15
  113. data/lib/wire4_client/models/account.rb +11 -11
  114. data/lib/wire4_client/models/account_detail.rb +1 -1
  115. data/lib/wire4_client/models/account_reassigned.rb +15 -15
  116. data/lib/wire4_client/models/account_request.rb +3 -3
  117. data/lib/wire4_client/models/account_response.rb +14 -14
  118. data/lib/wire4_client/models/account_spid.rb +59 -11
  119. data/lib/wire4_client/models/amount_request.rb +6 -6
  120. data/lib/wire4_client/models/authorization_transaction_group.rb +2 -2
  121. data/lib/wire4_client/models/authorized_beneficiaries_response.rb +3 -3
  122. data/lib/wire4_client/models/balance.rb +4 -4
  123. data/lib/wire4_client/models/balance_list_response.rb +1 -1
  124. data/lib/wire4_client/models/beneficiaries_query_register_status.rb +2 -2
  125. data/lib/wire4_client/models/beneficiaries_response.rb +1 -1
  126. data/lib/wire4_client/models/billing_transaction.rb +1 -1
  127. data/lib/wire4_client/models/cep_response.rb +20 -20
  128. data/lib/wire4_client/models/cep_search_banxico.rb +8 -8
  129. data/lib/wire4_client/models/certificate_request.rb +5 -5
  130. data/lib/wire4_client/models/codi_code_qr_response_dto.rb +10 -10
  131. data/lib/wire4_client/models/codi_operation_response_dto.rb +7 -7
  132. data/lib/wire4_client/models/codi_operations_filters_request_dto.rb +8 -8
  133. data/lib/wire4_client/models/company_registered.rb +6 -6
  134. data/lib/wire4_client/models/company_requested.rb +5 -5
  135. data/lib/wire4_client/models/configurations_limits.rb +197 -0
  136. data/lib/wire4_client/models/contact_request.rb +6 -6
  137. data/lib/wire4_client/models/deposit.rb +32 -22
  138. data/lib/wire4_client/models/deposit_authorization_request.rb +205 -0
  139. data/lib/wire4_client/models/depositant.rb +5 -5
  140. data/lib/wire4_client/models/depositant_count_response.rb +185 -0
  141. data/lib/wire4_client/models/depositants_register.rb +4 -4
  142. data/lib/wire4_client/models/depositants_response.rb +1 -1
  143. data/lib/wire4_client/models/deposits_authorization_response.rb +205 -0
  144. data/lib/wire4_client/models/detailed_error_response.rb +203 -0
  145. data/lib/wire4_client/models/get_depositants.rb +2 -2
  146. data/lib/wire4_client/models/institution.rb +5 -5
  147. data/lib/wire4_client/models/institutions_list.rb +1 -1
  148. data/lib/wire4_client/models/item.rb +205 -0
  149. data/lib/wire4_client/models/message_account_beneficiary.rb +4 -4
  150. data/lib/wire4_client/models/message_cep.rb +20 -20
  151. data/lib/wire4_client/models/message_codi_action.rb +13 -13
  152. data/lib/wire4_client/models/message_configurations_limits.rb +187 -0
  153. data/lib/wire4_client/models/message_deposit_authorization_request.rb +385 -0
  154. data/lib/wire4_client/models/message_deposit_received.rb +33 -23
  155. data/lib/wire4_client/models/message_institution.rb +5 -5
  156. data/lib/wire4_client/models/message_payment.rb +21 -21
  157. data/lib/wire4_client/models/message_payment_state_pending.rb +17 -17
  158. data/lib/wire4_client/models/message_request_changed.rb +3 -3
  159. data/lib/wire4_client/models/message_sales_point.rb +4 -4
  160. data/lib/wire4_client/models/message_subscription.rb +7 -7
  161. data/lib/wire4_client/models/message_user_authorized.rb +21 -11
  162. data/lib/wire4_client/models/message_web_hook.rb +10 -10
  163. data/lib/wire4_client/models/operations.rb +9 -9
  164. data/lib/wire4_client/models/pager_response_dto.rb +6 -6
  165. data/lib/wire4_client/models/payment.rb +19 -19
  166. data/lib/wire4_client/models/payment_codi.rb +269 -0
  167. data/lib/wire4_client/models/payment_request_codi_response_dto.rb +11 -11
  168. data/lib/wire4_client/models/pre_enrollment_data.rb +20 -2
  169. data/lib/wire4_client/models/pre_enrollment_response.rb +2 -2
  170. data/lib/wire4_client/models/relationship.rb +2 -2
  171. data/lib/wire4_client/models/relationships_response.rb +1 -1
  172. data/lib/wire4_client/models/sales_point_found.rb +10 -10
  173. data/lib/wire4_client/models/sales_point_request.rb +5 -5
  174. data/lib/wire4_client/models/sales_point_respose.rb +5 -5
  175. data/lib/wire4_client/models/service_banking.rb +193 -0
  176. data/lib/wire4_client/models/spid_beneficiaries_response.rb +1 -1
  177. data/lib/wire4_client/models/spid_beneficiary_response.rb +11 -11
  178. data/lib/wire4_client/models/spid_classification_dto.rb +2 -2
  179. data/lib/wire4_client/models/subscription_change_status_request.rb +222 -0
  180. data/lib/wire4_client/models/token_required_response.rb +3 -3
  181. data/lib/wire4_client/models/transaction_error_code.rb +201 -0
  182. data/lib/wire4_client/models/transaction_outgoing_spid.rb +11 -11
  183. data/lib/wire4_client/models/transactions_outgoing_register.rb +4 -4
  184. data/lib/wire4_client/models/update_configurations_request_dto.rb +192 -0
  185. data/lib/wire4_client/models/urls_redirect.rb +59 -3
  186. data/lib/wire4_client/models/use_service_banking.rb +251 -0
  187. data/lib/wire4_client/models/web_hook_deposit_authorization_request.rb +195 -0
  188. data/lib/wire4_client/models/{timestamp.rb → web_hook_deposit_authorization_response.rb} +47 -74
  189. data/lib/wire4_client/models/webhook.rb +7 -7
  190. data/lib/wire4_client/models/webhook_request.rb +3 -3
  191. data/lib/wire4_client/models/webhook_response.rb +5 -5
  192. data/lib/wire4_client/version.rb +1 -1
  193. data/lib/wire4_client.rb +18 -1
  194. data/spec/api/autorizacin_de_depsitos_api_spec.rb +62 -0
  195. data/spec/api/contracts_details_api_spec.rb +14 -0
  196. data/spec/api/cuentas_de_beneficiarios_spei_api_spec.rb +28 -28
  197. data/spec/api/cuentas_de_beneficiarios_spid_api_spec.rb +12 -11
  198. data/spec/api/depositantes_api_spec.rb +4 -4
  199. data/spec/api/empresas_co_di_api_spec.rb +4 -4
  200. data/spec/api/instituciones_api_spec.rb +2 -1
  201. data/spec/api/lmites_de_montos_api_spec.rb +62 -0
  202. data/spec/api/operaciones_co_di_api_spec.rb +6 -6
  203. data/spec/api/peticiones_de_pago_por_co_di_api_spec.rb +3 -3
  204. data/spec/api/puntos_de_venta_co_di_api_spec.rb +7 -7
  205. data/spec/api/saldo_api_spec.rb +2 -2
  206. data/spec/api/suscripciones_api_spec.rb +36 -8
  207. data/spec/api/transferencias_spei_api_spec.rb +19 -17
  208. data/spec/api/transferencias_spid_api_spec.rb +6 -6
  209. data/spec/api/webhooks_api_spec.rb +4 -4
  210. data/spec/models/configurations_limits_spec.rb +47 -0
  211. data/spec/models/deposit_authorization_request_spec.rb +53 -0
  212. data/spec/models/deposit_spec.rb +6 -0
  213. data/spec/models/deposits_authorization_response_spec.rb +53 -0
  214. data/spec/models/detailed_error_response_spec.rb +53 -0
  215. data/spec/models/item_spec.rb +53 -0
  216. data/spec/models/message_configurations_limits_spec.rb +41 -0
  217. data/spec/models/message_deposit_authorization_request_spec.rb +161 -0
  218. data/spec/models/message_deposit_received_spec.rb +6 -0
  219. data/spec/models/message_user_authorized_spec.rb +6 -0
  220. data/spec/models/{timestamp_spec.rb → payment_codi_spec.rb} +16 -36
  221. data/spec/models/service_banking_spec.rb +47 -0
  222. data/spec/models/subscription_change_status_request_spec.rb +45 -0
  223. data/spec/models/transaction_error_code_spec.rb +53 -0
  224. data/spec/models/update_configurations_request_dto_spec.rb +41 -0
  225. data/spec/models/use_service_banking_spec.rb +55 -0
  226. data/spec/models/web_hook_deposit_authorization_request_spec.rb +47 -0
  227. data/spec/models/web_hook_deposit_authorization_response_spec.rb +71 -0
  228. metadata +72 -7
  229. data/docs/Timestamp.md +0 -17
@@ -19,10 +19,81 @@ module Wire4Client
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
+ # Consulta cuantas cuentas de depositantes existen
23
+ # Obtiene la cantidad el total de depositantes asociados al contrato relacionado a la suscripción.
24
+ # @param authorization Header para token
25
+ # @param subscription Es el identificador de la suscripción a esta API.
26
+ # @param [Hash] opts the optional parameters
27
+ # @return [DepositantCountResponse]
28
+ def get_depositants_totals_using_get(authorization, subscription, opts = {})
29
+ data, _status_code, _headers = get_depositants_totals_using_get_with_http_info(authorization, subscription, opts)
30
+ data
31
+ end
32
+
33
+ # Consulta cuantas cuentas de depositantes existen
34
+ # Obtiene la cantidad el total de depositantes asociados al contrato relacionado a la suscripción.
35
+ # @param authorization Header para token
36
+ # @param subscription Es el identificador de la suscripción a esta API.
37
+ # @param [Hash] opts the optional parameters
38
+ # @return [Array<(DepositantCountResponse, Fixnum, Hash)>] DepositantCountResponse data, response status code and response headers
39
+ def get_depositants_totals_using_get_with_http_info(authorization, subscription, opts = {})
40
+ if @api_client.config.debugging
41
+ @api_client.config.logger.debug 'Calling API: DepositantesApi.get_depositants_totals_using_get ...'
42
+ end
43
+ # verify the required parameter 'authorization' is set
44
+ if @api_client.config.client_side_validation && authorization.nil?
45
+ fail ArgumentError, "Missing the required parameter 'authorization' when calling DepositantesApi.get_depositants_totals_using_get"
46
+ end
47
+ # verify the required parameter 'subscription' is set
48
+ if @api_client.config.client_side_validation && subscription.nil?
49
+ fail ArgumentError, "Missing the required parameter 'subscription' when calling DepositantesApi.get_depositants_totals_using_get"
50
+ end
51
+ if @api_client.config.client_side_validation && subscription.to_s.length > 36
52
+ fail ArgumentError, 'invalid value for "subscription" when calling DepositantesApi.get_depositants_totals_using_get, the character length must be smaller than or equal to 36.'
53
+ end
54
+
55
+ if @api_client.config.client_side_validation && subscription.to_s.length < 36
56
+ fail ArgumentError, 'invalid value for "subscription" when calling DepositantesApi.get_depositants_totals_using_get, the character length must be great than or equal to 36.'
57
+ end
58
+
59
+ if @api_client.config.client_side_validation && subscription !~ Regexp.new(/[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[34][A-Fa-f0-9]{3}-[89ab][A-Fa-f0-9]{3}-[A-Fa-f0-9]{12}$/)
60
+ fail ArgumentError, "invalid value for 'subscription' when calling DepositantesApi.get_depositants_totals_using_get, must conform to the pattern /[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[34][A-Fa-f0-9]{3}-[89ab][A-Fa-f0-9]{3}-[A-Fa-f0-9]{12}$/."
61
+ end
62
+
63
+ # resource path
64
+ local_var_path = '/subscriptions/{subscription}/depositants/count'.sub('{' + 'subscription' + '}', subscription.to_s)
65
+
66
+ # query parameters
67
+ query_params = {}
68
+
69
+ # header parameters
70
+ header_params = {}
71
+ # HTTP header 'Accept' (if needed)
72
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
73
+ header_params[:'Authorization'] = authorization
74
+
75
+ # form parameters
76
+ form_params = {}
77
+
78
+ # http body (model)
79
+ post_body = nil
80
+ auth_names = []
81
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
82
+ :header_params => header_params,
83
+ :query_params => query_params,
84
+ :form_params => form_params,
85
+ :body => post_body,
86
+ :auth_names => auth_names,
87
+ :return_type => 'DepositantCountResponse')
88
+ if @api_client.config.debugging
89
+ @api_client.config.logger.debug "API called: DepositantesApi#get_depositants_totals_using_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
90
+ end
91
+ return data, status_code, headers
92
+ end
22
93
  # Consulta de cuentas de depositantes
23
- # Obtiene una lista de depositantes asociados al contrato relacionado a la subscripción.
94
+ # Obtiene una lista de depositantes asociados al contrato relacionado a la suscripción.
24
95
  # @param authorization Header para token
25
- # @param subscription El identificador de la suscripción a esta API
96
+ # @param subscription Es el identificador de la suscripción a esta API.
26
97
  # @param [Hash] opts the optional parameters
27
98
  # @return [GetDepositants]
28
99
  def get_depositants_using_get(authorization, subscription, opts = {})
@@ -31,9 +102,9 @@ module Wire4Client
31
102
  end
32
103
 
33
104
  # Consulta de cuentas de depositantes
34
- # Obtiene una lista de depositantes asociados al contrato relacionado a la subscripción.
105
+ # Obtiene una lista de depositantes asociados al contrato relacionado a la suscripción.
35
106
  # @param authorization Header para token
36
- # @param subscription El identificador de la suscripción a esta API
107
+ # @param subscription Es el identificador de la suscripción a esta API.
37
108
  # @param [Hash] opts the optional parameters
38
109
  # @return [Array<(GetDepositants, Fixnum, Hash)>] GetDepositants data, response status code and response headers
39
110
  def get_depositants_using_get_with_http_info(authorization, subscription, opts = {})
@@ -91,10 +162,10 @@ module Wire4Client
91
162
  return data, status_code, headers
92
163
  end
93
164
  # Registra un nuevo depositante
94
- # Registra un nuevo depositante en el contrato asociado a la subscripción.
165
+ # Registra un nuevo depositante en el contrato asociado a la suscripción.
95
166
  # @param authorization Header para token
96
167
  # @param register Depositant info
97
- # @param subscription El identificador de la suscripción a esta API
168
+ # @param subscription Es el identificador de la suscripción a esta API.
98
169
  # @param [Hash] opts the optional parameters
99
170
  # @return [DepositantsResponse]
100
171
  def register_depositants_using_post(authorization, register, subscription, opts = {})
@@ -103,10 +174,10 @@ module Wire4Client
103
174
  end
104
175
 
105
176
  # Registra un nuevo depositante
106
- # Registra un nuevo depositante en el contrato asociado a la subscripción.
177
+ # Registra un nuevo depositante en el contrato asociado a la suscripción.
107
178
  # @param authorization Header para token
108
179
  # @param register Depositant info
109
- # @param subscription El identificador de la suscripción a esta API
180
+ # @param subscription Es el identificador de la suscripción a esta API.
110
181
  # @param [Hash] opts the optional parameters
111
182
  # @return [Array<(DepositantsResponse, Fixnum, Hash)>] DepositantsResponse data, response status code and response headers
112
183
  def register_depositants_using_post_with_http_info(authorization, register, subscription, opts = {})
@@ -19,8 +19,8 @@ module Wire4Client
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
- # Consulta de empresas CODI
23
- # Consulta de empresas CODI registradas para la aplicación.
22
+ # Consulta de empresas CODI®
23
+ # Consulta de empresas CODI® registradas para la aplicación.
24
24
  # @param authorization Header para token
25
25
  # @param [Hash] opts the optional parameters
26
26
  # @return [Array<CompanyRegistered>]
@@ -29,8 +29,8 @@ module Wire4Client
29
29
  data
30
30
  end
31
31
 
32
- # Consulta de empresas CODI
33
- # Consulta de empresas CODI registradas para la aplicación.
32
+ # Consulta de empresas CODI®
33
+ # Consulta de empresas CODI® registradas para la aplicación.
34
34
  # @param authorization Header para token
35
35
  # @param [Hash] opts the optional parameters
36
36
  # @return [Array<(Array<CompanyRegistered>, Fixnum, Hash)>] Array<CompanyRegistered> data, response status code and response headers
@@ -72,8 +72,8 @@ module Wire4Client
72
72
  end
73
73
  return data, status_code, headers
74
74
  end
75
- # Registro de empresas CODI
76
- # Registra una empresa para hacer uso de operaciones CODI. Es requerido tener el certificado emitido por BANXICO® asi como el Nombre de la empresa, Nombre comercial y RFC de la empresa.<br/>
75
+ # Registro de empresas CODI®
76
+ # Registra una empresa para hacer uso de operaciones CODI®.<br><br> <b>Nota:<b> Es requerido tener el certificado emitido por BANXICO® asi como el Nombre de la empresa, Nombre comercial y el Registro Federal de Contribuyentes (RFC) de la empresa.<br/>
77
77
  # @param authorization Header para token
78
78
  # @param request_dto Información de la cuenta del beneficiario
79
79
  # @param [Hash] opts the optional parameters
@@ -83,8 +83,8 @@ module Wire4Client
83
83
  data
84
84
  end
85
85
 
86
- # Registro de empresas CODI
87
- # Registra una empresa para hacer uso de operaciones CODI. Es requerido tener el certificado emitido por BANXICO® asi como el Nombre de la empresa, Nombre comercial y RFC de la empresa.&lt;br/&gt;
86
+ # Registro de empresas CODI®
87
+ # Registra una empresa para hacer uso de operaciones CODI®.&lt;br&gt;&lt;br&gt; &lt;b&gt;Nota:&lt;b&gt; Es requerido tener el certificado emitido por BANXICO® asi como el Nombre de la empresa, Nombre comercial y el Registro Federal de Contribuyentes (RFC) de la empresa.&lt;br/&gt;
88
88
  # @param authorization Header para token
89
89
  # @param request_dto Información de la cuenta del beneficiario
90
90
  # @param [Hash] opts the optional parameters
@@ -19,7 +19,8 @@ module Wire4Client
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
- # Información de instituciones bancarias.
22
+ # Consulta de instituciones bancarias
23
+ # Se obtiene un listado de las instituciones bancarias y la información de cada una de estas.
23
24
  # @param authorization Header para token
24
25
  # @param [Hash] opts the optional parameters
25
26
  # @return [InstitutionsList]
@@ -28,7 +29,8 @@ module Wire4Client
28
29
  data
29
30
  end
30
31
 
31
- # Información de instituciones bancarias.
32
+ # Consulta de instituciones bancarias
33
+ # Se obtiene un listado de las instituciones bancarias y la información de cada una de estas.
32
34
  # @param authorization Header para token
33
35
  # @param [Hash] opts the optional parameters
34
36
  # @return [Array<(InstitutionsList, Fixnum, Hash)>] InstitutionsList data, response status code and response headers
@@ -0,0 +1,160 @@
1
+ =begin
2
+ #Wire4RestAPI
3
+
4
+ #Referencia de la API de Wire4
5
+
6
+ OpenAPI spec version: 1.0.0
7
+
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 2.4.10
10
+
11
+ =end
12
+
13
+ require 'uri'
14
+
15
+ module Wire4Client
16
+ class LmitesDeMontosApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # Consulta de configuraciones
23
+ # Consulta las configuraciones para el contrato asocaido al enrolamiento en la aplicación.
24
+ # @param authorization Header para token
25
+ # @param suscription Es el identificador de la suscripción a esta API.
26
+ # @param [Hash] opts the optional parameters
27
+ # @return [MessageConfigurationsLimits]
28
+ def obtain_configurations_limits(authorization, suscription, opts = {})
29
+ data, _status_code, _headers = obtain_configurations_limits_with_http_info(authorization, suscription, opts)
30
+ data
31
+ end
32
+
33
+ # Consulta de configuraciones
34
+ # Consulta las configuraciones para el contrato asocaido al enrolamiento en la aplicación.
35
+ # @param authorization Header para token
36
+ # @param suscription Es el identificador de la suscripción a esta API.
37
+ # @param [Hash] opts the optional parameters
38
+ # @return [Array<(MessageConfigurationsLimits, Fixnum, Hash)>] MessageConfigurationsLimits data, response status code and response headers
39
+ def obtain_configurations_limits_with_http_info(authorization, suscription, opts = {})
40
+ if @api_client.config.debugging
41
+ @api_client.config.logger.debug 'Calling API: LmitesDeMontosApi.obtain_configurations_limits ...'
42
+ end
43
+ # verify the required parameter 'authorization' is set
44
+ if @api_client.config.client_side_validation && authorization.nil?
45
+ fail ArgumentError, "Missing the required parameter 'authorization' when calling LmitesDeMontosApi.obtain_configurations_limits"
46
+ end
47
+ # verify the required parameter 'suscription' is set
48
+ if @api_client.config.client_side_validation && suscription.nil?
49
+ fail ArgumentError, "Missing the required parameter 'suscription' when calling LmitesDeMontosApi.obtain_configurations_limits"
50
+ end
51
+ if @api_client.config.client_side_validation && suscription.to_s.length > 36
52
+ fail ArgumentError, 'invalid value for "suscription" when calling LmitesDeMontosApi.obtain_configurations_limits, the character length must be smaller than or equal to 36.'
53
+ end
54
+
55
+ if @api_client.config.client_side_validation && suscription.to_s.length < 36
56
+ fail ArgumentError, 'invalid value for "suscription" when calling LmitesDeMontosApi.obtain_configurations_limits, the character length must be great than or equal to 36.'
57
+ end
58
+
59
+ if @api_client.config.client_side_validation && suscription !~ Regexp.new(/[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[34][A-Fa-f0-9]{3}-[89ab][A-Fa-f0-9]{3}-[A-Fa-f0-9]{12}$/)
60
+ fail ArgumentError, "invalid value for 'suscription' when calling LmitesDeMontosApi.obtain_configurations_limits, must conform to the pattern /[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[34][A-Fa-f0-9]{3}-[89ab][A-Fa-f0-9]{3}-[A-Fa-f0-9]{12}$/."
61
+ end
62
+
63
+ # resource path
64
+ local_var_path = '/subscriptions/{suscription}/configurations'.sub('{' + 'suscription' + '}', suscription.to_s)
65
+
66
+ # query parameters
67
+ query_params = {}
68
+
69
+ # header parameters
70
+ header_params = {}
71
+ # HTTP header 'Accept' (if needed)
72
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
73
+ header_params[:'Authorization'] = authorization
74
+
75
+ # form parameters
76
+ form_params = {}
77
+
78
+ # http body (model)
79
+ post_body = nil
80
+ auth_names = []
81
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
82
+ :header_params => header_params,
83
+ :query_params => query_params,
84
+ :form_params => form_params,
85
+ :body => post_body,
86
+ :auth_names => auth_names,
87
+ :return_type => 'MessageConfigurationsLimits')
88
+ if @api_client.config.debugging
89
+ @api_client.config.logger.debug "API called: LmitesDeMontosApi#obtain_configurations_limits\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
90
+ end
91
+ return data, status_code, headers
92
+ end
93
+ # Actualiza configuraciones por suscripción
94
+ # Actualiza las configuraciones de un contrato asociado a una suscripción
95
+ # @param authorization Header para token
96
+ # @param suscription suscription
97
+ # @param update_configurations_resquest_dto updateConfigurationsResquestDTO
98
+ # @param [Hash] opts the optional parameters
99
+ # @return [nil]
100
+ def update_configurations(authorization, suscription, update_configurations_resquest_dto, opts = {})
101
+ update_configurations_with_http_info(authorization, suscription, update_configurations_resquest_dto, opts)
102
+ nil
103
+ end
104
+
105
+ # Actualiza configuraciones por suscripción
106
+ # Actualiza las configuraciones de un contrato asociado a una suscripción
107
+ # @param authorization Header para token
108
+ # @param suscription suscription
109
+ # @param update_configurations_resquest_dto updateConfigurationsResquestDTO
110
+ # @param [Hash] opts the optional parameters
111
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
112
+ def update_configurations_with_http_info(authorization, suscription, update_configurations_resquest_dto, opts = {})
113
+ if @api_client.config.debugging
114
+ @api_client.config.logger.debug 'Calling API: LmitesDeMontosApi.update_configurations ...'
115
+ end
116
+ # verify the required parameter 'authorization' is set
117
+ if @api_client.config.client_side_validation && authorization.nil?
118
+ fail ArgumentError, "Missing the required parameter 'authorization' when calling LmitesDeMontosApi.update_configurations"
119
+ end
120
+ # verify the required parameter 'suscription' is set
121
+ if @api_client.config.client_side_validation && suscription.nil?
122
+ fail ArgumentError, "Missing the required parameter 'suscription' when calling LmitesDeMontosApi.update_configurations"
123
+ end
124
+ # verify the required parameter 'update_configurations_resquest_dto' is set
125
+ if @api_client.config.client_side_validation && update_configurations_resquest_dto.nil?
126
+ fail ArgumentError, "Missing the required parameter 'update_configurations_resquest_dto' when calling LmitesDeMontosApi.update_configurations"
127
+ end
128
+ # resource path
129
+ local_var_path = '/subscriptions/{suscription}/configurations'.sub('{' + 'suscription' + '}', suscription.to_s)
130
+
131
+ # query parameters
132
+ query_params = {}
133
+
134
+ # header parameters
135
+ header_params = {}
136
+ # HTTP header 'Accept' (if needed)
137
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
138
+ # HTTP header 'Content-Type'
139
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
140
+ header_params[:'Authorization'] = authorization
141
+
142
+ # form parameters
143
+ form_params = {}
144
+
145
+ # http body (model)
146
+ post_body = @api_client.object_to_http_body(update_configurations_resquest_dto)
147
+ auth_names = []
148
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
149
+ :header_params => header_params,
150
+ :query_params => query_params,
151
+ :form_params => form_params,
152
+ :body => post_body,
153
+ :auth_names => auth_names)
154
+ if @api_client.config.debugging
155
+ @api_client.config.logger.debug "API called: LmitesDeMontosApi#update_configurations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
156
+ end
157
+ return data, status_code, headers
158
+ end
159
+ end
160
+ end
@@ -19,30 +19,30 @@ module Wire4Client
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
- # Obtiene las operaciones generadas a partir de peticiones de pago CoDi® de forma paginada, pudiendo aplicar filtros
23
- # Obtiene las operaciones generadas a partir de peticiones de pago CoDi® de forma paginada, pudiendo aplicar filtros
22
+ # Consulta de operaciones
23
+ # Obtiene las operaciones generadas a partir de peticiones de pago CODI® de forma paginada, pudiendo aplicar filtros.
24
24
  # @param authorization Header para token
25
25
  # @param [Hash] opts the optional parameters
26
- # @option opts [String] :company_id Identificador de empresa CoDi
27
- # @option opts [String] :page Número de pago (default to 0)
26
+ # @option opts [String] :company_id Es el identificador de empresa CODI®.
27
+ # @option opts [String] :page Es el número de pago. (default to 0)
28
28
  # @option opts [CodiOperationsFiltersRequestDTO] :request_filters Filtros de busqueda
29
- # @option opts [String] :sales_point_id Identificador del punto de venta
30
- # @option opts [String] :size Tamaño de pagina (default to 20)
29
+ # @option opts [String] :sales_point_id Es el identificador del punto de venta.
30
+ # @option opts [String] :size Es el tamaño de página. (default to 20)
31
31
  # @return [PagerResponseDto]
32
32
  def consult_codi_operations(authorization, opts = {})
33
33
  data, _status_code, _headers = consult_codi_operations_with_http_info(authorization, opts)
34
34
  data
35
35
  end
36
36
 
37
- # Obtiene las operaciones generadas a partir de peticiones de pago CoDi® de forma paginada, pudiendo aplicar filtros
38
- # Obtiene las operaciones generadas a partir de peticiones de pago CoDi® de forma paginada, pudiendo aplicar filtros
37
+ # Consulta de operaciones
38
+ # Obtiene las operaciones generadas a partir de peticiones de pago CODI® de forma paginada, pudiendo aplicar filtros.
39
39
  # @param authorization Header para token
40
40
  # @param [Hash] opts the optional parameters
41
- # @option opts [String] :company_id Identificador de empresa CoDi
42
- # @option opts [String] :page Número de pago
41
+ # @option opts [String] :company_id Es el identificador de empresa CODI®.
42
+ # @option opts [String] :page Es el número de pago.
43
43
  # @option opts [CodiOperationsFiltersRequestDTO] :request_filters Filtros de busqueda
44
- # @option opts [String] :sales_point_id Identificador del punto de venta
45
- # @option opts [String] :size Tamaño de pagina
44
+ # @option opts [String] :sales_point_id Es el identificador del punto de venta.
45
+ # @option opts [String] :size Es el tamaño de página.
46
46
  # @return [Array<(PagerResponseDto, Fixnum, Hash)>] PagerResponseDto data, response status code and response headers
47
47
  def consult_codi_operations_with_http_info(authorization, opts = {})
48
48
  if @api_client.config.debugging
@@ -19,8 +19,8 @@ module Wire4Client
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
- # Obtiene la información de una petición de pago CODI® por orderId para un punto de venta
23
- # Obtiene la información de una petición de pago CODI® por orderId para un punto de venta
22
+ # Consulta información de petición por orderId
23
+ # Obtiene la información de una petición de pago CODI® por orderId para un punto de venta.
24
24
  # @param authorization Header para token
25
25
  # @param order_id Identificador del pago CODI®
26
26
  # @param sales_point_id Identificador del punto de venta
@@ -31,8 +31,8 @@ module Wire4Client
31
31
  data
32
32
  end
33
33
 
34
- # Obtiene la información de una petición de pago CODI® por orderId para un punto de venta
35
- # Obtiene la información de una petición de pago CODI® por orderId para un punto de venta
34
+ # Consulta información de petición por orderId
35
+ # Obtiene la información de una petición de pago CODI® por orderId para un punto de venta.
36
36
  # @param authorization Header para token
37
37
  # @param order_id Identificador del pago CODI®
38
38
  # @param sales_point_id Identificador del punto de venta
@@ -94,7 +94,7 @@ module Wire4Client
94
94
  end
95
95
  return data, status_code, headers
96
96
  end
97
- # Genera un código QR para un pago mediante CODI®
97
+ # Genera código QR
98
98
  # Genera un código QR solicitado por un punto de venta para un pago mediante CODI®
99
99
  # @param authorization Header para token
100
100
  # @param codi_info Información del pago CODI®
@@ -106,7 +106,7 @@ module Wire4Client
106
106
  data
107
107
  end
108
108
 
109
- # Genera un código QR para un pago mediante CODI®
109
+ # Genera código QR
110
110
  # Genera un código QR solicitado por un punto de venta para un pago mediante CODI®
111
111
  # @param authorization Header para token
112
112
  # @param codi_info Información del pago CODI®
@@ -19,11 +19,11 @@ module Wire4Client
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
- # Registra un punto de venta asociado a una empresa
23
- # 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®
22
+ # Registro de punto de venta.
23
+ # 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®.
24
24
  # @param authorization Header para token
25
- # @param company_id El identificador de la empresa
26
- # @param sales_point_info Información del punto de venta CODI®
25
+ # @param company_id Es el identificador de la empresa.
26
+ # @param sales_point_info Es el objeto que contiene información del punto de venta CODI®.
27
27
  # @param [Hash] opts the optional parameters
28
28
  # @return [SalesPointRespose]
29
29
  def create_sales_point(authorization, company_id, sales_point_info, opts = {})
@@ -31,11 +31,11 @@ module Wire4Client
31
31
  data
32
32
  end
33
33
 
34
- # Registra un punto de venta asociado a una empresa
35
- # 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®
34
+ # Registro de punto de venta.
35
+ # 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®.
36
36
  # @param authorization Header para token
37
- # @param company_id El identificador de la empresa
38
- # @param sales_point_info Información del punto de venta CODI®
37
+ # @param company_id Es el identificador de la empresa.
38
+ # @param sales_point_info Es el objeto que contiene información del punto de venta CODI®.
39
39
  # @param [Hash] opts the optional parameters
40
40
  # @return [Array<(SalesPointRespose, Fixnum, Hash)>] SalesPointRespose data, response status code and response headers
41
41
  def create_sales_point_with_http_info(authorization, company_id, sales_point_info, opts = {})
@@ -87,10 +87,10 @@ module Wire4Client
87
87
  end
88
88
  return data, status_code, headers
89
89
  end
90
- # Obtiene los puntos de venta asociados a una empresa
91
- # Obtiene los puntos de venta asociados a una empresa en las cuales se hacen operaciones CODI®
90
+ # Consulta de puntos de venta
91
+ # Obtiene los puntos de venta asociados a una empresa en las cuales se hacen operaciones CODI®.
92
92
  # @param authorization Header para token
93
- # @param company_id El identificador de la empresa
93
+ # @param company_id Es el identificador de la empresa. Ejemplo: 8838d513-5916-4662-bb30-2448f0f543ed
94
94
  # @param [Hash] opts the optional parameters
95
95
  # @return [Array<SalesPointFound>]
96
96
  def obtain_sale_points(authorization, company_id, opts = {})
@@ -98,10 +98,10 @@ module Wire4Client
98
98
  data
99
99
  end
100
100
 
101
- # Obtiene los puntos de venta asociados a una empresa
102
- # Obtiene los puntos de venta asociados a una empresa en las cuales se hacen operaciones CODI®
101
+ # Consulta de puntos de venta
102
+ # Obtiene los puntos de venta asociados a una empresa en las cuales se hacen operaciones CODI®.
103
103
  # @param authorization Header para token
104
- # @param company_id El identificador de la empresa
104
+ # @param company_id Es el identificador de la empresa. Ejemplo: 8838d513-5916-4662-bb30-2448f0f543ed
105
105
  # @param [Hash] opts the optional parameters
106
106
  # @return [Array<(Array<SalesPointFound>, Fixnum, Hash)>] Array<SalesPointFound> data, response status code and response headers
107
107
  def obtain_sale_points_with_http_info(authorization, company_id, opts = {})
@@ -20,9 +20,9 @@ module Wire4Client
20
20
  @api_client = api_client
21
21
  end
22
22
  # Consulta los saldo de una cuenta
23
- # Obtiene el de las divisas que se manejen en el contrato.
23
+ # 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).
24
24
  # @param authorization Header para token
25
- # @param subscription El identificador de la suscripción a esta API
25
+ # @param subscription Es el identificador de la suscripción a esta API.
26
26
  # @param [Hash] opts the optional parameters
27
27
  # @return [BalanceListResponse]
28
28
  def get_balance_using_get(authorization, subscription, opts = {})
@@ -31,9 +31,9 @@ module Wire4Client
31
31
  end
32
32
 
33
33
  # Consulta los saldo de una cuenta
34
- # Obtiene el de las divisas que se manejen en el contrato.
34
+ # 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).
35
35
  # @param authorization Header para token
36
- # @param subscription El identificador de la suscripción a esta API
36
+ # @param subscription Es el identificador de la suscripción a esta API.
37
37
  # @param [Hash] opts the optional parameters
38
38
  # @return [Array<(BalanceListResponse, Fixnum, Hash)>] BalanceListResponse data, response status code and response headers
39
39
  def get_balance_using_get_with_http_info(authorization, subscription, opts = {})