Class: Stigg::Models::V1::AddonUpdateParams::Charges::OveragePricingModel::PricePeriod
- Inherits:
-
Internal::Type::BaseModel
- Object
- Internal::Type::BaseModel
- Stigg::Models::V1::AddonUpdateParams::Charges::OveragePricingModel::PricePeriod
- Defined in:
- lib/stigg/models/v1/addon_update_params.rb,
sig/stigg/models/v1/addon_update_params.rbs
Defined Under Namespace
Modules: BillingPeriod, CreditGrantCadence Classes: CreditRate, Price, Tier
Instance Attribute Summary collapse
-
#billing_country_code ⇒ String?
ISO country code for localized pricing.
-
#billing_period ⇒ Symbol, Stigg::Models::V1::AddonUpdateParams::Charges::OveragePricingModel::PricePeriod::BillingPeriod
The billing period (MONTHLY or ANNUALLY).
-
#block_size ⇒ Float?
Block size for usage-based pricing.
-
#credit_grant_cadence ⇒ Symbol, ...
When credits are granted.
-
#credit_rate ⇒ Stigg::Models::V1::AddonUpdateParams::Charges::OveragePricingModel::PricePeriod::CreditRate?
Credit rate configuration for credit-based pricing.
-
#price ⇒ Stigg::Models::V1::AddonUpdateParams::Charges::OveragePricingModel::PricePeriod::Price?
The price amount and currency.
-
#tiers ⇒ Array<Stigg::Models::V1::AddonUpdateParams::Charges::OveragePricingModel::PricePeriod::Tier>?
Tiered pricing configuration.
Class Method Summary collapse
Instance Method Summary collapse
-
#initialize(amount:, currency_id:, cost_formula: nil) ⇒ Object
constructor
Credit rate configuration for credit-based pricing.
- #to_hash ⇒ {
Methods inherited from Internal::Type::BaseModel
==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml
Methods included from Internal::Type::Converter
#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info
Methods included from Internal::Util::SorbetRuntimeSupport
#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type
Constructor Details
#initialize(amount:, currency_id:, cost_formula: nil) ⇒ Object
Credit rate configuration for credit-based pricing
431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 |
# File 'lib/stigg/models/v1/addon_update_params.rb', line 431 class PricePeriod < Stigg::Internal::Type::BaseModel # @!attribute billing_period # The billing period (MONTHLY or ANNUALLY) # # @return [Symbol, Stigg::Models::V1::AddonUpdateParams::Charges::OveragePricingModel::PricePeriod::BillingPeriod] required :billing_period, enum: -> { Stigg::V1::AddonUpdateParams::Charges::OveragePricingModel::PricePeriod::BillingPeriod }, api_name: :billingPeriod # @!attribute billing_country_code # ISO country code for localized pricing # # @return [String, nil] optional :billing_country_code, String, api_name: :billingCountryCode # @!attribute block_size # Block size for usage-based pricing # # @return [Float, nil] optional :block_size, Float, api_name: :blockSize # @!attribute credit_grant_cadence # When credits are granted # # @return [Symbol, Stigg::Models::V1::AddonUpdateParams::Charges::OveragePricingModel::PricePeriod::CreditGrantCadence, nil] optional :credit_grant_cadence, enum: -> { Stigg::V1::AddonUpdateParams::Charges::OveragePricingModel::PricePeriod::CreditGrantCadence }, api_name: :creditGrantCadence # @!attribute credit_rate # Credit rate configuration for credit-based pricing # # @return [Stigg::Models::V1::AddonUpdateParams::Charges::OveragePricingModel::PricePeriod::CreditRate, nil] optional :credit_rate, -> { Stigg::V1::AddonUpdateParams::Charges::OveragePricingModel::PricePeriod::CreditRate }, api_name: :creditRate # @!attribute price # The price amount and currency # # @return [Stigg::Models::V1::AddonUpdateParams::Charges::OveragePricingModel::PricePeriod::Price, nil] optional :price, -> { Stigg::V1::AddonUpdateParams::Charges::OveragePricingModel::PricePeriod::Price } # @!attribute tiers # Tiered pricing configuration # # @return [Array<Stigg::Models::V1::AddonUpdateParams::Charges::OveragePricingModel::PricePeriod::Tier>, nil] optional :tiers, -> { Stigg::Internal::Type::ArrayOf[Stigg::V1::AddonUpdateParams::Charges::OveragePricingModel::PricePeriod::Tier] } # @!method initialize(billing_period:, billing_country_code: nil, block_size: nil, credit_grant_cadence: nil, credit_rate: nil, price: nil, tiers: nil) # Price configuration for a specific billing period. # # @param billing_period [Symbol, Stigg::Models::V1::AddonUpdateParams::Charges::OveragePricingModel::PricePeriod::BillingPeriod] The billing period (MONTHLY or ANNUALLY) # # @param billing_country_code [String] ISO country code for localized pricing # # @param block_size [Float] Block size for usage-based pricing # # @param credit_grant_cadence [Symbol, Stigg::Models::V1::AddonUpdateParams::Charges::OveragePricingModel::PricePeriod::CreditGrantCadence] When credits are granted # # @param credit_rate [Stigg::Models::V1::AddonUpdateParams::Charges::OveragePricingModel::PricePeriod::CreditRate] Credit rate configuration for credit-based pricing # # @param price [Stigg::Models::V1::AddonUpdateParams::Charges::OveragePricingModel::PricePeriod::Price] The price amount and currency # # @param tiers [Array<Stigg::Models::V1::AddonUpdateParams::Charges::OveragePricingModel::PricePeriod::Tier>] Tiered pricing configuration # The billing period (MONTHLY or ANNUALLY) # # @see Stigg::Models::V1::AddonUpdateParams::Charges::OveragePricingModel::PricePeriod#billing_period module BillingPeriod extend Stigg::Internal::Type::Enum MONTHLY = :MONTHLY ANNUALLY = :ANNUALLY # @!method self.values # @return [Array<Symbol>] end # When credits are granted # # @see Stigg::Models::V1::AddonUpdateParams::Charges::OveragePricingModel::PricePeriod#credit_grant_cadence module CreditGrantCadence extend Stigg::Internal::Type::Enum BEGINNING_OF_BILLING_PERIOD = :BEGINNING_OF_BILLING_PERIOD MONTHLY = :MONTHLY # @!method self.values # @return [Array<Symbol>] end # @see Stigg::Models::V1::AddonUpdateParams::Charges::OveragePricingModel::PricePeriod#credit_rate class CreditRate < Stigg::Internal::Type::BaseModel # @!attribute amount # The credit rate amount # # @return [Float] required :amount, Float # @!attribute currency_id # The custom currency ID # # @return [String] required :currency_id, String, api_name: :currencyId # @!attribute cost_formula # Optional cost formula expression # # @return [String, nil] optional :cost_formula, String, api_name: :costFormula # @!method initialize(amount:, currency_id:, cost_formula: nil) # Credit rate configuration for credit-based pricing # # @param amount [Float] The credit rate amount # # @param currency_id [String] The custom currency ID # # @param cost_formula [String] Optional cost formula expression end # @see Stigg::Models::V1::AddonUpdateParams::Charges::OveragePricingModel::PricePeriod#price class Price < Stigg::Internal::Type::BaseModel # @!attribute amount # The price amount # # @return [Float] required :amount, Float # @!attribute currency # The price currency # # @return [Symbol, Stigg::Models::V1::AddonUpdateParams::Charges::OveragePricingModel::PricePeriod::Price::Currency, nil] optional :currency, enum: -> { Stigg::V1::AddonUpdateParams::Charges::OveragePricingModel::PricePeriod::Price::Currency } # @!method initialize(amount:, currency: nil) # The price amount and currency # # @param amount [Float] The price amount # # @param currency [Symbol, Stigg::Models::V1::AddonUpdateParams::Charges::OveragePricingModel::PricePeriod::Price::Currency] The price currency # The price currency # # @see Stigg::Models::V1::AddonUpdateParams::Charges::OveragePricingModel::PricePeriod::Price#currency module Currency extend Stigg::Internal::Type::Enum USD = :usd AED = :aed ALL = :all AMD = :amd ANG = :ang AUD = :aud AWG = :awg AZN = :azn BAM = :bam BBD = :bbd BDT = :bdt BGN = :bgn BIF = :bif BMD = :bmd BND = :bnd BSD = :bsd BWP = :bwp BYN = :byn BZD = :bzd BRL = :brl CAD = :cad CDF = :cdf CHF = :chf CNY = :cny CZK = :czk DKK = :dkk DOP = :dop DZD = :dzd EGP = :egp ETB = :etb EUR = :eur FJD = :fjd GBP = :gbp GEL = :gel GIP = :gip GMD = :gmd GYD = :gyd HKD = :hkd HRK = :hrk HTG = :htg IDR = :idr ILS = :ils INR = :inr ISK = :isk JMD = :jmd JPY = :jpy KES = :kes KGS = :kgs KHR = :khr KMF = :kmf KRW = :krw KYD = :kyd KZT = :kzt LBP = :lbp LKR = :lkr LRD = :lrd LSL = :lsl MAD = :mad MDL = :mdl MGA = :mga MKD = :mkd MMK = :mmk MNT = :mnt MOP = :mop MRO = :mro MVR = :mvr MWK = :mwk MXN = :mxn MYR = :myr MZN = :mzn NAD = :nad NGN = :ngn NOK = :nok NPR = :npr NZD = :nzd PGK = :pgk PHP = :php PKR = :pkr PLN = :pln QAR = :qar RON = :ron RSD = :rsd RUB = :rub RWF = :rwf SAR = :sar SBD = :sbd SCR = :scr SEK = :sek SGD = :sgd SLE = :sle SLL = :sll SOS = :sos SZL = :szl THB = :thb TJS = :tjs TOP = :top TRY = :try TTD = :ttd TZS = :tzs UAH = :uah UZS = :uzs VND = :vnd VUV = :vuv WST = :wst XAF = :xaf XCD = :xcd YER = :yer ZAR = :zar ZMW = :zmw CLP = :clp DJF = :djf GNF = :gnf UGX = :ugx PYG = :pyg XOF = :xof XPF = :xpf # @!method self.values # @return [Array<Symbol>] end end class Tier < Stigg::Internal::Type::BaseModel # @!attribute flat_price # Flat price for this tier # # @return [Stigg::Models::V1::AddonUpdateParams::Charges::OveragePricingModel::PricePeriod::Tier::FlatPrice, nil] optional :flat_price, -> { Stigg::V1::AddonUpdateParams::Charges::OveragePricingModel::PricePeriod::Tier::FlatPrice }, api_name: :flatPrice # @!attribute unit_price # Per-unit price in this tier # # @return [Stigg::Models::V1::AddonUpdateParams::Charges::OveragePricingModel::PricePeriod::Tier::UnitPrice, nil] optional :unit_price, -> { Stigg::V1::AddonUpdateParams::Charges::OveragePricingModel::PricePeriod::Tier::UnitPrice }, api_name: :unitPrice # @!attribute up_to # Upper bound of this tier (null for unlimited) # # @return [Float, nil] optional :up_to, Float, api_name: :upTo # @!method initialize(flat_price: nil, unit_price: nil, up_to: nil) # A tier in tiered pricing. # # @param flat_price [Stigg::Models::V1::AddonUpdateParams::Charges::OveragePricingModel::PricePeriod::Tier::FlatPrice] Flat price for this tier # # @param unit_price [Stigg::Models::V1::AddonUpdateParams::Charges::OveragePricingModel::PricePeriod::Tier::UnitPrice] Per-unit price in this tier # # @param up_to [Float] Upper bound of this tier (null for unlimited) # @see Stigg::Models::V1::AddonUpdateParams::Charges::OveragePricingModel::PricePeriod::Tier#flat_price class FlatPrice < Stigg::Internal::Type::BaseModel # @!attribute amount # The price amount # # @return [Float] required :amount, Float # @!attribute currency # The price currency # # @return [Symbol, Stigg::Models::V1::AddonUpdateParams::Charges::OveragePricingModel::PricePeriod::Tier::FlatPrice::Currency, nil] optional :currency, enum: -> { Stigg::V1::AddonUpdateParams::Charges::OveragePricingModel::PricePeriod::Tier::FlatPrice::Currency } # @!method initialize(amount:, currency: nil) # Flat price for this tier # # @param amount [Float] The price amount # # @param currency [Symbol, Stigg::Models::V1::AddonUpdateParams::Charges::OveragePricingModel::PricePeriod::Tier::FlatPrice::Currency] The price currency # The price currency # # @see Stigg::Models::V1::AddonUpdateParams::Charges::OveragePricingModel::PricePeriod::Tier::FlatPrice#currency module Currency extend Stigg::Internal::Type::Enum USD = :usd AED = :aed ALL = :all AMD = :amd ANG = :ang AUD = :aud AWG = :awg AZN = :azn BAM = :bam BBD = :bbd BDT = :bdt BGN = :bgn BIF = :bif BMD = :bmd BND = :bnd BSD = :bsd BWP = :bwp BYN = :byn BZD = :bzd BRL = :brl CAD = :cad CDF = :cdf CHF = :chf CNY = :cny CZK = :czk DKK = :dkk DOP = :dop DZD = :dzd EGP = :egp ETB = :etb EUR = :eur FJD = :fjd GBP = :gbp GEL = :gel GIP = :gip GMD = :gmd GYD = :gyd HKD = :hkd HRK = :hrk HTG = :htg IDR = :idr ILS = :ils INR = :inr ISK = :isk JMD = :jmd JPY = :jpy KES = :kes KGS = :kgs KHR = :khr KMF = :kmf KRW = :krw KYD = :kyd KZT = :kzt LBP = :lbp LKR = :lkr LRD = :lrd LSL = :lsl MAD = :mad MDL = :mdl MGA = :mga MKD = :mkd MMK = :mmk MNT = :mnt MOP = :mop MRO = :mro MVR = :mvr MWK = :mwk MXN = :mxn MYR = :myr MZN = :mzn NAD = :nad NGN = :ngn NOK = :nok NPR = :npr NZD = :nzd PGK = :pgk PHP = :php PKR = :pkr PLN = :pln QAR = :qar RON = :ron RSD = :rsd RUB = :rub RWF = :rwf SAR = :sar SBD = :sbd SCR = :scr SEK = :sek SGD = :sgd SLE = :sle SLL = :sll SOS = :sos SZL = :szl THB = :thb TJS = :tjs TOP = :top TRY = :try TTD = :ttd TZS = :tzs UAH = :uah UZS = :uzs VND = :vnd VUV = :vuv WST = :wst XAF = :xaf XCD = :xcd YER = :yer ZAR = :zar ZMW = :zmw CLP = :clp DJF = :djf GNF = :gnf UGX = :ugx PYG = :pyg XOF = :xof XPF = :xpf # @!method self.values # @return [Array<Symbol>] end end # @see Stigg::Models::V1::AddonUpdateParams::Charges::OveragePricingModel::PricePeriod::Tier#unit_price class UnitPrice < Stigg::Internal::Type::BaseModel # @!attribute amount # The price amount # # @return [Float] required :amount, Float # @!attribute currency # The price currency # # @return [Symbol, Stigg::Models::V1::AddonUpdateParams::Charges::OveragePricingModel::PricePeriod::Tier::UnitPrice::Currency, nil] optional :currency, enum: -> { Stigg::V1::AddonUpdateParams::Charges::OveragePricingModel::PricePeriod::Tier::UnitPrice::Currency } # @!method initialize(amount:, currency: nil) # Per-unit price in this tier # # @param amount [Float] The price amount # # @param currency [Symbol, Stigg::Models::V1::AddonUpdateParams::Charges::OveragePricingModel::PricePeriod::Tier::UnitPrice::Currency] The price currency # The price currency # # @see Stigg::Models::V1::AddonUpdateParams::Charges::OveragePricingModel::PricePeriod::Tier::UnitPrice#currency module Currency extend Stigg::Internal::Type::Enum USD = :usd AED = :aed ALL = :all AMD = :amd ANG = :ang AUD = :aud AWG = :awg AZN = :azn BAM = :bam BBD = :bbd BDT = :bdt BGN = :bgn BIF = :bif BMD = :bmd BND = :bnd BSD = :bsd BWP = :bwp BYN = :byn BZD = :bzd BRL = :brl CAD = :cad CDF = :cdf CHF = :chf CNY = :cny CZK = :czk DKK = :dkk DOP = :dop DZD = :dzd EGP = :egp ETB = :etb EUR = :eur FJD = :fjd GBP = :gbp GEL = :gel GIP = :gip GMD = :gmd GYD = :gyd HKD = :hkd HRK = :hrk HTG = :htg IDR = :idr ILS = :ils INR = :inr ISK = :isk JMD = :jmd JPY = :jpy KES = :kes KGS = :kgs KHR = :khr KMF = :kmf KRW = :krw KYD = :kyd KZT = :kzt LBP = :lbp LKR = :lkr LRD = :lrd LSL = :lsl MAD = :mad MDL = :mdl MGA = :mga MKD = :mkd MMK = :mmk MNT = :mnt MOP = :mop MRO = :mro MVR = :mvr MWK = :mwk MXN = :mxn MYR = :myr MZN = :mzn NAD = :nad NGN = :ngn NOK = :nok NPR = :npr NZD = :nzd PGK = :pgk PHP = :php PKR = :pkr PLN = :pln QAR = :qar RON = :ron RSD = :rsd RUB = :rub RWF = :rwf SAR = :sar SBD = :sbd SCR = :scr SEK = :sek SGD = :sgd SLE = :sle SLL = :sll SOS = :sos SZL = :szl THB = :thb TJS = :tjs TOP = :top TRY = :try TTD = :ttd TZS = :tzs UAH = :uah UZS = :uzs VND = :vnd VUV = :vuv WST = :wst XAF = :xaf XCD = :xcd YER = :yer ZAR = :zar ZMW = :zmw CLP = :clp DJF = :djf GNF = :gnf UGX = :ugx PYG = :pyg XOF = :xof XPF = :xpf # @!method self.values # @return [Array<Symbol>] end end end end |
Instance Attribute Details
#billing_country_code ⇒ String?
ISO country code for localized pricing
446 |
# File 'lib/stigg/models/v1/addon_update_params.rb', line 446 optional :billing_country_code, String, api_name: :billingCountryCode |
#billing_period ⇒ Symbol, Stigg::Models::V1::AddonUpdateParams::Charges::OveragePricingModel::PricePeriod::BillingPeriod
The billing period (MONTHLY or ANNUALLY)
436 437 438 439 440 |
# File 'lib/stigg/models/v1/addon_update_params.rb', line 436 required :billing_period, enum: -> { Stigg::V1::AddonUpdateParams::Charges::OveragePricingModel::PricePeriod::BillingPeriod }, api_name: :billingPeriod |
#block_size ⇒ Float?
Block size for usage-based pricing
452 |
# File 'lib/stigg/models/v1/addon_update_params.rb', line 452 optional :block_size, Float, api_name: :blockSize |
#credit_grant_cadence ⇒ Symbol, ...
When credits are granted
458 459 460 461 462 |
# File 'lib/stigg/models/v1/addon_update_params.rb', line 458 optional :credit_grant_cadence, enum: -> { Stigg::V1::AddonUpdateParams::Charges::OveragePricingModel::PricePeriod::CreditGrantCadence }, api_name: :creditGrantCadence |
#credit_rate ⇒ Stigg::Models::V1::AddonUpdateParams::Charges::OveragePricingModel::PricePeriod::CreditRate?
Credit rate configuration for credit-based pricing
468 469 470 471 472 |
# File 'lib/stigg/models/v1/addon_update_params.rb', line 468 optional :credit_rate, -> { Stigg::V1::AddonUpdateParams::Charges::OveragePricingModel::PricePeriod::CreditRate }, api_name: :creditRate |
#price ⇒ Stigg::Models::V1::AddonUpdateParams::Charges::OveragePricingModel::PricePeriod::Price?
The price amount and currency
478 |
# File 'lib/stigg/models/v1/addon_update_params.rb', line 478 optional :price, -> { Stigg::V1::AddonUpdateParams::Charges::OveragePricingModel::PricePeriod::Price } |
#tiers ⇒ Array<Stigg::Models::V1::AddonUpdateParams::Charges::OveragePricingModel::PricePeriod::Tier>?
Tiered pricing configuration
484 485 |
# File 'lib/stigg/models/v1/addon_update_params.rb', line 484 optional :tiers, -> { Stigg::Internal::Type::ArrayOf[Stigg::V1::AddonUpdateParams::Charges::OveragePricingModel::PricePeriod::Tier] } |
Class Method Details
.values ⇒ Array<Symbol>
|
|
# File 'lib/stigg/models/v1/addon_update_params.rb', line 513
|
Instance Method Details
#to_hash ⇒ {
574 |
# File 'sig/stigg/models/v1/addon_update_params.rbs', line 574
def to_hash: -> {
|