dodopayments 1.20.0 → 1.47.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +45 -0
- data/README.md +144 -60
- data/SECURITY.md +2 -2
- data/lib/dodopayments/client.rb +25 -12
- data/lib/dodopayments/errors.rb +23 -1
- data/lib/dodopayments/file_part.rb +2 -2
- data/lib/dodopayments/internal/cursor_page_pagination.rb +90 -0
- data/lib/dodopayments/internal/default_page_number_pagination.rb +2 -2
- data/lib/dodopayments/internal/transport/base_client.rb +90 -10
- data/lib/dodopayments/internal/transport/pooled_net_requester.rb +17 -1
- data/lib/dodopayments/internal/type/array_of.rb +16 -2
- data/lib/dodopayments/internal/type/base_model.rb +152 -59
- data/lib/dodopayments/internal/type/boolean.rb +15 -1
- data/lib/dodopayments/internal/type/converter.rb +86 -33
- data/lib/dodopayments/internal/type/enum.rb +30 -6
- data/lib/dodopayments/internal/type/file_input.rb +13 -1
- data/lib/dodopayments/internal/type/hash_of.rb +16 -2
- data/lib/dodopayments/internal/type/request_parameters.rb +6 -12
- data/lib/dodopayments/internal/type/union.rb +44 -31
- data/lib/dodopayments/internal/type/unknown.rb +15 -1
- data/lib/dodopayments/internal/util.rb +136 -12
- data/lib/dodopayments/internal.rb +9 -0
- data/lib/dodopayments/models/addon_create_params.rb +6 -10
- data/lib/dodopayments/models/addon_list_params.rb +4 -4
- data/lib/dodopayments/models/addon_response.rb +6 -10
- data/lib/dodopayments/models/addon_update_params.rb +6 -10
- data/lib/dodopayments/models/attach_addon.rb +21 -0
- data/lib/dodopayments/models/billing_address.rb +3 -3
- data/lib/dodopayments/models/brand.rb +107 -0
- data/lib/dodopayments/models/brand_create_params.rb +44 -0
- data/lib/dodopayments/models/{webhook_event_retrieve_params.rb → brand_list_params.rb} +2 -2
- data/lib/dodopayments/models/brand_list_response.rb +17 -0
- data/lib/dodopayments/models/brand_retrieve_params.rb +14 -0
- data/lib/dodopayments/models/brand_update_images_params.rb +14 -0
- data/lib/dodopayments/models/brand_update_images_response.rb +25 -0
- data/lib/dodopayments/models/brand_update_params.rb +43 -0
- data/lib/dodopayments/models/create_new_customer.rb +0 -1
- data/lib/dodopayments/models/customer_list_params.rb +13 -5
- data/lib/dodopayments/models/customer_request.rb +3 -3
- data/lib/dodopayments/models/customers/customer_portal_create_params.rb +2 -2
- data/lib/dodopayments/models/discount.rb +15 -4
- data/lib/dodopayments/models/discount_create_params.rb +17 -6
- data/lib/dodopayments/models/discount_list_params.rb +4 -4
- data/lib/dodopayments/models/discount_update_params.rb +16 -5
- data/lib/dodopayments/models/dispute.rb +15 -7
- data/lib/dodopayments/models/dispute_list_params.rb +44 -16
- data/lib/dodopayments/models/dispute_list_response.rb +77 -0
- data/lib/dodopayments/models/get_dispute.rb +101 -0
- data/lib/dodopayments/models/license_key.rb +3 -3
- data/lib/dodopayments/models/license_key_duration.rb +1 -1
- data/lib/dodopayments/models/license_key_list_params.rb +23 -11
- data/lib/dodopayments/models/license_key_update_params.rb +3 -3
- data/lib/dodopayments/models/misc_list_supported_countries_response.rb +1 -1
- data/lib/dodopayments/models/new_customer.rb +27 -0
- data/lib/dodopayments/models/one_time_product_cart_item.rb +0 -1
- data/lib/dodopayments/models/payment.rb +79 -18
- data/lib/dodopayments/models/payment_create_params.rb +22 -41
- data/lib/dodopayments/models/payment_create_response.rb +16 -6
- data/lib/dodopayments/models/payment_list_params.rb +44 -16
- data/lib/dodopayments/models/payment_list_response.rb +16 -4
- data/lib/dodopayments/models/payment_method_types.rb +31 -0
- data/lib/dodopayments/models/payment_retrieve_line_items_params.rb +14 -0
- data/lib/dodopayments/models/payment_retrieve_line_items_response.rb +63 -0
- data/lib/dodopayments/models/payout_list_params.rb +4 -4
- data/lib/dodopayments/models/payout_list_response.rb +7 -3
- data/lib/dodopayments/models/price.rb +57 -30
- data/lib/dodopayments/models/product.rb +85 -12
- data/lib/dodopayments/models/product_create_params.rb +61 -12
- data/lib/dodopayments/models/product_list_params.rb +15 -7
- data/lib/dodopayments/models/product_list_response.rb +19 -11
- data/lib/dodopayments/models/product_update_files_params.rb +20 -0
- data/lib/dodopayments/models/product_update_files_response.rb +22 -0
- data/lib/dodopayments/models/product_update_params.rb +70 -13
- data/lib/dodopayments/models/products/image_update_params.rb +2 -2
- data/lib/dodopayments/models/refund.rb +15 -5
- data/lib/dodopayments/models/refund_create_params.rb +38 -1
- data/lib/dodopayments/models/refund_list_params.rb +26 -13
- data/lib/dodopayments/models/subscription.rb +38 -18
- data/lib/dodopayments/models/subscription_change_plan_params.rb +19 -3
- data/lib/dodopayments/models/subscription_charge_params.rb +38 -2
- data/lib/dodopayments/models/subscription_create_params.rb +53 -66
- data/lib/dodopayments/models/subscription_create_response.rb +24 -8
- data/lib/dodopayments/models/subscription_list_params.rb +37 -14
- data/lib/dodopayments/models/subscription_list_response.rb +37 -16
- data/lib/dodopayments/models/subscription_status.rb +0 -1
- data/lib/dodopayments/models/subscription_update_params.rb +10 -6
- data/lib/dodopayments/models/webhook_create_params.rb +86 -0
- data/lib/dodopayments/models/webhook_create_response.rb +88 -0
- data/lib/dodopayments/models/webhook_delete_params.rb +14 -0
- data/lib/dodopayments/models/webhook_event_type.rb +35 -0
- data/lib/dodopayments/models/webhook_list_params.rb +30 -0
- data/lib/dodopayments/models/webhook_list_response.rb +88 -0
- data/lib/dodopayments/models/webhook_payload.rb +161 -0
- data/lib/dodopayments/models/webhook_retrieve_params.rb +14 -0
- data/lib/dodopayments/models/webhook_retrieve_response.rb +88 -0
- data/lib/dodopayments/models/webhook_update_params.rb +69 -0
- data/lib/dodopayments/models/webhook_update_response.rb +88 -0
- data/lib/dodopayments/models/webhooks/header_retrieve_params.rb +16 -0
- data/lib/dodopayments/models/webhooks/header_retrieve_response.rb +31 -0
- data/lib/dodopayments/models/webhooks/header_update_params.rb +24 -0
- data/lib/dodopayments/models/your_webhook_url_create_params.rb +32 -0
- data/lib/dodopayments/models.rb +241 -0
- data/lib/dodopayments/request_options.rb +4 -0
- data/lib/dodopayments/resources/addons.rb +13 -21
- data/lib/dodopayments/resources/brands.rb +119 -0
- data/lib/dodopayments/resources/customers/customer_portal.rb +3 -3
- data/lib/dodopayments/resources/customers.rb +12 -10
- data/lib/dodopayments/resources/discounts.rb +24 -19
- data/lib/dodopayments/resources/disputes.rb +12 -12
- data/lib/dodopayments/resources/invoices/payments.rb +3 -2
- data/lib/dodopayments/resources/license_key_instances.rb +5 -5
- data/lib/dodopayments/resources/license_keys.rb +13 -13
- data/lib/dodopayments/resources/licenses.rb +4 -4
- data/lib/dodopayments/resources/misc.rb +1 -1
- data/lib/dodopayments/resources/payments.rb +38 -19
- data/lib/dodopayments/resources/payouts.rb +3 -3
- data/lib/dodopayments/resources/products/images.rb +2 -2
- data/lib/dodopayments/resources/products.rb +58 -24
- data/lib/dodopayments/resources/refunds.rb +14 -12
- data/lib/dodopayments/resources/subscriptions.rb +44 -29
- data/lib/dodopayments/resources/webhook_events.rb +0 -52
- data/lib/dodopayments/resources/webhooks/headers.rb +59 -0
- data/lib/dodopayments/resources/webhooks.rb +157 -0
- data/lib/dodopayments/resources/your_webhook_url.rb +56 -0
- data/lib/dodopayments/version.rb +1 -1
- data/lib/dodopayments.rb +47 -8
- data/rbi/dodopayments/client.rbi +24 -10
- data/rbi/dodopayments/errors.rbi +51 -16
- data/rbi/dodopayments/file_part.rbi +9 -6
- data/rbi/dodopayments/internal/cursor_page_pagination.rbi +25 -0
- data/rbi/dodopayments/internal/default_page_number_pagination.rbi +2 -1
- data/rbi/dodopayments/internal/transport/base_client.rbi +165 -77
- data/rbi/dodopayments/internal/transport/pooled_net_requester.rbi +33 -13
- data/rbi/dodopayments/internal/type/array_of.rbi +40 -24
- data/rbi/dodopayments/internal/type/base_model.rbi +160 -70
- data/rbi/dodopayments/internal/type/base_page.rbi +13 -8
- data/rbi/dodopayments/internal/type/boolean.rbi +24 -14
- data/rbi/dodopayments/internal/type/converter.rbi +135 -33
- data/rbi/dodopayments/internal/type/enum.rbi +29 -13
- data/rbi/dodopayments/internal/type/file_input.rbi +13 -4
- data/rbi/dodopayments/internal/type/hash_of.rbi +40 -24
- data/rbi/dodopayments/internal/type/request_parameters.rbi +14 -4
- data/rbi/dodopayments/internal/type/union.rbi +71 -23
- data/rbi/dodopayments/internal/type/unknown.rbi +24 -6
- data/rbi/dodopayments/internal/util.rbi +274 -89
- data/rbi/dodopayments/internal.rbi +7 -0
- data/rbi/dodopayments/models/addon_cart_response_item.rbi +16 -4
- data/rbi/dodopayments/models/addon_create_params.rbi +33 -24
- data/rbi/dodopayments/models/addon_list_params.rbi +29 -17
- data/rbi/dodopayments/models/addon_response.rbi +33 -27
- data/rbi/dodopayments/models/addon_retrieve_params.rbi +18 -5
- data/rbi/dodopayments/models/addon_update_images_params.rbi +18 -5
- data/rbi/dodopayments/models/addon_update_images_response.rbi +13 -3
- data/rbi/dodopayments/models/addon_update_params.rbi +34 -25
- data/rbi/dodopayments/models/attach_addon.rbi +28 -0
- data/rbi/dodopayments/models/attach_existing_customer.rbi +13 -3
- data/rbi/dodopayments/models/billing_address.rbi +24 -12
- data/rbi/dodopayments/models/brand.rbi +132 -0
- data/rbi/dodopayments/models/brand_create_params.rbi +68 -0
- data/rbi/dodopayments/models/brand_list_params.rbi +29 -0
- data/rbi/dodopayments/models/brand_list_response.rbi +34 -0
- data/rbi/dodopayments/models/brand_retrieve_params.rbi +32 -0
- data/rbi/dodopayments/models/brand_update_images_params.rbi +32 -0
- data/rbi/dodopayments/models/brand_update_images_response.rbi +36 -0
- data/rbi/dodopayments/models/brand_update_params.rbi +64 -0
- data/rbi/dodopayments/models/country_code.rbi +255 -252
- data/rbi/dodopayments/models/create_new_customer.rbi +27 -11
- data/rbi/dodopayments/models/currency.rbi +149 -148
- data/rbi/dodopayments/models/customer.rbi +27 -15
- data/rbi/dodopayments/models/customer_create_params.rbi +22 -14
- data/rbi/dodopayments/models/customer_limited_details.rbi +21 -4
- data/rbi/dodopayments/models/customer_list_params.rbi +43 -17
- data/rbi/dodopayments/models/customer_portal_session.rbi +13 -3
- data/rbi/dodopayments/models/customer_request.rbi +10 -2
- data/rbi/dodopayments/models/customer_retrieve_params.rbi +18 -5
- data/rbi/dodopayments/models/customer_update_params.rbi +21 -13
- data/rbi/dodopayments/models/customers/customer_portal_create_params.rbi +26 -8
- data/rbi/dodopayments/models/discount.rbi +42 -22
- data/rbi/dodopayments/models/discount_create_params.rbi +43 -20
- data/rbi/dodopayments/models/discount_delete_params.rbi +18 -5
- data/rbi/dodopayments/models/discount_list_params.rbi +32 -17
- data/rbi/dodopayments/models/discount_retrieve_params.rbi +18 -5
- data/rbi/dodopayments/models/discount_type.rbi +7 -4
- data/rbi/dodopayments/models/discount_update_params.rbi +43 -20
- data/rbi/dodopayments/models/dispute.rbi +41 -23
- data/rbi/dodopayments/models/dispute_list_params.rbi +178 -33
- data/rbi/dodopayments/models/dispute_list_response.rbi +98 -0
- data/rbi/dodopayments/models/dispute_retrieve_params.rbi +18 -5
- data/rbi/dodopayments/models/dispute_stage.rbi +11 -6
- data/rbi/dodopayments/models/dispute_status.rbi +20 -10
- data/rbi/dodopayments/models/get_dispute.rbi +124 -0
- data/rbi/dodopayments/models/intent_status.rbi +32 -14
- data/rbi/dodopayments/models/invoices/payment_retrieve_params.rbi +18 -5
- data/rbi/dodopayments/models/license_activate_params.rbi +21 -6
- data/rbi/dodopayments/models/license_deactivate_params.rbi +21 -13
- data/rbi/dodopayments/models/license_key.rbi +31 -23
- data/rbi/dodopayments/models/license_key_duration.rbi +24 -5
- data/rbi/dodopayments/models/license_key_instance.rbi +19 -4
- data/rbi/dodopayments/models/license_key_instance_list_params.rbi +23 -14
- data/rbi/dodopayments/models/license_key_instance_retrieve_params.rbi +18 -5
- data/rbi/dodopayments/models/license_key_instance_update_params.rbi +19 -6
- data/rbi/dodopayments/models/license_key_list_params.rbi +91 -26
- data/rbi/dodopayments/models/license_key_retrieve_params.rbi +18 -5
- data/rbi/dodopayments/models/license_key_status.rbi +10 -6
- data/rbi/dodopayments/models/license_key_update_params.rbi +23 -14
- data/rbi/dodopayments/models/license_validate_params.rbi +25 -13
- data/rbi/dodopayments/models/license_validate_response.rbi +13 -3
- data/rbi/dodopayments/models/misc_list_supported_countries_params.rbi +18 -5
- data/rbi/dodopayments/models/misc_list_supported_countries_response.rbi +1 -1
- data/rbi/dodopayments/models/new_customer.rbi +39 -0
- data/rbi/dodopayments/models/one_time_product_cart_item.rbi +23 -4
- data/rbi/dodopayments/models/payment.rbi +149 -54
- data/rbi/dodopayments/models/payment_create_params.rbi +67 -87
- data/rbi/dodopayments/models/payment_create_response.rbi +45 -22
- data/rbi/dodopayments/models/payment_list_params.rbi +149 -32
- data/rbi/dodopayments/models/payment_list_response.rbi +47 -26
- data/rbi/dodopayments/models/payment_method_types.rbi +52 -0
- data/rbi/dodopayments/models/payment_retrieve_line_items_params.rbi +32 -0
- data/rbi/dodopayments/models/payment_retrieve_line_items_response.rbi +114 -0
- data/rbi/dodopayments/models/payment_retrieve_params.rbi +18 -5
- data/rbi/dodopayments/models/payout_list_params.rbi +29 -17
- data/rbi/dodopayments/models/payout_list_response.rbi +82 -35
- data/rbi/dodopayments/models/price.rbi +142 -55
- data/rbi/dodopayments/models/product.rbi +177 -38
- data/rbi/dodopayments/models/product_create_params.rbi +151 -36
- data/rbi/dodopayments/models/product_delete_params.rbi +18 -5
- data/rbi/dodopayments/models/product_list_params.rbi +50 -21
- data/rbi/dodopayments/models/product_list_response.rbi +57 -42
- data/rbi/dodopayments/models/product_retrieve_params.rbi +18 -5
- data/rbi/dodopayments/models/product_unarchive_params.rbi +18 -5
- data/rbi/dodopayments/models/product_update_files_params.rbi +38 -0
- data/rbi/dodopayments/models/product_update_files_response.rbi +29 -0
- data/rbi/dodopayments/models/product_update_params.rbi +160 -37
- data/rbi/dodopayments/models/products/image_update_params.rbi +20 -8
- data/rbi/dodopayments/models/products/image_update_response.rbi +18 -4
- data/rbi/dodopayments/models/refund.rbi +39 -21
- data/rbi/dodopayments/models/refund_create_params.rbi +87 -11
- data/rbi/dodopayments/models/refund_list_params.rbi +86 -29
- data/rbi/dodopayments/models/refund_retrieve_params.rbi +18 -5
- data/rbi/dodopayments/models/refund_status.rbi +10 -7
- data/rbi/dodopayments/models/subscription.rbi +83 -47
- data/rbi/dodopayments/models/subscription_change_plan_params.rbi +68 -21
- data/rbi/dodopayments/models/subscription_charge_params.rbi +65 -6
- data/rbi/dodopayments/models/subscription_charge_response.rbi +13 -3
- data/rbi/dodopayments/models/subscription_create_params.rbi +136 -128
- data/rbi/dodopayments/models/subscription_create_response.rbi +51 -22
- data/rbi/dodopayments/models/subscription_list_params.rbi +125 -29
- data/rbi/dodopayments/models/subscription_list_response.rbi +85 -44
- data/rbi/dodopayments/models/subscription_retrieve_params.rbi +18 -5
- data/rbi/dodopayments/models/subscription_status.rbi +16 -10
- data/rbi/dodopayments/models/subscription_update_params.rbi +63 -33
- data/rbi/dodopayments/models/tax_category.rbi +11 -7
- data/rbi/dodopayments/models/time_interval.rbi +10 -7
- data/rbi/dodopayments/models/webhook_create_params.rbi +115 -0
- data/rbi/dodopayments/models/webhook_create_response.rbi +112 -0
- data/rbi/dodopayments/models/webhook_delete_params.rbi +32 -0
- data/rbi/dodopayments/models/webhook_event_type.rbi +102 -0
- data/rbi/dodopayments/models/webhook_list_params.rbi +54 -0
- data/rbi/dodopayments/models/webhook_list_response.rbi +112 -0
- data/rbi/dodopayments/models/webhook_payload.rbi +440 -0
- data/rbi/dodopayments/models/webhook_retrieve_params.rbi +32 -0
- data/rbi/dodopayments/models/webhook_retrieve_response.rbi +112 -0
- data/rbi/dodopayments/models/webhook_update_params.rbi +94 -0
- data/rbi/dodopayments/models/webhook_update_response.rbi +112 -0
- data/rbi/dodopayments/models/webhooks/header_retrieve_params.rbi +34 -0
- data/rbi/dodopayments/models/webhooks/header_retrieve_response.rbi +50 -0
- data/rbi/dodopayments/models/webhooks/header_update_params.rbi +48 -0
- data/rbi/dodopayments/models/your_webhook_url_create_params.rbi +56 -0
- data/rbi/dodopayments/models.rbi +209 -0
- data/rbi/dodopayments/request_options.rbi +18 -7
- data/rbi/dodopayments/resources/addons.rbi +44 -27
- data/rbi/dodopayments/resources/brands.rbi +89 -0
- data/rbi/dodopayments/resources/customers/customer_portal.rbi +8 -6
- data/rbi/dodopayments/resources/customers.rbi +31 -17
- data/rbi/dodopayments/resources/discounts.rbi +54 -22
- data/rbi/dodopayments/resources/disputes.rbi +26 -14
- data/rbi/dodopayments/resources/invoices/payments.rbi +10 -3
- data/rbi/dodopayments/resources/invoices.rbi +2 -1
- data/rbi/dodopayments/resources/license_key_instances.rbi +25 -10
- data/rbi/dodopayments/resources/license_keys.rbi +29 -15
- data/rbi/dodopayments/resources/licenses.rbi +25 -12
- data/rbi/dodopayments/resources/misc.rbi +7 -4
- data/rbi/dodopayments/resources/payments.rbi +61 -27
- data/rbi/dodopayments/resources/payouts.rbi +12 -6
- data/rbi/dodopayments/resources/products/images.rbi +10 -4
- data/rbi/dodopayments/resources/products.rbi +118 -41
- data/rbi/dodopayments/resources/refunds.rbi +35 -15
- data/rbi/dodopayments/resources/subscriptions.rbi +98 -50
- data/rbi/dodopayments/resources/webhook_events.rbi +2 -34
- data/rbi/dodopayments/resources/webhooks/headers.rbi +40 -0
- data/rbi/dodopayments/resources/webhooks.rbi +127 -0
- data/rbi/dodopayments/resources/your_webhook_url.rbi +51 -0
- data/sig/dodopayments/client.rbs +8 -2
- data/sig/dodopayments/errors.rbs +9 -0
- data/sig/dodopayments/internal/cursor_page_pagination.rbs +15 -0
- data/sig/dodopayments/internal/transport/base_client.rbs +17 -2
- data/sig/dodopayments/internal/transport/pooled_net_requester.rbs +4 -0
- data/sig/dodopayments/internal/type/array_of.rbs +3 -0
- data/sig/dodopayments/internal/type/base_model.rbs +13 -5
- data/sig/dodopayments/internal/type/base_page.rbs +1 -1
- data/sig/dodopayments/internal/type/boolean.rbs +3 -0
- data/sig/dodopayments/internal/type/converter.rbs +26 -1
- data/sig/dodopayments/internal/type/enum.rbs +3 -0
- data/sig/dodopayments/internal/type/file_input.rbs +2 -0
- data/sig/dodopayments/internal/type/hash_of.rbs +3 -0
- data/sig/dodopayments/internal/type/request_parameters.rbs +5 -1
- data/sig/dodopayments/internal/type/union.rbs +5 -2
- data/sig/dodopayments/internal/type/unknown.rbs +3 -0
- data/sig/dodopayments/internal/util.rbs +27 -0
- data/sig/dodopayments/internal.rbs +4 -0
- data/sig/dodopayments/models/addon_cart_response_item.rbs +1 -1
- data/sig/dodopayments/models/addon_create_params.rbs +8 -1
- data/sig/dodopayments/models/addon_list_params.rbs +14 -6
- data/sig/dodopayments/models/addon_response.rbs +12 -1
- data/sig/dodopayments/models/addon_retrieve_params.rbs +1 -1
- data/sig/dodopayments/models/addon_update_images_params.rbs +1 -1
- data/sig/dodopayments/models/addon_update_images_response.rbs +1 -1
- data/sig/dodopayments/models/addon_update_params.rbs +9 -1
- data/sig/dodopayments/models/attach_addon.rbs +15 -0
- data/sig/dodopayments/models/attach_existing_customer.rbs +1 -1
- data/sig/dodopayments/models/billing_address.rbs +7 -1
- data/sig/dodopayments/models/brand.rbs +88 -0
- data/sig/dodopayments/models/brand_create_params.rbs +46 -0
- data/sig/dodopayments/models/{webhook_event_retrieve_params.rbs → brand_list_params.rbs} +3 -3
- data/sig/dodopayments/models/brand_list_response.rbs +13 -0
- data/sig/dodopayments/models/brand_retrieve_params.rbs +15 -0
- data/sig/dodopayments/models/brand_update_images_params.rbs +15 -0
- data/sig/dodopayments/models/brand_update_images_response.rbs +15 -0
- data/sig/dodopayments/models/brand_update_params.rbs +41 -0
- data/sig/dodopayments/models/create_new_customer.rbs +6 -1
- data/sig/dodopayments/models/customer.rbs +8 -1
- data/sig/dodopayments/models/customer_create_params.rbs +6 -1
- data/sig/dodopayments/models/customer_limited_details.rbs +1 -1
- data/sig/dodopayments/models/customer_list_params.rbs +20 -6
- data/sig/dodopayments/models/customer_portal_session.rbs +1 -1
- data/sig/dodopayments/models/customer_request.rbs +2 -3
- data/sig/dodopayments/models/customer_retrieve_params.rbs +1 -1
- data/sig/dodopayments/models/customer_update_params.rbs +5 -1
- data/sig/dodopayments/models/customers/customer_portal_create_params.rbs +9 -4
- data/sig/dodopayments/models/discount.rbs +18 -1
- data/sig/dodopayments/models/discount_create_params.rbs +15 -1
- data/sig/dodopayments/models/discount_delete_params.rbs +1 -1
- data/sig/dodopayments/models/discount_list_params.rbs +14 -6
- data/sig/dodopayments/models/discount_retrieve_params.rbs +1 -1
- data/sig/dodopayments/models/discount_update_params.rbs +15 -1
- data/sig/dodopayments/models/dispute.rbs +17 -3
- data/sig/dodopayments/models/dispute_list_params.rbs +84 -22
- data/sig/dodopayments/models/dispute_list_response.rbs +55 -0
- data/sig/dodopayments/models/dispute_retrieve_params.rbs +1 -1
- data/sig/dodopayments/models/get_dispute.rbs +70 -0
- data/sig/dodopayments/models/invoices/payment_retrieve_params.rbs +1 -1
- data/sig/dodopayments/models/license_activate_params.rbs +5 -1
- data/sig/dodopayments/models/license_deactivate_params.rbs +5 -1
- data/sig/dodopayments/models/license_key.rbs +14 -1
- data/sig/dodopayments/models/license_key_duration.rbs +4 -1
- data/sig/dodopayments/models/license_key_instance.rbs +7 -1
- data/sig/dodopayments/models/license_key_instance_list_params.rbs +6 -1
- data/sig/dodopayments/models/license_key_instance_retrieve_params.rbs +1 -1
- data/sig/dodopayments/models/license_key_instance_update_params.rbs +4 -1
- data/sig/dodopayments/models/license_key_list_params.rbs +47 -16
- data/sig/dodopayments/models/license_key_retrieve_params.rbs +1 -1
- data/sig/dodopayments/models/license_key_update_params.rbs +6 -1
- data/sig/dodopayments/models/license_validate_params.rbs +5 -1
- data/sig/dodopayments/models/license_validate_response.rbs +1 -1
- data/sig/dodopayments/models/misc_list_supported_countries_params.rbs +1 -1
- data/sig/dodopayments/models/new_customer.rbs +21 -0
- data/sig/dodopayments/models/one_time_product_cart_item.rbs +5 -1
- data/sig/dodopayments/models/payment.rbs +76 -17
- data/sig/dodopayments/models/payment_create_params.rbs +23 -55
- data/sig/dodopayments/models/payment_create_response.rbs +21 -7
- data/sig/dodopayments/models/payment_list_params.rbs +85 -22
- data/sig/dodopayments/models/payment_list_response.rbs +25 -4
- data/sig/dodopayments/models/payment_method_types.rbs +48 -0
- data/sig/dodopayments/models/payment_retrieve_line_items_params.rbs +15 -0
- data/sig/dodopayments/models/payment_retrieve_line_items_response.rbs +67 -0
- data/sig/dodopayments/models/payment_retrieve_params.rbs +1 -1
- data/sig/dodopayments/models/payout_list_params.rbs +14 -6
- data/sig/dodopayments/models/payout_list_response.rbs +17 -1
- data/sig/dodopayments/models/price.rbs +53 -13
- data/sig/dodopayments/models/product.rbs +80 -4
- data/sig/dodopayments/models/product_create_params.rbs +45 -4
- data/sig/dodopayments/models/product_delete_params.rbs +1 -1
- data/sig/dodopayments/models/product_list_params.rbs +29 -10
- data/sig/dodopayments/models/product_list_response.rbs +20 -1
- data/sig/dodopayments/models/product_retrieve_params.rbs +1 -1
- data/sig/dodopayments/models/product_unarchive_params.rbs +1 -1
- data/sig/dodopayments/models/product_update_files_params.rbs +23 -0
- data/sig/dodopayments/models/product_update_files_response.rbs +15 -0
- data/sig/dodopayments/models/product_update_params.rbs +58 -4
- data/sig/dodopayments/models/products/image_update_params.rbs +9 -4
- data/sig/dodopayments/models/products/image_update_response.rbs +1 -1
- data/sig/dodopayments/models/refund.rbs +15 -1
- data/sig/dodopayments/models/refund_create_params.rbs +38 -2
- data/sig/dodopayments/models/refund_list_params.rbs +54 -19
- data/sig/dodopayments/models/refund_retrieve_params.rbs +1 -1
- data/sig/dodopayments/models/subscription.rbs +43 -10
- data/sig/dodopayments/models/subscription_change_plan_params.rbs +16 -3
- data/sig/dodopayments/models/subscription_charge_params.rbs +27 -2
- data/sig/dodopayments/models/subscription_charge_response.rbs +1 -1
- data/sig/dodopayments/models/subscription_create_params.rbs +58 -73
- data/sig/dodopayments/models/subscription_create_response.rbs +26 -7
- data/sig/dodopayments/models/subscription_list_params.rbs +64 -19
- data/sig/dodopayments/models/subscription_list_response.rbs +39 -7
- data/sig/dodopayments/models/subscription_retrieve_params.rbs +1 -1
- data/sig/dodopayments/models/subscription_status.rbs +1 -2
- data/sig/dodopayments/models/subscription_update_params.rbs +20 -8
- data/sig/dodopayments/models/webhook_create_params.rbs +65 -0
- data/sig/dodopayments/models/webhook_create_response.rbs +60 -0
- data/sig/dodopayments/models/webhook_delete_params.rbs +15 -0
- data/sig/dodopayments/models/webhook_event_type.rbs +54 -0
- data/sig/dodopayments/models/webhook_list_params.rbs +28 -0
- data/sig/dodopayments/models/webhook_list_response.rbs +60 -0
- data/sig/dodopayments/models/webhook_payload.rbs +203 -0
- data/sig/dodopayments/models/webhook_retrieve_params.rbs +15 -0
- data/sig/dodopayments/models/webhook_retrieve_response.rbs +60 -0
- data/sig/dodopayments/models/webhook_update_params.rbs +51 -0
- data/sig/dodopayments/models/webhook_update_response.rbs +60 -0
- data/sig/dodopayments/models/webhooks/header_retrieve_params.rbs +17 -0
- data/sig/dodopayments/models/webhooks/header_retrieve_response.rbs +24 -0
- data/sig/dodopayments/models/webhooks/header_update_params.rbs +26 -0
- data/sig/dodopayments/models/your_webhook_url_create_params.rbs +42 -0
- data/sig/dodopayments/models.rbs +201 -0
- data/sig/dodopayments/request_options.rbs +1 -1
- data/sig/dodopayments/resources/addons.rbs +6 -6
- data/sig/dodopayments/resources/brands.rbs +39 -0
- data/sig/dodopayments/resources/customers/customer_portal.rbs +2 -2
- data/sig/dodopayments/resources/customers.rbs +7 -6
- data/sig/dodopayments/resources/discounts.rbs +8 -6
- data/sig/dodopayments/resources/disputes.rbs +9 -9
- data/sig/dodopayments/resources/invoices/payments.rbs +1 -1
- data/sig/dodopayments/resources/license_key_instances.rbs +3 -3
- data/sig/dodopayments/resources/license_keys.rbs +8 -8
- data/sig/dodopayments/resources/licenses.rbs +1 -1
- data/sig/dodopayments/resources/payments.rbs +17 -11
- data/sig/dodopayments/resources/payouts.rbs +2 -2
- data/sig/dodopayments/resources/products/images.rbs +1 -1
- data/sig/dodopayments/resources/products.rbs +20 -7
- data/sig/dodopayments/resources/refunds.rbs +10 -9
- data/sig/dodopayments/resources/subscriptions.rbs +21 -14
- data/sig/dodopayments/resources/webhook_events.rbs +0 -15
- data/sig/dodopayments/resources/webhooks/headers.rbs +20 -0
- data/sig/dodopayments/resources/webhooks.rbs +48 -0
- data/sig/dodopayments/resources/your_webhook_url.rbs +18 -0
- metadata +116 -11
- data/lib/dodopayments/models/webhook_event.rb +0 -58
- data/lib/dodopayments/models/webhook_event_list_params.rb +0 -66
- data/rbi/dodopayments/models/webhook_event.rbi +0 -71
- data/rbi/dodopayments/models/webhook_event_list_params.rbi +0 -77
- data/rbi/dodopayments/models/webhook_event_retrieve_params.rbi +0 -19
- data/sig/dodopayments/models/webhook_event.rbs +0 -46
- data/sig/dodopayments/models/webhook_event_list_params.rbs +0 -43
@@ -0,0 +1,101 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Dodopayments
|
4
|
+
module Models
|
5
|
+
# @see Dodopayments::Resources::Disputes#retrieve
|
6
|
+
class GetDispute < Dodopayments::Internal::Type::BaseModel
|
7
|
+
# @!attribute amount
|
8
|
+
# The amount involved in the dispute, represented as a string to accommodate
|
9
|
+
# precision.
|
10
|
+
#
|
11
|
+
# @return [String]
|
12
|
+
required :amount, String
|
13
|
+
|
14
|
+
# @!attribute business_id
|
15
|
+
# The unique identifier of the business involved in the dispute.
|
16
|
+
#
|
17
|
+
# @return [String]
|
18
|
+
required :business_id, String
|
19
|
+
|
20
|
+
# @!attribute created_at
|
21
|
+
# The timestamp of when the dispute was created, in UTC.
|
22
|
+
#
|
23
|
+
# @return [Time]
|
24
|
+
required :created_at, Time
|
25
|
+
|
26
|
+
# @!attribute currency
|
27
|
+
# The currency of the disputed amount, represented as an ISO 4217 currency code.
|
28
|
+
#
|
29
|
+
# @return [String]
|
30
|
+
required :currency, String
|
31
|
+
|
32
|
+
# @!attribute customer
|
33
|
+
# The customer who filed the dispute
|
34
|
+
#
|
35
|
+
# @return [Dodopayments::Models::CustomerLimitedDetails]
|
36
|
+
required :customer, -> { Dodopayments::CustomerLimitedDetails }
|
37
|
+
|
38
|
+
# @!attribute dispute_id
|
39
|
+
# The unique identifier of the dispute.
|
40
|
+
#
|
41
|
+
# @return [String]
|
42
|
+
required :dispute_id, String
|
43
|
+
|
44
|
+
# @!attribute dispute_stage
|
45
|
+
# The current stage of the dispute process.
|
46
|
+
#
|
47
|
+
# @return [Symbol, Dodopayments::Models::DisputeStage]
|
48
|
+
required :dispute_stage, enum: -> { Dodopayments::DisputeStage }
|
49
|
+
|
50
|
+
# @!attribute dispute_status
|
51
|
+
# The current status of the dispute.
|
52
|
+
#
|
53
|
+
# @return [Symbol, Dodopayments::Models::DisputeStatus]
|
54
|
+
required :dispute_status, enum: -> { Dodopayments::DisputeStatus }
|
55
|
+
|
56
|
+
# @!attribute payment_id
|
57
|
+
# The unique identifier of the payment associated with the dispute.
|
58
|
+
#
|
59
|
+
# @return [String]
|
60
|
+
required :payment_id, String
|
61
|
+
|
62
|
+
# @!attribute reason
|
63
|
+
# Reason for the dispute
|
64
|
+
#
|
65
|
+
# @return [String, nil]
|
66
|
+
optional :reason, String, nil?: true
|
67
|
+
|
68
|
+
# @!attribute remarks
|
69
|
+
# Remarks
|
70
|
+
#
|
71
|
+
# @return [String, nil]
|
72
|
+
optional :remarks, String, nil?: true
|
73
|
+
|
74
|
+
# @!method initialize(amount:, business_id:, created_at:, currency:, customer:, dispute_id:, dispute_stage:, dispute_status:, payment_id:, reason: nil, remarks: nil)
|
75
|
+
# Some parameter documentations has been truncated, see
|
76
|
+
# {Dodopayments::Models::GetDispute} for more details.
|
77
|
+
#
|
78
|
+
# @param amount [String] The amount involved in the dispute, represented as a string to accommodate preci
|
79
|
+
#
|
80
|
+
# @param business_id [String] The unique identifier of the business involved in the dispute.
|
81
|
+
#
|
82
|
+
# @param created_at [Time] The timestamp of when the dispute was created, in UTC.
|
83
|
+
#
|
84
|
+
# @param currency [String] The currency of the disputed amount, represented as an ISO 4217 currency code.
|
85
|
+
#
|
86
|
+
# @param customer [Dodopayments::Models::CustomerLimitedDetails] The customer who filed the dispute
|
87
|
+
#
|
88
|
+
# @param dispute_id [String] The unique identifier of the dispute.
|
89
|
+
#
|
90
|
+
# @param dispute_stage [Symbol, Dodopayments::Models::DisputeStage] The current stage of the dispute process.
|
91
|
+
#
|
92
|
+
# @param dispute_status [Symbol, Dodopayments::Models::DisputeStatus] The current status of the dispute.
|
93
|
+
#
|
94
|
+
# @param payment_id [String] The unique identifier of the payment associated with the dispute.
|
95
|
+
#
|
96
|
+
# @param reason [String, nil] Reason for the dispute
|
97
|
+
#
|
98
|
+
# @param remarks [String, nil] Remarks
|
99
|
+
end
|
100
|
+
end
|
101
|
+
end
|
@@ -53,9 +53,10 @@ module Dodopayments
|
|
53
53
|
required :product_id, String
|
54
54
|
|
55
55
|
# @!attribute status
|
56
|
+
# The current status of the license key (e.g., active, inactive, expired).
|
56
57
|
#
|
57
58
|
# @return [Symbol, Dodopayments::Models::LicenseKeyStatus]
|
58
|
-
required :status, enum: -> { Dodopayments::
|
59
|
+
required :status, enum: -> { Dodopayments::LicenseKeyStatus }
|
59
60
|
|
60
61
|
# @!attribute activations_limit
|
61
62
|
# The maximum number of activations allowed for this license key.
|
@@ -96,14 +97,13 @@ module Dodopayments
|
|
96
97
|
#
|
97
98
|
# @param product_id [String] The unique identifier of the product associated with the license key.
|
98
99
|
#
|
99
|
-
# @param status [Symbol, Dodopayments::Models::LicenseKeyStatus]
|
100
|
+
# @param status [Symbol, Dodopayments::Models::LicenseKeyStatus] The current status of the license key (e.g., active, inactive, expired).
|
100
101
|
#
|
101
102
|
# @param activations_limit [Integer, nil] The maximum number of activations allowed for this license key.
|
102
103
|
#
|
103
104
|
# @param expires_at [Time, nil] The timestamp indicating when the license key expires, in UTC.
|
104
105
|
#
|
105
106
|
# @param subscription_id [String, nil] The unique identifier of the subscription associated with the license key, if an
|
106
|
-
# ...
|
107
107
|
end
|
108
108
|
end
|
109
109
|
end
|
@@ -11,7 +11,7 @@ module Dodopayments
|
|
11
11
|
# @!attribute interval
|
12
12
|
#
|
13
13
|
# @return [Symbol, Dodopayments::Models::TimeInterval]
|
14
|
-
required :interval, enum: -> { Dodopayments::
|
14
|
+
required :interval, enum: -> { Dodopayments::TimeInterval }
|
15
15
|
|
16
16
|
# @!method initialize(count:, interval:)
|
17
17
|
# @param count [Integer]
|
@@ -11,44 +11,56 @@ module Dodopayments
|
|
11
11
|
# Filter by customer ID
|
12
12
|
#
|
13
13
|
# @return [String, nil]
|
14
|
-
optional :customer_id, String
|
14
|
+
optional :customer_id, String
|
15
15
|
|
16
16
|
# @!attribute page_number
|
17
17
|
# Page number default is 0
|
18
18
|
#
|
19
19
|
# @return [Integer, nil]
|
20
|
-
optional :page_number, Integer
|
20
|
+
optional :page_number, Integer
|
21
21
|
|
22
22
|
# @!attribute page_size
|
23
23
|
# Page size default is 10 max is 100
|
24
24
|
#
|
25
25
|
# @return [Integer, nil]
|
26
|
-
optional :page_size, Integer
|
26
|
+
optional :page_size, Integer
|
27
27
|
|
28
28
|
# @!attribute product_id
|
29
29
|
# Filter by product ID
|
30
30
|
#
|
31
31
|
# @return [String, nil]
|
32
|
-
optional :product_id, String
|
32
|
+
optional :product_id, String
|
33
33
|
|
34
34
|
# @!attribute status
|
35
35
|
# Filter by license key status
|
36
36
|
#
|
37
|
-
# @return [Symbol, Dodopayments::Models::
|
38
|
-
optional :status, enum: -> { Dodopayments::
|
37
|
+
# @return [Symbol, Dodopayments::Models::LicenseKeyListParams::Status, nil]
|
38
|
+
optional :status, enum: -> { Dodopayments::LicenseKeyListParams::Status }
|
39
39
|
|
40
40
|
# @!method initialize(customer_id: nil, page_number: nil, page_size: nil, product_id: nil, status: nil, request_options: {})
|
41
|
-
# @param customer_id [String
|
41
|
+
# @param customer_id [String] Filter by customer ID
|
42
42
|
#
|
43
|
-
# @param page_number [Integer
|
43
|
+
# @param page_number [Integer] Page number default is 0
|
44
44
|
#
|
45
|
-
# @param page_size [Integer
|
45
|
+
# @param page_size [Integer] Page size default is 10 max is 100
|
46
46
|
#
|
47
|
-
# @param product_id [String
|
47
|
+
# @param product_id [String] Filter by product ID
|
48
48
|
#
|
49
|
-
# @param status [Symbol, Dodopayments::Models::
|
49
|
+
# @param status [Symbol, Dodopayments::Models::LicenseKeyListParams::Status] Filter by license key status
|
50
50
|
#
|
51
51
|
# @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
|
52
|
+
|
53
|
+
# Filter by license key status
|
54
|
+
module Status
|
55
|
+
extend Dodopayments::Internal::Type::Enum
|
56
|
+
|
57
|
+
ACTIVE = :active
|
58
|
+
EXPIRED = :expired
|
59
|
+
DISABLED = :disabled
|
60
|
+
|
61
|
+
# @!method self.values
|
62
|
+
# @return [Array<Symbol>]
|
63
|
+
end
|
52
64
|
end
|
53
65
|
end
|
54
66
|
end
|
@@ -32,11 +32,11 @@ module Dodopayments
|
|
32
32
|
# Some parameter documentations has been truncated, see
|
33
33
|
# {Dodopayments::Models::LicenseKeyUpdateParams} for more details.
|
34
34
|
#
|
35
|
-
# @param activations_limit [Integer, nil] The updated activation limit for the license key.
|
35
|
+
# @param activations_limit [Integer, nil] The updated activation limit for the license key.
|
36
36
|
#
|
37
|
-
# @param disabled [Boolean, nil] Indicates whether the license key should be disabled.
|
37
|
+
# @param disabled [Boolean, nil] Indicates whether the license key should be disabled.
|
38
38
|
#
|
39
|
-
# @param expires_at [Time, nil] The updated expiration timestamp for the license key in UTC.
|
39
|
+
# @param expires_at [Time, nil] The updated expiration timestamp for the license key in UTC.
|
40
40
|
#
|
41
41
|
# @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
|
42
42
|
end
|
@@ -4,6 +4,6 @@ module Dodopayments
|
|
4
4
|
module Models
|
5
5
|
# @type [Dodopayments::Internal::Type::Converter]
|
6
6
|
MiscListSupportedCountriesResponse =
|
7
|
-
Dodopayments::Internal::Type::ArrayOf[enum: -> { Dodopayments::
|
7
|
+
Dodopayments::Internal::Type::ArrayOf[enum: -> { Dodopayments::CountryCode }]
|
8
8
|
end
|
9
9
|
end
|
@@ -0,0 +1,27 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Dodopayments
|
4
|
+
module Models
|
5
|
+
class NewCustomer < Dodopayments::Internal::Type::BaseModel
|
6
|
+
# @!attribute email
|
7
|
+
#
|
8
|
+
# @return [String]
|
9
|
+
required :email, String
|
10
|
+
|
11
|
+
# @!attribute name
|
12
|
+
#
|
13
|
+
# @return [String]
|
14
|
+
required :name, String
|
15
|
+
|
16
|
+
# @!attribute phone_number
|
17
|
+
#
|
18
|
+
# @return [String, nil]
|
19
|
+
optional :phone_number, String, nil?: true
|
20
|
+
|
21
|
+
# @!method initialize(email:, name:, phone_number: nil)
|
22
|
+
# @param email [String]
|
23
|
+
# @param name [String]
|
24
|
+
# @param phone_number [String, nil]
|
25
|
+
end
|
26
|
+
end
|
27
|
+
end
|
@@ -5,9 +5,16 @@ module Dodopayments
|
|
5
5
|
# @see Dodopayments::Resources::Payments#retrieve
|
6
6
|
class Payment < Dodopayments::Internal::Type::BaseModel
|
7
7
|
# @!attribute billing
|
8
|
+
# Billing address details for payments
|
8
9
|
#
|
9
10
|
# @return [Dodopayments::Models::BillingAddress]
|
10
|
-
required :billing, -> { Dodopayments::
|
11
|
+
required :billing, -> { Dodopayments::BillingAddress }
|
12
|
+
|
13
|
+
# @!attribute brand_id
|
14
|
+
# brand id this payment belongs to
|
15
|
+
#
|
16
|
+
# @return [String]
|
17
|
+
required :brand_id, String
|
11
18
|
|
12
19
|
# @!attribute business_id
|
13
20
|
# Identifier of the business associated with the payment
|
@@ -22,22 +29,31 @@ module Dodopayments
|
|
22
29
|
required :created_at, Time
|
23
30
|
|
24
31
|
# @!attribute currency
|
32
|
+
# Currency used for the payment
|
25
33
|
#
|
26
34
|
# @return [Symbol, Dodopayments::Models::Currency]
|
27
|
-
required :currency, enum: -> { Dodopayments::
|
35
|
+
required :currency, enum: -> { Dodopayments::Currency }
|
28
36
|
|
29
37
|
# @!attribute customer
|
38
|
+
# Details about the customer who made the payment
|
30
39
|
#
|
31
40
|
# @return [Dodopayments::Models::CustomerLimitedDetails]
|
32
|
-
required :customer, -> { Dodopayments::
|
41
|
+
required :customer, -> { Dodopayments::CustomerLimitedDetails }
|
42
|
+
|
43
|
+
# @!attribute digital_products_delivered
|
44
|
+
# brand id this payment belongs to
|
45
|
+
#
|
46
|
+
# @return [Boolean]
|
47
|
+
required :digital_products_delivered, Dodopayments::Internal::Type::Boolean
|
33
48
|
|
34
49
|
# @!attribute disputes
|
35
50
|
# List of disputes associated with this payment
|
36
51
|
#
|
37
52
|
# @return [Array<Dodopayments::Models::Dispute>]
|
38
|
-
required :disputes, -> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::
|
53
|
+
required :disputes, -> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::Dispute] }
|
39
54
|
|
40
55
|
# @!attribute metadata
|
56
|
+
# Additional custom data associated with the payment
|
41
57
|
#
|
42
58
|
# @return [Hash{Symbol=>String}]
|
43
59
|
required :metadata, Dodopayments::Internal::Type::HashOf[String]
|
@@ -52,7 +68,7 @@ module Dodopayments
|
|
52
68
|
# List of refunds issued for this payment
|
53
69
|
#
|
54
70
|
# @return [Array<Dodopayments::Models::Refund>]
|
55
|
-
required :refunds, -> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::
|
71
|
+
required :refunds, -> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::Refund] }
|
56
72
|
|
57
73
|
# @!attribute settlement_amount
|
58
74
|
# The amount that will be credited to your Dodo balance after currency conversion
|
@@ -63,9 +79,12 @@ module Dodopayments
|
|
63
79
|
required :settlement_amount, Integer
|
64
80
|
|
65
81
|
# @!attribute settlement_currency
|
82
|
+
# The currency in which the settlement_amount will be credited to your Dodo
|
83
|
+
# balance. This may differ from the customer's payment currency in adaptive
|
84
|
+
# pricing scenarios.
|
66
85
|
#
|
67
86
|
# @return [Symbol, Dodopayments::Models::Currency]
|
68
|
-
required :settlement_currency, enum: -> { Dodopayments::
|
87
|
+
required :settlement_currency, enum: -> { Dodopayments::Currency }
|
69
88
|
|
70
89
|
# @!attribute total_amount
|
71
90
|
# Total amount charged to the customer including tax, in smallest currency unit
|
@@ -74,12 +93,42 @@ module Dodopayments
|
|
74
93
|
# @return [Integer]
|
75
94
|
required :total_amount, Integer
|
76
95
|
|
96
|
+
# @!attribute card_issuing_country
|
97
|
+
# ISO2 country code of the card
|
98
|
+
#
|
99
|
+
# @return [Symbol, Dodopayments::Models::CountryCode, nil]
|
100
|
+
optional :card_issuing_country, enum: -> { Dodopayments::CountryCode }, nil?: true
|
101
|
+
|
102
|
+
# @!attribute card_last_four
|
103
|
+
# The last four digits of the card
|
104
|
+
#
|
105
|
+
# @return [String, nil]
|
106
|
+
optional :card_last_four, String, nil?: true
|
107
|
+
|
108
|
+
# @!attribute card_network
|
109
|
+
# Card network like VISA, MASTERCARD etc.
|
110
|
+
#
|
111
|
+
# @return [String, nil]
|
112
|
+
optional :card_network, String, nil?: true
|
113
|
+
|
114
|
+
# @!attribute card_type
|
115
|
+
# The type of card DEBIT or CREDIT
|
116
|
+
#
|
117
|
+
# @return [String, nil]
|
118
|
+
optional :card_type, String, nil?: true
|
119
|
+
|
77
120
|
# @!attribute discount_id
|
78
121
|
# The discount id if discount is applied
|
79
122
|
#
|
80
123
|
# @return [String, nil]
|
81
124
|
optional :discount_id, String, nil?: true
|
82
125
|
|
126
|
+
# @!attribute error_code
|
127
|
+
# An error code if the payment failed
|
128
|
+
#
|
129
|
+
# @return [String, nil]
|
130
|
+
optional :error_code, String, nil?: true
|
131
|
+
|
83
132
|
# @!attribute error_message
|
84
133
|
# An error message if the payment failed
|
85
134
|
#
|
@@ -109,7 +158,7 @@ module Dodopayments
|
|
109
158
|
#
|
110
159
|
# @return [Array<Dodopayments::Models::Payment::ProductCart>, nil]
|
111
160
|
optional :product_cart,
|
112
|
-
-> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::
|
161
|
+
-> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::Payment::ProductCart] },
|
113
162
|
nil?: true
|
114
163
|
|
115
164
|
# @!attribute settlement_tax
|
@@ -121,9 +170,10 @@ module Dodopayments
|
|
121
170
|
optional :settlement_tax, Integer, nil?: true
|
122
171
|
|
123
172
|
# @!attribute status
|
173
|
+
# Current status of the payment intent
|
124
174
|
#
|
125
175
|
# @return [Symbol, Dodopayments::Models::IntentStatus, nil]
|
126
|
-
optional :status, enum: -> { Dodopayments::
|
176
|
+
optional :status, enum: -> { Dodopayments::IntentStatus }, nil?: true
|
127
177
|
|
128
178
|
# @!attribute subscription_id
|
129
179
|
# Identifier of the subscription if payment is part of a subscription
|
@@ -143,38 +193,50 @@ module Dodopayments
|
|
143
193
|
# @return [Time, nil]
|
144
194
|
optional :updated_at, Time, nil?: true
|
145
195
|
|
146
|
-
# @!method initialize(billing:, business_id:, created_at:, currency:, customer:, disputes:, metadata:, payment_id:, refunds:, settlement_amount:, settlement_currency:, total_amount:, discount_id: nil, error_message: nil, payment_link: nil, payment_method: nil, payment_method_type: nil, product_cart: nil, settlement_tax: nil, status: nil, subscription_id: nil, tax: nil, updated_at: nil)
|
196
|
+
# @!method initialize(billing:, brand_id:, business_id:, created_at:, currency:, customer:, digital_products_delivered:, disputes:, metadata:, payment_id:, refunds:, settlement_amount:, settlement_currency:, total_amount:, card_issuing_country: nil, card_last_four: nil, card_network: nil, card_type: nil, discount_id: nil, error_code: nil, error_message: nil, payment_link: nil, payment_method: nil, payment_method_type: nil, product_cart: nil, settlement_tax: nil, status: nil, subscription_id: nil, tax: nil, updated_at: nil)
|
147
197
|
# Some parameter documentations has been truncated, see
|
148
198
|
# {Dodopayments::Models::Payment} for more details.
|
149
199
|
#
|
150
|
-
# @param billing [Dodopayments::Models::BillingAddress]
|
200
|
+
# @param billing [Dodopayments::Models::BillingAddress] Billing address details for payments
|
201
|
+
#
|
202
|
+
# @param brand_id [String] brand id this payment belongs to
|
151
203
|
#
|
152
204
|
# @param business_id [String] Identifier of the business associated with the payment
|
153
205
|
#
|
154
206
|
# @param created_at [Time] Timestamp when the payment was created
|
155
207
|
#
|
156
|
-
# @param currency [Symbol, Dodopayments::Models::Currency]
|
208
|
+
# @param currency [Symbol, Dodopayments::Models::Currency] Currency used for the payment
|
157
209
|
#
|
158
|
-
# @param customer [Dodopayments::Models::CustomerLimitedDetails]
|
210
|
+
# @param customer [Dodopayments::Models::CustomerLimitedDetails] Details about the customer who made the payment
|
211
|
+
#
|
212
|
+
# @param digital_products_delivered [Boolean] brand id this payment belongs to
|
159
213
|
#
|
160
214
|
# @param disputes [Array<Dodopayments::Models::Dispute>] List of disputes associated with this payment
|
161
215
|
#
|
162
|
-
# @param metadata [Hash{Symbol=>String}]
|
216
|
+
# @param metadata [Hash{Symbol=>String}] Additional custom data associated with the payment
|
163
217
|
#
|
164
218
|
# @param payment_id [String] Unique identifier for the payment
|
165
219
|
#
|
166
220
|
# @param refunds [Array<Dodopayments::Models::Refund>] List of refunds issued for this payment
|
167
221
|
#
|
168
222
|
# @param settlement_amount [Integer] The amount that will be credited to your Dodo balance after currency conversion
|
169
|
-
# ...
|
170
223
|
#
|
171
|
-
# @param settlement_currency [Symbol, Dodopayments::Models::Currency]
|
224
|
+
# @param settlement_currency [Symbol, Dodopayments::Models::Currency] The currency in which the settlement_amount will be credited to your Dodo balanc
|
172
225
|
#
|
173
226
|
# @param total_amount [Integer] Total amount charged to the customer including tax, in smallest currency unit (e
|
174
|
-
#
|
227
|
+
#
|
228
|
+
# @param card_issuing_country [Symbol, Dodopayments::Models::CountryCode, nil] ISO2 country code of the card
|
229
|
+
#
|
230
|
+
# @param card_last_four [String, nil] The last four digits of the card
|
231
|
+
#
|
232
|
+
# @param card_network [String, nil] Card network like VISA, MASTERCARD etc.
|
233
|
+
#
|
234
|
+
# @param card_type [String, nil] The type of card DEBIT or CREDIT
|
175
235
|
#
|
176
236
|
# @param discount_id [String, nil] The discount id if discount is applied
|
177
237
|
#
|
238
|
+
# @param error_code [String, nil] An error code if the payment failed
|
239
|
+
#
|
178
240
|
# @param error_message [String, nil] An error message if the payment failed
|
179
241
|
#
|
180
242
|
# @param payment_link [String, nil] Checkout URL
|
@@ -186,9 +248,8 @@ module Dodopayments
|
|
186
248
|
# @param product_cart [Array<Dodopayments::Models::Payment::ProductCart>, nil] List of products purchased in a one-time payment
|
187
249
|
#
|
188
250
|
# @param settlement_tax [Integer, nil] This represents the portion of settlement_amount that corresponds to taxes colle
|
189
|
-
# ...
|
190
251
|
#
|
191
|
-
# @param status [Symbol, Dodopayments::Models::IntentStatus, nil]
|
252
|
+
# @param status [Symbol, Dodopayments::Models::IntentStatus, nil] Current status of the payment intent
|
192
253
|
#
|
193
254
|
# @param subscription_id [String, nil] Identifier of the subscription if payment is part of a subscription
|
194
255
|
#
|
@@ -8,21 +8,25 @@ module Dodopayments
|
|
8
8
|
include Dodopayments::Internal::Type::RequestParameters
|
9
9
|
|
10
10
|
# @!attribute billing
|
11
|
+
# Billing address details for the payment
|
11
12
|
#
|
12
13
|
# @return [Dodopayments::Models::BillingAddress]
|
13
|
-
required :billing, -> { Dodopayments::
|
14
|
+
required :billing, -> { Dodopayments::BillingAddress }
|
14
15
|
|
15
16
|
# @!attribute customer
|
17
|
+
# Customer information for the payment
|
16
18
|
#
|
17
|
-
# @return [Dodopayments::Models::AttachExistingCustomer, Dodopayments::Models::
|
18
|
-
required :customer, union: -> { Dodopayments::
|
19
|
+
# @return [Dodopayments::Models::AttachExistingCustomer, Dodopayments::Models::NewCustomer]
|
20
|
+
required :customer, union: -> { Dodopayments::CustomerRequest }
|
19
21
|
|
20
22
|
# @!attribute product_cart
|
21
23
|
# List of products in the cart. Must contain at least 1 and at most 100 items.
|
22
24
|
#
|
23
25
|
# @return [Array<Dodopayments::Models::OneTimeProductCartItem>]
|
24
26
|
required :product_cart,
|
25
|
-
-> {
|
27
|
+
-> {
|
28
|
+
Dodopayments::Internal::Type::ArrayOf[Dodopayments::OneTimeProductCartItem]
|
29
|
+
}
|
26
30
|
|
27
31
|
# @!attribute allowed_payment_method_types
|
28
32
|
# List of payment methods allowed during checkout.
|
@@ -32,15 +36,17 @@ module Dodopayments
|
|
32
36
|
# Availability still depends on other factors (e.g., customer location, merchant
|
33
37
|
# settings).
|
34
38
|
#
|
35
|
-
# @return [Array<Symbol, Dodopayments::Models::
|
39
|
+
# @return [Array<Symbol, Dodopayments::Models::PaymentMethodTypes>, nil]
|
36
40
|
optional :allowed_payment_method_types,
|
37
|
-
-> { Dodopayments::Internal::Type::ArrayOf[enum: Dodopayments::
|
41
|
+
-> { Dodopayments::Internal::Type::ArrayOf[enum: Dodopayments::PaymentMethodTypes] },
|
38
42
|
nil?: true
|
39
43
|
|
40
44
|
# @!attribute billing_currency
|
45
|
+
# Fix the currency in which the end customer is billed. If Dodo Payments cannot
|
46
|
+
# support that currency for this transaction, it will not proceed
|
41
47
|
#
|
42
48
|
# @return [Symbol, Dodopayments::Models::Currency, nil]
|
43
|
-
optional :billing_currency, enum: -> { Dodopayments::
|
49
|
+
optional :billing_currency, enum: -> { Dodopayments::Currency }, nil?: true
|
44
50
|
|
45
51
|
# @!attribute discount_code
|
46
52
|
# Discount Code to apply to the transaction
|
@@ -49,6 +55,8 @@ module Dodopayments
|
|
49
55
|
optional :discount_code, String, nil?: true
|
50
56
|
|
51
57
|
# @!attribute metadata
|
58
|
+
# Additional metadata associated with the payment. Defaults to empty if not
|
59
|
+
# provided.
|
52
60
|
#
|
53
61
|
# @return [Hash{Symbol=>String}, nil]
|
54
62
|
optional :metadata, Dodopayments::Internal::Type::HashOf[String]
|
@@ -83,56 +91,29 @@ module Dodopayments
|
|
83
91
|
# Some parameter documentations has been truncated, see
|
84
92
|
# {Dodopayments::Models::PaymentCreateParams} for more details.
|
85
93
|
#
|
86
|
-
# @param billing [Dodopayments::Models::BillingAddress]
|
94
|
+
# @param billing [Dodopayments::Models::BillingAddress] Billing address details for the payment
|
87
95
|
#
|
88
|
-
# @param customer [Dodopayments::Models::AttachExistingCustomer, Dodopayments::Models::
|
96
|
+
# @param customer [Dodopayments::Models::AttachExistingCustomer, Dodopayments::Models::NewCustomer] Customer information for the payment
|
89
97
|
#
|
90
98
|
# @param product_cart [Array<Dodopayments::Models::OneTimeProductCartItem>] List of products in the cart. Must contain at least 1 and at most 100 items.
|
91
99
|
#
|
92
|
-
# @param allowed_payment_method_types [Array<Symbol, Dodopayments::Models::
|
100
|
+
# @param allowed_payment_method_types [Array<Symbol, Dodopayments::Models::PaymentMethodTypes>, nil] List of payment methods allowed during checkout.
|
93
101
|
#
|
94
|
-
# @param billing_currency [Symbol, Dodopayments::Models::Currency, nil]
|
102
|
+
# @param billing_currency [Symbol, Dodopayments::Models::Currency, nil] Fix the currency in which the end customer is billed.
|
95
103
|
#
|
96
104
|
# @param discount_code [String, nil] Discount Code to apply to the transaction
|
97
105
|
#
|
98
|
-
# @param metadata [Hash{Symbol=>String}]
|
106
|
+
# @param metadata [Hash{Symbol=>String}] Additional metadata associated with the payment.
|
99
107
|
#
|
100
108
|
# @param payment_link [Boolean, nil] Whether to generate a payment link. Defaults to false if not specified.
|
101
109
|
#
|
102
|
-
# @param return_url [String, nil] Optional URL to redirect the customer after payment.
|
110
|
+
# @param return_url [String, nil] Optional URL to redirect the customer after payment.
|
103
111
|
#
|
104
|
-
# @param show_saved_payment_methods [Boolean] Display saved payment methods of a returning customer
|
112
|
+
# @param show_saved_payment_methods [Boolean] Display saved payment methods of a returning customer
|
105
113
|
#
|
106
114
|
# @param tax_id [String, nil] Tax ID in case the payment is B2B. If tax id validation fails the payment creati
|
107
|
-
# ...
|
108
115
|
#
|
109
116
|
# @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
|
110
|
-
|
111
|
-
module AllowedPaymentMethodType
|
112
|
-
extend Dodopayments::Internal::Type::Enum
|
113
|
-
|
114
|
-
CREDIT = :credit
|
115
|
-
DEBIT = :debit
|
116
|
-
UPI_COLLECT = :upi_collect
|
117
|
-
UPI_INTENT = :upi_intent
|
118
|
-
APPLE_PAY = :apple_pay
|
119
|
-
CASHAPP = :cashapp
|
120
|
-
GOOGLE_PAY = :google_pay
|
121
|
-
MULTIBANCO = :multibanco
|
122
|
-
BANCONTACT_CARD = :bancontact_card
|
123
|
-
EPS = :eps
|
124
|
-
IDEAL = :ideal
|
125
|
-
PRZELEWY24 = :przelewy24
|
126
|
-
AFFIRM = :affirm
|
127
|
-
KLARNA = :klarna
|
128
|
-
SEPA = :sepa
|
129
|
-
ACH = :ach
|
130
|
-
AMAZON_PAY = :amazon_pay
|
131
|
-
AFTERPAY_CLEARPAY = :afterpay_clearpay
|
132
|
-
|
133
|
-
# @!method self.values
|
134
|
-
# @return [Array<Symbol>]
|
135
|
-
end
|
136
117
|
end
|
137
118
|
end
|
138
119
|
end
|
@@ -12,11 +12,13 @@ module Dodopayments
|
|
12
12
|
required :client_secret, String
|
13
13
|
|
14
14
|
# @!attribute customer
|
15
|
+
# Limited details about the customer making the payment
|
15
16
|
#
|
16
17
|
# @return [Dodopayments::Models::CustomerLimitedDetails]
|
17
|
-
required :customer, -> { Dodopayments::
|
18
|
+
required :customer, -> { Dodopayments::CustomerLimitedDetails }
|
18
19
|
|
19
20
|
# @!attribute metadata
|
21
|
+
# Additional metadata associated with the payment
|
20
22
|
#
|
21
23
|
# @return [Hash{Symbol=>String}]
|
22
24
|
required :metadata, Dodopayments::Internal::Type::HashOf[String]
|
@@ -39,6 +41,12 @@ module Dodopayments
|
|
39
41
|
# @return [String, nil]
|
40
42
|
optional :discount_id, String, nil?: true
|
41
43
|
|
44
|
+
# @!attribute expires_on
|
45
|
+
# Expiry timestamp of the payment link
|
46
|
+
#
|
47
|
+
# @return [Time, nil]
|
48
|
+
optional :expires_on, Time, nil?: true
|
49
|
+
|
42
50
|
# @!attribute payment_link
|
43
51
|
# Optional URL to a hosted payment page
|
44
52
|
#
|
@@ -50,18 +58,18 @@ module Dodopayments
|
|
50
58
|
#
|
51
59
|
# @return [Array<Dodopayments::Models::OneTimeProductCartItem>, nil]
|
52
60
|
optional :product_cart,
|
53
|
-
-> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::
|
61
|
+
-> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::OneTimeProductCartItem] },
|
54
62
|
nil?: true
|
55
63
|
|
56
|
-
# @!method initialize(client_secret:, customer:, metadata:, payment_id:, total_amount:, discount_id: nil, payment_link: nil, product_cart: nil)
|
64
|
+
# @!method initialize(client_secret:, customer:, metadata:, payment_id:, total_amount:, discount_id: nil, expires_on: nil, payment_link: nil, product_cart: nil)
|
57
65
|
# Some parameter documentations has been truncated, see
|
58
66
|
# {Dodopayments::Models::PaymentCreateResponse} for more details.
|
59
67
|
#
|
60
|
-
# @param client_secret [String] Client secret used to load Dodo checkout SDK
|
68
|
+
# @param client_secret [String] Client secret used to load Dodo checkout SDK
|
61
69
|
#
|
62
|
-
# @param customer [Dodopayments::Models::CustomerLimitedDetails]
|
70
|
+
# @param customer [Dodopayments::Models::CustomerLimitedDetails] Limited details about the customer making the payment
|
63
71
|
#
|
64
|
-
# @param metadata [Hash{Symbol=>String}]
|
72
|
+
# @param metadata [Hash{Symbol=>String}] Additional metadata associated with the payment
|
65
73
|
#
|
66
74
|
# @param payment_id [String] Unique identifier for the payment
|
67
75
|
#
|
@@ -69,6 +77,8 @@ module Dodopayments
|
|
69
77
|
#
|
70
78
|
# @param discount_id [String, nil] The discount id if discount is applied
|
71
79
|
#
|
80
|
+
# @param expires_on [Time, nil] Expiry timestamp of the payment link
|
81
|
+
#
|
72
82
|
# @param payment_link [String, nil] Optional URL to a hosted payment page
|
73
83
|
#
|
74
84
|
# @param product_cart [Array<Dodopayments::Models::OneTimeProductCartItem>, nil] Optional list of products included in the payment
|