vortex-sdk 0.2.0__tar.gz

vortex_sdk-0.2.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Vortex NYC, Inc.
+
+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:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+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.

vortex_sdk-0.2.0/PKG-INFO

@@ -0,0 +1,34 @@
+Metadata-Version: 2.4
+Name: vortex-sdk
+Version: 0.2.0
+Summary: Generated Python SDK for the Vortex Payments public API.
+License: MIT
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: urllib3<3.0.0,>=2.1.0
+Requires-Dist: python-dateutil>=2.8.2
+Requires-Dist: pydantic>=2
+Requires-Dist: typing-extensions>=4.7.1
+Dynamic: license-file
+
+# vortex-sdk
+
+Generated Python SDK for the Vortex Payments public API.
+
+This package is generated from `docs/openapi/vortex-public.openapi.json` by `pnpm run sdk:generate`.
+It is MIT-licensed and published to PyPI.
+
+```bash
+pip install vortex-sdk
+```
+
+```py
+import vortex
+
+# Point at the sandbox host for test data; vb_test_ keys are sandbox-only.
+configuration = vortex.Configuration(
+    host = "https://api.sandbox.vortex.nyc"
+)
+configuration.access_token = "<VORTEX_API_KEY>"
+```

vortex_sdk-0.2.0/README.md

@@ -0,0 +1,20 @@
+# vortex-sdk
+
+Generated Python SDK for the Vortex Payments public API.
+
+This package is generated from `docs/openapi/vortex-public.openapi.json` by `pnpm run sdk:generate`.
+It is MIT-licensed and published to PyPI.
+
+```bash
+pip install vortex-sdk
+```
+
+```py
+import vortex
+
+# Point at the sandbox host for test data; vb_test_ keys are sandbox-only.
+configuration = vortex.Configuration(
+    host = "https://api.sandbox.vortex.nyc"
+)
+configuration.access_token = "<VORTEX_API_KEY>"
+```

vortex_sdk-0.2.0/pyproject.toml

@@ -0,0 +1,20 @@
+[project]
+name = "vortex-sdk"
+version = "0.2.0"
+description = "Generated Python SDK for the Vortex Payments public API."
+readme = "README.md"
+license = { text = "MIT" }
+requires-python = ">=3.9"
+dependencies = [
+  "urllib3 >= 2.1.0, < 3.0.0",
+  "python-dateutil >= 2.8.2",
+  "pydantic >= 2",
+  "typing-extensions >= 4.7.1",
+]
+
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools.packages.find]
+include = ["vortex*"]

vortex_sdk-0.2.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

vortex_sdk-0.2.0/vortex/__init__.py

