schematichq 1.5.4 → 1.5.6

data/lib/schematic/types/flag_response_data.rb

@@ -5,7 +5,7 @@ module Schematic
     class FlagResponseData < Internal::Types::Model
       field :created_at, -> { String }, optional: false, nullable: false
 
-      field :default_value, -> { Internal::Types::Boolean }, optional: false, nullable: false
+      field :default_value, -> { Internal::Types::Boolean }, optional: true, nullable: false
 
       field :description, -> { String }, optional: false, nullable: false
 

data/lib/schematic/types/invoice_collection_state.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Schematic
+  module Types
+    module InvoiceCollectionState
+      extend Schematic::Internal::Types::Enum
+
+      EXPORTED = "exported"
+      PAID = "paid"
+      PARTIALLY_PAID = "partially_paid"
+      PAST_DUE = "past_due"
+      PAYMENT_FAILED = "payment_failed"
+      QUEUED = "queued"
+      SENT = "sent"
+    end
+  end
+end

data/lib/schematic/types/invoice_document_state.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Schematic
+  module Types
+    module InvoiceDocumentState
+      extend Schematic::Internal::Types::Enum
+
+      CREDITED = "credited"
+      DRAFT = "draft"
+      FINALIZED = "finalized"
+      VOID = "void"
+    end
+  end
+end

data/lib/schematic/types/invoice_line_kind.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Schematic
+  module Types
+    module InvoiceLineKind
+      extend Schematic::Internal::Types::Enum
+
+      ADJUSTMENT = "adjustment"
+      PURCHASE = "purchase"
+      RECONCILIATION = "reconciliation"
+      SUBSCRIPTION = "subscription"
+      TRUE_UP = "true_up"
+    end
+  end
+end

data/lib/schematic/types/line_kind.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Schematic
+  module Types
+    module LineKind
+      extend Schematic::Internal::Types::Enum
+
+      ALLOWANCE = "allowance"
+      CAPACITY = "capacity"
+      RATE = "rate"
+    end
+  end
+end

data/lib/schematic/types/payment_gating.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Schematic
+  module Types
+    module PaymentGating
+      extend Schematic::Internal::Types::Enum
+
+      KEEP_SERVING = "keep_serving"
+      REVOKE_AFTER = "revoke_after"
+    end
+  end
+end

data/lib/schematic/types/payment_method_billing_details_request_body.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Schematic
+  module Types
+    class PaymentMethodBillingDetailsRequestBody < Internal::Types::Model
+      field :address, -> { Schematic::Types::CustomerBillingAddress }, optional: true, nullable: false
+
+      field :email, -> { String }, optional: true, nullable: false
+
+      field :phone, -> { String }, optional: true, nullable: false
+    end
+  end
+end

data/lib/schematic/types/plan_credit_grant_warning_tier_request_body.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Schematic
+  module Types
+    class PlanCreditGrantWarningTierRequestBody < Internal::Types::Model
+      field :key, -> { String }, optional: false, nullable: false
+
+      field :value, -> { Integer }, optional: false, nullable: false
+    end
+  end
+end

data/lib/schematic/types/plan_version_migration_preview_company_response_data.rb

@@ -11,6 +11,8 @@ module Schematic
 
       field :note, -> { String }, optional: true, nullable: false
 
+      field :notes, -> { Internal::Types::Array[Schematic::Types::PlanVersionMigrationPreviewNoteResponseData] }, optional: false, nullable: false
+
       field :plan_version_id_from, -> { String }, optional: true, nullable: false
 
       field :will_update_subscription, -> { Internal::Types::Boolean }, optional: false, nullable: false

data/lib/schematic/types/plan_version_migration_preview_note_response_data.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Schematic
+  module Types
+    class PlanVersionMigrationPreviewNoteResponseData < Internal::Types::Model
+      field :blocking, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+      field :code, -> { Schematic::Types::MigrationErrorCode }, optional: true, nullable: false
+
+      field :message, -> { String }, optional: false, nullable: false
+    end
+  end
+end

data/lib/schematic/types/plan_version_response_data.rb

@@ -19,6 +19,8 @@ module Schematic
 
       field :plan_type, -> { Schematic::Types::PlanType }, optional: false, nullable: false
 
+      field :renewal_policy, -> { Schematic::Types::RenewalPolicy }, optional: false, nullable: false
+
       field :status, -> { Schematic::Types::PlanVersionStatus }, optional: false, nullable: false
 
       field :updated_at, -> { String }, optional: false, nullable: false

