bitpesa-sdk 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/Gemfile +8 -0
- data/Gemfile.lock +92 -0
- data/LICENSE +7 -0
- data/README.md +264 -0
- data/Rakefile +10 -0
- data/bitpesa-sdk.gemspec +46 -0
- data/docs/APILogsApi.md +141 -0
- data/docs/Account.md +9 -0
- data/docs/AccountBase.md +9 -0
- data/docs/AccountDebitsApi.md +199 -0
- data/docs/AccountListResponse.md +9 -0
- data/docs/AccountMeta.md +8 -0
- data/docs/AccountResponse.md +9 -0
- data/docs/AccountValidationApi.md +70 -0
- data/docs/AccountValidationError.md +8 -0
- data/docs/AccountValidationRequest.md +12 -0
- data/docs/AccountValidationResponse.md +9 -0
- data/docs/AccountValidationResult.md +8 -0
- data/docs/AccountsApi.md +128 -0
- data/docs/ApiLog.md +16 -0
- data/docs/ApiLogBase.md +16 -0
- data/docs/ApiLogListResponse.md +9 -0
- data/docs/ApiLogResponse.md +8 -0
- data/docs/Body.md +12 -0
- data/docs/Currency.md +17 -0
- data/docs/CurrencyBase.md +17 -0
- data/docs/CurrencyExchange.md +18 -0
- data/docs/CurrencyExchangeListResponse.md +8 -0
- data/docs/CurrencyInfoApi.md +182 -0
- data/docs/CurrencyListResponse.md +8 -0
- data/docs/CurrencyOpposite.md +18 -0
- data/docs/Debit.md +17 -0
- data/docs/DebitBase.md +12 -0
- data/docs/DebitErrorResponse.md +13 -0
- data/docs/DebitListRequest.md +8 -0
- data/docs/DebitListResponse.md +9 -0
- data/docs/DebitRequest.md +8 -0
- data/docs/DebitRequestWrapper.md +8 -0
- data/docs/DebitResponse.md +8 -0
- data/docs/DebitValidResponse.md +16 -0
- data/docs/DefaultDocument.md +16 -0
- data/docs/DefaultRecipient.md +11 -0
- data/docs/DefaultSender.md +24 -0
- data/docs/DefaultWebhook.md +11 -0
- data/docs/Document.md +17 -0
- data/docs/DocumentBase.md +15 -0
- data/docs/DocumentErrorResponse.md +16 -0
- data/docs/DocumentListResponse.md +9 -0
- data/docs/DocumentRequest.md +8 -0
- data/docs/DocumentResponse.md +8 -0
- data/docs/DocumentValidResponse.md +16 -0
- data/docs/DocumentWebhook.md +10 -0
- data/docs/DocumentsApi.md +199 -0
- data/docs/ErrorStatus.md +9 -0
- data/docs/FieldDescription.md +9 -0
- data/docs/FieldSelectValidation.md +9 -0
- data/docs/FieldValidation.md +10 -0
- data/docs/FullInvalidTransaction.md +12 -0
- data/docs/FullInvalidTransactionRequest.md +14 -0
- data/docs/FullValidTransaction.md +11 -0
- data/docs/FullValidTransactionRequest.md +12 -0
- data/docs/InlineResponse200.md +9 -0
- data/docs/InlineResponse2001.md +8 -0
- data/docs/InlineResponse20010.md +9 -0
- data/docs/InlineResponse20011.md +9 -0
- data/docs/InlineResponse20012.md +8 -0
- data/docs/InlineResponse20013.md +9 -0
- data/docs/InlineResponse20014.md +9 -0
- data/docs/InlineResponse20015.md +8 -0
- data/docs/InlineResponse20016.md +9 -0
- data/docs/InlineResponse20017.md +8 -0
- data/docs/InlineResponse20018.md +9 -0
- data/docs/InlineResponse20019.md +9 -0
- data/docs/InlineResponse2002.md +9 -0
- data/docs/InlineResponse20020.md +9 -0
- data/docs/InlineResponse20021.md +8 -0
- data/docs/InlineResponse20021Object.md +8 -0
- data/docs/InlineResponse20022.md +8 -0
- data/docs/InlineResponse20022Object.md +8 -0
- data/docs/InlineResponse20023.md +9 -0
- data/docs/InlineResponse20023Object.md +8 -0
- data/docs/InlineResponse20024.md +8 -0
- data/docs/InlineResponse20025.md +8 -0
- data/docs/InlineResponse20026.md +8 -0
- data/docs/InlineResponse20027.md +9 -0
- data/docs/InlineResponse20028.md +8 -0
- data/docs/InlineResponse20029.md +9 -0
- data/docs/InlineResponse2002Object.md +8 -0
- data/docs/InlineResponse2003.md +8 -0
- data/docs/InlineResponse20030.md +8 -0
- data/docs/InlineResponse20031.md +9 -0
- data/docs/InlineResponse20032.md +9 -0
- data/docs/InlineResponse20033.md +8 -0
- data/docs/InlineResponse20034.md +9 -0
- data/docs/InlineResponse20035.md +9 -0
- data/docs/InlineResponse20036.md +8 -0
- data/docs/InlineResponse20037.md +9 -0
- data/docs/InlineResponse20038.md +8 -0
- data/docs/InlineResponse20039.md +9 -0
- data/docs/InlineResponse2004.md +8 -0
- data/docs/InlineResponse20040.md +8 -0
- data/docs/InlineResponse2004Object.md +8 -0
- data/docs/InlineResponse2005.md +8 -0
- data/docs/InlineResponse2006.md +9 -0
- data/docs/InlineResponse2007.md +8 -0
- data/docs/InlineResponse2008.md +9 -0
- data/docs/InlineResponse2009.md +8 -0
- data/docs/InlineResponse201.md +8 -0
- data/docs/InlineResponse2011.md +8 -0
- data/docs/InlineResponse20110.md +8 -0
- data/docs/InlineResponse20111.md +8 -0
- data/docs/InlineResponse2012.md +8 -0
- data/docs/InlineResponse2013.md +8 -0
- data/docs/InlineResponse2014.md +8 -0
- data/docs/InlineResponse2015.md +8 -0
- data/docs/InlineResponse2016.md +8 -0
- data/docs/InlineResponse2017.md +8 -0
- data/docs/InlineResponse2018.md +8 -0
- data/docs/InlineResponse2019.md +8 -0
- data/docs/InlineResponse400.md +9 -0
- data/docs/InlineResponse4001.md +9 -0
- data/docs/InlineResponse422.md +8 -0
- data/docs/InlineResponse4221.md +8 -0
- data/docs/InlineResponse42210.md +8 -0
- data/docs/InlineResponse42211.md +8 -0
- data/docs/InlineResponse42212.md +8 -0
- data/docs/InlineResponse42213.md +8 -0
- data/docs/InlineResponse42214.md +8 -0
- data/docs/InlineResponse4221Meta.md +8 -0
- data/docs/InlineResponse4221Object.md +8 -0
- data/docs/InlineResponse4222.md +8 -0
- data/docs/InlineResponse4223.md +8 -0
- data/docs/InlineResponse4224.md +8 -0
- data/docs/InlineResponse4225.md +8 -0
- data/docs/InlineResponse4226.md +8 -0
- data/docs/InlineResponse4227.md +8 -0
- data/docs/InlineResponse4227Meta.md +8 -0
- data/docs/InlineResponse4228.md +8 -0
- data/docs/InlineResponse4228Meta.md +8 -0
- data/docs/InlineResponse4228Object.md +8 -0
- data/docs/InlineResponse4229.md +8 -0
- data/docs/InlineResponse422Meta.md +8 -0
- data/docs/InlineResponse422Object.md +8 -0
- data/docs/InvalidDebit.md +14 -0
- data/docs/InvalidDocument.md +17 -0
- data/docs/InvalidRecipient.md +12 -0
- data/docs/InvalidSender.md +25 -0
- data/docs/InvalidWebhook.md +11 -0
- data/docs/LogsApi.md +141 -0
- data/docs/Meta.md +8 -0
- data/docs/Meta2.md +8 -0
- data/docs/Meta2Pagination.md +12 -0
- data/docs/MetaPagination.md +12 -0
- data/docs/Object.md +9 -0
- data/docs/OppositePaymentMethod.md +13 -0
- data/docs/OppositePaymentMethodBase.md +13 -0
- data/docs/Pagination.md +12 -0
- data/docs/PaginationMeta.md +8 -0
- data/docs/PaginationPagination.md +12 -0
- data/docs/PayinMethod.md +12 -0
- data/docs/PayinMethodBase.md +12 -0
- data/docs/PayinMethodDetails.md +10 -0
- data/docs/PayinMethodDetailsBase.md +7 -0
- data/docs/PayinMethodDetailsMobile.md +9 -0
- data/docs/PayinMethodDetailsNGNBank.md +8 -0
- data/docs/PayinMethodRequest.md +8 -0
- data/docs/PayinMethodType.md +8 -0
- data/docs/PayinMethodTypeBase.md +8 -0
- data/docs/PaymentMethod.md +13 -0
- data/docs/PaymentMethodBase.md +15 -0
- data/docs/PaymentMethodListResponse.md +8 -0
- data/docs/PaymentMethodOpposite.md +14 -0
- data/docs/PaymentMethodsApi.md +124 -0
- data/docs/PayoutMethod.md +13 -0
- data/docs/PayoutMethodBankAccountTypeEnum.md +7 -0
- data/docs/PayoutMethodBase.md +10 -0
- data/docs/PayoutMethodDetails.md +26 -0
- data/docs/PayoutMethodDetailsBalance.md +8 -0
- data/docs/PayoutMethodDetailsBase.md +7 -0
- data/docs/PayoutMethodDetailsGHSBank.md +11 -0
- data/docs/PayoutMethodDetailsIBAN.md +12 -0
- data/docs/PayoutMethodDetailsMADCash.md +18 -0
- data/docs/PayoutMethodDetailsMobile.md +10 -0
- data/docs/PayoutMethodDetailsNGNBank.md +12 -0
- data/docs/PayoutMethodDetailsXOFMobile.md +11 -0
- data/docs/PayoutMethodErrorResponse.md +11 -0
- data/docs/PayoutMethodGenderEnum.md +7 -0
- data/docs/PayoutMethodIdentityCardTypeEnum.md +7 -0
- data/docs/PayoutMethodListResponse.md +9 -0
- data/docs/PayoutMethodMobileProviderEnum.md +7 -0
- data/docs/PayoutMethodRequest.md +8 -0
- data/docs/PayoutMethodResponse.md +8 -0
- data/docs/PayoutMethodValidResponse.md +11 -0
- data/docs/PayoutMethodWebhook.md +10 -0
- data/docs/PayoutMethodsApi.md +334 -0
- data/docs/Recipient.md +27 -0
- data/docs/RecipientBase.md +11 -0
- data/docs/RecipientErrorResponse.md +26 -0
- data/docs/RecipientListResponse.md +9 -0
- data/docs/RecipientRequest.md +8 -0
- data/docs/RecipientResponse.md +8 -0
- data/docs/RecipientState.md +7 -0
- data/docs/RecipientValidResponse.md +26 -0
- data/docs/RecipientWebhook.md +10 -0
- data/docs/RecipientsApi.md +212 -0
- data/docs/Sender.md +32 -0
- data/docs/SenderBase.md +30 -0
- data/docs/SenderErrorResponse.md +32 -0
- data/docs/SenderExistingRequest.md +8 -0
- data/docs/SenderFullRequest.md +30 -0
- data/docs/SenderListResponse.md +9 -0
- data/docs/SenderRequest.md +8 -0
- data/docs/SenderResponse.md +8 -0
- data/docs/SenderState.md +7 -0
- data/docs/SenderValidResponse.md +32 -0
- data/docs/SenderWebhook.md +10 -0
- data/docs/SendersApi.md +328 -0
- data/docs/Transaction.md +22 -0
- data/docs/TransactionBase.md +13 -0
- data/docs/TransactionErrorResponse.md +21 -0
- data/docs/TransactionListResponse.md +9 -0
- data/docs/TransactionRequest.md +8 -0
- data/docs/TransactionRequestBase.md +9 -0
- data/docs/TransactionRequestErrorResponse.md +10 -0
- data/docs/TransactionRequestRequest.md +9 -0
- data/docs/TransactionRequestValidResponse.md +10 -0
- data/docs/TransactionRequestsApi.md +199 -0
- data/docs/TransactionResponse.md +8 -0
- data/docs/TransactionState.md +7 -0
- data/docs/TransactionTraits.md +9 -0
- data/docs/TransactionValidResponse.md +21 -0
- data/docs/TransactionWebhook.md +10 -0
- data/docs/TransactionsApi.md +448 -0
- data/docs/ValidDebit.md +16 -0
- data/docs/ValidationErrorDescription.md +8 -0
- data/docs/Webhook.md +10 -0
- data/docs/WebhookBase.md +10 -0
- data/docs/WebhookDefinition.md +12 -0
- data/docs/WebhookDefinitionBase.md +10 -0
- data/docs/WebhookDefinitionErrorResponse.md +11 -0
- data/docs/WebhookDefinitionEventListResponse.md +8 -0
- data/docs/WebhookDefinitionListResponse.md +9 -0
- data/docs/WebhookDefinitionRequest.md +8 -0
- data/docs/WebhookDefinitionResponse.md +8 -0
- data/docs/WebhookDefinitionValidResponse.md +11 -0
- data/docs/WebhookErrorResponse.md +11 -0
- data/docs/WebhookLog.md +13 -0
- data/docs/WebhookLogBase.md +13 -0
- data/docs/WebhookLogBaseMetadata.md +17 -0
- data/docs/WebhookLogBaseMetadataParams.md +8 -0
- data/docs/WebhookLogBaseMetadataRequest.md +10 -0
- data/docs/WebhookLogBaseMetadataResponse.md +10 -0
- data/docs/WebhookLogListResponse.md +9 -0
- data/docs/WebhookLogMetadata.md +17 -0
- data/docs/WebhookLogMetadataParams.md +8 -0
- data/docs/WebhookLogMetadataRequest.md +10 -0
- data/docs/WebhookLogMetadataResponse.md +10 -0
- data/docs/WebhookLogResponse.md +8 -0
- data/docs/WebhookRequest.md +10 -0
- data/docs/WebhookValidResponse.md +11 -0
- data/docs/WebhooksApi.md +319 -0
- data/example/.LICENSE.un~ +0 -0
- data/example/.client.rb.un~ +0 -0
- data/example/client.rb +395 -0
- data/git_push.sh +55 -0
- data/lib/bitpesa-sdk/api/account_debits_api.rb +187 -0
- data/lib/bitpesa-sdk/api/account_validation_api.rb +79 -0
- data/lib/bitpesa-sdk/api/accounts_api.rb +135 -0
- data/lib/bitpesa-sdk/api/api_logs_api.rb +137 -0
- data/lib/bitpesa-sdk/api/currency_info_api.rb +167 -0
- data/lib/bitpesa-sdk/api/documents_api.rb +197 -0
- data/lib/bitpesa-sdk/api/logs_api.rb +137 -0
- data/lib/bitpesa-sdk/api/payment_methods_api.rb +119 -0
- data/lib/bitpesa-sdk/api/payout_methods_api.rb +321 -0
- data/lib/bitpesa-sdk/api/recipients_api.rb +221 -0
- data/lib/bitpesa-sdk/api/senders_api.rb +319 -0
- data/lib/bitpesa-sdk/api/transactions_api.rb +425 -0
- data/lib/bitpesa-sdk/api/webhooks_api.rb +299 -0
- data/lib/bitpesa-sdk/api_client.rb +449 -0
- data/lib/bitpesa-sdk/api_error.rb +61 -0
- data/lib/bitpesa-sdk/configuration.rb +220 -0
- data/lib/bitpesa-sdk/models/account.rb +206 -0
- data/lib/bitpesa-sdk/models/account_list_response.rb +206 -0
- data/lib/bitpesa-sdk/models/account_meta.rb +196 -0
- data/lib/bitpesa-sdk/models/account_response.rb +204 -0
- data/lib/bitpesa-sdk/models/account_validation_error.rb +196 -0
- data/lib/bitpesa-sdk/models/account_validation_request.rb +319 -0
- data/lib/bitpesa-sdk/models/account_validation_response.rb +204 -0
- data/lib/bitpesa-sdk/models/account_validation_result.rb +196 -0
- data/lib/bitpesa-sdk/models/api_log.rb +281 -0
- data/lib/bitpesa-sdk/models/api_log_list_response.rb +207 -0
- data/lib/bitpesa-sdk/models/api_log_response.rb +195 -0
- data/lib/bitpesa-sdk/models/currency.rb +286 -0
- data/lib/bitpesa-sdk/models/currency_exchange.rb +305 -0
- data/lib/bitpesa-sdk/models/currency_exchange_list_response.rb +198 -0
- data/lib/bitpesa-sdk/models/currency_list_response.rb +198 -0
- data/lib/bitpesa-sdk/models/currency_opposite.rb +303 -0
- data/lib/bitpesa-sdk/models/debit.rb +303 -0
- data/lib/bitpesa-sdk/models/debit_list_request.rb +197 -0
- data/lib/bitpesa-sdk/models/debit_list_response.rb +206 -0
- data/lib/bitpesa-sdk/models/debit_request.rb +195 -0
- data/lib/bitpesa-sdk/models/debit_request_wrapper.rb +221 -0
- data/lib/bitpesa-sdk/models/debit_response.rb +195 -0
- data/lib/bitpesa-sdk/models/document.rb +329 -0
- data/lib/bitpesa-sdk/models/document_list_response.rb +206 -0
- data/lib/bitpesa-sdk/models/document_request.rb +195 -0
- data/lib/bitpesa-sdk/models/document_response.rb +195 -0
- data/lib/bitpesa-sdk/models/document_webhook.rb +237 -0
- data/lib/bitpesa-sdk/models/error_status.rb +204 -0
- data/lib/bitpesa-sdk/models/field_description.rb +239 -0
- data/lib/bitpesa-sdk/models/field_select_validation.rb +206 -0
- data/lib/bitpesa-sdk/models/field_validation.rb +215 -0
- data/lib/bitpesa-sdk/models/pagination.rb +236 -0
- data/lib/bitpesa-sdk/models/pagination_meta.rb +195 -0
- data/lib/bitpesa-sdk/models/payin_method.rb +236 -0
- data/lib/bitpesa-sdk/models/payin_method_details.rb +251 -0
- data/lib/bitpesa-sdk/models/payin_method_details_mobile.rb +212 -0
- data/lib/bitpesa-sdk/models/payin_method_details_ngn_bank.rb +202 -0
- data/lib/bitpesa-sdk/models/payin_method_request.rb +195 -0
- data/lib/bitpesa-sdk/models/payment_method.rb +251 -0
- data/lib/bitpesa-sdk/models/payment_method_list_response.rb +197 -0
- data/lib/bitpesa-sdk/models/payment_method_opposite.rb +269 -0
- data/lib/bitpesa-sdk/models/payout_method.rb +249 -0
- data/lib/bitpesa-sdk/models/payout_method_bank_account_type_enum.rb +38 -0
- data/lib/bitpesa-sdk/models/payout_method_details.rb +456 -0
- data/lib/bitpesa-sdk/models/payout_method_details_balance.rb +196 -0
- data/lib/bitpesa-sdk/models/payout_method_details_ghs_bank.rb +243 -0
- data/lib/bitpesa-sdk/models/payout_method_details_iban.rb +252 -0
- data/lib/bitpesa-sdk/models/payout_method_details_mad_cash.rb +326 -0
- data/lib/bitpesa-sdk/models/payout_method_details_mobile.rb +229 -0
- data/lib/bitpesa-sdk/models/payout_method_details_ngn_bank.rb +257 -0
- data/lib/bitpesa-sdk/models/payout_method_details_xof_mobile.rb +243 -0
- data/lib/bitpesa-sdk/models/payout_method_gender_enum.rb +38 -0
- data/lib/bitpesa-sdk/models/payout_method_identity_card_type_enum.rb +39 -0
- data/lib/bitpesa-sdk/models/payout_method_list_response.rb +206 -0
- data/lib/bitpesa-sdk/models/payout_method_mobile_provider_enum.rb +38 -0
- data/lib/bitpesa-sdk/models/payout_method_request.rb +195 -0
- data/lib/bitpesa-sdk/models/payout_method_response.rb +195 -0
- data/lib/bitpesa-sdk/models/payout_method_webhook.rb +237 -0
- data/lib/bitpesa-sdk/models/recipient.rb +400 -0
- data/lib/bitpesa-sdk/models/recipient_list_response.rb +206 -0
- data/lib/bitpesa-sdk/models/recipient_request.rb +195 -0
- data/lib/bitpesa-sdk/models/recipient_response.rb +195 -0
- data/lib/bitpesa-sdk/models/recipient_state.rb +46 -0
- data/lib/bitpesa-sdk/models/recipient_webhook.rb +237 -0
- data/lib/bitpesa-sdk/models/sender.rb +513 -0
- data/lib/bitpesa-sdk/models/sender_list_response.rb +206 -0
- data/lib/bitpesa-sdk/models/sender_request.rb +195 -0
- data/lib/bitpesa-sdk/models/sender_response.rb +195 -0
- data/lib/bitpesa-sdk/models/sender_state.rb +42 -0
- data/lib/bitpesa-sdk/models/sender_webhook.rb +237 -0
- data/lib/bitpesa-sdk/models/transaction.rb +354 -0
- data/lib/bitpesa-sdk/models/transaction_list_response.rb +206 -0
- data/lib/bitpesa-sdk/models/transaction_request.rb +195 -0
- data/lib/bitpesa-sdk/models/transaction_response.rb +195 -0
- data/lib/bitpesa-sdk/models/transaction_state.rb +46 -0
- data/lib/bitpesa-sdk/models/transaction_traits.rb +207 -0
- data/lib/bitpesa-sdk/models/transaction_webhook.rb +237 -0
- data/lib/bitpesa-sdk/models/validation_error_description.rb +197 -0
- data/lib/bitpesa-sdk/models/webhook.rb +232 -0
- data/lib/bitpesa-sdk/models/webhook_definition.rb +250 -0
- data/lib/bitpesa-sdk/models/webhook_definition_event_list_response.rb +197 -0
- data/lib/bitpesa-sdk/models/webhook_definition_list_response.rb +206 -0
- data/lib/bitpesa-sdk/models/webhook_definition_request.rb +195 -0
- data/lib/bitpesa-sdk/models/webhook_definition_response.rb +195 -0
- data/lib/bitpesa-sdk/models/webhook_log.rb +243 -0
- data/lib/bitpesa-sdk/models/webhook_log_list_response.rb +207 -0
- data/lib/bitpesa-sdk/models/webhook_log_metadata.rb +283 -0
- data/lib/bitpesa-sdk/models/webhook_log_metadata_request.rb +218 -0
- data/lib/bitpesa-sdk/models/webhook_log_metadata_response.rb +219 -0
- data/lib/bitpesa-sdk/models/webhook_log_response.rb +195 -0
- data/lib/bitpesa-sdk/version.rb +15 -0
- data/lib/bitpesa-sdk.rb +142 -0
- data/spec/api/account_debits_api_spec.rb +70 -0
- data/spec/api/account_validation_api_spec.rb +47 -0
- data/spec/api/accounts_api_spec.rb +58 -0
- data/spec/api/api_logs_api_spec.rb +58 -0
- data/spec/api/currency_info_api_spec.rb +68 -0
- data/spec/api/documents_api_spec.rb +70 -0
- data/spec/api/logs_api_spec.rb +58 -0
- data/spec/api/payment_methods_api_spec.rb +57 -0
- data/spec/api/payout_methods_api_spec.rb +58 -0
- data/spec/api/recipients_api_spec.rb +74 -0
- data/spec/api/senders_api_spec.rb +95 -0
- data/spec/api/transaction_requests_api_spec.rb +76 -0
- data/spec/api/transactions_api_spec.rb +96 -0
- data/spec/api/webhooks_api_spec.rb +95 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/account_base_spec.rb +48 -0
- data/spec/models/account_list_response_spec.rb +47 -0
- data/spec/models/account_meta_spec.rb +42 -0
- data/spec/models/account_response_spec.rb +47 -0
- data/spec/models/account_spec.rb +47 -0
- data/spec/models/account_validation_error_spec.rb +41 -0
- data/spec/models/account_validation_request_spec.rb +77 -0
- data/spec/models/account_validation_response_spec.rb +47 -0
- data/spec/models/account_validation_result_spec.rb +41 -0
- data/spec/models/api_log_base_spec.rb +90 -0
- data/spec/models/api_log_list_response_spec.rb +47 -0
- data/spec/models/api_log_response_spec.rb +41 -0
- data/spec/models/api_log_spec.rb +90 -0
- data/spec/models/body_spec.rb +58 -0
- data/spec/models/currency_base_spec.rb +84 -0
- data/spec/models/currency_exchange_list_response_spec.rb +41 -0
- data/spec/models/currency_exchange_spec.rb +101 -0
- data/spec/models/currency_list_response_spec.rb +41 -0
- data/spec/models/currency_opposite_spec.rb +101 -0
- data/spec/models/currency_spec.rb +84 -0
- data/spec/models/debit_base_spec.rb +66 -0
- data/spec/models/debit_error_response_spec.rb +72 -0
- data/spec/models/debit_list_request_spec.rb +41 -0
- data/spec/models/debit_list_response_spec.rb +47 -0
- data/spec/models/debit_request_spec.rb +66 -0
- data/spec/models/debit_request_wrapper_spec.rb +41 -0
- data/spec/models/debit_response_spec.rb +41 -0
- data/spec/models/debit_spec.rb +66 -0
- data/spec/models/debit_valid_response_spec.rb +72 -0
- data/spec/models/default_document_spec.rb +94 -0
- data/spec/models/default_recipient_spec.rb +60 -0
- data/spec/models/default_sender_spec.rb +142 -0
- data/spec/models/default_webhook_spec.rb +60 -0
- data/spec/models/document_base_spec.rb +88 -0
- data/spec/models/document_error_response_spec.rb +94 -0
- data/spec/models/document_list_response_spec.rb +47 -0
- data/spec/models/document_request_spec.rb +88 -0
- data/spec/models/document_response_spec.rb +41 -0
- data/spec/models/document_spec.rb +36 -0
- data/spec/models/document_valid_response_spec.rb +94 -0
- data/spec/models/document_webhook_spec.rb +53 -0
- data/spec/models/error_status_spec.rb +47 -0
- data/spec/models/field_description_spec.rb +51 -0
- data/spec/models/field_select_validation_spec.rb +47 -0
- data/spec/models/field_validation_spec.rb +53 -0
- data/spec/models/full_invalid_transaction_request_spec.rb +78 -0
- data/spec/models/full_invalid_transaction_spec.rb +66 -0
- data/spec/models/full_valid_transaction_request_spec.rb +66 -0
- data/spec/models/full_valid_transaction_spec.rb +60 -0
- data/spec/models/inline_response_200_10_spec.rb +42 -0
- data/spec/models/inline_response_200_11_spec.rb +48 -0
- data/spec/models/inline_response_200_12_spec.rb +42 -0
- data/spec/models/inline_response_200_13_spec.rb +48 -0
- data/spec/models/inline_response_200_14_spec.rb +42 -0
- data/spec/models/inline_response_200_15_spec.rb +48 -0
- data/spec/models/inline_response_200_16_spec.rb +48 -0
- data/spec/models/inline_response_200_17_spec.rb +48 -0
- data/spec/models/inline_response_200_18_spec.rb +42 -0
- data/spec/models/inline_response_200_19_spec.rb +48 -0
- data/spec/models/inline_response_200_1_spec.rb +48 -0
- data/spec/models/inline_response_200_20_spec.rb +42 -0
- data/spec/models/inline_response_200_21_object_spec.rb +42 -0
- data/spec/models/inline_response_200_21_spec.rb +42 -0
- data/spec/models/inline_response_200_22_object_spec.rb +42 -0
- data/spec/models/inline_response_200_22_spec.rb +42 -0
- data/spec/models/inline_response_200_23_object_spec.rb +42 -0
- data/spec/models/inline_response_200_23_spec.rb +48 -0
- data/spec/models/inline_response_200_24_spec.rb +42 -0
- data/spec/models/inline_response_200_25_spec.rb +42 -0
- data/spec/models/inline_response_200_26_spec.rb +42 -0
- data/spec/models/inline_response_200_27_spec.rb +48 -0
- data/spec/models/inline_response_200_28_spec.rb +42 -0
- data/spec/models/inline_response_200_29_spec.rb +48 -0
- data/spec/models/inline_response_200_2_object_spec.rb +42 -0
- data/spec/models/inline_response_200_2_spec.rb +42 -0
- data/spec/models/inline_response_200_30_spec.rb +42 -0
- data/spec/models/inline_response_200_31_spec.rb +48 -0
- data/spec/models/inline_response_200_32_spec.rb +42 -0
- data/spec/models/inline_response_200_33_spec.rb +48 -0
- data/spec/models/inline_response_200_34_spec.rb +42 -0
- data/spec/models/inline_response_200_35_spec.rb +48 -0
- data/spec/models/inline_response_200_36_spec.rb +48 -0
- data/spec/models/inline_response_200_37_spec.rb +48 -0
- data/spec/models/inline_response_200_38_spec.rb +42 -0
- data/spec/models/inline_response_200_39_spec.rb +48 -0
- data/spec/models/inline_response_200_3_spec.rb +48 -0
- data/spec/models/inline_response_200_40_spec.rb +42 -0
- data/spec/models/inline_response_200_4_object_spec.rb +42 -0
- data/spec/models/inline_response_200_4_spec.rb +42 -0
- data/spec/models/inline_response_200_5_spec.rb +42 -0
- data/spec/models/inline_response_200_6_spec.rb +42 -0
- data/spec/models/inline_response_200_7_spec.rb +48 -0
- data/spec/models/inline_response_200_8_spec.rb +42 -0
- data/spec/models/inline_response_200_9_spec.rb +48 -0
- data/spec/models/inline_response_200_spec.rb +48 -0
- data/spec/models/inline_response_201_10_spec.rb +42 -0
- data/spec/models/inline_response_201_11_spec.rb +42 -0
- data/spec/models/inline_response_201_1_spec.rb +42 -0
- data/spec/models/inline_response_201_2_spec.rb +42 -0
- data/spec/models/inline_response_201_3_spec.rb +42 -0
- data/spec/models/inline_response_201_4_spec.rb +42 -0
- data/spec/models/inline_response_201_5_spec.rb +42 -0
- data/spec/models/inline_response_201_6_spec.rb +42 -0
- data/spec/models/inline_response_201_7_spec.rb +42 -0
- data/spec/models/inline_response_201_8_spec.rb +42 -0
- data/spec/models/inline_response_201_9_spec.rb +42 -0
- data/spec/models/inline_response_201_spec.rb +42 -0
- data/spec/models/inline_response_400_1_spec.rb +48 -0
- data/spec/models/inline_response_400_spec.rb +48 -0
- data/spec/models/inline_response_422_10_spec.rb +42 -0
- data/spec/models/inline_response_422_11_spec.rb +42 -0
- data/spec/models/inline_response_422_12_spec.rb +42 -0
- data/spec/models/inline_response_422_13_spec.rb +42 -0
- data/spec/models/inline_response_422_14_spec.rb +42 -0
- data/spec/models/inline_response_422_1_meta_spec.rb +42 -0
- data/spec/models/inline_response_422_1_object_spec.rb +42 -0
- data/spec/models/inline_response_422_1_spec.rb +42 -0
- data/spec/models/inline_response_422_2_spec.rb +42 -0
- data/spec/models/inline_response_422_3_spec.rb +42 -0
- data/spec/models/inline_response_422_4_spec.rb +42 -0
- data/spec/models/inline_response_422_5_spec.rb +42 -0
- data/spec/models/inline_response_422_6_spec.rb +42 -0
- data/spec/models/inline_response_422_7_meta_spec.rb +42 -0
- data/spec/models/inline_response_422_7_spec.rb +42 -0
- data/spec/models/inline_response_422_8_meta_spec.rb +42 -0
- data/spec/models/inline_response_422_8_object_spec.rb +42 -0
- data/spec/models/inline_response_422_8_spec.rb +48 -0
- data/spec/models/inline_response_422_9_spec.rb +42 -0
- data/spec/models/inline_response_422_meta_spec.rb +42 -0
- data/spec/models/inline_response_422_object_spec.rb +42 -0
- data/spec/models/inline_response_422_spec.rb +48 -0
- data/spec/models/invalid_debit_spec.rb +78 -0
- data/spec/models/invalid_document_spec.rb +100 -0
- data/spec/models/invalid_recipient_spec.rb +66 -0
- data/spec/models/invalid_sender_spec.rb +148 -0
- data/spec/models/invalid_webhook_spec.rb +60 -0
- data/spec/models/meta_2_pagination_spec.rb +66 -0
- data/spec/models/meta_2_spec.rb +42 -0
- data/spec/models/meta_pagination_spec.rb +66 -0
- data/spec/models/meta_spec.rb +42 -0
- data/spec/models/object_spec.rb +48 -0
- data/spec/models/opposite_payment_method_base_spec.rb +72 -0
- data/spec/models/opposite_payment_method_spec.rb +72 -0
- data/spec/models/pagination_meta_spec.rb +41 -0
- data/spec/models/pagination_pagination_spec.rb +66 -0
- data/spec/models/pagination_spec.rb +42 -0
- data/spec/models/payin_method_base_spec.rb +66 -0
- data/spec/models/payin_method_details_base_spec.rb +36 -0
- data/spec/models/payin_method_details_mobile_spec.rb +48 -0
- data/spec/models/payin_method_details_ngn_bank_spec.rb +42 -0
- data/spec/models/payin_method_details_spec.rb +53 -0
- data/spec/models/payin_method_request_spec.rb +41 -0
- data/spec/models/payin_method_spec.rb +65 -0
- data/spec/models/payin_method_type_base_spec.rb +42 -0
- data/spec/models/payin_method_type_spec.rb +42 -0
- data/spec/models/payment_method_base_spec.rb +66 -0
- data/spec/models/payment_method_list_response_spec.rb +41 -0
- data/spec/models/payment_method_opposite_spec.rb +77 -0
- data/spec/models/payment_method_spec.rb +66 -0
- data/spec/models/payout_method_bank_account_type_enum_spec.rb +35 -0
- data/spec/models/payout_method_base_spec.rb +54 -0
- data/spec/models/payout_method_details_balance_spec.rb +42 -0
- data/spec/models/payout_method_details_base_spec.rb +36 -0
- data/spec/models/payout_method_details_ghs_bank_spec.rb +60 -0
- data/spec/models/payout_method_details_iban_spec.rb +66 -0
- data/spec/models/payout_method_details_mad_cash_spec.rb +110 -0
- data/spec/models/payout_method_details_mobile_spec.rb +54 -0
- data/spec/models/payout_method_details_ngn_bank_spec.rb +70 -0
- data/spec/models/payout_method_details_spec.rb +149 -0
- data/spec/models/payout_method_details_xof_mobile_spec.rb +64 -0
- data/spec/models/payout_method_error_response_spec.rb +60 -0
- data/spec/models/payout_method_gender_enum_spec.rb +35 -0
- data/spec/models/payout_method_identity_card_type_enum_spec.rb +35 -0
- data/spec/models/payout_method_list_response_spec.rb +47 -0
- data/spec/models/payout_method_mobile_provider_enum_spec.rb +35 -0
- data/spec/models/payout_method_request_spec.rb +54 -0
- data/spec/models/payout_method_response_spec.rb +54 -0
- data/spec/models/payout_method_spec.rb +72 -0
- data/spec/models/payout_method_valid_response_spec.rb +60 -0
- data/spec/models/payout_method_webhook_spec.rb +53 -0
- data/spec/models/recipient_base_spec.rb +54 -0
- data/spec/models/recipient_error_response_spec.rb +60 -0
- data/spec/models/recipient_list_response_spec.rb +47 -0
- data/spec/models/recipient_request_spec.rb +60 -0
- data/spec/models/recipient_response_spec.rb +138 -0
- data/spec/models/recipient_spec.rb +36 -0
- data/spec/models/recipient_state_spec.rb +35 -0
- data/spec/models/recipient_valid_response_spec.rb +60 -0
- data/spec/models/recipient_webhook_spec.rb +53 -0
- data/spec/models/sender_base_spec.rb +136 -0
- data/spec/models/sender_error_response_spec.rb +142 -0
- data/spec/models/sender_existing_request_spec.rb +42 -0
- data/spec/models/sender_full_request_spec.rb +136 -0
- data/spec/models/sender_list_response_spec.rb +47 -0
- data/spec/models/sender_request_spec.rb +136 -0
- data/spec/models/sender_response_spec.rb +142 -0
- data/spec/models/sender_spec.rb +36 -0
- data/spec/models/sender_state_spec.rb +35 -0
- data/spec/models/sender_valid_response_spec.rb +142 -0
- data/spec/models/sender_webhook_spec.rb +53 -0
- data/spec/models/transaction_base_spec.rb +60 -0
- data/spec/models/transaction_error_response_spec.rb +66 -0
- data/spec/models/transaction_list_response_spec.rb +47 -0
- data/spec/models/transaction_request_base_spec.rb +48 -0
- data/spec/models/transaction_request_error_response_spec.rb +54 -0
- data/spec/models/transaction_request_request_spec.rb +48 -0
- data/spec/models/transaction_request_spec.rb +48 -0
- data/spec/models/transaction_request_valid_response_spec.rb +54 -0
- data/spec/models/transaction_response_spec.rb +114 -0
- data/spec/models/transaction_spec.rb +60 -0
- data/spec/models/transaction_state_spec.rb +35 -0
- data/spec/models/transaction_traits_spec.rb +48 -0
- data/spec/models/transaction_valid_response_spec.rb +66 -0
- data/spec/models/transaction_webhook_spec.rb +53 -0
- data/spec/models/valid_debit_spec.rb +90 -0
- data/spec/models/validation_error_description_spec.rb +41 -0
- data/spec/models/webhook_base_spec.rb +54 -0
- data/spec/models/webhook_definition_base_spec.rb +54 -0
- data/spec/models/webhook_definition_error_response_spec.rb +60 -0
- data/spec/models/webhook_definition_event_list_response_spec.rb +41 -0
- data/spec/models/webhook_definition_list_response_spec.rb +47 -0
- data/spec/models/webhook_definition_request_spec.rb +54 -0
- data/spec/models/webhook_definition_response_spec.rb +41 -0
- data/spec/models/webhook_definition_spec.rb +65 -0
- data/spec/models/webhook_definition_valid_response_spec.rb +60 -0
- data/spec/models/webhook_error_response_spec.rb +60 -0
- data/spec/models/webhook_log_base_metadata_params_spec.rb +42 -0
- data/spec/models/webhook_log_base_metadata_request_spec.rb +54 -0
- data/spec/models/webhook_log_base_metadata_response_spec.rb +54 -0
- data/spec/models/webhook_log_base_metadata_spec.rb +96 -0
- data/spec/models/webhook_log_base_spec.rb +72 -0
- data/spec/models/webhook_log_list_response_spec.rb +47 -0
- data/spec/models/webhook_log_metadata_params_spec.rb +42 -0
- data/spec/models/webhook_log_metadata_request_spec.rb +54 -0
- data/spec/models/webhook_log_metadata_response_spec.rb +54 -0
- data/spec/models/webhook_log_metadata_spec.rb +96 -0
- data/spec/models/webhook_log_response_spec.rb +41 -0
- data/spec/models/webhook_log_spec.rb +72 -0
- data/spec/models/webhook_request_spec.rb +54 -0
- data/spec/models/webhook_spec.rb +54 -0
- data/spec/models/webhook_valid_response_spec.rb +60 -0
- data/spec/spec_helper.rb +111 -0
- metadata +1127 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 5b80e402eceef9833efcd099523b0fbb57a58c61746d7eee54229e79774302d1
|
4
|
+
data.tar.gz: ebeeb5560dcfb3e759a3724da21db230e41e7980b1d8b4fa19fd8d2c4a265575
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 2717df8e9a025cedd2aeb9334b02fa80f097a8a82fa61cb73a1602407466389ac4daa9bd4fc400ecfa2625f585589771914594b70264673003293339013d7e75
|
7
|
+
data.tar.gz: 42dbc484b8eb729fb10e2149ac142505695291dac5d19e3f5b7e4234b076b44a3da6789d4724dd6eab900689bd4373945480c4d2f7c0b264a7f23ca111d17f63
|
data/Gemfile
ADDED
data/Gemfile.lock
ADDED
@@ -0,0 +1,92 @@
|
|
1
|
+
PATH
|
2
|
+
remote: .
|
3
|
+
specs:
|
4
|
+
bitpesa-sdk (1.0.0)
|
5
|
+
activesupport (~> 5)
|
6
|
+
json (~> 2.1, >= 2.1.0)
|
7
|
+
typhoeus (~> 1.0, >= 1.0.1)
|
8
|
+
|
9
|
+
GEM
|
10
|
+
remote: https://rubygems.org/
|
11
|
+
specs:
|
12
|
+
ZenTest (4.11.1)
|
13
|
+
activesupport (5.2.2)
|
14
|
+
concurrent-ruby (~> 1.0, >= 1.0.2)
|
15
|
+
i18n (>= 0.7, < 2)
|
16
|
+
minitest (~> 5.1)
|
17
|
+
tzinfo (~> 1.1)
|
18
|
+
addressable (2.5.2)
|
19
|
+
public_suffix (>= 2.0.2, < 4.0)
|
20
|
+
autotest (4.4.6)
|
21
|
+
ZenTest (>= 4.4.1)
|
22
|
+
autotest-fsevent (0.2.14)
|
23
|
+
sys-uname
|
24
|
+
autotest-growl (0.2.16)
|
25
|
+
autotest-rails-pure (4.1.2)
|
26
|
+
byebug (10.0.2)
|
27
|
+
coderay (1.1.2)
|
28
|
+
concurrent-ruby (1.1.5)
|
29
|
+
crack (0.4.3)
|
30
|
+
safe_yaml (~> 1.0.0)
|
31
|
+
diff-lcs (1.3)
|
32
|
+
ethon (0.12.0)
|
33
|
+
ffi (>= 1.3.0)
|
34
|
+
ffi (1.9.25)
|
35
|
+
hashdiff (0.3.7)
|
36
|
+
i18n (1.6.0)
|
37
|
+
concurrent-ruby (~> 1.0)
|
38
|
+
json (2.2.0)
|
39
|
+
method_source (0.9.0)
|
40
|
+
minitest (5.11.3)
|
41
|
+
pry (0.11.3)
|
42
|
+
coderay (~> 1.1.0)
|
43
|
+
method_source (~> 0.9.0)
|
44
|
+
pry-byebug (3.6.0)
|
45
|
+
byebug (~> 10.0)
|
46
|
+
pry (~> 0.10)
|
47
|
+
public_suffix (3.0.3)
|
48
|
+
rake (12.0.0)
|
49
|
+
rspec (3.8.0)
|
50
|
+
rspec-core (~> 3.8.0)
|
51
|
+
rspec-expectations (~> 3.8.0)
|
52
|
+
rspec-mocks (~> 3.8.0)
|
53
|
+
rspec-core (3.8.0)
|
54
|
+
rspec-support (~> 3.8.0)
|
55
|
+
rspec-expectations (3.8.1)
|
56
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
57
|
+
rspec-support (~> 3.8.0)
|
58
|
+
rspec-mocks (3.8.0)
|
59
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
60
|
+
rspec-support (~> 3.8.0)
|
61
|
+
rspec-support (3.8.0)
|
62
|
+
safe_yaml (1.0.4)
|
63
|
+
sys-uname (1.0.3)
|
64
|
+
ffi (>= 1.0.0)
|
65
|
+
thread_safe (0.3.6)
|
66
|
+
typhoeus (1.3.1)
|
67
|
+
ethon (>= 0.9.0)
|
68
|
+
tzinfo (1.2.5)
|
69
|
+
thread_safe (~> 0.1)
|
70
|
+
vcr (3.0.3)
|
71
|
+
webmock (1.24.6)
|
72
|
+
addressable (>= 2.3.6)
|
73
|
+
crack (>= 0.3.2)
|
74
|
+
hashdiff
|
75
|
+
|
76
|
+
PLATFORMS
|
77
|
+
ruby
|
78
|
+
|
79
|
+
DEPENDENCIES
|
80
|
+
autotest (~> 4.4, >= 4.4.6)
|
81
|
+
autotest-fsevent (~> 0.2, >= 0.2.12)
|
82
|
+
autotest-growl (~> 0.2, >= 0.2.16)
|
83
|
+
autotest-rails-pure (~> 4.1, >= 4.1.2)
|
84
|
+
bitpesa-sdk!
|
85
|
+
pry-byebug
|
86
|
+
rake (~> 12.0.0)
|
87
|
+
rspec (~> 3.6, >= 3.6.0)
|
88
|
+
vcr (~> 3.0, >= 3.0.1)
|
89
|
+
webmock (~> 1.24, >= 1.24.3)
|
90
|
+
|
91
|
+
BUNDLED WITH
|
92
|
+
1.16.6
|
data/LICENSE
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
Copyright 2019 BitPesa
|
2
|
+
|
3
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the Software), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
4
|
+
|
5
|
+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
6
|
+
|
7
|
+
THE SOFTWARE IS PROVIDED AS IS, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,264 @@
|
|
1
|
+
# bitpesa
|
2
|
+
|
3
|
+
Bitpesa - the Ruby gem for the BitPesa API
|
4
|
+
|
5
|
+
Reference documentation for the BitPesa API V1
|
6
|
+
|
7
|
+
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
8
|
+
|
9
|
+
- API version: 1.0
|
10
|
+
- Package version: 1.0.0
|
11
|
+
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
12
|
+
|
13
|
+
## Installation
|
14
|
+
|
15
|
+
### Build a gem
|
16
|
+
|
17
|
+
To build the Ruby code into a gem:
|
18
|
+
|
19
|
+
```shell
|
20
|
+
gem build bitpesa.gemspec
|
21
|
+
```
|
22
|
+
|
23
|
+
Then either install the gem locally:
|
24
|
+
|
25
|
+
```shell
|
26
|
+
gem install ./bitpesa-1.0.0.gem
|
27
|
+
```
|
28
|
+
(for development, run `gem install --dev ./bitpesa-1.0.0.gem` to install the development dependencies)
|
29
|
+
|
30
|
+
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
31
|
+
|
32
|
+
Finally add this to the Gemfile:
|
33
|
+
|
34
|
+
gem 'bitpesa', '~> 1.0.0'
|
35
|
+
|
36
|
+
### Install from Git
|
37
|
+
|
38
|
+
If the Ruby gem is hosted at a git repository: https://github.com/bitpesa/bitpesa-ruby-sdk, then add the following in the Gemfile:
|
39
|
+
|
40
|
+
gem 'bitpesa', :git => 'https://github.com/bitpesa/bitpesa-ruby-sdk.git'
|
41
|
+
|
42
|
+
### Include the Ruby code directly
|
43
|
+
|
44
|
+
Include the Ruby code directly using `-I` as follows:
|
45
|
+
|
46
|
+
```shell
|
47
|
+
ruby -Ilib script.rb
|
48
|
+
```
|
49
|
+
|
50
|
+
## Getting Started
|
51
|
+
|
52
|
+
Please follow the [installation](#installation) procedure and then run the following code:
|
53
|
+
|
54
|
+
## Webhooks
|
55
|
+
|
56
|
+
To parse webhooks you can use the following snippet:
|
57
|
+
```ruby
|
58
|
+
webhook_content = "{ (...) }"
|
59
|
+
|
60
|
+
webhook_api = Bitpesa::ApiClient.new
|
61
|
+
webhook = webhook_api.parse_response(webhook_content, "Webhook")
|
62
|
+
|
63
|
+
if webhook['event'].start_with?('transaction')
|
64
|
+
transaction_webhook = webhook_api.parse_response(webhook_content, 'TransactionWebhook')
|
65
|
+
puts transaction_webhook.object.to_s
|
66
|
+
elsif webhook['event'].start_with?('recipient')
|
67
|
+
recipient_webhook = webhook_api.parse_response(webhook_content, 'RecipientWebhook')
|
68
|
+
puts recipient_webhook.object.to_s
|
69
|
+
elsif webhook['event'].start_with?('payout_method')
|
70
|
+
payout_method_webhook = webhook_api.parse_response(webhook_content, 'PayoutMethodWebhook')
|
71
|
+
puts payout_method_webhook.object.to_s
|
72
|
+
elsif webhook['event'].start_with?('sender')
|
73
|
+
sender_webhook = webhook_api.parse_response(webhook_content, 'SenderWebhook')
|
74
|
+
puts sender_webhook.object.to_s
|
75
|
+
elsif webhook['event'].start_with?('document')
|
76
|
+
document_webhook = webhook_api.parse_response(webhook_content, 'DocumentWebhook')
|
77
|
+
puts document_webhook.object.to_s
|
78
|
+
else
|
79
|
+
puts webhook
|
80
|
+
end
|
81
|
+
```
|
82
|
+
|
83
|
+
## Documentation for API Endpoints
|
84
|
+
|
85
|
+
All URIs are relative to *https://api-sandbox.bitpesa.co/v1*
|
86
|
+
|
87
|
+
Class | Method | HTTP request | Description
|
88
|
+
------------ | ------------- | ------------- | -------------
|
89
|
+
*Bitpesa::APILogsApi* | [**get_api_log**](docs/APILogsApi.md#get_api_log) | **GET** /api_logs/{API Log ID} | Fetch an individual API log
|
90
|
+
*Bitpesa::APILogsApi* | [**get_api_logs**](docs/APILogsApi.md#get_api_logs) | **GET** /api_logs | Fetch a list of API logs
|
91
|
+
*Bitpesa::AccountDebitsApi* | [**get_accounts_debit**](docs/AccountDebitsApi.md#get_accounts_debit) | **GET** /accounts/debits/{Account Debit ID} | Fetching an account debit
|
92
|
+
*Bitpesa::AccountDebitsApi* | [**get_accounts_debits**](docs/AccountDebitsApi.md#get_accounts_debits) | **GET** /accounts/debits | Listing Accounts debits
|
93
|
+
*Bitpesa::AccountDebitsApi* | [**post_accounts_debits**](docs/AccountDebitsApi.md#post_accounts_debits) | **POST** /accounts/debits | Creating an account debit
|
94
|
+
*Bitpesa::AccountValidationApi* | [**post_account_validations**](docs/AccountValidationApi.md#post_account_validations) | **POST** /account_validations | Validates the existence of a bank account
|
95
|
+
*Bitpesa::AccountsApi* | [**get_account**](docs/AccountsApi.md#get_account) | **GET** /accounts/{Currency} | Fetches account balance for specified currrency
|
96
|
+
*Bitpesa::AccountsApi* | [**get_accounts**](docs/AccountsApi.md#get_accounts) | **GET** /accounts | Fetches account balances for all currencies
|
97
|
+
*Bitpesa::CurrencyInfoApi* | [**info_currencies**](docs/CurrencyInfoApi.md#info_currencies) | **GET** /info/currencies | Getting a list of possible requested currencies
|
98
|
+
*Bitpesa::CurrencyInfoApi* | [**info_currencies_in**](docs/CurrencyInfoApi.md#info_currencies_in) | **GET** /info/currencies/in | Getting a list of possible input currencies
|
99
|
+
*Bitpesa::CurrencyInfoApi* | [**info_currencies_out**](docs/CurrencyInfoApi.md#info_currencies_out) | **GET** /info/currencies/out | Getting a list of possible output currencies
|
100
|
+
*Bitpesa::DocumentsApi* | [**get_document**](docs/DocumentsApi.md#get_document) | **GET** /documents/{Document ID} | Fetching a document
|
101
|
+
*Bitpesa::DocumentsApi* | [**get_documents**](docs/DocumentsApi.md#get_documents) | **GET** /documents | Getting a list of documents
|
102
|
+
*Bitpesa::DocumentsApi* | [**post_documents**](docs/DocumentsApi.md#post_documents) | **POST** /documents | Creating a document
|
103
|
+
*Bitpesa::LogsApi* | [**get_webhook_log**](docs/LogsApi.md#get_webhook_log) | **GET** /logs/{Webhook Log ID} | Fetch an individual webhook log
|
104
|
+
*Bitpesa::LogsApi* | [**get_webhook_logs**](docs/LogsApi.md#get_webhook_logs) | **GET** /logs/webhooks | Fetch a list of webhook logs
|
105
|
+
*Bitpesa::PaymentMethodsApi* | [**payment_methods_in**](docs/PaymentMethodsApi.md#payment_methods_in) | **GET** /info/payment_methods/in | This method returns possible payin methods.
|
106
|
+
*Bitpesa::PaymentMethodsApi* | [**payment_methods_out**](docs/PaymentMethodsApi.md#payment_methods_out) | **GET** /info/payment_methods/out | This method returns possible payout methods.
|
107
|
+
*Bitpesa::PayoutMethodsApi* | [**delete_payout_method**](docs/PayoutMethodsApi.md#delete_payout_method) | **DELETE** /payout_methods/{Payout Method ID} | Deleting a payout method
|
108
|
+
*Bitpesa::PayoutMethodsApi* | [**get_payout_method**](docs/PayoutMethodsApi.md#get_payout_method) | **GET** /payout_methods/{Payout Method ID} | Fetching a payout method
|
109
|
+
*Bitpesa::PayoutMethodsApi* | [**get_payout_methods**](docs/PayoutMethodsApi.md#get_payout_methods) | **GET** /payout_methods | Listing payout methods
|
110
|
+
*Bitpesa::PayoutMethodsApi* | [**patch_payout_method**](docs/PayoutMethodsApi.md#patch_payout_method) | **PATCH** /payout_methods/{Payout Method ID} | Updating a payout method
|
111
|
+
*Bitpesa::PayoutMethodsApi* | [**post_payout_methods**](docs/PayoutMethodsApi.md#post_payout_methods) | **POST** /payout_methods | Creating a payout method
|
112
|
+
*Bitpesa::RecipientsApi* | [**delete_recipient**](docs/RecipientsApi.md#delete_recipient) | **DELETE** /recipients/{Recipient ID} | Cancelling a recipient
|
113
|
+
*Bitpesa::RecipientsApi* | [**get_recipients**](docs/RecipientsApi.md#get_recipients) | **GET** /recipients | Getting a list of recipients with filtering
|
114
|
+
*Bitpesa::RecipientsApi* | [**patch_recipient**](docs/RecipientsApi.md#patch_recipient) | **PATCH** /recipients/{Recipient ID} | Updating a recipient
|
115
|
+
*Bitpesa::SendersApi* | [**delete_sender**](docs/SendersApi.md#delete_sender) | **DELETE** /senders/{Sender ID} | Deleting a sender
|
116
|
+
*Bitpesa::SendersApi* | [**get_sender**](docs/SendersApi.md#get_sender) | **GET** /senders/{Sender ID} | Fetching a sender
|
117
|
+
*Bitpesa::SendersApi* | [**get_senders**](docs/SendersApi.md#get_senders) | **GET** /senders | Listing senders
|
118
|
+
*Bitpesa::SendersApi* | [**patch_sender**](docs/SendersApi.md#patch_sender) | **PATCH** /senders/{Sender ID} | Updating a sender
|
119
|
+
*Bitpesa::SendersApi* | [**post_senders**](docs/SendersApi.md#post_senders) | **POST** /senders | Creating a sender
|
120
|
+
*Bitpesa::TransactionsApi* | [**calculate_transactions**](docs/TransactionsApi.md#calculate_transactions) | **POST** /transactions/calculate | Calculates transaction amounts for a transaction payload
|
121
|
+
*Bitpesa::TransactionsApi* | [**get_transaction**](docs/TransactionsApi.md#get_transaction) | **GET** /transactions/{Transaction ID} | Fetch a single transaction
|
122
|
+
*Bitpesa::TransactionsApi* | [**get_transactions**](docs/TransactionsApi.md#get_transactions) | **GET** /transactions | Get a list of transactions
|
123
|
+
*Bitpesa::TransactionsApi* | [**payin_transaction**](docs/TransactionsApi.md#payin_transaction) | **POST** /transactions/{Transaction ID}/payin | Creates a fake payin for transaction
|
124
|
+
*Bitpesa::TransactionsApi* | [**payout_transaction**](docs/TransactionsApi.md#payout_transaction) | **POST** /transactions/{Transaction ID}/payout | Creates a fake payout for transaction
|
125
|
+
*Bitpesa::TransactionsApi* | [**post_transactions**](docs/TransactionsApi.md#post_transactions) | **POST** /transactions | Creates a new transaction
|
126
|
+
*Bitpesa::TransactionsApi* | [**validate_transactions**](docs/TransactionsApi.md#validate_transactions) | **POST** /transactions/validate | Validates a transaction payload
|
127
|
+
*Bitpesa::WebhooksApi* | [**delete_webhook**](docs/WebhooksApi.md#delete_webhook) | **DELETE** /webhooks/{Webhook ID} | Unsubscribing from a webhook
|
128
|
+
*Bitpesa::WebhooksApi* | [**get_webhook**](docs/WebhooksApi.md#get_webhook) | **GET** /webhooks/{Webhook ID} | Find a webhook's details
|
129
|
+
*Bitpesa::WebhooksApi* | [**get_webhook_events**](docs/WebhooksApi.md#get_webhook_events) | **GET** /webhooks/events | Find possible webhook events
|
130
|
+
*Bitpesa::WebhooksApi* | [**get_webhooks**](docs/WebhooksApi.md#get_webhooks) | **GET** /webhooks | Listing webhooks
|
131
|
+
*Bitpesa::WebhooksApi* | [**post_webhooks**](docs/WebhooksApi.md#post_webhooks) | **POST** /webhooks | Creating a webhook
|
132
|
+
|
133
|
+
|
134
|
+
## Documentation for Models
|
135
|
+
|
136
|
+
- [Bitpesa::Account](docs/Account.md)
|
137
|
+
- [Bitpesa::AccountListResponse](docs/AccountListResponse.md)
|
138
|
+
- [Bitpesa::AccountMeta](docs/AccountMeta.md)
|
139
|
+
- [Bitpesa::AccountResponse](docs/AccountResponse.md)
|
140
|
+
- [Bitpesa::AccountValidationError](docs/AccountValidationError.md)
|
141
|
+
- [Bitpesa::AccountValidationRequest](docs/AccountValidationRequest.md)
|
142
|
+
- [Bitpesa::AccountValidationResponse](docs/AccountValidationResponse.md)
|
143
|
+
- [Bitpesa::AccountValidationResult](docs/AccountValidationResult.md)
|
144
|
+
- [Bitpesa::ApiLog](docs/ApiLog.md)
|
145
|
+
- [Bitpesa::ApiLogListResponse](docs/ApiLogListResponse.md)
|
146
|
+
- [Bitpesa::ApiLogResponse](docs/ApiLogResponse.md)
|
147
|
+
- [Bitpesa::Currency](docs/Currency.md)
|
148
|
+
- [Bitpesa::CurrencyExchange](docs/CurrencyExchange.md)
|
149
|
+
- [Bitpesa::CurrencyExchangeListResponse](docs/CurrencyExchangeListResponse.md)
|
150
|
+
- [Bitpesa::CurrencyListResponse](docs/CurrencyListResponse.md)
|
151
|
+
- [Bitpesa::CurrencyOpposite](docs/CurrencyOpposite.md)
|
152
|
+
- [Bitpesa::Debit](docs/Debit.md)
|
153
|
+
- [Bitpesa::DebitListRequest](docs/DebitListRequest.md)
|
154
|
+
- [Bitpesa::DebitListResponse](docs/DebitListResponse.md)
|
155
|
+
- [Bitpesa::DebitRequest](docs/DebitRequest.md)
|
156
|
+
- [Bitpesa::DebitRequestWrapper](docs/DebitRequestWrapper.md)
|
157
|
+
- [Bitpesa::DebitResponse](docs/DebitResponse.md)
|
158
|
+
- [Bitpesa::Document](docs/Document.md)
|
159
|
+
- [Bitpesa::DocumentListResponse](docs/DocumentListResponse.md)
|
160
|
+
- [Bitpesa::DocumentRequest](docs/DocumentRequest.md)
|
161
|
+
- [Bitpesa::DocumentResponse](docs/DocumentResponse.md)
|
162
|
+
- [Bitpesa::DocumentWebhook](docs/DocumentWebhook.md)
|
163
|
+
- [Bitpesa::ErrorStatus](docs/ErrorStatus.md)
|
164
|
+
- [Bitpesa::FieldDescription](docs/FieldDescription.md)
|
165
|
+
- [Bitpesa::FieldSelectValidation](docs/FieldSelectValidation.md)
|
166
|
+
- [Bitpesa::FieldValidation](docs/FieldValidation.md)
|
167
|
+
- [Bitpesa::Pagination](docs/Pagination.md)
|
168
|
+
- [Bitpesa::PaginationMeta](docs/PaginationMeta.md)
|
169
|
+
- [Bitpesa::PayinMethod](docs/PayinMethod.md)
|
170
|
+
- [Bitpesa::PayinMethodDetails](docs/PayinMethodDetails.md)
|
171
|
+
- [Bitpesa::PayinMethodDetailsMobile](docs/PayinMethodDetailsMobile.md)
|
172
|
+
- [Bitpesa::PayinMethodDetailsNGNBank](docs/PayinMethodDetailsNGNBank.md)
|
173
|
+
- [Bitpesa::PayinMethodRequest](docs/PayinMethodRequest.md)
|
174
|
+
- [Bitpesa::PaymentMethod](docs/PaymentMethod.md)
|
175
|
+
- [Bitpesa::PaymentMethodListResponse](docs/PaymentMethodListResponse.md)
|
176
|
+
- [Bitpesa::PaymentMethodOpposite](docs/PaymentMethodOpposite.md)
|
177
|
+
- [Bitpesa::PayoutMethod](docs/PayoutMethod.md)
|
178
|
+
- [Bitpesa::PayoutMethodBankAccountTypeEnum](docs/PayoutMethodBankAccountTypeEnum.md)
|
179
|
+
- [Bitpesa::PayoutMethodDetails](docs/PayoutMethodDetails.md)
|
180
|
+
- [Bitpesa::PayoutMethodDetailsBalance](docs/PayoutMethodDetailsBalance.md)
|
181
|
+
- [Bitpesa::PayoutMethodDetailsGHSBank](docs/PayoutMethodDetailsGHSBank.md)
|
182
|
+
- [Bitpesa::PayoutMethodDetailsIBAN](docs/PayoutMethodDetailsIBAN.md)
|
183
|
+
- [Bitpesa::PayoutMethodDetailsMADCash](docs/PayoutMethodDetailsMADCash.md)
|
184
|
+
- [Bitpesa::PayoutMethodDetailsMobile](docs/PayoutMethodDetailsMobile.md)
|
185
|
+
- [Bitpesa::PayoutMethodDetailsNGNBank](docs/PayoutMethodDetailsNGNBank.md)
|
186
|
+
- [Bitpesa::PayoutMethodDetailsXOFMobile](docs/PayoutMethodDetailsXOFMobile.md)
|
187
|
+
- [Bitpesa::PayoutMethodGenderEnum](docs/PayoutMethodGenderEnum.md)
|
188
|
+
- [Bitpesa::PayoutMethodIdentityCardTypeEnum](docs/PayoutMethodIdentityCardTypeEnum.md)
|
189
|
+
- [Bitpesa::PayoutMethodListResponse](docs/PayoutMethodListResponse.md)
|
190
|
+
- [Bitpesa::PayoutMethodMobileProviderEnum](docs/PayoutMethodMobileProviderEnum.md)
|
191
|
+
- [Bitpesa::PayoutMethodRequest](docs/PayoutMethodRequest.md)
|
192
|
+
- [Bitpesa::PayoutMethodResponse](docs/PayoutMethodResponse.md)
|
193
|
+
- [Bitpesa::PayoutMethodWebhook](docs/PayoutMethodWebhook.md)
|
194
|
+
- [Bitpesa::Recipient](docs/Recipient.md)
|
195
|
+
- [Bitpesa::RecipientListResponse](docs/RecipientListResponse.md)
|
196
|
+
- [Bitpesa::RecipientRequest](docs/RecipientRequest.md)
|
197
|
+
- [Bitpesa::RecipientResponse](docs/RecipientResponse.md)
|
198
|
+
- [Bitpesa::RecipientState](docs/RecipientState.md)
|
199
|
+
- [Bitpesa::RecipientWebhook](docs/RecipientWebhook.md)
|
200
|
+
- [Bitpesa::Sender](docs/Sender.md)
|
201
|
+
- [Bitpesa::SenderListResponse](docs/SenderListResponse.md)
|
202
|
+
- [Bitpesa::SenderRequest](docs/SenderRequest.md)
|
203
|
+
- [Bitpesa::SenderResponse](docs/SenderResponse.md)
|
204
|
+
- [Bitpesa::SenderState](docs/SenderState.md)
|
205
|
+
- [Bitpesa::SenderWebhook](docs/SenderWebhook.md)
|
206
|
+
- [Bitpesa::Transaction](docs/Transaction.md)
|
207
|
+
- [Bitpesa::TransactionListResponse](docs/TransactionListResponse.md)
|
208
|
+
- [Bitpesa::TransactionRequest](docs/TransactionRequest.md)
|
209
|
+
- [Bitpesa::TransactionResponse](docs/TransactionResponse.md)
|
210
|
+
- [Bitpesa::TransactionState](docs/TransactionState.md)
|
211
|
+
- [Bitpesa::TransactionTraits](docs/TransactionTraits.md)
|
212
|
+
- [Bitpesa::TransactionWebhook](docs/TransactionWebhook.md)
|
213
|
+
- [Bitpesa::ValidationErrorDescription](docs/ValidationErrorDescription.md)
|
214
|
+
- [Bitpesa::Webhook](docs/Webhook.md)
|
215
|
+
- [Bitpesa::WebhookDefinition](docs/WebhookDefinition.md)
|
216
|
+
- [Bitpesa::WebhookDefinitionEventListResponse](docs/WebhookDefinitionEventListResponse.md)
|
217
|
+
- [Bitpesa::WebhookDefinitionListResponse](docs/WebhookDefinitionListResponse.md)
|
218
|
+
- [Bitpesa::WebhookDefinitionRequest](docs/WebhookDefinitionRequest.md)
|
219
|
+
- [Bitpesa::WebhookDefinitionResponse](docs/WebhookDefinitionResponse.md)
|
220
|
+
- [Bitpesa::WebhookLog](docs/WebhookLog.md)
|
221
|
+
- [Bitpesa::WebhookLogListResponse](docs/WebhookLogListResponse.md)
|
222
|
+
- [Bitpesa::WebhookLogMetadata](docs/WebhookLogMetadata.md)
|
223
|
+
- [Bitpesa::WebhookLogMetadataRequest](docs/WebhookLogMetadataRequest.md)
|
224
|
+
- [Bitpesa::WebhookLogMetadataResponse](docs/WebhookLogMetadataResponse.md)
|
225
|
+
- [Bitpesa::WebhookLogResponse](docs/WebhookLogResponse.md)
|
226
|
+
|
227
|
+
|
228
|
+
## Documentation for Authorization
|
229
|
+
|
230
|
+
You can set the API Key and Secret on the ApiClient object for authentication:
|
231
|
+
|
232
|
+
|
233
|
+
```ruby
|
234
|
+
# Load the gem
|
235
|
+
require 'bitpesa'
|
236
|
+
|
237
|
+
# Setup authorization
|
238
|
+
|
239
|
+
Bitpesa.configure do |config|
|
240
|
+
config.api_key = 'YOUR API KEY'
|
241
|
+
config.api_secret = 'YOUR API SECRET'
|
242
|
+
config.host = "https://api-sandbox.bitpesa.co/v1"
|
243
|
+
end
|
244
|
+
|
245
|
+
begin
|
246
|
+
request = Bitpesa::AccountValidationRequest.new # account validation api
|
247
|
+
request.bank_account = '9040004458219'
|
248
|
+
request.bank_code = '020100'
|
249
|
+
request.country = 'GH'
|
250
|
+
request.currency = 'GHS'
|
251
|
+
request.method = 'bank'
|
252
|
+
|
253
|
+
avi = Bitpesa::AccountValidationApi.new
|
254
|
+
account_validation = avi.post_account_validations(request)
|
255
|
+
account_name = account_validation.object.account_name
|
256
|
+
puts "Account Name: #{account_name}"
|
257
|
+
rescue Bitpesa::ApiError => e
|
258
|
+
if e.validation_error
|
259
|
+
puts e.response_object("AccountValidationResponse").meta.error
|
260
|
+
else
|
261
|
+
puts "Exception when calling AccountValidationApi#account_validation_example: #{e}"
|
262
|
+
end
|
263
|
+
end
|
264
|
+
```
|
data/Rakefile
ADDED
data/bitpesa-sdk.gemspec
ADDED
@@ -0,0 +1,46 @@
|
|
1
|
+
# -*- encoding: utf-8 -*-
|
2
|
+
|
3
|
+
=begin
|
4
|
+
#BitPesa API
|
5
|
+
|
6
|
+
#Reference documentation for the BitPesa API V1
|
7
|
+
|
8
|
+
OpenAPI spec version: 1.0
|
9
|
+
|
10
|
+
Generated by: https://openapi-generator.tech
|
11
|
+
OpenAPI Generator version: 4.0.0-beta2
|
12
|
+
|
13
|
+
=end
|
14
|
+
|
15
|
+
$:.push File.expand_path("../lib", __FILE__)
|
16
|
+
require "bitpesa-sdk/version"
|
17
|
+
|
18
|
+
Gem::Specification.new do |s|
|
19
|
+
s.name = "bitpesa-sdk"
|
20
|
+
s.version = Bitpesa::VERSION
|
21
|
+
s.platform = Gem::Platform::RUBY
|
22
|
+
s.authors = ["Bitpesa"]
|
23
|
+
s.email = [""]
|
24
|
+
s.homepage = "https://github.com/bitpesa/bitpesa-sdk-ruby"
|
25
|
+
s.summary = "BitPesa API Ruby Gem"
|
26
|
+
s.description = "Ruby library for the BitPesa API"
|
27
|
+
s.license = 'MIT'
|
28
|
+
s.required_ruby_version = ">= 1.9"
|
29
|
+
|
30
|
+
s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
|
31
|
+
s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
|
32
|
+
s.add_runtime_dependency 'activesupport', '~> 5'
|
33
|
+
|
34
|
+
s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
|
35
|
+
s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'
|
36
|
+
s.add_development_dependency 'webmock', '~> 1.24', '>= 1.24.3'
|
37
|
+
s.add_development_dependency 'autotest', '~> 4.4', '>= 4.4.6'
|
38
|
+
s.add_development_dependency 'autotest-rails-pure', '~> 4.1', '>= 4.1.2'
|
39
|
+
s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
|
40
|
+
s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.12'
|
41
|
+
|
42
|
+
s.files = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
|
43
|
+
s.test_files = `find spec/*`.split("\n")
|
44
|
+
s.executables = []
|
45
|
+
s.require_paths = ["lib"]
|
46
|
+
end
|
data/docs/APILogsApi.md
ADDED
@@ -0,0 +1,141 @@
|
|
1
|
+
# Bitpesa::APILogsApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api-sandbox.bitpesa.co/v1*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**get_api_log**](APILogsApi.md#get_api_log) | **GET** /api_logs/{API Log ID} | Fetch an individual API log
|
8
|
+
[**get_api_logs**](APILogsApi.md#get_api_logs) | **GET** /api_logs | Fetch a list of API logs
|
9
|
+
|
10
|
+
|
11
|
+
# **get_api_log**
|
12
|
+
> ApiLogResponse get_api_log(api_log_id)
|
13
|
+
|
14
|
+
Fetch an individual API log
|
15
|
+
|
16
|
+
Returns a single API log based on the API log ID.
|
17
|
+
|
18
|
+
### Example
|
19
|
+
```ruby
|
20
|
+
# load the gem
|
21
|
+
require 'bitpesa-sdk'
|
22
|
+
|
23
|
+
api_instance = Bitpesa::APILogsApi.new
|
24
|
+
|
25
|
+
|
26
|
+
begin
|
27
|
+
#Fetch an individual API log
|
28
|
+
result = api_instance.get_api_log(api_log_id)
|
29
|
+
p result
|
30
|
+
rescue Bitpesa::ApiError => e
|
31
|
+
if e.validation_error
|
32
|
+
puts "WARN: Validation error occured when calling the endpoint"
|
33
|
+
result = e.response_object("ApiLogResponse")
|
34
|
+
p result
|
35
|
+
else
|
36
|
+
puts "Exception when calling APILogsApi->get_api_log: #{e}"
|
37
|
+
end
|
38
|
+
end
|
39
|
+
```
|
40
|
+
|
41
|
+
### Parameters
|
42
|
+
|
43
|
+
Name | Type | Description | Notes
|
44
|
+
------------- | ------------- | ------------- | -------------
|
45
|
+
**api_log_id** | [**String**](.md)| ID of the API log to retrieve Example: `/v1/api_logs/00485ce9-532b-45e7-8518-7e5582242407` |
|
46
|
+
|
47
|
+
### Return type
|
48
|
+
|
49
|
+
[**ApiLogResponse**](ApiLogResponse.md)
|
50
|
+
|
51
|
+
### Authorization
|
52
|
+
|
53
|
+
You can set the API Key and Secret on the Bitpesa object when setting it up:
|
54
|
+
|
55
|
+
```ruby
|
56
|
+
|
57
|
+
Bitpesa.configure do |config|
|
58
|
+
config.api_key = '<key'
|
59
|
+
config.api_secret = '<secret>'
|
60
|
+
config.host = 'https://api-sandbox.bitpesa.co/v1'
|
61
|
+
end
|
62
|
+
|
63
|
+
```
|
64
|
+
|
65
|
+
### HTTP request headers
|
66
|
+
|
67
|
+
- **Content-Type**: Not defined
|
68
|
+
- **Accept**: application/json
|
69
|
+
|
70
|
+
|
71
|
+
|
72
|
+
# **get_api_logs**
|
73
|
+
> ApiLogListResponse get_api_logs(opts)
|
74
|
+
|
75
|
+
Fetch a list of API logs
|
76
|
+
|
77
|
+
Returns a list of API logs. Also includes information relating to the original request.
|
78
|
+
|
79
|
+
### Example
|
80
|
+
```ruby
|
81
|
+
# load the gem
|
82
|
+
require 'bitpesa-sdk'
|
83
|
+
|
84
|
+
api_instance = Bitpesa::APILogsApi.new
|
85
|
+
|
86
|
+
opts = {
|
87
|
+
page: 1 # Integer | The page number to request (defaults to 1)
|
88
|
+
per: 10 # Integer | The number of results to load per page (defaults to 10)
|
89
|
+
created_at_from: 'created_at_from_example' # String | Start date to filter recipients by created_at range Allows filtering results by the specified `created_at` timeframe. Example: `/v1/recipients?created_at_from=2018-06-06&created_at_to=2018-06-08`
|
90
|
+
created_at_to: 'created_at_to_example' # String | End date to filter recipients by created_at range Allows filtering results by the specified `created_at` timeframe. Example: `/v1/recipients?created_at_from=2018-06-06&created_at_to=2018-06-08`
|
91
|
+
}
|
92
|
+
|
93
|
+
begin
|
94
|
+
#Fetch a list of API logs
|
95
|
+
result = api_instance.get_api_logs(opts)
|
96
|
+
p result
|
97
|
+
rescue Bitpesa::ApiError => e
|
98
|
+
if e.validation_error
|
99
|
+
puts "WARN: Validation error occured when calling the endpoint"
|
100
|
+
result = e.response_object("ApiLogListResponse")
|
101
|
+
p result
|
102
|
+
else
|
103
|
+
puts "Exception when calling APILogsApi->get_api_logs: #{e}"
|
104
|
+
end
|
105
|
+
end
|
106
|
+
```
|
107
|
+
|
108
|
+
### Parameters
|
109
|
+
|
110
|
+
Name | Type | Description | Notes
|
111
|
+
------------- | ------------- | ------------- | -------------
|
112
|
+
**page** | **Integer**| The page number to request (defaults to 1) | [optional]
|
113
|
+
**per** | **Integer**| The number of results to load per page (defaults to 10) | [optional]
|
114
|
+
**created_at_from** | **String**| Start date to filter recipients by created_at range Allows filtering results by the specified `created_at` timeframe. Example: `/v1/recipients?created_at_from=2018-06-06&created_at_to=2018-06-08` | [optional]
|
115
|
+
**created_at_to** | **String**| End date to filter recipients by created_at range Allows filtering results by the specified `created_at` timeframe. Example: `/v1/recipients?created_at_from=2018-06-06&created_at_to=2018-06-08` | [optional]
|
116
|
+
|
117
|
+
### Return type
|
118
|
+
|
119
|
+
[**ApiLogListResponse**](ApiLogListResponse.md)
|
120
|
+
|
121
|
+
### Authorization
|
122
|
+
|
123
|
+
You can set the API Key and Secret on the Bitpesa object when setting it up:
|
124
|
+
|
125
|
+
```ruby
|
126
|
+
|
127
|
+
Bitpesa.configure do |config|
|
128
|
+
config.api_key = '<key'
|
129
|
+
config.api_secret = '<secret>'
|
130
|
+
config.host = 'https://api-sandbox.bitpesa.co/v1'
|
131
|
+
end
|
132
|
+
|
133
|
+
```
|
134
|
+
|
135
|
+
### HTTP request headers
|
136
|
+
|
137
|
+
- **Content-Type**: Not defined
|
138
|
+
- **Accept**: application/json
|
139
|
+
|
140
|
+
|
141
|
+
|