@@ -0,0 +1,265 @@
+# coding: utf-8
+
+# flake8: noqa
+
+"""
+    Vortex Payments API
+
+    Public Vortex Payments API for customers, subscriptions, invoices, payment requests, checkout, receipts, webhooks, tax.
+
+    The version of the OpenAPI document: 2026-08
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+__version__ = "0.2.0"
+
+# Define package exports
+__all__ = [
+    "BillingApi",
+    "CatalogApi",
+    "CheckoutApi",
+    "CreditNotesApi",
+    "CustomerBalanceApi",
+    "CustomersApi",
+    "DiscountsApi",
+    "EntitlementsApi",
+    "HostedApi",
+    "InvoicesApi",
+    "PayablesApi",
+    "PaymentMethodsApi",
+    "PaymentRequestsApi",
+    "PaymentsApi",
+    "PaymentsReadinessApi",
+    "PublicApi",
+    "QuotesApi",
+    "ReceiptsApi",
+    "SubscriptionsApi",
+    "TaxApi",
+    "WebhooksApi",
+    "ApiResponse",
+    "ApiClient",
+    "Configuration",
+    "OpenApiException",
+    "ApiTypeError",
+    "ApiValueError",
+    "ApiKeyError",
+    "ApiAttributeError",
+    "ApiException",
+    "ApiError",
+    "ApiErrorError",
+    "ApiWriteEnvelope",
+    "ApplyCouponRequest",
+    "BillingOrderFormSignRequest",
+    "BillingOrderFormSignatureRequestRequest",
+    "BillingOrderFormVoidRequest",
+    "BillingOrderFormsExpireDueRequest",
+    "BillingOrderUpdateRequest",
+    "BillingOrdersExecuteDueRequest",
+    "BillingQuoteCreateRequest",
+    "BillingQuoteLineInput",
+    "BillingQuoteVersionApproveRequest",
+    "BillingQuoteVersionCreateRequest",
+    "BillingQuoteVersionUpdateRequest",
+    "BillingQuoteVersionVoidRequest",
+    "CheckoutSessionLineItemRequest",
+    "CouponTargets",
+    "CreateCheckoutSessionRequest",
+    "CreateCouponRequest",
+    "CreateDepositBalancePayableRequest",
+    "CreateInstallmentPayableRequest",
+    "CreatePayableRequest",
+    "CreateRecurringPayableRequest",
+    "CreateRecurringPayableRequestCadence",
+    "CreditNoteCreateLine",
+    "CreditNoteCreateRequest",
+    "CreditNoteReason",
+    "CreditNoteRefundReconcileRequest",
+    "CreditNoteRefundRequest",
+    "CustomerBalanceTargets",
+    "CustomerDefaultPaymentMethodRequest",
+    "CustomerPaymentMethodArchiveRequest",
+    "CustomerPaymentMethodAttachRequest",
+    "CustomerPaymentMethodSetupRequest",
+    "CustomerUpsertRequest",
+    "ExpireCustomerBalanceRequest",
+    "GrantCustomerBalanceFromPaymentRequest",
+    "GrantCustomerBalanceRequest",
+    "GrantEntitlementRequest",
+    "InvoiceCollectRequest",
+    "InvoiceCreateRequest",
+    "InvoiceFinalizeRequest",
+    "InvoiceMarkUncollectibleRequest",
+    "InvoiceTax",
+    "InvoiceVoidRequest",
+    "MerchantAccountCreateRequest",
+    "MerchantAddress",
+    "MerchantAssociatedIdentity",
+    "MerchantOnboardingLinkRequest",
+    "MerchantProfileDate",
+    "MerchantSettlementBankAccount",
+    "MerchantTaxProfileRequest",
+    "MerchantTaxProfileRequestRegistrationsInner",
+    "MerchantUnderwritingData",
+    "MerchantUnderwritingDataCardVolumeDistribution",
+    "MerchantUnderwritingDataVolumeDistributionByBusinessType",
+    "OpenApiInvoiceTaxResponse",
+    "OpenApiInvoiceTaxResponseAllOfData",
+    "PaymentRequestCollectRequest",
+    "PaymentRequestCreateRequest",
+    "PaymentRequestLinkCreateRequest",
+    "PriceCreateRequest",
+    "ProductCreateRequest",
+    "ReverseCustomerBalanceRequest",
+    "RevokeEntitlementRequest",
+    "SubscriptionChangeRequest",
+    "SubscriptionCreateRequest",
+    "SubscriptionItemChangePreviewRequest",
+    "SubscriptionItemChangeRequestItem",
+    "TaxAddress",
+    "TaxBehavior",
+    "TaxBehaviorPolicy",
+    "TaxBehaviorPolicyRequest",
+    "TaxFailure",
+    "TaxFinalizeRequest",
+    "TaxJurisdictionEvidence",
+    "TaxLineEvidence",
+    "TaxQuoteRequest",
+    "TerminateAppliedCouponRequest",
+    "TerminateCouponRequest",
+    "WebhookDeliveriesDispatchRequest",
+    "WebhookDeliveriesRedriveRequest",
+    "WebhookDeliveryReplayRequest",
+    "WebhookEndpointCreateRequest",
+    "WebhookEndpointSecretRotateRequest",
+    "WebhookEndpointTestRequest",
+    "WebhookEndpointUpdateRequest",
+    "WebhookEventResendRequest",
+]
+
+# import apis into sdk package
+from vortex.api.billing_api import BillingApi as BillingApi
+from vortex.api.catalog_api import CatalogApi as CatalogApi
+from vortex.api.checkout_api import CheckoutApi as CheckoutApi
+from vortex.api.credit_notes_api import CreditNotesApi as CreditNotesApi
+from vortex.api.customer_balance_api import CustomerBalanceApi as CustomerBalanceApi
+from vortex.api.customers_api import CustomersApi as CustomersApi
+from vortex.api.discounts_api import DiscountsApi as DiscountsApi
+from vortex.api.entitlements_api import EntitlementsApi as EntitlementsApi
+from vortex.api.hosted_api import HostedApi as HostedApi
+from vortex.api.invoices_api import InvoicesApi as InvoicesApi
+from vortex.api.payables_api import PayablesApi as PayablesApi
+from vortex.api.payment_methods_api import PaymentMethodsApi as PaymentMethodsApi
+from vortex.api.payment_requests_api import PaymentRequestsApi as PaymentRequestsApi
+from vortex.api.payments_api import PaymentsApi as PaymentsApi
+from vortex.api.payments_readiness_api import PaymentsReadinessApi as PaymentsReadinessApi
+from vortex.api.public_api import PublicApi as PublicApi
+from vortex.api.quotes_api import QuotesApi as QuotesApi
+from vortex.api.receipts_api import ReceiptsApi as ReceiptsApi
+from vortex.api.subscriptions_api import SubscriptionsApi as SubscriptionsApi
+from vortex.api.tax_api import TaxApi as TaxApi
+from vortex.api.webhooks_api import WebhooksApi as WebhooksApi
+
+# import ApiClient
+from vortex.api_response import ApiResponse as ApiResponse
+from vortex.api_client import ApiClient as ApiClient
+from vortex.configuration import Configuration as Configuration
+from vortex.exceptions import OpenApiException as OpenApiException
+from vortex.exceptions import ApiTypeError as ApiTypeError
+from vortex.exceptions import ApiValueError as ApiValueError
+from vortex.exceptions import ApiKeyError as ApiKeyError
+from vortex.exceptions import ApiAttributeError as ApiAttributeError
+from vortex.exceptions import ApiException as ApiException
+
+# import models into sdk package
+from vortex.models.api_error import ApiError as ApiError
+from vortex.models.api_error_error import ApiErrorError as ApiErrorError
+from vortex.models.api_write_envelope import ApiWriteEnvelope as ApiWriteEnvelope
+from vortex.models.apply_coupon_request import ApplyCouponRequest as ApplyCouponRequest
+from vortex.models.billing_order_form_sign_request import BillingOrderFormSignRequest as BillingOrderFormSignRequest
+from vortex.models.billing_order_form_signature_request_request import BillingOrderFormSignatureRequestRequest as BillingOrderFormSignatureRequestRequest
+from vortex.models.billing_order_form_void_request import BillingOrderFormVoidRequest as BillingOrderFormVoidRequest
+from vortex.models.billing_order_forms_expire_due_request import BillingOrderFormsExpireDueRequest as BillingOrderFormsExpireDueRequest
+from vortex.models.billing_order_update_request import BillingOrderUpdateRequest as BillingOrderUpdateRequest
+from vortex.models.billing_orders_execute_due_request import BillingOrdersExecuteDueRequest as BillingOrdersExecuteDueRequest
+from vortex.models.billing_quote_create_request import BillingQuoteCreateRequest as BillingQuoteCreateRequest
+from vortex.models.billing_quote_line_input import BillingQuoteLineInput as BillingQuoteLineInput
+from vortex.models.billing_quote_version_approve_request import BillingQuoteVersionApproveRequest as BillingQuoteVersionApproveRequest
+from vortex.models.billing_quote_version_create_request import BillingQuoteVersionCreateRequest as BillingQuoteVersionCreateRequest
+from vortex.models.billing_quote_version_update_request import BillingQuoteVersionUpdateRequest as BillingQuoteVersionUpdateRequest
+from vortex.models.billing_quote_version_void_request import BillingQuoteVersionVoidRequest as BillingQuoteVersionVoidRequest
+from vortex.models.checkout_session_line_item_request import CheckoutSessionLineItemRequest as CheckoutSessionLineItemRequest
+from vortex.models.coupon_targets import CouponTargets as CouponTargets
+from vortex.models.create_checkout_session_request import CreateCheckoutSessionRequest as CreateCheckoutSessionRequest
+from vortex.models.create_coupon_request import CreateCouponRequest as CreateCouponRequest
+from vortex.models.create_deposit_balance_payable_request import CreateDepositBalancePayableRequest as CreateDepositBalancePayableRequest
+from vortex.models.create_installment_payable_request import CreateInstallmentPayableRequest as CreateInstallmentPayableRequest
+from vortex.models.create_payable_request import CreatePayableRequest as CreatePayableRequest
+from vortex.models.create_recurring_payable_request import CreateRecurringPayableRequest as CreateRecurringPayableRequest
+from vortex.models.create_recurring_payable_request_cadence import CreateRecurringPayableRequestCadence as CreateRecurringPayableRequestCadence
+from vortex.models.credit_note_create_line import CreditNoteCreateLine as CreditNoteCreateLine
+from vortex.models.credit_note_create_request import CreditNoteCreateRequest as CreditNoteCreateRequest
+from vortex.models.credit_note_reason import CreditNoteReason as CreditNoteReason
+from vortex.models.credit_note_refund_reconcile_request import CreditNoteRefundReconcileRequest as CreditNoteRefundReconcileRequest
+from vortex.models.credit_note_refund_request import CreditNoteRefundRequest as CreditNoteRefundRequest
+from vortex.models.customer_balance_targets import CustomerBalanceTargets as CustomerBalanceTargets
+from vortex.models.customer_default_payment_method_request import CustomerDefaultPaymentMethodRequest as CustomerDefaultPaymentMethodRequest
+from vortex.models.customer_payment_method_archive_request import CustomerPaymentMethodArchiveRequest as CustomerPaymentMethodArchiveRequest
+from vortex.models.customer_payment_method_attach_request import CustomerPaymentMethodAttachRequest as CustomerPaymentMethodAttachRequest
+from vortex.models.customer_payment_method_setup_request import CustomerPaymentMethodSetupRequest as CustomerPaymentMethodSetupRequest
+from vortex.models.customer_upsert_request import CustomerUpsertRequest as CustomerUpsertRequest
+from vortex.models.expire_customer_balance_request import ExpireCustomerBalanceRequest as ExpireCustomerBalanceRequest
+from vortex.models.grant_customer_balance_from_payment_request import GrantCustomerBalanceFromPaymentRequest as GrantCustomerBalanceFromPaymentRequest
+from vortex.models.grant_customer_balance_request import GrantCustomerBalanceRequest as GrantCustomerBalanceRequest
+from vortex.models.grant_entitlement_request import GrantEntitlementRequest as GrantEntitlementRequest
+from vortex.models.invoice_collect_request import InvoiceCollectRequest as InvoiceCollectRequest
+from vortex.models.invoice_create_request import InvoiceCreateRequest as InvoiceCreateRequest
+from vortex.models.invoice_finalize_request import InvoiceFinalizeRequest as InvoiceFinalizeRequest
+from vortex.models.invoice_mark_uncollectible_request import InvoiceMarkUncollectibleRequest as InvoiceMarkUncollectibleRequest
+from vortex.models.invoice_tax import InvoiceTax as InvoiceTax
+from vortex.models.invoice_void_request import InvoiceVoidRequest as InvoiceVoidRequest
+from vortex.models.merchant_account_create_request import MerchantAccountCreateRequest as MerchantAccountCreateRequest
+from vortex.models.merchant_address import MerchantAddress as MerchantAddress
+from vortex.models.merchant_associated_identity import MerchantAssociatedIdentity as MerchantAssociatedIdentity
+from vortex.models.merchant_onboarding_link_request import MerchantOnboardingLinkRequest as MerchantOnboardingLinkRequest
+from vortex.models.merchant_profile_date import MerchantProfileDate as MerchantProfileDate
+from vortex.models.merchant_settlement_bank_account import MerchantSettlementBankAccount as MerchantSettlementBankAccount
+from vortex.models.merchant_tax_profile_request import MerchantTaxProfileRequest as MerchantTaxProfileRequest
+from vortex.models.merchant_tax_profile_request_registrations_inner import MerchantTaxProfileRequestRegistrationsInner as MerchantTaxProfileRequestRegistrationsInner
+from vortex.models.merchant_underwriting_data import MerchantUnderwritingData as MerchantUnderwritingData
+from vortex.models.merchant_underwriting_data_card_volume_distribution import MerchantUnderwritingDataCardVolumeDistribution as MerchantUnderwritingDataCardVolumeDistribution
+from vortex.models.merchant_underwriting_data_volume_distribution_by_business_type import MerchantUnderwritingDataVolumeDistributionByBusinessType as MerchantUnderwritingDataVolumeDistributionByBusinessType
+from vortex.models.open_api_invoice_tax_response import OpenApiInvoiceTaxResponse as OpenApiInvoiceTaxResponse
+from vortex.models.open_api_invoice_tax_response_all_of_data import OpenApiInvoiceTaxResponseAllOfData as OpenApiInvoiceTaxResponseAllOfData
+from vortex.models.payment_request_collect_request import PaymentRequestCollectRequest as PaymentRequestCollectRequest
+from vortex.models.payment_request_create_request import PaymentRequestCreateRequest as PaymentRequestCreateRequest
+from vortex.models.payment_request_link_create_request import PaymentRequestLinkCreateRequest as PaymentRequestLinkCreateRequest
+from vortex.models.price_create_request import PriceCreateRequest as PriceCreateRequest
+from vortex.models.product_create_request import ProductCreateRequest as ProductCreateRequest
+from vortex.models.reverse_customer_balance_request import ReverseCustomerBalanceRequest as ReverseCustomerBalanceRequest
+from vortex.models.revoke_entitlement_request import RevokeEntitlementRequest as RevokeEntitlementRequest
+from vortex.models.subscription_change_request import SubscriptionChangeRequest as SubscriptionChangeRequest
+from vortex.models.subscription_create_request import SubscriptionCreateRequest as SubscriptionCreateRequest
+from vortex.models.subscription_item_change_preview_request import SubscriptionItemChangePreviewRequest as SubscriptionItemChangePreviewRequest
+from vortex.models.subscription_item_change_request_item import SubscriptionItemChangeRequestItem as SubscriptionItemChangeRequestItem
+from vortex.models.tax_address import TaxAddress as TaxAddress
+from vortex.models.tax_behavior import TaxBehavior as TaxBehavior
+from vortex.models.tax_behavior_policy import TaxBehaviorPolicy as TaxBehaviorPolicy
+from vortex.models.tax_behavior_policy_request import TaxBehaviorPolicyRequest as TaxBehaviorPolicyRequest
+from vortex.models.tax_failure import TaxFailure as TaxFailure
+from vortex.models.tax_finalize_request import TaxFinalizeRequest as TaxFinalizeRequest
+from vortex.models.tax_jurisdiction_evidence import TaxJurisdictionEvidence as TaxJurisdictionEvidence
+from vortex.models.tax_line_evidence import TaxLineEvidence as TaxLineEvidence
+from vortex.models.tax_quote_request import TaxQuoteRequest as TaxQuoteRequest
+from vortex.models.terminate_applied_coupon_request import TerminateAppliedCouponRequest as TerminateAppliedCouponRequest
+from vortex.models.terminate_coupon_request import TerminateCouponRequest as TerminateCouponRequest
+from vortex.models.webhook_deliveries_dispatch_request import WebhookDeliveriesDispatchRequest as WebhookDeliveriesDispatchRequest
+from vortex.models.webhook_deliveries_redrive_request import WebhookDeliveriesRedriveRequest as WebhookDeliveriesRedriveRequest
+from vortex.models.webhook_delivery_replay_request import WebhookDeliveryReplayRequest as WebhookDeliveryReplayRequest
+from vortex.models.webhook_endpoint_create_request import WebhookEndpointCreateRequest as WebhookEndpointCreateRequest
+from vortex.models.webhook_endpoint_secret_rotate_request import WebhookEndpointSecretRotateRequest as WebhookEndpointSecretRotateRequest
+from vortex.models.webhook_endpoint_test_request import WebhookEndpointTestRequest as WebhookEndpointTestRequest
+from vortex.models.webhook_endpoint_update_request import WebhookEndpointUpdateRequest as WebhookEndpointUpdateRequest
+from vortex.models.webhook_event_resend_request import WebhookEventResendRequest as WebhookEventResendRequest

vortex_sdk-0.2.0/vortex/api/__init__.py

@@ -0,0 +1,24 @@
+# flake8: noqa
+
+# import apis into api package
+from vortex.api.billing_api import BillingApi
+from vortex.api.catalog_api import CatalogApi
+from vortex.api.checkout_api import CheckoutApi
+from vortex.api.credit_notes_api import CreditNotesApi
+from vortex.api.customer_balance_api import CustomerBalanceApi
+from vortex.api.customers_api import CustomersApi
+from vortex.api.discounts_api import DiscountsApi
+from vortex.api.entitlements_api import EntitlementsApi
+from vortex.api.hosted_api import HostedApi
+from vortex.api.invoices_api import InvoicesApi
+from vortex.api.payables_api import PayablesApi
+from vortex.api.payment_methods_api import PaymentMethodsApi
+from vortex.api.payment_requests_api import PaymentRequestsApi
+from vortex.api.payments_api import PaymentsApi
+from vortex.api.payments_readiness_api import PaymentsReadinessApi
+from vortex.api.public_api import PublicApi
+from vortex.api.quotes_api import QuotesApi
+from vortex.api.receipts_api import ReceiptsApi
+from vortex.api.subscriptions_api import SubscriptionsApi
+from vortex.api.tax_api import TaxApi
+from vortex.api.webhooks_api import WebhooksApi