data/lib/schematic/types/preflight_event_quantities_request_body.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Schematic
+  module Types
+    class PreflightEventQuantitiesRequestBody < Internal::Types::Model
+      field :event_subtype, -> { String }, optional: false, nullable: false
+
+      field :quantities, -> { Internal::Types::Hash[String, Float] }, optional: true, nullable: false
+
+      field :quantity, -> { Float }, optional: true, nullable: false
+    end
+  end
+end

data/lib/schematic/types/preflight_request_body.rb

@@ -5,6 +5,8 @@ module Schematic
     class PreflightRequestBody < Internal::Types::Model
       field :credit_cost, -> { Internal::Types::Hash[String, Float] }, optional: true, nullable: false
 
+      field :event_quantities, -> { Schematic::Types::PreflightEventQuantitiesRequestBody }, optional: true, nullable: false
+
       field :event_usage, -> { Schematic::Types::PreflightEventUsageRequestBody }, optional: true, nullable: false
 
       field :usage, -> { Integer }, optional: true, nullable: false

data/lib/schematic/types/preview_subscription_finance_response_data.rb

@@ -7,6 +7,10 @@ module Schematic
 
       field :currency, -> { Schematic::Types::Currency }, optional: false, nullable: false
 
+      field :customer_balance_applied, -> { Integer }, optional: false, nullable: false
+
+      field :customer_balance_remaining, -> { Integer }, optional: false, nullable: false
+
       field :discount_amount, -> { Integer }, optional: false, nullable: false
 
       field :discounts, -> { Internal::Types::Array[Schematic::Types::PreviewSubscriptionDiscountResponseData] }, optional: false, nullable: false
@@ -27,6 +31,8 @@ module Schematic
 
       field :proration_billed_at, -> { String }, optional: true, nullable: false
 
+      field :proration_detail, -> { Schematic::Types::PreviewSubscriptionProrationResponseData }, optional: true, nullable: false
+
       field :tax_amount, -> { Integer }, optional: true, nullable: false
 
       field :tax_display_name, -> { String }, optional: true, nullable: false

data/lib/schematic/types/preview_subscription_proration_line_response_data.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Schematic
+  module Types
+    class PreviewSubscriptionProrationLineResponseData < Internal::Types::Model
+      field :amount, -> { Integer }, optional: false, nullable: false
+
+      field :kind, -> { Schematic::Types::ProrationLineKind }, optional: false, nullable: false
+
+      field :period_end, -> { String }, optional: true, nullable: false
+
+      field :period_start, -> { String }, optional: true, nullable: false
+
+      field :plan_id, -> { String }, optional: true, nullable: false
+
+      field :price_id, -> { String }, optional: true, nullable: false
+
+      field :quantity, -> { Integer }, optional: true, nullable: false
+    end
+  end
+end

data/lib/schematic/types/preview_subscription_proration_response_data.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Schematic
+  module Types
+    class PreviewSubscriptionProrationResponseData < Internal::Types::Model
+      field :billed_at, -> { String }, optional: true, nullable: false
+
+      field :charge, -> { Integer }, optional: false, nullable: false
+
+      field :credit, -> { Integer }, optional: false, nullable: false
+
+      field :currency, -> { Schematic::Types::Currency }, optional: false, nullable: false
+
+      field :lines, -> { Internal::Types::Array[Schematic::Types::PreviewSubscriptionProrationLineResponseData] }, optional: false, nullable: false
+
+      field :timing, -> { Schematic::Types::CheckoutChargeTiming }, optional: false, nullable: false
+
+      field :total, -> { Integer }, optional: false, nullable: false
+    end
+  end
+end

data/lib/schematic/types/proration_line_kind.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Schematic
+  module Types
+    module ProrationLineKind
+      extend Schematic::Internal::Types::Enum
+
+      CHARGE = "charge"
+      CREDIT = "credit"
+    end
+  end
+end

