Module: Inttegro

Extended by:

T::Sig

Defined in:

lib/inttegro/version.rb,
lib/inttegro.rb,
lib/inttegro/types.rb,
lib/inttegro/client.rb,
lib/inttegro/errors.rb,
lib/inttegro/models.rb,
lib/inttegro/telemetry.rb,
lib/inttegro/http_client.rb,
lib/inttegro/file_download.rb,
lib/inttegro/resources/otp.rb,
lib/inttegro/resources/apps.rb,
lib/inttegro/resources/keys.rb,
lib/inttegro/resources/spec.rb,
lib/inttegro/error_reporting.rb,
lib/inttegro/generated/enums.rb,
lib/inttegro/resources/files.rb,
lib/inttegro/response_object.rb,
lib/inttegro/generated/models.rb,
lib/inttegro/resources/chimes.rb,
lib/inttegro/resources/orders.rb,
lib/inttegro/resources/prices.rb,
lib/inttegro/resources/payouts.rb,
lib/inttegro/resources/refunds.rb,
lib/inttegro/resources/balances.rb,
lib/inttegro/resources/products.rb,
lib/inttegro/transport_response.rb,
lib/inttegro/resources/customers.rb,
lib/inttegro/resources/schedules.rb,
lib/inttegro/generated/operations.rb,
lib/inttegro/resources/broadcasts.rb,
lib/inttegro/resources/file_links.rb,
lib/inttegro/resources/file_references.rb,
lib/inttegro/resources/payment_methods.rb,
lib/inttegro/resources/upload_requests.rb,
lib/inttegro/resources/purchase_intents.rb,
lib/inttegro/resources/message_templates.rb,
lib/inttegro/resources/financial_accounts.rb,
lib/inttegro/resources/balance_transactions.rb

Overview

typed: strict

Defined Under Namespace

