maxio-advanced-billing-sdk 5.2.0 → 6.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/LICENSE +1 -1
- data/README.md +48 -50
- data/lib/advanced_billing/client.rb +3 -4
- data/lib/advanced_billing/configuration.rb +21 -24
- data/lib/advanced_billing/controllers/advance_invoice_controller.rb +3 -3
- data/lib/advanced_billing/controllers/api_exports_controller.rb +9 -9
- data/lib/advanced_billing/controllers/base_controller.rb +1 -1
- data/lib/advanced_billing/controllers/billing_portal_controller.rb +4 -4
- data/lib/advanced_billing/controllers/component_price_points_controller.rb +34 -20
- data/lib/advanced_billing/controllers/components_controller.rb +12 -12
- data/lib/advanced_billing/controllers/coupons_controller.rb +45 -27
- data/lib/advanced_billing/controllers/custom_fields_controller.rb +9 -9
- data/lib/advanced_billing/controllers/customers_controller.rb +7 -7
- data/lib/advanced_billing/controllers/events_based_billing_segments_controller.rb +6 -6
- data/lib/advanced_billing/controllers/events_controller.rb +26 -9
- data/lib/advanced_billing/controllers/insights_controller.rb +4 -4
- data/lib/advanced_billing/controllers/invoices_controller.rb +17 -17
- data/lib/advanced_billing/controllers/offers_controller.rb +10 -6
- data/lib/advanced_billing/controllers/payment_profiles_controller.rb +12 -12
- data/lib/advanced_billing/controllers/product_families_controller.rb +22 -20
- data/lib/advanced_billing/controllers/product_price_points_controller.rb +14 -11
- data/lib/advanced_billing/controllers/products_controller.rb +6 -6
- data/lib/advanced_billing/controllers/proforma_invoices_controller.rb +9 -9
- data/lib/advanced_billing/controllers/reason_codes_controller.rb +17 -9
- data/lib/advanced_billing/controllers/referral_codes_controller.rb +1 -1
- data/lib/advanced_billing/controllers/sales_commissions_controller.rb +3 -3
- data/lib/advanced_billing/controllers/sites_controller.rb +3 -3
- data/lib/advanced_billing/controllers/subscription_components_controller.rb +21 -31
- data/lib/advanced_billing/controllers/subscription_group_invoice_account_controller.rb +4 -4
- data/lib/advanced_billing/controllers/subscription_group_status_controller.rb +4 -4
- data/lib/advanced_billing/controllers/subscription_groups_controller.rb +9 -9
- data/lib/advanced_billing/controllers/subscription_invoice_account_controller.rb +6 -6
- data/lib/advanced_billing/controllers/subscription_notes_controller.rb +20 -8
- data/lib/advanced_billing/controllers/subscription_products_controller.rb +2 -2
- data/lib/advanced_billing/controllers/subscription_status_controller.rb +20 -12
- data/lib/advanced_billing/controllers/subscriptions_controller.rb +40 -17
- data/lib/advanced_billing/controllers/webhooks_controller.rb +6 -6
- data/lib/advanced_billing/exceptions/api_exception.rb +11 -0
- data/lib/advanced_billing/exceptions/component_allocation_error_exception.rb +12 -0
- data/lib/advanced_billing/exceptions/component_price_point_error_exception.rb +12 -0
- data/lib/advanced_billing/exceptions/customer_error_response_exception.rb +12 -0
- data/lib/advanced_billing/exceptions/error_array_map_response_exception.rb +12 -0
- data/lib/advanced_billing/exceptions/error_list_response_exception.rb +12 -0
- data/lib/advanced_billing/exceptions/error_string_map_response_exception.rb +12 -0
- data/lib/advanced_billing/exceptions/event_based_billing_list_segments_errors_exception.rb +12 -0
- data/lib/advanced_billing/exceptions/event_based_billing_segment_errors_exception.rb +12 -0
- data/lib/advanced_billing/exceptions/event_based_billing_segment_exception.rb +12 -0
- data/lib/advanced_billing/exceptions/product_price_point_error_response_exception.rb +12 -0
- data/lib/advanced_billing/exceptions/proforma_bad_request_error_response_exception.rb +12 -0
- data/lib/advanced_billing/exceptions/refund_prepayment_base_errors_response_exception.rb +12 -0
- data/lib/advanced_billing/exceptions/single_error_response_exception.rb +12 -0
- data/lib/advanced_billing/exceptions/single_string_error_response_exception.rb +12 -0
- data/lib/advanced_billing/exceptions/subscription_add_coupon_error_exception.rb +14 -0
- data/lib/advanced_billing/exceptions/subscription_component_allocation_error_exception.rb +12 -0
- data/lib/advanced_billing/exceptions/subscription_group_create_error_response_exception.rb +12 -0
- data/lib/advanced_billing/exceptions/subscription_group_signup_error_response_exception.rb +12 -0
- data/lib/advanced_billing/exceptions/subscription_group_update_error_response_exception.rb +12 -0
- data/lib/advanced_billing/exceptions/subscription_remove_coupon_errors_exception.rb +12 -0
- data/lib/advanced_billing/exceptions/subscription_response_error_exception.rb +44 -0
- data/lib/advanced_billing/exceptions/subscriptions_mrr_error_response_exception.rb +12 -0
- data/lib/advanced_billing/exceptions/too_many_management_link_requests_error_exception.rb +12 -0
- data/lib/advanced_billing/models/account_balance.rb +24 -7
- data/lib/advanced_billing/models/account_balances.rb +24 -7
- data/lib/advanced_billing/models/ach_agreement.rb +23 -7
- data/lib/advanced_billing/models/activate_event_based_component.rb +21 -6
- data/lib/advanced_billing/models/activate_subscription_request.rb +18 -4
- data/lib/advanced_billing/models/add_coupons_request.rb +17 -4
- data/lib/advanced_billing/models/add_subscription_to_a_group.rb +16 -15
- data/lib/advanced_billing/models/address_change.rb +19 -5
- data/lib/advanced_billing/models/agreement_acceptance.rb +27 -7
- data/lib/advanced_billing/models/allocate_components.rb +29 -7
- data/lib/advanced_billing/models/allocation.rb +44 -7
- data/lib/advanced_billing/models/allocation_expiration_date.rb +18 -4
- data/lib/advanced_billing/models/allocation_preview.rb +33 -7
- data/lib/advanced_billing/models/allocation_preview_item.rb +38 -7
- data/lib/advanced_billing/models/allocation_preview_line_item.rb +28 -7
- data/lib/advanced_billing/models/allocation_preview_response.rb +18 -4
- data/lib/advanced_billing/models/allocation_response.rb +18 -4
- data/lib/advanced_billing/models/allocation_settings.rb +21 -6
- data/lib/advanced_billing/models/apple_pay_payment_profile.rb +34 -7
- data/lib/advanced_billing/models/applied_credit_note_data.rb +19 -5
- data/lib/advanced_billing/models/apply_credit_note_event.rb +23 -7
- data/lib/advanced_billing/models/apply_credit_note_event_data.rb +28 -7
- data/lib/advanced_billing/models/apply_debit_note_event.rb +23 -7
- data/lib/advanced_billing/models/apply_debit_note_event_data.rb +25 -7
- data/lib/advanced_billing/models/apply_payment_event.rb +23 -7
- data/lib/advanced_billing/models/apply_payment_event_data.rb +30 -7
- data/lib/advanced_billing/models/attribute_error.rb +18 -4
- data/lib/advanced_billing/models/auto_resume.rb +18 -4
- data/lib/advanced_billing/models/backport_invoice_event.rb +23 -7
- data/lib/advanced_billing/models/bank_account_attributes.rb +32 -7
- data/lib/advanced_billing/models/bank_account_payment_profile.rb +42 -7
- data/lib/advanced_billing/models/bank_account_response.rb +18 -4
- data/lib/advanced_billing/models/bank_account_verification.rb +19 -5
- data/lib/advanced_billing/models/bank_account_verification_request.rb +18 -4
- data/lib/advanced_billing/models/base_model.rb +88 -28
- data/lib/advanced_billing/models/base_refund_error.rb +17 -4
- data/lib/advanced_billing/models/base_string_error.rb +17 -4
- data/lib/advanced_billing/models/batch_job.rb +23 -7
- data/lib/advanced_billing/models/batch_job_response.rb +18 -4
- data/lib/advanced_billing/models/billing_manifest.rb +30 -7
- data/lib/advanced_billing/models/billing_manifest_item.rb +34 -7
- data/lib/advanced_billing/models/billing_schedule.rb +18 -4
- data/lib/advanced_billing/models/breakouts.rb +25 -7
- data/lib/advanced_billing/models/bulk_components_price_point_assignment.rb +18 -4
- data/lib/advanced_billing/models/bulk_create_product_price_points_request.rb +18 -4
- data/lib/advanced_billing/models/bulk_create_product_price_points_response.rb +18 -4
- data/lib/advanced_billing/models/bulk_create_segments.rb +18 -4
- data/lib/advanced_billing/models/bulk_update_segments.rb +18 -4
- data/lib/advanced_billing/models/bulk_update_segments_item.rb +20 -6
- data/lib/advanced_billing/models/calendar_billing.rb +22 -7
- data/lib/advanced_billing/models/cancel_grouped_subscriptions_request.rb +18 -4
- data/lib/advanced_billing/models/cancellation_options.rb +19 -5
- data/lib/advanced_billing/models/cancellation_request.rb +18 -4
- data/lib/advanced_billing/models/change_chargeback_status_event.rb +23 -7
- data/lib/advanced_billing/models/change_chargeback_status_event_data.rb +18 -4
- data/lib/advanced_billing/models/change_invoice_collection_method_event.rb +23 -7
- data/lib/advanced_billing/models/change_invoice_collection_method_event_data.rb +20 -5
- data/lib/advanced_billing/models/change_invoice_status_event.rb +23 -7
- data/lib/advanced_billing/models/change_invoice_status_event_data.rb +24 -7
- data/lib/advanced_billing/models/chargify_ebb.rb +25 -7
- data/lib/advanced_billing/models/component.rb +54 -9
- data/lib/advanced_billing/models/component_allocation_change.rb +27 -7
- data/lib/advanced_billing/models/component_allocation_error_item.rb +22 -7
- data/lib/advanced_billing/models/component_cost_data.rb +26 -7
- data/lib/advanced_billing/models/component_cost_data_rate_tier.rb +24 -7
- data/lib/advanced_billing/models/component_currency_price.rb +24 -7
- data/lib/advanced_billing/models/component_currency_prices_response.rb +18 -4
- data/lib/advanced_billing/models/component_custom_price.rb +24 -7
- data/lib/advanced_billing/models/component_price.rb +26 -7
- data/lib/advanced_billing/models/component_price_point.rb +127 -7
- data/lib/advanced_billing/models/component_price_point_assignment.rb +19 -5
- data/lib/advanced_billing/models/component_price_point_error_item.rb +21 -6
- data/lib/advanced_billing/models/component_price_point_item.rb +24 -7
- data/lib/advanced_billing/models/component_price_point_response.rb +18 -4
- data/lib/advanced_billing/models/component_price_points_response.rb +19 -5
- data/lib/advanced_billing/models/component_response.rb +18 -4
- data/lib/advanced_billing/models/compounding_strategy.rb +5 -1
- data/lib/advanced_billing/models/consolidated_invoice.rb +18 -4
- data/lib/advanced_billing/models/count_response.rb +17 -4
- data/lib/advanced_billing/models/coupon.rb +150 -29
- data/lib/advanced_billing/models/coupon_currency.rb +27 -9
- data/lib/advanced_billing/models/coupon_currency_request.rb +18 -4
- data/lib/advanced_billing/models/coupon_currency_response.rb +18 -4
- data/lib/advanced_billing/models/coupon_payload.rb +273 -0
- data/lib/advanced_billing/models/{create_or_update_coupon.rb → coupon_request.rb} +26 -22
- data/lib/advanced_billing/models/coupon_response.rb +17 -4
- data/lib/advanced_billing/models/coupon_restriction.rb +22 -7
- data/lib/advanced_billing/models/coupon_subcodes.rb +17 -4
- data/lib/advanced_billing/models/coupon_subcodes_response.rb +21 -6
- data/lib/advanced_billing/models/coupon_usage.rb +24 -7
- data/lib/advanced_billing/models/create_allocation.rb +31 -7
- data/lib/advanced_billing/models/create_allocation_request.rb +18 -4
- data/lib/advanced_billing/models/create_component_price_point.rb +30 -9
- data/lib/advanced_billing/models/create_component_price_point_request.rb +18 -4
- data/lib/advanced_billing/models/create_component_price_points_request.rb +18 -4
- data/lib/advanced_billing/models/create_credit_note_event.rb +23 -7
- data/lib/advanced_billing/models/create_currency_price.rb +20 -6
- data/lib/advanced_billing/models/create_currency_prices_request.rb +18 -4
- data/lib/advanced_billing/models/create_customer.rb +33 -7
- data/lib/advanced_billing/models/create_customer_request.rb +18 -4
- data/lib/advanced_billing/models/create_debit_note_event.rb +23 -7
- data/lib/advanced_billing/models/create_ebb_component.rb +18 -4
- data/lib/advanced_billing/models/create_invoice.rb +28 -7
- data/lib/advanced_billing/models/create_invoice_address.rb +24 -7
- data/lib/advanced_billing/models/create_invoice_coupon.rb +30 -8
- data/lib/advanced_billing/models/create_invoice_item.rb +30 -7
- data/lib/advanced_billing/models/create_invoice_payment.rb +24 -7
- data/lib/advanced_billing/models/create_invoice_payment_application.rb +19 -5
- data/lib/advanced_billing/models/create_invoice_payment_request.rb +19 -5
- data/lib/advanced_billing/models/create_invoice_request.rb +17 -4
- data/lib/advanced_billing/models/create_metadata.rb +19 -5
- data/lib/advanced_billing/models/create_metadata_request.rb +18 -4
- data/lib/advanced_billing/models/create_metafield.rb +22 -7
- data/lib/advanced_billing/models/create_metafields_request.rb +18 -4
- data/lib/advanced_billing/models/create_metered_component.rb +18 -4
- data/lib/advanced_billing/models/create_multi_invoice_payment.rb +24 -7
- data/lib/advanced_billing/models/create_multi_invoice_payment_request.rb +17 -4
- data/lib/advanced_billing/models/create_offer.rb +25 -7
- data/lib/advanced_billing/models/create_offer_component.rb +22 -6
- data/lib/advanced_billing/models/create_offer_request.rb +17 -4
- data/lib/advanced_billing/models/create_on_off_component.rb +18 -4
- data/lib/advanced_billing/models/create_or_update_endpoint.rb +19 -5
- data/lib/advanced_billing/models/create_or_update_endpoint_request.rb +18 -4
- data/lib/advanced_billing/models/create_or_update_product.rb +36 -7
- data/lib/advanced_billing/models/create_or_update_product_request.rb +17 -4
- data/lib/advanced_billing/models/create_or_update_segment_price.rb +22 -6
- data/lib/advanced_billing/models/create_payment.rb +22 -7
- data/lib/advanced_billing/models/create_payment_profile.rb +50 -7
- data/lib/advanced_billing/models/create_payment_profile_request.rb +18 -4
- data/lib/advanced_billing/models/create_prepaid_component.rb +18 -4
- data/lib/advanced_billing/models/create_prepaid_usage_component_price_point.rb +38 -13
- data/lib/advanced_billing/models/create_prepayment.rb +23 -7
- data/lib/advanced_billing/models/create_prepayment_request.rb +18 -4
- data/lib/advanced_billing/models/create_prepayment_response.rb +18 -4
- data/lib/advanced_billing/models/create_product_currency_price.rb +20 -6
- data/lib/advanced_billing/models/create_product_currency_prices_request.rb +18 -4
- data/lib/advanced_billing/models/create_product_family.rb +20 -6
- data/lib/advanced_billing/models/create_product_family_request.rb +18 -4
- data/lib/advanced_billing/models/create_product_price_point.rb +35 -7
- data/lib/advanced_billing/models/create_product_price_point_request.rb +18 -4
- data/lib/advanced_billing/models/create_quantity_based_component.rb +18 -4
- data/lib/advanced_billing/models/create_reason_code.rb +20 -6
- data/lib/advanced_billing/models/create_reason_code_request.rb +18 -4
- data/lib/advanced_billing/models/create_segment.rb +27 -7
- data/lib/advanced_billing/models/create_segment_request.rb +17 -4
- data/lib/advanced_billing/models/create_subscription.rb +79 -8
- data/lib/advanced_billing/models/create_subscription_component.rb +26 -7
- data/lib/advanced_billing/models/create_subscription_group.rb +19 -5
- data/lib/advanced_billing/models/create_subscription_group_request.rb +18 -4
- data/lib/advanced_billing/models/create_subscription_request.rb +18 -4
- data/lib/advanced_billing/models/create_usage.rb +23 -7
- data/lib/advanced_billing/models/create_usage_request.rb +17 -4
- data/lib/advanced_billing/models/created_prepayment.rb +26 -7
- data/lib/advanced_billing/models/credit_account_balance_changed.rb +27 -7
- data/lib/advanced_billing/models/credit_card_attributes.rb +22 -6
- data/lib/advanced_billing/models/credit_card_payment_profile.rb +39 -7
- data/lib/advanced_billing/models/credit_note.rb +42 -7
- data/lib/advanced_billing/models/credit_note_application.rb +23 -7
- data/lib/advanced_billing/models/credit_note_line_item.rb +37 -7
- data/lib/advanced_billing/models/credit_scheme_request.rb +18 -4
- data/lib/advanced_billing/models/currency_price.rb +46 -7
- data/lib/advanced_billing/models/currency_prices_response.rb +18 -4
- data/lib/advanced_billing/models/custom_field_value_change.rb +26 -7
- data/lib/advanced_billing/models/customer.rb +47 -7
- data/lib/advanced_billing/models/customer_attributes.rb +34 -7
- data/lib/advanced_billing/models/customer_change.rb +23 -7
- data/lib/advanced_billing/models/customer_changes_preview_response.rb +17 -4
- data/lib/advanced_billing/models/customer_custom_fields_change.rb +19 -5
- data/lib/advanced_billing/models/customer_error.rb +18 -4
- data/lib/advanced_billing/models/customer_payer_change.rb +19 -5
- data/lib/advanced_billing/models/customer_response.rb +18 -4
- data/lib/advanced_billing/models/debit_note.rb +37 -7
- data/lib/advanced_billing/models/deduct_service_credit.rb +19 -5
- data/lib/advanced_billing/models/deduct_service_credit_request.rb +18 -4
- data/lib/advanced_billing/models/delayed_cancellation_response.rb +17 -4
- data/lib/advanced_billing/models/delete_subscription_group_response.rb +19 -5
- data/lib/advanced_billing/models/dunner_data.rb +25 -7
- data/lib/advanced_billing/models/dunning_step_data.rb +26 -7
- data/lib/advanced_billing/models/dunning_step_reached.rb +20 -6
- data/lib/advanced_billing/models/ebb_component.rb +41 -53
- data/lib/advanced_billing/models/ebb_event.rb +18 -4
- data/lib/advanced_billing/models/enable_webhooks_request.rb +18 -4
- data/lib/advanced_billing/models/enable_webhooks_response.rb +18 -4
- data/lib/advanced_billing/models/endpoint.rb +23 -7
- data/lib/advanced_billing/models/endpoint_response.rb +18 -4
- data/lib/advanced_billing/models/errors.rb +19 -5
- data/lib/advanced_billing/models/event.rb +89 -11
- data/lib/advanced_billing/models/event_based_billing_segment_error.rb +18 -4
- data/lib/advanced_billing/models/event_key.rb +264 -0
- data/lib/advanced_billing/models/event_response.rb +17 -4
- data/lib/advanced_billing/models/failed_payment_event.rb +23 -7
- data/lib/advanced_billing/models/failed_payment_event_data.rb +24 -7
- data/lib/advanced_billing/models/full_subscription_group_response.rb +32 -7
- data/lib/advanced_billing/models/get_one_time_token_payment_profile.rb +39 -7
- data/lib/advanced_billing/models/get_one_time_token_request.rb +18 -4
- data/lib/advanced_billing/models/group_billing.rb +20 -6
- data/lib/advanced_billing/models/group_settings.rb +19 -5
- data/lib/advanced_billing/models/group_target.rb +19 -5
- data/lib/advanced_billing/models/historic_usage.rb +22 -6
- data/lib/advanced_billing/models/invoice.rb +114 -13
- data/lib/advanced_billing/models/invoice_address.rb +22 -7
- data/lib/advanced_billing/models/invoice_avatax_details.rb +146 -0
- data/lib/advanced_billing/models/invoice_balance_item.rb +20 -6
- data/lib/advanced_billing/models/invoice_credit.rb +26 -7
- data/lib/advanced_billing/models/invoice_custom_field.rb +23 -7
- data/lib/advanced_billing/models/invoice_customer.rb +25 -7
- data/lib/advanced_billing/models/invoice_debit.rb +167 -0
- data/lib/advanced_billing/models/invoice_discount.rb +30 -7
- data/lib/advanced_billing/models/invoice_discount_breakout.rb +21 -6
- data/lib/advanced_billing/models/invoice_display_settings.rb +23 -7
- data/lib/advanced_billing/models/invoice_issued.rb +31 -7
- data/lib/advanced_billing/models/invoice_line_item.rb +55 -8
- data/lib/advanced_billing/models/invoice_line_item_component_cost_data.rb +17 -4
- data/lib/advanced_billing/models/invoice_line_item_event_data.rb +37 -7
- data/lib/advanced_billing/models/invoice_line_item_pricing_detail.rb +19 -5
- data/lib/advanced_billing/models/invoice_payer.rb +24 -7
- data/lib/advanced_billing/models/invoice_payer_change.rb +22 -7
- data/lib/advanced_billing/models/invoice_payment.rb +30 -7
- data/lib/advanced_billing/models/invoice_payment_application.rb +21 -6
- data/lib/advanced_billing/models/invoice_payment_method.rb +26 -7
- data/lib/advanced_billing/models/invoice_pre_payment.rb +22 -6
- data/lib/advanced_billing/models/invoice_previous_balance.rb +19 -5
- data/lib/advanced_billing/models/invoice_refund.rb +28 -7
- data/lib/advanced_billing/models/invoice_response.rb +17 -4
- data/lib/advanced_billing/models/invoice_seller.rb +22 -7
- data/lib/advanced_billing/models/invoice_status.rb +4 -1
- data/lib/advanced_billing/models/invoice_tax.rb +31 -7
- data/lib/advanced_billing/models/invoice_tax_breakout.rb +23 -7
- data/lib/advanced_billing/models/invoice_tax_component_breakout.rb +33 -7
- data/lib/advanced_billing/models/issue_advance_invoice_request.rb +17 -4
- data/lib/advanced_billing/models/issue_invoice_event.rb +23 -7
- data/lib/advanced_billing/models/issue_invoice_event_data.rb +24 -7
- data/lib/advanced_billing/models/issue_invoice_request.rb +18 -4
- data/lib/advanced_billing/models/issue_service_credit.rb +19 -5
- data/lib/advanced_billing/models/issue_service_credit_request.rb +18 -4
- data/lib/advanced_billing/models/item_price_point_changed.rb +25 -7
- data/lib/advanced_billing/models/item_price_point_data.rb +20 -6
- data/lib/advanced_billing/models/list_components_filter.rb +19 -5
- data/lib/advanced_billing/models/list_components_price_points_response.rb +18 -4
- data/lib/advanced_billing/models/list_coupons_filter.rb +26 -7
- data/lib/advanced_billing/models/list_credit_notes_response.rb +18 -4
- data/lib/advanced_billing/models/list_invoice_events_response.rb +22 -7
- data/lib/advanced_billing/models/list_invoices_response.rb +18 -4
- data/lib/advanced_billing/models/list_metafields_response.rb +24 -7
- data/lib/advanced_billing/models/list_mrr_filter.rb +18 -4
- data/lib/advanced_billing/models/list_mrr_response.rb +16 -4
- data/lib/advanced_billing/models/list_mrr_response_result.rb +25 -7
- data/lib/advanced_billing/models/list_offers_response.rb +17 -4
- data/lib/advanced_billing/models/list_prepayments_filter.rb +20 -6
- data/lib/advanced_billing/models/list_price_points_filter.rb +25 -7
- data/lib/advanced_billing/models/list_product_price_points_response.rb +18 -4
- data/lib/advanced_billing/models/list_products_filter.rb +23 -7
- data/lib/advanced_billing/models/list_proforma_invoices_meta.rb +23 -7
- data/lib/advanced_billing/models/list_proforma_invoices_response.rb +19 -5
- data/lib/advanced_billing/models/list_public_keys_meta.rb +23 -7
- data/lib/advanced_billing/models/list_public_keys_response.rb +19 -5
- data/lib/advanced_billing/models/list_sale_rep_item.rb +23 -7
- data/lib/advanced_billing/models/list_segments_filter.rb +26 -7
- data/lib/advanced_billing/models/list_segments_response.rb +18 -4
- data/lib/advanced_billing/models/list_subcription_group_prepayment_item.rb +28 -7
- data/lib/advanced_billing/models/list_subscription_components_filter.rb +19 -5
- data/lib/advanced_billing/models/list_subscription_components_for_site_filter.rb +22 -6
- data/lib/advanced_billing/models/list_subscription_components_response.rb +18 -4
- data/lib/advanced_billing/models/list_subscription_group_prepayment.rb +18 -4
- data/lib/advanced_billing/models/list_subscription_group_prepayment_response.rb +18 -4
- data/lib/advanced_billing/models/list_subscription_groups_item.rb +30 -7
- data/lib/advanced_billing/models/list_subscription_groups_meta.rb +19 -5
- data/lib/advanced_billing/models/list_subscription_groups_response.rb +19 -5
- data/lib/advanced_billing/models/metadata.rb +24 -7
- data/lib/advanced_billing/models/metafield.rb +23 -7
- data/lib/advanced_billing/models/metafield_scope.rb +24 -7
- data/lib/advanced_billing/models/metered_component.rb +49 -51
- data/lib/advanced_billing/models/metered_usage.rb +25 -7
- data/lib/advanced_billing/models/movement.rb +28 -7
- data/lib/advanced_billing/models/movement_line_item.rb +26 -7
- data/lib/advanced_billing/models/mrr.rb +25 -7
- data/lib/advanced_billing/models/mrr_movement.rb +23 -7
- data/lib/advanced_billing/models/mrr_response.rb +16 -4
- data/lib/advanced_billing/models/multi_invoice_payment.rb +23 -7
- data/lib/advanced_billing/models/multi_invoice_payment_response.rb +17 -4
- data/lib/advanced_billing/models/nested_subscription_group.rb +23 -7
- data/lib/advanced_billing/models/net_terms.rb +28 -7
- data/lib/advanced_billing/models/offer.rb +37 -7
- data/lib/advanced_billing/models/offer_discount.rb +21 -6
- data/lib/advanced_billing/models/offer_item.rb +29 -7
- data/lib/advanced_billing/models/offer_response.rb +17 -4
- data/lib/advanced_billing/models/offer_signup_page.rb +24 -7
- data/lib/advanced_billing/models/{reason_codes_json_response.rb → ok_response.rb} +19 -7
- data/lib/advanced_billing/models/on_off_component.rb +66 -61
- data/lib/advanced_billing/models/organization_address.rb +24 -7
- data/lib/advanced_billing/models/origin_invoice.rb +19 -5
- data/lib/advanced_billing/models/overage_pricing.rb +19 -5
- data/lib/advanced_billing/models/override_subscription.rb +26 -7
- data/lib/advanced_billing/models/override_subscription_request.rb +18 -4
- data/lib/advanced_billing/models/paginated_metadata.rb +24 -7
- data/lib/advanced_billing/models/paid_invoice.rb +22 -7
- data/lib/advanced_billing/models/pause_request.rb +17 -4
- data/lib/advanced_billing/models/payer_attributes.rb +31 -7
- data/lib/advanced_billing/models/payer_error.rb +20 -6
- data/lib/advanced_billing/models/payment_collection_method_changed.rb +19 -5
- data/lib/advanced_billing/models/payment_for_allocation.rb +22 -7
- data/lib/advanced_billing/models/payment_method_apple_pay.rb +17 -4
- data/lib/advanced_billing/models/payment_method_bank_account.rb +22 -6
- data/lib/advanced_billing/models/payment_method_credit_card.rb +24 -7
- data/lib/advanced_billing/models/payment_method_external.rb +22 -7
- data/lib/advanced_billing/models/payment_method_paypal.rb +19 -5
- data/lib/advanced_billing/models/payment_profile_attributes.rb +42 -7
- data/lib/advanced_billing/models/payment_profile_response.rb +18 -4
- data/lib/advanced_billing/models/payment_related_events.rb +19 -5
- data/lib/advanced_billing/models/paypal_payment_profile.rb +35 -7
- data/lib/advanced_billing/models/pending_cancellation_change.rb +19 -5
- data/lib/advanced_billing/models/portal_management_link.rb +25 -7
- data/lib/advanced_billing/models/prepaid_configuration.rb +27 -7
- data/lib/advanced_billing/models/prepaid_configuration_response.rb +18 -4
- data/lib/advanced_billing/models/prepaid_product_price_point_filter.rb +18 -4
- data/lib/advanced_billing/models/prepaid_subscription_balance_changed.rb +26 -7
- data/lib/advanced_billing/models/prepaid_usage.rb +32 -7
- data/lib/advanced_billing/models/prepaid_usage_allocation_detail.rb +21 -6
- data/lib/advanced_billing/models/prepaid_usage_component.rb +83 -41
- data/lib/advanced_billing/models/prepayment.rb +28 -7
- data/lib/advanced_billing/models/prepayment_account_balance_changed.rb +25 -7
- data/lib/advanced_billing/models/prepayment_response.rb +18 -4
- data/lib/advanced_billing/models/prepayments_response.rb +18 -4
- data/lib/advanced_billing/models/preview_allocations_request.rb +24 -7
- data/lib/advanced_billing/models/price.rb +22 -6
- data/lib/advanced_billing/models/product.rb +62 -7
- data/lib/advanced_billing/models/product_family.rb +24 -7
- data/lib/advanced_billing/models/product_family_response.rb +18 -4
- data/lib/advanced_billing/models/product_price_point.rb +44 -7
- data/lib/advanced_billing/models/product_price_point_errors.rb +24 -7
- data/lib/advanced_billing/models/product_price_point_response.rb +18 -4
- data/lib/advanced_billing/models/product_response.rb +17 -4
- data/lib/advanced_billing/models/proforma_error.rb +18 -4
- data/lib/advanced_billing/models/proforma_invoice.rb +49 -7
- data/lib/advanced_billing/models/proforma_invoice_credit.rb +22 -7
- data/lib/advanced_billing/models/proforma_invoice_discount.rb +26 -7
- data/lib/advanced_billing/models/proforma_invoice_issued.rb +28 -7
- data/lib/advanced_billing/models/proforma_invoice_payment.rb +23 -7
- data/lib/advanced_billing/models/proforma_invoice_tax.rb +25 -7
- data/lib/advanced_billing/models/proration.rb +18 -4
- data/lib/advanced_billing/models/public_key.rb +22 -6
- data/lib/advanced_billing/models/public_signup_page.rb +22 -7
- data/lib/advanced_billing/models/quantity_based_component.rb +51 -23
- data/lib/advanced_billing/models/reactivate_subscription_group_request.rb +19 -5
- data/lib/advanced_billing/models/reactivate_subscription_group_response.rb +28 -7
- data/lib/advanced_billing/models/reactivate_subscription_request.rb +26 -7
- data/lib/advanced_billing/models/reactivation_billing.rb +18 -4
- data/lib/advanced_billing/models/reason_code.rb +24 -7
- data/lib/advanced_billing/models/reason_code_response.rb +18 -4
- data/lib/advanced_billing/models/record_payment_request.rb +17 -4
- data/lib/advanced_billing/models/record_payment_response.rb +19 -5
- data/lib/advanced_billing/models/referral_code.rb +22 -7
- data/lib/advanced_billing/models/referral_validation_response.rb +18 -4
- data/lib/advanced_billing/models/refund_consolidated_invoice.rb +24 -7
- data/lib/advanced_billing/models/refund_invoice.rb +24 -7
- data/lib/advanced_billing/models/refund_invoice_event.rb +23 -7
- data/lib/advanced_billing/models/refund_invoice_event_data.rb +28 -7
- data/lib/advanced_billing/models/refund_invoice_request.rb +17 -4
- data/lib/advanced_billing/models/refund_prepayment.rb +22 -7
- data/lib/advanced_billing/models/refund_prepayment_base_refund_error.rb +17 -4
- data/lib/advanced_billing/models/refund_prepayment_request.rb +17 -4
- data/lib/advanced_billing/models/refund_success.rb +22 -6
- data/lib/advanced_billing/models/remove_payment_event.rb +23 -7
- data/lib/advanced_billing/models/remove_payment_event_data.rb +26 -7
- data/lib/advanced_billing/models/renewal_preview.rb +30 -7
- data/lib/advanced_billing/models/renewal_preview_component.rb +21 -6
- data/lib/advanced_billing/models/renewal_preview_line_item.rb +34 -7
- data/lib/advanced_billing/models/renewal_preview_request.rb +18 -4
- data/lib/advanced_billing/models/renewal_preview_response.rb +18 -4
- data/lib/advanced_billing/models/replay_webhooks_request.rb +16 -4
- data/lib/advanced_billing/models/replay_webhooks_response.rb +17 -4
- data/lib/advanced_billing/models/resent_invitation.rb +26 -7
- data/lib/advanced_billing/models/resume_options.rb +19 -5
- data/lib/advanced_billing/models/revoked_invitation.rb +22 -6
- data/lib/advanced_billing/models/sale_rep.rb +23 -7
- data/lib/advanced_billing/models/sale_rep_item_mrr.rb +20 -6
- data/lib/advanced_billing/models/sale_rep_settings.rb +26 -7
- data/lib/advanced_billing/models/sale_rep_subscription.rb +26 -7
- data/lib/advanced_billing/models/segment.rb +33 -7
- data/lib/advanced_billing/models/segment_price.rb +26 -7
- data/lib/advanced_billing/models/segment_response.rb +17 -4
- data/lib/advanced_billing/models/send_invoice_request.rb +22 -6
- data/lib/advanced_billing/models/service_credit.rb +24 -7
- data/lib/advanced_billing/models/service_credit_response.rb +18 -4
- data/lib/advanced_billing/models/signup_proforma_preview.rb +21 -5
- data/lib/advanced_billing/models/signup_proforma_preview_response.rb +18 -4
- data/lib/advanced_billing/models/site.rb +56 -7
- data/lib/advanced_billing/models/site_response.rb +17 -4
- data/lib/advanced_billing/models/site_statistics.rb +35 -7
- data/lib/advanced_billing/models/site_summary.rb +23 -7
- data/lib/advanced_billing/models/subscription.rb +91 -7
- data/lib/advanced_billing/models/subscription_component.rb +50 -7
- data/lib/advanced_billing/models/subscription_component_allocation_error_item.rb +19 -5
- data/lib/advanced_billing/models/subscription_component_response.rb +18 -4
- data/lib/advanced_billing/models/subscription_component_subscription.rb +19 -5
- data/lib/advanced_billing/models/subscription_custom_price.rb +34 -7
- data/lib/advanced_billing/models/subscription_filter.rb +24 -7
- data/lib/advanced_billing/models/subscription_group.rb +25 -7
- data/lib/advanced_billing/models/subscription_group_balances.rb +23 -7
- data/lib/advanced_billing/models/subscription_group_bank_account.rb +35 -7
- data/lib/advanced_billing/models/subscription_group_component_custom_price.rb +21 -6
- data/lib/advanced_billing/models/subscription_group_credit_card.rb +37 -7
- data/lib/advanced_billing/models/subscription_group_customer.rb +23 -7
- data/lib/advanced_billing/models/subscription_group_item.rb +30 -7
- data/lib/advanced_billing/models/subscription_group_members_array_error.rb +17 -4
- data/lib/advanced_billing/models/subscription_group_payment_profile.rb +23 -7
- data/lib/advanced_billing/models/subscription_group_prepayment.rb +22 -7
- data/lib/advanced_billing/models/subscription_group_prepayment_request.rb +18 -4
- data/lib/advanced_billing/models/subscription_group_prepayment_response.rb +24 -7
- data/lib/advanced_billing/models/subscription_group_response.rb +18 -4
- data/lib/advanced_billing/models/subscription_group_signup.rb +29 -7
- data/lib/advanced_billing/models/subscription_group_signup_component.rb +24 -7
- data/lib/advanced_billing/models/subscription_group_signup_error.rb +25 -7
- data/lib/advanced_billing/models/{subscription_group_signup_success.rb → subscription_group_signup_event_data.rb} +31 -15
- data/lib/advanced_billing/models/subscription_group_signup_failure_data.rb +29 -7
- data/lib/advanced_billing/models/subscription_group_signup_item.rb +31 -7
- data/lib/advanced_billing/models/subscription_group_signup_request.rb +18 -4
- data/lib/advanced_billing/models/subscription_group_signup_response.rb +31 -7
- data/lib/advanced_billing/models/subscription_group_single_error.rb +18 -4
- data/lib/advanced_billing/models/subscription_group_subscription_error.rb +31 -7
- data/lib/advanced_billing/models/subscription_group_update_error.rb +19 -15
- data/lib/advanced_billing/models/subscription_included_coupon.rb +25 -7
- data/lib/advanced_billing/models/subscription_migration_preview.rb +25 -7
- data/lib/advanced_billing/models/subscription_migration_preview_options.rb +30 -7
- data/lib/advanced_billing/models/subscription_migration_preview_request.rb +18 -4
- data/lib/advanced_billing/models/subscription_migration_preview_response.rb +18 -4
- data/lib/advanced_billing/models/subscription_mrr.rb +22 -6
- data/lib/advanced_billing/models/subscription_mrr_breakout.rb +20 -5
- data/lib/advanced_billing/models/subscription_mrr_response.rb +18 -4
- data/lib/advanced_billing/models/subscription_note.rb +24 -7
- data/lib/advanced_billing/models/subscription_note_response.rb +17 -4
- data/lib/advanced_billing/models/subscription_preview.rb +21 -5
- data/lib/advanced_billing/models/subscription_preview_response.rb +18 -4
- data/lib/advanced_billing/models/subscription_product_change.rb +19 -5
- data/lib/advanced_billing/models/subscription_product_migration.rb +30 -7
- data/lib/advanced_billing/models/subscription_product_migration_request.rb +18 -4
- data/lib/advanced_billing/models/subscription_response.rb +18 -4
- data/lib/advanced_billing/models/subscription_state_change.rb +21 -5
- data/lib/advanced_billing/models/tax_configuration.rb +22 -6
- data/lib/advanced_billing/models/too_many_management_link_requests.rb +19 -5
- data/lib/advanced_billing/models/update_allocation_expiration_date.rb +18 -4
- data/lib/advanced_billing/models/update_component.rb +27 -7
- data/lib/advanced_billing/models/update_component_price_point.rb +26 -7
- data/lib/advanced_billing/models/update_component_price_point_request.rb +18 -4
- data/lib/advanced_billing/models/update_component_request.rb +18 -4
- data/lib/advanced_billing/models/update_coupon_currency.rb +19 -5
- data/lib/advanced_billing/models/update_currency_price.rb +20 -6
- data/lib/advanced_billing/models/update_currency_prices_request.rb +18 -4
- data/lib/advanced_billing/models/update_customer.rb +33 -7
- data/lib/advanced_billing/models/update_customer_request.rb +18 -4
- data/lib/advanced_billing/models/update_metadata.rb +20 -6
- data/lib/advanced_billing/models/update_metadata_request.rb +18 -4
- data/lib/advanced_billing/models/update_metafield.rb +23 -7
- data/lib/advanced_billing/models/update_metafields_request.rb +18 -4
- data/lib/advanced_billing/models/update_payment_profile.rb +30 -7
- data/lib/advanced_billing/models/update_payment_profile_request.rb +18 -4
- data/lib/advanced_billing/models/update_price.rb +23 -7
- data/lib/advanced_billing/models/update_product_price_point.rb +19 -5
- data/lib/advanced_billing/models/update_product_price_point_request.rb +18 -4
- data/lib/advanced_billing/models/update_reason_code.rb +20 -6
- data/lib/advanced_billing/models/update_reason_code_request.rb +18 -4
- data/lib/advanced_billing/models/update_segment.rb +19 -5
- data/lib/advanced_billing/models/update_segment_request.rb +17 -4
- data/lib/advanced_billing/models/update_subscription.rb +45 -8
- data/lib/advanced_billing/models/update_subscription_component.rb +19 -5
- data/lib/advanced_billing/models/update_subscription_group.rb +18 -4
- data/lib/advanced_billing/models/update_subscription_group_request.rb +18 -4
- data/lib/advanced_billing/models/update_subscription_note.rb +19 -5
- data/lib/advanced_billing/models/update_subscription_note_request.rb +17 -4
- data/lib/advanced_billing/models/update_subscription_request.rb +18 -4
- data/lib/advanced_billing/models/upsert_prepaid_configuration.rb +27 -7
- data/lib/advanced_billing/models/upsert_prepaid_configuration_request.rb +18 -4
- data/lib/advanced_billing/models/usage.rb +26 -7
- data/lib/advanced_billing/models/usage_response.rb +17 -4
- data/lib/advanced_billing/models/void_invoice.rb +17 -4
- data/lib/advanced_billing/models/void_invoice_event.rb +23 -7
- data/lib/advanced_billing/models/void_invoice_event_data.rb +25 -7
- data/lib/advanced_billing/models/void_invoice_request.rb +17 -4
- data/lib/advanced_billing/models/void_remainder_event.rb +23 -7
- data/lib/advanced_billing/models/void_remainder_event_data.rb +23 -7
- data/lib/advanced_billing/models/webhook.rb +29 -7
- data/lib/advanced_billing/models/webhook_response.rb +17 -4
- data/lib/advanced_billing/utilities/file_wrapper.rb +14 -2
- data/lib/advanced_billing/utilities/union_type_lookup.rb +12 -33
- data/lib/advanced_billing.rb +9 -11
- metadata +12 -14
- data/lib/advanced_billing/models/create_or_update_flat_amount_coupon.rb +0 -249
- data/lib/advanced_billing/models/create_or_update_percentage_coupon.rb +0 -250
- data/lib/advanced_billing/models/event_type.rb +0 -121
- data/lib/advanced_billing/models/prepaid_component_price_point.rb +0 -123
- data/lib/advanced_billing/models/subscription_group_member_error.rb +0 -78
- data/lib/advanced_billing/models/subscription_group_signup_failure.rb +0 -93
- data/lib/advanced_billing/models/subscription_group_signup_success_data.rb +0 -185
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 551586ad662e49e7a307d50d9a2392245b774d01363dc5d43c2642a8059bfdd7
|
4
|
+
data.tar.gz: 06f750ad290bd25a0335fe88e5537e56e89dc31e7d3b3e4d6ae44d55fc42645f
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: d8886d5e8cfc76389dd5fcec1093984ec2d4a0e826ee4c55c0d46cd92ee62d19c72ea87e2fc12c9115ee42fe7d17d1307c5a7d3309d52fe748bd70bf5c29c84c
|
7
|
+
data.tar.gz: bc55cb35c5e74108f1c257319585665158690efc67e501a9b12ea8ce4a0f5f7699e99d47ad5681219084ffee5bc3253ac7b019137033698a2b26ebdd61a9501b
|
data/LICENSE
CHANGED
@@ -3,7 +3,7 @@ License:
|
|
3
3
|
The MIT License (MIT)
|
4
4
|
http://opensource.org/licenses/MIT
|
5
5
|
|
6
|
-
Copyright (c) 2014 -
|
6
|
+
Copyright (c) 2014 - 2025 APIMATIC Limited
|
7
7
|
|
8
8
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
9
9
|
of this software and associated documentation files (the "Software"), to deal
|
data/README.md
CHANGED
@@ -29,29 +29,28 @@ curl -u <api_key>:x -H Accept:application/json -H Content-Type:application/json
|
|
29
29
|
|
30
30
|
Install the gem from the command line:
|
31
31
|
|
32
|
-
```
|
33
|
-
gem install maxio-advanced-billing-sdk -v
|
32
|
+
```bash
|
33
|
+
gem install maxio-advanced-billing-sdk -v 6.1.0
|
34
34
|
```
|
35
35
|
|
36
36
|
Or add the gem to your Gemfile and run `bundle`:
|
37
37
|
|
38
38
|
```ruby
|
39
|
-
gem 'maxio-advanced-billing-sdk', '
|
39
|
+
gem 'maxio-advanced-billing-sdk', '6.1.0'
|
40
40
|
```
|
41
41
|
|
42
|
-
For additional gem details, see the [RubyGems page for the maxio-advanced-billing-sdk gem](https://rubygems.org/gems/maxio-advanced-billing-sdk/versions/
|
42
|
+
For additional gem details, see the [RubyGems page for the maxio-advanced-billing-sdk gem](https://rubygems.org/gems/maxio-advanced-billing-sdk/versions/6.1.0).
|
43
43
|
|
44
44
|
## Initialize the API Client
|
45
45
|
|
46
|
-
**_Note:_** Documentation for the client can be found [here.](https://www.github.com/maxio-com/ab-ruby-sdk/tree/
|
46
|
+
**_Note:_** Documentation for the client can be found [here.](https://www.github.com/maxio-com/ab-ruby-sdk/tree/6.1.0/doc/client.md)
|
47
47
|
|
48
48
|
The following parameters are configurable for the API Client:
|
49
49
|
|
50
50
|
| Parameter | Type | Description |
|
51
51
|
| --- | --- | --- |
|
52
|
-
| `
|
53
|
-
| `
|
54
|
-
| `environment` | `Environment` | The API environment. <br> **Default: `Environment.PRODUCTION`** |
|
52
|
+
| `site` | `String` | The subdomain for your Advanced Billing site.<br>*Default*: `'subdomain'` |
|
53
|
+
| `environment` | `Environment` | The API environment. <br> **Default: `Environment.US`** |
|
55
54
|
| `connection` | `Faraday::Connection` | The Faraday connection object passed by the SDK user for making requests |
|
56
55
|
| `adapter` | `Faraday::Adapter` | The Faraday adapter object passed by the SDK user for performing http requests |
|
57
56
|
| `timeout` | `Float` | The value to use for connection timeout. <br> **Default: 120** |
|
@@ -61,7 +60,7 @@ The following parameters are configurable for the API Client:
|
|
61
60
|
| `retry_statuses` | `Array` | A list of HTTP statuses to retry. <br> **Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]** |
|
62
61
|
| `retry_methods` | `Array` | A list of HTTP methods to retry. <br> **Default: %i[get put]** |
|
63
62
|
| `http_callback` | `HttpCallBack` | The Http CallBack allows defining callables for pre and post API calls. |
|
64
|
-
| `basic_auth_credentials` | [`BasicAuthCredentials`](https://www.github.com/maxio-com/ab-ruby-sdk/tree/
|
63
|
+
| `basic_auth_credentials` | [`BasicAuthCredentials`](https://www.github.com/maxio-com/ab-ruby-sdk/tree/6.1.0/doc/auth/basic-authentication.md) | The credential object for Basic Authentication |
|
65
64
|
|
66
65
|
The API client can be initialized as follows:
|
67
66
|
|
@@ -71,9 +70,8 @@ client = AdvancedBilling::Client.new(
|
|
71
70
|
username: 'BasicAuthUserName',
|
72
71
|
password: 'BasicAuthPassword'
|
73
72
|
),
|
74
|
-
environment: Environment::
|
75
|
-
|
76
|
-
domain: 'chargify.com'
|
73
|
+
environment: Environment::US,
|
74
|
+
site: 'subdomain'
|
77
75
|
)
|
78
76
|
```
|
79
77
|
|
@@ -85,53 +83,53 @@ The SDK can be configured to use a different environment for making API calls. A
|
|
85
83
|
|
86
84
|
| Name | Description |
|
87
85
|
| --- | --- |
|
88
|
-
|
|
89
|
-
|
|
86
|
+
| US | **Default** Default Advanced Billing environment hosted in US. Valid for the majority of our customers. |
|
87
|
+
| EU | Advanced Billing environment hosted in EU. Use only when you requested EU hosting for your AB account. |
|
90
88
|
|
91
89
|
## Authorization
|
92
90
|
|
93
91
|
This API uses the following authentication schemes.
|
94
92
|
|
95
|
-
* [`BasicAuth (Basic Authentication)`](https://www.github.com/maxio-com/ab-ruby-sdk/tree/
|
93
|
+
* [`BasicAuth (Basic Authentication)`](https://www.github.com/maxio-com/ab-ruby-sdk/tree/6.1.0/doc/auth/basic-authentication.md)
|
96
94
|
|
97
95
|
## List of APIs
|
98
96
|
|
99
|
-
* [API Exports](https://www.github.com/maxio-com/ab-ruby-sdk/tree/
|
100
|
-
* [Advance Invoice](https://www.github.com/maxio-com/ab-ruby-sdk/tree/
|
101
|
-
* [Billing Portal](https://www.github.com/maxio-com/ab-ruby-sdk/tree/
|
102
|
-
* [Component Price Points](https://www.github.com/maxio-com/ab-ruby-sdk/tree/
|
103
|
-
* [Custom Fields](https://www.github.com/maxio-com/ab-ruby-sdk/tree/
|
104
|
-
* [Events-Based Billing Segments](https://www.github.com/maxio-com/ab-ruby-sdk/tree/
|
105
|
-
* [Payment Profiles](https://www.github.com/maxio-com/ab-ruby-sdk/tree/
|
106
|
-
* [Product Families](https://www.github.com/maxio-com/ab-ruby-sdk/tree/
|
107
|
-
* [Product Price Points](https://www.github.com/maxio-com/ab-ruby-sdk/tree/
|
108
|
-
* [Proforma Invoices](https://www.github.com/maxio-com/ab-ruby-sdk/tree/
|
109
|
-
* [Reason Codes](https://www.github.com/maxio-com/ab-ruby-sdk/tree/
|
110
|
-
* [Referral Codes](https://www.github.com/maxio-com/ab-ruby-sdk/tree/
|
111
|
-
* [Sales Commissions](https://www.github.com/maxio-com/ab-ruby-sdk/tree/
|
112
|
-
* [Subscription Components](https://www.github.com/maxio-com/ab-ruby-sdk/tree/
|
113
|
-
* [Subscription Groups](https://www.github.com/maxio-com/ab-ruby-sdk/tree/
|
114
|
-
* [Subscription Group Invoice Account](https://www.github.com/maxio-com/ab-ruby-sdk/tree/
|
115
|
-
* [Subscription Group Status](https://www.github.com/maxio-com/ab-ruby-sdk/tree/
|
116
|
-
* [Subscription Invoice Account](https://www.github.com/maxio-com/ab-ruby-sdk/tree/
|
117
|
-
* [Subscription Notes](https://www.github.com/maxio-com/ab-ruby-sdk/tree/
|
118
|
-
* [Subscription Products](https://www.github.com/maxio-com/ab-ruby-sdk/tree/
|
119
|
-
* [Subscription Status](https://www.github.com/maxio-com/ab-ruby-sdk/tree/
|
120
|
-
* [Coupons](https://www.github.com/maxio-com/ab-ruby-sdk/tree/
|
121
|
-
* [Components](https://www.github.com/maxio-com/ab-ruby-sdk/tree/
|
122
|
-
* [Customers](https://www.github.com/maxio-com/ab-ruby-sdk/tree/
|
123
|
-
* [Events](https://www.github.com/maxio-com/ab-ruby-sdk/tree/
|
124
|
-
* [Insights](https://www.github.com/maxio-com/ab-ruby-sdk/tree/
|
125
|
-
* [Invoices](https://www.github.com/maxio-com/ab-ruby-sdk/tree/
|
126
|
-
* [Offers](https://www.github.com/maxio-com/ab-ruby-sdk/tree/
|
127
|
-
* [Products](https://www.github.com/maxio-com/ab-ruby-sdk/tree/
|
128
|
-
* [Sites](https://www.github.com/maxio-com/ab-ruby-sdk/tree/
|
129
|
-
* [Subscriptions](https://www.github.com/maxio-com/ab-ruby-sdk/tree/
|
130
|
-
* [Webhooks](https://www.github.com/maxio-com/ab-ruby-sdk/tree/
|
97
|
+
* [API Exports](https://www.github.com/maxio-com/ab-ruby-sdk/tree/6.1.0/doc/controllers/api-exports.md)
|
98
|
+
* [Advance Invoice](https://www.github.com/maxio-com/ab-ruby-sdk/tree/6.1.0/doc/controllers/advance-invoice.md)
|
99
|
+
* [Billing Portal](https://www.github.com/maxio-com/ab-ruby-sdk/tree/6.1.0/doc/controllers/billing-portal.md)
|
100
|
+
* [Component Price Points](https://www.github.com/maxio-com/ab-ruby-sdk/tree/6.1.0/doc/controllers/component-price-points.md)
|
101
|
+
* [Custom Fields](https://www.github.com/maxio-com/ab-ruby-sdk/tree/6.1.0/doc/controllers/custom-fields.md)
|
102
|
+
* [Events-Based Billing Segments](https://www.github.com/maxio-com/ab-ruby-sdk/tree/6.1.0/doc/controllers/events-based-billing-segments.md)
|
103
|
+
* [Payment Profiles](https://www.github.com/maxio-com/ab-ruby-sdk/tree/6.1.0/doc/controllers/payment-profiles.md)
|
104
|
+
* [Product Families](https://www.github.com/maxio-com/ab-ruby-sdk/tree/6.1.0/doc/controllers/product-families.md)
|
105
|
+
* [Product Price Points](https://www.github.com/maxio-com/ab-ruby-sdk/tree/6.1.0/doc/controllers/product-price-points.md)
|
106
|
+
* [Proforma Invoices](https://www.github.com/maxio-com/ab-ruby-sdk/tree/6.1.0/doc/controllers/proforma-invoices.md)
|
107
|
+
* [Reason Codes](https://www.github.com/maxio-com/ab-ruby-sdk/tree/6.1.0/doc/controllers/reason-codes.md)
|
108
|
+
* [Referral Codes](https://www.github.com/maxio-com/ab-ruby-sdk/tree/6.1.0/doc/controllers/referral-codes.md)
|
109
|
+
* [Sales Commissions](https://www.github.com/maxio-com/ab-ruby-sdk/tree/6.1.0/doc/controllers/sales-commissions.md)
|
110
|
+
* [Subscription Components](https://www.github.com/maxio-com/ab-ruby-sdk/tree/6.1.0/doc/controllers/subscription-components.md)
|
111
|
+
* [Subscription Groups](https://www.github.com/maxio-com/ab-ruby-sdk/tree/6.1.0/doc/controllers/subscription-groups.md)
|
112
|
+
* [Subscription Group Invoice Account](https://www.github.com/maxio-com/ab-ruby-sdk/tree/6.1.0/doc/controllers/subscription-group-invoice-account.md)
|
113
|
+
* [Subscription Group Status](https://www.github.com/maxio-com/ab-ruby-sdk/tree/6.1.0/doc/controllers/subscription-group-status.md)
|
114
|
+
* [Subscription Invoice Account](https://www.github.com/maxio-com/ab-ruby-sdk/tree/6.1.0/doc/controllers/subscription-invoice-account.md)
|
115
|
+
* [Subscription Notes](https://www.github.com/maxio-com/ab-ruby-sdk/tree/6.1.0/doc/controllers/subscription-notes.md)
|
116
|
+
* [Subscription Products](https://www.github.com/maxio-com/ab-ruby-sdk/tree/6.1.0/doc/controllers/subscription-products.md)
|
117
|
+
* [Subscription Status](https://www.github.com/maxio-com/ab-ruby-sdk/tree/6.1.0/doc/controllers/subscription-status.md)
|
118
|
+
* [Coupons](https://www.github.com/maxio-com/ab-ruby-sdk/tree/6.1.0/doc/controllers/coupons.md)
|
119
|
+
* [Components](https://www.github.com/maxio-com/ab-ruby-sdk/tree/6.1.0/doc/controllers/components.md)
|
120
|
+
* [Customers](https://www.github.com/maxio-com/ab-ruby-sdk/tree/6.1.0/doc/controllers/customers.md)
|
121
|
+
* [Events](https://www.github.com/maxio-com/ab-ruby-sdk/tree/6.1.0/doc/controllers/events.md)
|
122
|
+
* [Insights](https://www.github.com/maxio-com/ab-ruby-sdk/tree/6.1.0/doc/controllers/insights.md)
|
123
|
+
* [Invoices](https://www.github.com/maxio-com/ab-ruby-sdk/tree/6.1.0/doc/controllers/invoices.md)
|
124
|
+
* [Offers](https://www.github.com/maxio-com/ab-ruby-sdk/tree/6.1.0/doc/controllers/offers.md)
|
125
|
+
* [Products](https://www.github.com/maxio-com/ab-ruby-sdk/tree/6.1.0/doc/controllers/products.md)
|
126
|
+
* [Sites](https://www.github.com/maxio-com/ab-ruby-sdk/tree/6.1.0/doc/controllers/sites.md)
|
127
|
+
* [Subscriptions](https://www.github.com/maxio-com/ab-ruby-sdk/tree/6.1.0/doc/controllers/subscriptions.md)
|
128
|
+
* [Webhooks](https://www.github.com/maxio-com/ab-ruby-sdk/tree/6.1.0/doc/controllers/webhooks.md)
|
131
129
|
|
132
130
|
## Classes Documentation
|
133
131
|
|
134
|
-
* [Utility Classes](https://www.github.com/maxio-com/ab-ruby-sdk/tree/
|
135
|
-
* [HttpResponse](https://www.github.com/maxio-com/ab-ruby-sdk/tree/
|
136
|
-
* [HttpRequest](https://www.github.com/maxio-com/ab-ruby-sdk/tree/
|
132
|
+
* [Utility Classes](https://www.github.com/maxio-com/ab-ruby-sdk/tree/6.1.0/doc/utility-classes.md)
|
133
|
+
* [HttpResponse](https://www.github.com/maxio-com/ab-ruby-sdk/tree/6.1.0/doc/http-response.md)
|
134
|
+
* [HttpRequest](https://www.github.com/maxio-com/ab-ruby-sdk/tree/6.1.0/doc/http-request.md)
|
137
135
|
|
@@ -206,8 +206,8 @@ module AdvancedBilling
|
|
206
206
|
max_retries: 0, retry_interval: 1, backoff_factor: 2,
|
207
207
|
retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
|
208
208
|
retry_methods: %i[get put], http_callback: nil,
|
209
|
-
environment: Environment::
|
210
|
-
|
209
|
+
environment: Environment::US, site: 'subdomain',
|
210
|
+
basic_auth_credentials: nil, config: nil
|
211
211
|
)
|
212
212
|
@config = if config.nil?
|
213
213
|
Configuration.new(
|
@@ -216,8 +216,7 @@ module AdvancedBilling
|
|
216
216
|
backoff_factor: backoff_factor,
|
217
217
|
retry_statuses: retry_statuses,
|
218
218
|
retry_methods: retry_methods, http_callback: http_callback,
|
219
|
-
environment: environment,
|
220
|
-
domain: domain,
|
219
|
+
environment: environment, site: site,
|
221
220
|
basic_auth_credentials: basic_auth_credentials
|
222
221
|
)
|
223
222
|
else
|
@@ -6,18 +6,19 @@
|
|
6
6
|
module AdvancedBilling
|
7
7
|
# An enum for SDK environments.
|
8
8
|
class Environment
|
9
|
-
#
|
10
|
-
#
|
9
|
+
# US: Default Advanced Billing environment hosted in US. Valid for the majority of our customers.
|
10
|
+
# EU: Advanced Billing environment hosted in EU. Use only when you requested EU hosting for your AB account.
|
11
11
|
ENVIRONMENT = [
|
12
|
-
|
13
|
-
|
12
|
+
US = 'US'.freeze,
|
13
|
+
EU = 'EU'.freeze
|
14
14
|
].freeze
|
15
15
|
end
|
16
16
|
|
17
17
|
# An enum for API servers.
|
18
18
|
class Server
|
19
19
|
SERVER = [
|
20
|
-
|
20
|
+
PRODUCTION = 'production'.freeze,
|
21
|
+
EBB = 'ebb'.freeze
|
21
22
|
].freeze
|
22
23
|
end
|
23
24
|
|
@@ -25,7 +26,7 @@ module AdvancedBilling
|
|
25
26
|
# are configured in this class.
|
26
27
|
class Configuration < CoreLibrary::HttpClientConfiguration
|
27
28
|
# The attribute readers for properties.
|
28
|
-
attr_reader :environment, :
|
29
|
+
attr_reader :environment, :site, :basic_auth_credentials
|
29
30
|
|
30
31
|
class << self
|
31
32
|
attr_reader :environments
|
@@ -36,8 +37,8 @@ module AdvancedBilling
|
|
36
37
|
max_retries: 0, retry_interval: 1, backoff_factor: 2,
|
37
38
|
retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
|
38
39
|
retry_methods: %i[get put], http_callback: nil,
|
39
|
-
environment: Environment::
|
40
|
-
|
40
|
+
environment: Environment::US, site: 'subdomain',
|
41
|
+
basic_auth_credentials: nil
|
41
42
|
)
|
42
43
|
|
43
44
|
super connection: connection, adapter: adapter, timeout: timeout,
|
@@ -49,10 +50,7 @@ module AdvancedBilling
|
|
49
50
|
@environment = String(environment)
|
50
51
|
|
51
52
|
# The subdomain for your Advanced Billing site.
|
52
|
-
@
|
53
|
-
|
54
|
-
# The Advanced Billing server domain.
|
55
|
-
@domain = domain
|
53
|
+
@site = site
|
56
54
|
|
57
55
|
# The object holding Basic Authentication credentials
|
58
56
|
@basic_auth_credentials = basic_auth_credentials
|
@@ -67,8 +65,7 @@ module AdvancedBilling
|
|
67
65
|
def clone_with(connection: nil, adapter: nil, timeout: nil,
|
68
66
|
max_retries: nil, retry_interval: nil, backoff_factor: nil,
|
69
67
|
retry_statuses: nil, retry_methods: nil, http_callback: nil,
|
70
|
-
environment: nil,
|
71
|
-
basic_auth_credentials: nil)
|
68
|
+
environment: nil, site: nil, basic_auth_credentials: nil)
|
72
69
|
connection ||= self.connection
|
73
70
|
adapter ||= self.adapter
|
74
71
|
timeout ||= self.timeout
|
@@ -79,8 +76,7 @@ module AdvancedBilling
|
|
79
76
|
retry_methods ||= self.retry_methods
|
80
77
|
http_callback ||= self.http_callback
|
81
78
|
environment ||= self.environment
|
82
|
-
|
83
|
-
domain ||= self.domain
|
79
|
+
site ||= self.site
|
84
80
|
basic_auth_credentials ||= basic_auth_credentials
|
85
81
|
|
86
82
|
Configuration.new(connection: connection, adapter: adapter,
|
@@ -90,18 +86,20 @@ module AdvancedBilling
|
|
90
86
|
retry_statuses: retry_statuses,
|
91
87
|
retry_methods: retry_methods,
|
92
88
|
http_callback: http_callback, environment: environment,
|
93
|
-
|
89
|
+
site: site,
|
94
90
|
basic_auth_credentials: basic_auth_credentials)
|
95
91
|
end
|
96
92
|
|
97
93
|
|
98
94
|
# All the environments the SDK can run in.
|
99
95
|
ENVIRONMENTS = {
|
100
|
-
Environment::
|
101
|
-
Server::
|
96
|
+
Environment::US => {
|
97
|
+
Server::PRODUCTION => 'https://{site}.chargify.com',
|
98
|
+
Server::EBB => 'https://events.chargify.com/{site}'
|
102
99
|
},
|
103
|
-
Environment::
|
104
|
-
Server::
|
100
|
+
Environment::EU => {
|
101
|
+
Server::PRODUCTION => 'https://{site}.ebilling.maxio.com',
|
102
|
+
Server::EBB => 'https://events.chargify.com/{site}'
|
105
103
|
}
|
106
104
|
}.freeze
|
107
105
|
|
@@ -109,10 +107,9 @@ module AdvancedBilling
|
|
109
107
|
# @param [Configuration::Server] server The server enum for which the base URI is
|
110
108
|
# required.
|
111
109
|
# @return [String] The base URI.
|
112
|
-
def get_base_uri(server = Server::
|
110
|
+
def get_base_uri(server = Server::PRODUCTION)
|
113
111
|
parameters = {
|
114
|
-
'
|
115
|
-
'domain' => { 'value' => domain, 'encode' => false }
|
112
|
+
'site' => { 'value' => site, 'encode' => false }
|
116
113
|
}
|
117
114
|
APIHelper.append_url_with_template_parameters(
|
118
115
|
ENVIRONMENTS[environment][server], parameters
|
@@ -32,7 +32,7 @@ module AdvancedBilling
|
|
32
32
|
new_api_call_builder
|
33
33
|
.request(new_request_builder(HttpMethodEnum::POST,
|
34
34
|
'/subscriptions/{subscription_id}/advance_invoice/issue.json',
|
35
|
-
Server::
|
35
|
+
Server::PRODUCTION)
|
36
36
|
.template_param(new_parameter(subscription_id, key: 'subscription_id')
|
37
37
|
.is_required(true)
|
38
38
|
.should_encode(true))
|
@@ -64,7 +64,7 @@ module AdvancedBilling
|
|
64
64
|
new_api_call_builder
|
65
65
|
.request(new_request_builder(HttpMethodEnum::GET,
|
66
66
|
'/subscriptions/{subscription_id}/advance_invoice.json',
|
67
|
-
Server::
|
67
|
+
Server::PRODUCTION)
|
68
68
|
.template_param(new_parameter(subscription_id, key: 'subscription_id')
|
69
69
|
.is_required(true)
|
70
70
|
.should_encode(true))
|
@@ -94,7 +94,7 @@ module AdvancedBilling
|
|
94
94
|
new_api_call_builder
|
95
95
|
.request(new_request_builder(HttpMethodEnum::POST,
|
96
96
|
'/subscriptions/{subscription_id}/advance_invoice/void.json',
|
97
|
-
Server::
|
97
|
+
Server::PRODUCTION)
|
98
98
|
.template_param(new_parameter(subscription_id, key: 'subscription_id')
|
99
99
|
.is_required(true)
|
100
100
|
.should_encode(true))
|
@@ -29,7 +29,7 @@ module AdvancedBilling
|
|
29
29
|
new_api_call_builder
|
30
30
|
.request(new_request_builder(HttpMethodEnum::GET,
|
31
31
|
'/api_exports/proforma_invoices/{batch_id}/rows.json',
|
32
|
-
Server::
|
32
|
+
Server::PRODUCTION)
|
33
33
|
.template_param(new_parameter(options['batch_id'], key: 'batch_id')
|
34
34
|
.is_required(true)
|
35
35
|
.should_encode(true))
|
@@ -70,7 +70,7 @@ module AdvancedBilling
|
|
70
70
|
new_api_call_builder
|
71
71
|
.request(new_request_builder(HttpMethodEnum::GET,
|
72
72
|
'/api_exports/invoices/{batch_id}/rows.json',
|
73
|
-
Server::
|
73
|
+
Server::PRODUCTION)
|
74
74
|
.template_param(new_parameter(options['batch_id'], key: 'batch_id')
|
75
75
|
.is_required(true)
|
76
76
|
.should_encode(true))
|
@@ -111,7 +111,7 @@ module AdvancedBilling
|
|
111
111
|
new_api_call_builder
|
112
112
|
.request(new_request_builder(HttpMethodEnum::GET,
|
113
113
|
'/api_exports/subscriptions/{batch_id}/rows.json',
|
114
|
-
Server::
|
114
|
+
Server::PRODUCTION)
|
115
115
|
.template_param(new_parameter(options['batch_id'], key: 'batch_id')
|
116
116
|
.is_required(true)
|
117
117
|
.should_encode(true))
|
@@ -136,7 +136,7 @@ module AdvancedBilling
|
|
136
136
|
new_api_call_builder
|
137
137
|
.request(new_request_builder(HttpMethodEnum::POST,
|
138
138
|
'/api_exports/proforma_invoices.json',
|
139
|
-
Server::
|
139
|
+
Server::PRODUCTION)
|
140
140
|
.header_param(new_parameter('application/json', key: 'accept'))
|
141
141
|
.auth(Single.new('BasicAuth')))
|
142
142
|
.response(new_response_handler
|
@@ -158,7 +158,7 @@ module AdvancedBilling
|
|
158
158
|
new_api_call_builder
|
159
159
|
.request(new_request_builder(HttpMethodEnum::POST,
|
160
160
|
'/api_exports/invoices.json',
|
161
|
-
Server::
|
161
|
+
Server::PRODUCTION)
|
162
162
|
.header_param(new_parameter('application/json', key: 'accept'))
|
163
163
|
.auth(Single.new('BasicAuth')))
|
164
164
|
.response(new_response_handler
|
@@ -180,7 +180,7 @@ module AdvancedBilling
|
|
180
180
|
new_api_call_builder
|
181
181
|
.request(new_request_builder(HttpMethodEnum::POST,
|
182
182
|
'/api_exports/subscriptions.json',
|
183
|
-
Server::
|
183
|
+
Server::PRODUCTION)
|
184
184
|
.header_param(new_parameter('application/json', key: 'accept'))
|
185
185
|
.auth(Single.new('BasicAuth')))
|
186
186
|
.response(new_response_handler
|
@@ -200,7 +200,7 @@ module AdvancedBilling
|
|
200
200
|
new_api_call_builder
|
201
201
|
.request(new_request_builder(HttpMethodEnum::GET,
|
202
202
|
'/api_exports/proforma_invoices/{batch_id}.json',
|
203
|
-
Server::
|
203
|
+
Server::PRODUCTION)
|
204
204
|
.template_param(new_parameter(batch_id, key: 'batch_id')
|
205
205
|
.is_required(true)
|
206
206
|
.should_encode(true))
|
@@ -222,7 +222,7 @@ module AdvancedBilling
|
|
222
222
|
new_api_call_builder
|
223
223
|
.request(new_request_builder(HttpMethodEnum::GET,
|
224
224
|
'/api_exports/invoices/{batch_id}.json',
|
225
|
-
Server::
|
225
|
+
Server::PRODUCTION)
|
226
226
|
.template_param(new_parameter(batch_id, key: 'batch_id')
|
227
227
|
.is_required(true)
|
228
228
|
.should_encode(true))
|
@@ -244,7 +244,7 @@ module AdvancedBilling
|
|
244
244
|
new_api_call_builder
|
245
245
|
.request(new_request_builder(HttpMethodEnum::GET,
|
246
246
|
'/api_exports/subscriptions/{batch_id}.json',
|
247
|
-
Server::
|
247
|
+
Server::PRODUCTION)
|
248
248
|
.template_param(new_parameter(batch_id, key: 'batch_id')
|
249
249
|
.is_required(true)
|
250
250
|
.should_encode(true))
|
@@ -43,7 +43,7 @@ module AdvancedBilling
|
|
43
43
|
new_api_call_builder
|
44
44
|
.request(new_request_builder(HttpMethodEnum::POST,
|
45
45
|
'/portal/customers/{customer_id}/enable.json',
|
46
|
-
Server::
|
46
|
+
Server::PRODUCTION)
|
47
47
|
.template_param(new_parameter(customer_id, key: 'customer_id')
|
48
48
|
.is_required(true)
|
49
49
|
.should_encode(true))
|
@@ -79,7 +79,7 @@ module AdvancedBilling
|
|
79
79
|
new_api_call_builder
|
80
80
|
.request(new_request_builder(HttpMethodEnum::GET,
|
81
81
|
'/portal/customers/{customer_id}/management_link.json',
|
82
|
-
Server::
|
82
|
+
Server::PRODUCTION)
|
83
83
|
.template_param(new_parameter(customer_id, key: 'customer_id')
|
84
84
|
.is_required(true)
|
85
85
|
.should_encode(true))
|
@@ -117,7 +117,7 @@ module AdvancedBilling
|
|
117
117
|
new_api_call_builder
|
118
118
|
.request(new_request_builder(HttpMethodEnum::POST,
|
119
119
|
'/portal/customers/{customer_id}/invitations/invite.json',
|
120
|
-
Server::
|
120
|
+
Server::PRODUCTION)
|
121
121
|
.template_param(new_parameter(customer_id, key: 'customer_id')
|
122
122
|
.is_required(true)
|
123
123
|
.should_encode(true))
|
@@ -148,7 +148,7 @@ module AdvancedBilling
|
|
148
148
|
new_api_call_builder
|
149
149
|
.request(new_request_builder(HttpMethodEnum::DELETE,
|
150
150
|
'/portal/customers/{customer_id}/invitations/revoke.json',
|
151
|
-
Server::
|
151
|
+
Server::PRODUCTION)
|
152
152
|
.template_param(new_parameter(customer_id, key: 'customer_id')
|
153
153
|
.is_required(true)
|
154
154
|
.should_encode(true))
|