data/lib/schematic/types/public_catalog_response_data.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Schematic
+  module Types
+    class PublicCatalogResponseData < Internal::Types::Model
+      field :add_ons, -> { Internal::Types::Array[Schematic::Types::CatalogPlanResponseData] }, optional: false, nullable: false
+
+      field :capabilities, -> { Schematic::Types::CatalogCapabilitiesResponseData }, optional: false, nullable: false
+
+      field :credit_bundles, -> { Internal::Types::Array[Schematic::Types::CatalogCreditBundleResponseData] }, optional: false, nullable: false
+
+      field :custom_plan_cta, -> { Schematic::Types::CatalogCustomPlanCtaResponseData }, optional: true, nullable: false
+
+      field :default_currency, -> { Schematic::Types::Currency }, optional: false, nullable: false
+
+      field :description, -> { String }, optional: true, nullable: false
+
+      field :id, -> { String }, optional: false, nullable: false
+
+      field :name, -> { String }, optional: false, nullable: false
+
+      field :plans, -> { Internal::Types::Array[Schematic::Types::CatalogPlanResponseData] }, optional: false, nullable: false
+
+      field :pricing_model, -> { String }, optional: true, nullable: false
+
+      field :pricing_url, -> { String }, optional: true, nullable: false
+    end
+  end
+end

data/lib/schematic/types/publish_plan_version_request_body.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Schematic
+  module Types
+    class PublishPlanVersionRequestBody < Internal::Types::Model
+      field :activation_strategy, -> { Schematic::Types::CustomPlanActivationStrategy }, optional: true, nullable: false
+
+      field :address, -> { Schematic::Types::CustomerBillingAddress }, optional: true, nullable: false
+
+      field :billing_cycle_anchor, -> { String }, optional: true, nullable: false
+
+      field :billing_start_date, -> { String }, optional: true, nullable: false
+
+      field :collection_method, -> { Schematic::Types::BillingCollectionMethod }, optional: true, nullable: false
+
+      field :coupon_external_id, -> { String }, optional: true, nullable: false
+
+      field :custom_field_values, -> { Internal::Types::Array[Schematic::Types::CheckoutFieldValue] }, optional: true, nullable: false
+
+      field :customer_email, -> { String }, optional: true, nullable: false
+
+      field :days_until_due, -> { Integer }, optional: true, nullable: false
+
+      field :end_date, -> { String }, optional: true, nullable: false
+
+      field :excluded_company_ids, -> { Internal::Types::Array[String] }, optional: false, nullable: false
+
+      field :migration_strategy, -> { Schematic::Types::PlanVersionMigrationStrategy }, optional: false, nullable: false
+
+      field :phone, -> { String }, optional: true, nullable: false
+
+      field :prorate_first_period, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+      field :proration_behavior, -> { Schematic::Types::MigrationProrationBehavior }, optional: true, nullable: false
+
+      field :require_no_migration, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+      field :scheduled_at, -> { String }, optional: true, nullable: false
+
+      field :send_invoice, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+      field :tax_id, -> { Schematic::Types::TaxIdInput }, optional: true, nullable: false
+    end
+  end
+end

data/lib/schematic/types/publish_preview_pay_in_advance_response_data.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Schematic
+  module Types
+    class PublishPreviewPayInAdvanceResponseData < Internal::Types::Model
+      field :committed_quantity, -> { Integer }, optional: false, nullable: false
+
+      field :current_quantity, -> { Integer }, optional: true, nullable: false
+
+      field :effective_quantity, -> { Integer }, optional: false, nullable: false
+
+      field :feature_id, -> { String }, optional: false, nullable: false
+    end
+  end
+end

data/lib/schematic/types/publish_preview_payment_method_response_data.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Schematic
+  module Types
+    class PublishPreviewPaymentMethodResponseData < Internal::Types::Model
+      field :card_brand, -> { String }, optional: true, nullable: false
+
+      field :card_last_4, -> { String }, optional: true, nullable: false, api_name: "card_last4"
+
+      field :has_default, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+      field :payment_method_type, -> { String }, optional: true, nullable: false
+    end
+  end
+end

data/lib/schematic/types/publish_preview_proration_line_response_data.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Schematic
+  module Types
+    class PublishPreviewProrationLineResponseData < Internal::Types::Model
+      field :amount, -> { Integer }, optional: false, nullable: false
+
+      field :description, -> { String }, optional: false, nullable: false
+
+      field :period_end, -> { String }, optional: false, nullable: false
+
+      field :period_start, -> { String }, optional: false, nullable: false
+
+      field :price_external_id, -> { String }, optional: true, nullable: false
+
+      field :quantity, -> { Integer }, optional: false, nullable: false
+    end
+  end
+end