Modules: BankAccounts, Money, Operations, Resources, Types, Wallets Classes: APIError, APIErrorReportContext, ActivatePaymentMethodRequest, ActivatePaymentMethodResponse, AddProductPriceRequest, AddProductPriceResponse, Address, Amount, AmountParams, AppCredentialOwner, AppManagementRole, AppRelationshipKind, AppRelationshipStatus, Application, ApplicationRelationship, ApplicationRelationshipPolicy, ApplicationSecretKey, ArchivePaymentMethodRequest, ArchivePaymentMethodResponse, AuthenticationError, BalanceSnapshot, BalanceSnapshotBalances, BalanceTransaction, BalanceTransactionAmount, BalanceTransactionPage, BalanceTransactionPageResponse, BalanceTransactionResponse, BalanceTransactionType, BalanceValue, BankAccountType, BillingDetails, BroadcastCancelDetail, BroadcastCancelResponse, BroadcastCreationDetail, BroadcastDetail, BroadcastError, BroadcastRequest, BroadcastRequestRequestMeta, BroadcastResponse, CancelBroadcastRequest, CancelOrderRequest, CancelPayoutRequest, CancelPayoutResponse, CancelPurchaseIntentRequest, CancelRefundRequest, CancelScheduleRequest, CancelUploadRequestRequest, CatalogPrice, CatalogPriceParams, CatalogProductWithPriceData, CatalogProductWithPriceReference, CheckoutBillingDetails, CheckoutConfirmPaymentRequest, CheckoutInvoiceView, CheckoutInvoiceViewBeneficiary, CheckoutInvoiceViewFormat, CheckoutInvoiceViewFormatPdf, CheckoutInvoiceViewFormatReceipt, CheckoutInvoiceViewFormatWeb, CheckoutInvoiceViewStatus, CheckoutMobileMoneyData, CheckoutMobileMoneyDataNetwork, CheckoutOrder, CheckoutOrderCheckoutSettings, CheckoutOrderCreatedFrom, CheckoutOrderCustomer, CheckoutOrderCustomerBillingAddress, CheckoutOrderCustomerShippingAddress, CheckoutOrderLineItemGroup, CheckoutOrderPayment, CheckoutOrderPaymentBillingDetails, CheckoutOrderPaymentLatestAttempt, CheckoutOrderPaymentLatestError, CheckoutOrderPaymentNextAction, CheckoutOrderPaymentPaymentMethod, CheckoutOrderReferenceRequest, CheckoutOrderResponse, CheckoutOrderStatus, CheckoutPayRequest, CheckoutPayRequestPaymentMethodData, CheckoutPayRequestPaymentMethodDataType, CheckoutPaymentAddress, CheckoutPaymentMethodData, CheckoutPaymentMethodDataBillingDetails, CheckoutPaymentMethodDataType, Chime, ChimeEmailEvent, ChimeEmailMailbox, ChimeEmailMessage, ChimeEmailMessageInput, ChimeEmailSafetyResult, ChimeEmailScannedLink, ChimeEmailSchemaKind, ChimeEmailSchemaMarkup, ChimeInlineRecipientVariant1, ChimeInlineRecipientVariant1Phone, ChimeInlineRecipientVariant1Type, ChimeInlineRecipientVariant2, ChimeInlineRecipientVariant2Email, ChimeInlineRecipientVariant2Type, ChimePage, ChimeRecipientDetail, ChimeRecipientDetailEmail, ChimeRecipientDetailPhone, ChimeRecipientType, ChimeResponse, ChimeSavedCustomerRecipient, ChimeTransmission, ChimeTransport, Client, CompactFinancialAccount, CompleteOrderEnvelope, CompleteOrderRequest, ConfirmPaymentRequest, ConnectFinancialAccountResponse, ConnectedFinancialAccount, ConnectedFinancialAccountDoshAccount, ContentSafetyStatus, CountryBank, CountryBankBranch, CountryBankDirectory, CountrySpecification, CountrySpecifications, CreateApplicationRequest, CreateApplicationRequestRelationshipPolicy, CreateApplicationResponse, CreateCustomerRequest, CreateEmailMessageTemplateRequest, CreateEmailMessageTemplateRequestChannel, CreateFileLinkRequest, CreateFileRequest, CreateFinancialAccountResponse, CreateOrderExistingCustomer, CreateOrderExistingCustomerCheckoutSettings, CreateOrderExistingCustomerRequestMeta, CreateOrderNewCustomer, CreateOrderNewCustomerCheckoutSettings, CreateOrderNewCustomerRequestMeta, CreateProductRequest, CreatePurchaseIntentRequest, CreatePurchaseIntentRequestPrice, CreatePurchaseIntentRequestPriceOriginal, CreatePurchaseIntentRequestProduct, CreatePurchaseIntentRequestQuantity, CreatePurchaseIntentRequestUsage, CreateRefundLineItem, CreateRefundRequest, CreateSMSMessageTemplateRequest, CreateSMSMessageTemplateRequestChannel, CreateUploadRequestRequest, CreatedFinancialAccount, CreatedFinancialAccountAddress, CreatedFinancialAccountBank, CreatedFinancialAccountOwner, CreatedGhanaBankAccount, Currency, CurrencyBalanceSnapshot, CurrencyBalanceSnapshotRefund, CurrencyBalanceSnapshotReserved, Customer, CustomerAddress, CustomerAddressInput, CustomerBalanceValue, CustomerData, CustomerPage, CustomerResponse, DeleteFileRequest, DeliveryChannel, DestroySecretKeyRequest, DestroySecretKeyResponse, DisableAutomaticPayoutsRequest, DisableAutomaticPayoutsResponse, DisableFinancialAccountPullResponse, DisableFinancialAccountPushResponse, DisactivatePaymentMethodRequest, DisactivatePaymentMethodResponse, DisconnectFinancialAccountResponse, EnableAutomaticPayoutsRequest, EnableAutomaticPayoutsResponse, EnableFinancialAccountPullResponse, EnableFinancialAccountPushResponse, Error, ErrorEnvelope, ErrorPayload, ErrorReport, FeeDetails, FeeLineItem, FeeLineItemType, File, FileActor, FileActorInput, FileApiError, FileContentsDeliveryMode, FileContentsRequest, FileDelivery, FileDisposition, FileDownload, FileLatestError, FileLink, FileLinkAccess, FileLinkAccessRequest, FileLinkActor, FileLinkCreation, FileLinkDelivery, FileLinkDeliveryMode, FileLinkKind, FileLinkPage, FileLinkPageResponse, FileLinkResponse, FileLinkStatus, FileMedia, FilePage, FilePageResponse, FileParty, FileReferenceInput, FileReferenceReconcileRequest, FileReferenceReconciliation, FileResource, FileResponse, FileScanStatus, FileServiceHealthResponse, FileServiceReadyResponse, FileSource, FileSourceType, FileStatus, FileStorageEncoding, FileUploadReceipt, FinalizeOrderEnvelope, FinalizeOrderRequest, FinancialAccount, FinancialAccountAddress, FinancialAccountBank, FinancialAccountBankRequest, FinancialAccountBankRequestBankAccount, FinancialAccountBankRequestBankAccountGhanaBankAccount, FinancialAccountBankRequestType, FinancialAccountDetails, FinancialAccountDetailsVerification, FinancialAccountDisableRequest, FinancialAccountDoshAccount, FinancialAccountDoshRequest, FinancialAccountDoshRequestDoshAccount, FinancialAccountDoshRequestType, FinancialAccountEnablePullRequest, FinancialAccountIDRequest, FinancialAccountOwner, FinancialAccountOwnerInput, FinancialAccountOwnerInputAddress, FinancialAccountOwnerUpdateInput, FinancialAccountOwnerUpdateInputAddress, FinancialAccountPage, FinancialAccountPageRequest, FinancialAccountPullConfiguration, FinancialAccountPullConfigurationMandate, FinancialAccountPushConfiguration, FinancialAccountRequestBase, FinancialAccountRequestBasePullConfiguration, FinancialAccountRequestBasePushConfiguration, FinancialAccountType, FinancialAccountUpdateRequest, FinancialAccountWallet, FinancialAccountWalletMobileMoney, FinancialAccountWalletRequest, FinancialAccountWalletRequestType, FinancialAccountWalletRequestWallet, FinancialAccountWalletRequestWalletMobileMoney, FinancialAccountWirePage, FinancialAccountWirePageAccountsItem, FinancialInstitution, FinancialInstitutionBank, FinancialInstitutionBankBranch, FinancialInstitutionMobileMoneyProvider, FulfillUploadRequestRequest, GenerateSecretKeyRequest, GenerateSecretKeyResponse, GeneratedSecretKey, GetPaymentMethodSettingsRequest, GetPaymentMethodSettingsResponse, GetPayoutSettingsRequest, GetPayoutSettingsResponse, GhanaBankAccount, HTTPClient, HTTPReportContext, InitiateOTPRequest, InitiateOTPResponse, InlineProductDetails, InvoiceSettings, ListCountrySpecsRequest, LookedUpApplication, LookupApplicationResponse, LookupBalanceTransactionRequest, LookupBalancesRequest, LookupBroadcastRequest, LookupBroadcastResponse, LookupChimeRequest, LookupCustomerRequest, LookupFileLinkRequest, LookupFileRequest, LookupFinancialAccountResponse, LookupOTPRequest, LookupOTPResponse, LookupOrderRequest, LookupPaymentMethodRequest, LookupPaymentMethodResponse, LookupPayoutRequest, LookupPayoutResponse, LookupPriceRequest, LookupProductRequest, LookupPurchaseIntentRequest, LookupRefundRequest, LookupScheduleRequest, LookupSecretKeyRequest, LookupSecretKeyResponse, LookupUploadRequestRequest, MessageTemplate, MessageTemplateChannel, MessageTemplateCreateFields, MessageTemplateEmailContent, MessageTemplateEnvelope, MessageTemplateIDRequest, MessageTemplateMailbox, MessageTemplatePreview, MessageTemplateReference, MessageTemplateSMSContent, MessageTemplateSafetyResult, MessageTemplateScannedLink, MessageTemplateStatus, MessageTemplateVariable, MessageTemplateVariableInput, MessageTemplateVariableItem, MessageTemplateVariableItemInput, MessageTemplateVariableItemType, MessageTemplateVariableType, MessageTemplateVariables, MessageTemplatesPage, MessageTemplatesPageEnvelope, MobileMoney, MobileMoneyNetwork, NetworkError, OTPAlphabetType, OTPStatus, OTPTransaction, OTPTransmission, OTPTransmissionSentVia, OTPTransmissionStatus, OTPVerification, OTPVerificationAttempt, OTPVerificationAttemptResult, OTPVerificationVerdict, Order, OrderAddress, OrderCheckoutSettings, OrderCreatedFrom, OrderCreatedFromResourceType, OrderCustomer, OrderDocumentDelivery, OrderDocumentDeliveryAttempt, OrderDocumentDeliveryFailure, OrderDocumentDeliveryRequest, OrderDocumentDeliveryResult, OrderDocumentFormat, OrderDocumentKind, OrderEnvelope, OrderFeeLineItem, OrderFeeLineItemFee, OrderFeeLineItemType, OrderInvoice, OrderInvoiceFormat, OrderLineItemGroup, OrderPage, OrderPayoutSettings, OrderPayoutSettingsRequest, OrderPayoutSettingsRequestDestination, OrderProductLineItem, OrderProductLineItemProduct, OrderProductLineItemType, OrderShipping, OrderShippingLineItem, OrderShippingLineItemShipping, OrderShippingLineItemType, OrderStatus, PageBalanceTransactionsRequest, PageChimesRequest, PageChimesResponse, PageCustomersRequest, PageCustomersResponse, PageFileLinksRequest, PageFilesRequest, PageFinancialAccountsRequest, PageFinancialAccountsResponse, PageFinancialAccountsResponseInline, PageMessageTemplatesRequest, PageOrdersEnvelope, PageOrdersRequest, PagePayoutsRequest, PagePayoutsResponse, PageProductsRequest, PageProductsResponse, PagePurchaseIntentsRequest, PagePurchaseIntentsResponse, PageRefundsRequest, PageSecretKeysRequest, PageSecretKeysResponse, PageUploadRequestsRequest, PayOrderRequest, Payment, PaymentAttemptStatus, PaymentConfirmationChannel, PaymentLatestAttempt, PaymentMethod, PaymentMethodBankAccount, PaymentMethodBankAccountGhanaBankAccount, PaymentMethodData, PaymentMethodDataMobileMoney, PaymentMethodDataType, PaymentMethodDeletion, PaymentMethodMobileMoney, PaymentMethodOwner, PaymentMethodOwnerAddress, PaymentMethodOwnerInput, PaymentMethodOwnerInputAddress, PaymentMethodPage, PaymentMethodPageRequest, PaymentMethodPageResponse, PaymentMethodSettings, PaymentMethodSnapshot, PaymentMethodSnapshotBankAccount, PaymentMethodSnapshotBankAccountGhanaBankAccount, PaymentMethodSnapshotCard, PaymentMethodSnapshotMobileMoney, PaymentMethodSnapshotOwner, PaymentMethodSupplied, PaymentMethodTokenizeBase, PaymentMethodTokenizeBaseType, PaymentMethodType, PaymentMethodTypeSetting, PaymentMethodVerification, PaymentNextAction, PaymentNextActionAuthorize, PaymentNextActionConfirmPayment, PaymentNextActionConfirmPaymentAttempt, PaymentNextActionConfirmPaymentRequest, PaymentNextActionExecute, PaymentNextActionRedirect, PaymentNextActionRedirectLatestVisit, PaymentNextActionType, PaymentPayoutConfiguration, PaymentPayoutConfigurationDestination, PaymentResult, PaymentResultStatus, PaymentStatus, Payout, PayoutError, PayoutPage, PayoutSettingsLookup, PayoutSettingsLookupSchedule, PayoutSettingsLookupScheduleAgingSpec, PayoutSettingsMutation, PayoutSettingsMutationSchedule, PayoutSettingsMutationScheduleSpec, PayoutStatus, Price, PriceActionRequest, PriceEmbeddedProduct, PricePage, PricePageRequest, PricePageResponse, PriceParams, PriceResponse, Product, ProductActionRequest, ProductAttribute, ProductDimensions, ProductDimensionsCustom, ProductDimensionsDigital, ProductDimensionsPhysical, ProductLineItem, ProductLineItemType, ProductMedia, ProductPage, ProductPriceSummary, ProductResponse, ProductShipment, ProductShipmentDelivery, ProductShipmentDownload, ProductShipmentInput, ProductShipmentInputType, ProductShipmentRender, ProductShipmentService, ProductShipmentStream, ProductShipmentType, ProductType, PublicFileStorage, PurchaseIntent, PurchaseIntentActivity, PurchaseIntentActivityAttribution, PurchaseIntentActivityInline, PurchaseIntentActivityLog, PurchaseIntentActivityType, PurchaseIntentActivityVisitor, PurchaseIntentMerchant, PurchaseIntentOriginalPrice, PurchaseIntentPage, PurchaseIntentPrice, PurchaseIntentProduct, PurchaseIntentProductAttributesItem, PurchaseIntentProductDimensions, PurchaseIntentProductMedia, PurchaseIntentProductShipment, PurchaseIntentQuantity, PurchaseIntentResponse, PurchaseIntentStatus, PurchaseIntentUsage, PurchaseIntentUsageOrder, PurchaseIntentVariant, PurchaseIntentVariantAxis, PurchaseIntentVariantSet, PurchaseIntentVariantSetInline, RateLimitError, ReconnectFinancialAccountResponse, Refund, RefundLineItem, RefundPage, RefundPageResponse, RefundReason, RefundRequestMeta, RefundResponse, RefundStatus, RenderMessageTemplatePreviewRequest, RenderedEmailMessageTemplate, RenderedMessageTemplate, RenderedSMSMessageTemplate, RequestConfirmationRequest, ResourceSupply, ResponseObject, ReviewUploadRequestAttemptByIDRequest, ReviewUploadRequestAttemptByOrdinalRequest, RevokeFileLinkRequest, SDKReportContext, ScheduleCancelDetail, ScheduleCancelResponse, ScheduleChimeRequest, ScheduleChimeRequestRequestMeta, ScheduleCreationDetail, ScheduleDetail, ScheduleError, ScheduleLookupResponse, SchedulePayoutRequest, SchedulePayoutResponse, ScheduleResponse, SecretKey, SecretKeyAuthResult, SecretKeyPage, SecretKeyStatus, SecretKeyTokenType, SecretKeyUsage, SecretKeyUsagePage, SecretKeyUsageRequest, SecretKeyUsageRow, SendChimeRequest, SendChimeRequestRequestMeta, SetDefaultUnitPriceRequest, SetPayoutDestinationsRequest, SetPayoutDestinationsResponse, Shipping, ShippingDetails, ShippingLineItem, ShippingLineItemType, TimeoutError, TokenizeMobileMoneyPaymentMethodRequest, TokenizeMobileMoneyPaymentMethodRequestMobileMoney, TokenizeMobileMoneyPaymentMethodRequestType, TokenizePaymentMethodResponse, TraceReportContext, TransportResponse, UnarchivePaymentMethodRequest, UnarchivePaymentMethodResponse, UpdateApplicationRequest, UpdateApplicationResponse, UpdateCustomerRequest, UpdateFinancialAccountResponse, UpdateMessageTemplateRequest, UpdateOrderRequest, UpdateOrderRequestPaymentMethodData, UpdateOrderRequestPaymentMethodDataType, UpdatePaymentMethodRequest, UpdatePaymentMethodRequestOwner, UpdatePaymentMethodRequestOwnerAddress, UpdatePaymentMethodResponse, UpdatePriceRequest, UpdateProductRequest, UpdateProductResponse, UpdatePurchaseIntentRequest, UpdatePurchaseIntentRequestQuantity, UpdateSecretKeyRequest, UpdateSecretKeyResponse, UpdatedApplication, UpdatedFinancialAccount, UpdatedFinancialAccountAddress, UpdatedFinancialAccountBank, UpdatedFinancialAccountDoshAccount, UpdatedFinancialAccountOwner, UpdatedFinancialAccountWallet, UpdatedGhanaBankAccount, UpdatedProduct, UploadFulfillment, UploadRequest, UploadRequestActor, UploadRequestAttempt, UploadRequestAttempts, UploadRequestAttemptsRequest, UploadRequestConstraints, UploadRequestDetails, UploadRequestDisplay, UploadRequestLatestError, UploadRequestPage, UploadRequestPageResponse, UploadRequestResponse, UploadRequestReview, UploadRequestReviewReason, UploadRequestReviewReasonInput, UploadRequestStatus, UploadRequestValidationFailure, UploadRequestValidationFailureError, UploadRequestWithAttemptResponse, UploadReviewDecision, UploadReviewType, VerifyOTPRequest, WalletType