data/lib/schematic/types/publish_preview_response_data.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Schematic
+  module Types
+    class PublishPreviewResponseData < Internal::Types::Model
+      field :billing_email, -> { String }, optional: true, nullable: false
+
+      field :currency, -> { Schematic::Types::Currency }, optional: true, nullable: false
+
+      field :current_period_end, -> { String }, optional: true, nullable: false
+
+      field :current_period_start, -> { String }, optional: true, nullable: false
+
+      field :default_collection_method, -> { Schematic::Types::BillingCollectionMethod }, optional: false, nullable: false
+
+      field :default_days_until_due, -> { Integer }, optional: false, nullable: false
+
+      field :default_send_invoice, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+      field :effective_at, -> { String }, optional: true, nullable: false
+
+      field :ends_at, -> { String }, optional: true, nullable: false
+
+      field :has_billing_changes, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+      field :immediate_invoice_amount, -> { Integer }, optional: true, nullable: false
+
+      field :lands_on, -> { Schematic::Types::AmendmentProrationLandsOn }, optional: false, nullable: false
+
+      field :new_recurring_amount, -> { Integer }, optional: true, nullable: false
+
+      field :next_invoice_amount, -> { Integer }, optional: true, nullable: false
+
+      field :next_invoice_at, -> { String }, optional: true, nullable: false
+
+      field :note, -> { String }, optional: true, nullable: false
+
+      field :pay_in_advance, -> { Internal::Types::Array[Schematic::Types::PublishPreviewPayInAdvanceResponseData] }, optional: false, nullable: false
+
+      field :payment_method, -> { Schematic::Types::PublishPreviewPaymentMethodResponseData }, optional: false, nullable: false
+
+      field :proration_charge, -> { Integer }, optional: false, nullable: false
+
+      field :proration_credit, -> { Integer }, optional: false, nullable: false
+
+      field :proration_lines, -> { Internal::Types::Array[Schematic::Types::PublishPreviewProrationLineResponseData] }, optional: false, nullable: false
+
+      field :proration_total, -> { Integer }, optional: false, nullable: false
+
+      field :will_update_subscription, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+      field :would_fail, -> { Internal::Types::Boolean }, optional: false, nullable: false
+    end
+  end
+end

data/lib/schematic/types/renewal_policy.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Schematic
+  module Types
+    module RenewalPolicy
+      extend Schematic::Internal::Types::Enum
+
+      AUTO_RENEW = "auto_renew"
+      EXPIRE_TO_DEFAULT = "expire_to_default"
+      HOLD_WITH_GRACE = "hold_with_grace"
+    end
+  end
+end

data/lib/schematic/types/rulesengine_credit_spend_policy.rb

@@ -3,6 +3,8 @@
 module Schematic
   module Types
     class RulesengineCreditSpendPolicy < Internal::Types::Model
+      field :company_id, -> { String }, optional: true, nullable: false
+
       field :consumed, -> { Float }, optional: true, nullable: false
 
       field :credit_id, -> { String }, optional: false, nullable: false

data/lib/schematic/types/subscription_change_action.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Schematic
+  module Types
+    module SubscriptionChangeAction
+      extend Schematic::Internal::Types::Enum
+
+      ADD = "add"
+      CANCEL = "cancel"
+      REMOVE = "remove"
+      REPLACE = "replace"
+    end
+  end
+end

data/lib/schematic/types/update_billing_plan_credit_grant_request_body.rb

@@ -70,6 +70,8 @@ module Schematic
       field :unit_price, -> { Integer }, optional: true, nullable: false
 
       field :unit_price_decimal, -> { String }, optional: true, nullable: false
+
+      field :warning_tiers, -> { Internal::Types::Array[Schematic::Types::PlanCreditGrantWarningTierRequestBody] }, optional: true, nullable: false
     end
   end
 end

data/lib/schematic/types/webhook_request_type.rb

@@ -18,6 +18,7 @@ module Schematic
       CREDIT_LIMIT_REACHED = "credit.limit.reached"
       CREDIT_LIMIT_WARNING = "credit.limit.warning"
       CREDIT_PURCHASE_SUCCESS = "credit.purchase.success"
+      CREDIT_USAGE_WARNING_REACHED = "credit.usage_warning_reached"
       ENTITLEMENT_LIMIT_REACHED = "entitlement.limit.reached"
       ENTITLEMENT_LIMIT_WARNING = "entitlement.limit.warning"
       ENTITLEMENT_SOFT_LIMIT_REACHED = "entitlement.soft_limit.reached"

data/lib/schematic/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Schematic
-  VERSION = "1.5.4"
+  VERSION = "1.5.6"
 end