Constant Summary

OtpTransaction =

Backward-compatible acronym spellings for domain objects.

OTPTransaction

OtpTransmission =

OTPTransmission

OtpVerificationAttempt =

OTPVerificationAttempt

VERSION =

"4.3.0"

DEFAULT_BASE_URL =

T.let("https://api.inttegro.com", String)

ErrorReporter =

T.type_alias { T.proc.params(report: ErrorReport).void }

ChimeInlineRecipient =

T.type_alias { T.any(Inttegro::ChimeInlineRecipientVariant1, Inttegro::ChimeInlineRecipientVariant2) }

ChimeRecipient =

T.type_alias { T.any(Inttegro::ChimeInlineRecipient, Inttegro::ChimeSavedCustomerRecipient) }

ProductDetails =

T.type_alias { T.any(Inttegro::InlineProductDetails, Inttegro::CatalogProductWithPriceData, Inttegro::CatalogProductWithPriceReference) }

LineItem =

T.type_alias { T.any(Inttegro::ProductLineItem, Inttegro::FeeLineItem, Inttegro::ShippingLineItem) }

OrderLineItem =

T.type_alias { T.any(Inttegro::OrderProductLineItem, Inttegro::OrderFeeLineItem, Inttegro::OrderShippingLineItem) }

MessageTemplateAttachmentIDs =

T.type_alias { T::Array[String] }

CreateMessageTemplateRequest =

T.type_alias { T.any(Inttegro::CreateSMSMessageTemplateRequest, Inttegro::CreateEmailMessageTemplateRequest) }

FinancialAccountCreateRequest =

T.type_alias { T.any(Inttegro::FinancialAccountWalletRequest, Inttegro::FinancialAccountBankRequest, Inttegro::FinancialAccountDoshRequest) }

PricePageItem =

T.type_alias { Inttegro::CatalogPrice }

ReviewUploadRequestAttemptRequest =

T.type_alias { T.any(Inttegro::ReviewUploadRequestAttemptByIDRequest, Inttegro::ReviewUploadRequestAttemptByOrdinalRequest) }

Class Method Summary

• .deserialize(value, klass) ⇒ Object

Class Method Details

.deserialize(value, klass) ⇒ Object

Raises:

• (TypeError)

# File 'lib/inttegro/models.rb', line 108

def self.deserialize(value, klass)
  data = stringify_json_keys(value)
  raise TypeError, "expected an object for #{klass}, got #{data.class}" unless data.is_a?(Hash)

  T.cast(klass, T.class_of(T::Struct)).from_hash(data)
end