subtain-apimatic-sdk 4.1.1 → 9.1.1

data/lib/advanced_billing/models/on_off_component.rb

@@ -0,0 +1,291 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # OnOffComponent Model.
+  class OnOffComponent < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A name for this component that is suitable for showing customers and
+    # displaying on billing statements, ie. "Minutes".
+    # @return [String]
+    attr_accessor :name
+
+    # The name of the unit of measurement for the component. It should be
+    # singular since it will be automatically pluralized when necessary. i.e.
+    # “message”, which may then be shown as “5 messages” on a subscription’s
+    # component line-item
+    # @return [String]
+    attr_accessor :unit_name
+
+    # A description for the component that will be displayed to the user on the
+    # hosted signup page.
+    # @return [String]
+    attr_accessor :description
+
+    # A unique identifier for your use that can be used to retrieve this
+    # component is subsequent requests.  Must start with a letter or number and
+    # may only contain lowercase letters, numbers, or the characters '.', ':',
+    # '-', or '_'.
+    # @return [String]
+    attr_accessor :handle
+
+    # Boolean flag describing whether a component is taxable or not.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :taxable
+
+    # The identifier for the pricing scheme. See [Product
+    # Components](https://help.chargify.com/products/product-components.html)
+    # for an overview of pricing schemes.
+    # @return [PricingScheme]
+    attr_accessor :pricing_scheme
+
+    # (Not required for ‘per_unit’ pricing schemes) One or more price brackets.
+    # See [Price Bracket
+    # Rules](https://chargify.zendesk.com/hc/en-us/articles/4407755865883#price-
+    # bracket-rules) for an overview of how price brackets work for different
+    # pricing schemes.
+    # @return [Array[Price]]
+    attr_accessor :prices
+
+    # (Not required for ‘per_unit’ pricing schemes) One or more price brackets.
+    # See [Price Bracket
+    # Rules](https://chargify.zendesk.com/hc/en-us/articles/4407755865883#price-
+    # bracket-rules) for an overview of how price brackets work for different
+    # pricing schemes.
+    # @return [String]
+    attr_accessor :upgrade_charge
+
+    # (Not required for ‘per_unit’ pricing schemes) One or more price brackets.
+    # See [Price Bracket
+    # Rules](https://chargify.zendesk.com/hc/en-us/articles/4407755865883#price-
+    # bracket-rules) for an overview of how price brackets work for different
+    # pricing schemes.
+    # @return [String]
+    attr_accessor :downgrade_credit
+
+    # (Not required for ‘per_unit’ pricing schemes) One or more price brackets.
+    # See [Price Bracket
+    # Rules](https://chargify.zendesk.com/hc/en-us/articles/4407755865883#price-
+    # bracket-rules) for an overview of how price brackets work for different
+    # pricing schemes.
+    # @return [Array[ComponentPricePointItem]]
+    attr_accessor :price_points
+
+    # The amount the customer will be charged per unit when the pricing scheme
+    # is “per_unit”. For On/Off Components, this is the amount that the customer
+    # will be charged when they turn the component on for the subscription. The
+    # price can contain up to 8 decimal places. i.e. 1.00 or 0.0012 or
+    # 0.00000065
+    # @return [Object]
+    attr_accessor :unit_price
+
+    # A string representing the tax code related to the component type. This is
+    # especially important when using the Avalara service to tax based on
+    # locale. This attribute has a max length of 10 characters.
+    # @return [String]
+    attr_accessor :tax_code
+
+    # (Only available on Relationship Invoicing sites) Boolean flag describing
+    # if the service date range should show for the component on generated
+    # invoices.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :hide_date_range_on_invoice
+
+    # deprecated May 2011 - use unit_price instead
+    # @return [String]
+    attr_accessor :price_in_cents
+
+    # deprecated May 2011 - use unit_price instead
+    # @return [TrueClass | FalseClass]
+    attr_accessor :display_on_hosted_page
+
+    # deprecated May 2011 - use unit_price instead
+    # @return [TrueClass | FalseClass]
+    attr_accessor :allow_fractional_quantities
+
+    # deprecated May 2011 - use unit_price instead
+    # @return [Array[Integer]]
+    attr_accessor :public_signup_page_ids
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['unit_name'] = 'unit_name'
+      @_hash['description'] = 'description'
+      @_hash['handle'] = 'handle'
+      @_hash['taxable'] = 'taxable'
+      @_hash['pricing_scheme'] = 'pricing_scheme'
+      @_hash['prices'] = 'prices'
+      @_hash['upgrade_charge'] = 'upgrade_charge'
+      @_hash['downgrade_credit'] = 'downgrade_credit'
+      @_hash['price_points'] = 'price_points'
+      @_hash['unit_price'] = 'unit_price'
+      @_hash['tax_code'] = 'tax_code'
+      @_hash['hide_date_range_on_invoice'] = 'hide_date_range_on_invoice'
+      @_hash['price_in_cents'] = 'price_in_cents'
+      @_hash['display_on_hosted_page'] = 'display_on_hosted_page'
+      @_hash['allow_fractional_quantities'] = 'allow_fractional_quantities'
+      @_hash['public_signup_page_ids'] = 'public_signup_page_ids'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        unit_name
+        description
+        handle
+        taxable
+        prices
+        upgrade_charge
+        downgrade_credit
+        price_points
+        unit_price
+        tax_code
+        hide_date_range_on_invoice
+        price_in_cents
+        display_on_hosted_page
+        allow_fractional_quantities
+        public_signup_page_ids
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name = nil, pricing_scheme = nil, unit_name = SKIP,
+                   description = SKIP, handle = SKIP, taxable = SKIP,
+                   prices = SKIP, upgrade_charge = SKIP,
+                   downgrade_credit = SKIP, price_points = SKIP,
+                   unit_price = SKIP, tax_code = SKIP,
+                   hide_date_range_on_invoice = SKIP, price_in_cents = SKIP,
+                   display_on_hosted_page = SKIP,
+                   allow_fractional_quantities = SKIP,
+                   public_signup_page_ids = SKIP)
+      @name = name
+      @unit_name = unit_name unless unit_name == SKIP
+      @description = description unless description == SKIP
+      @handle = handle unless handle == SKIP
+      @taxable = taxable unless taxable == SKIP
+      @pricing_scheme = pricing_scheme
+      @prices = prices unless prices == SKIP
+      @upgrade_charge = upgrade_charge unless upgrade_charge == SKIP
+      @downgrade_credit = downgrade_credit unless downgrade_credit == SKIP
+      @price_points = price_points unless price_points == SKIP
+      @unit_price = unit_price unless unit_price == SKIP
+      @tax_code = tax_code unless tax_code == SKIP
+      unless hide_date_range_on_invoice == SKIP
+        @hide_date_range_on_invoice =
+          hide_date_range_on_invoice
+      end
+      @price_in_cents = price_in_cents unless price_in_cents == SKIP
+      @display_on_hosted_page = display_on_hosted_page unless display_on_hosted_page == SKIP
+      unless allow_fractional_quantities == SKIP
+        @allow_fractional_quantities =
+          allow_fractional_quantities
+      end
+      @public_signup_page_ids = public_signup_page_ids unless public_signup_page_ids == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      name = hash.key?('name') ? hash['name'] : nil
+      pricing_scheme = hash.key?('pricing_scheme') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:OnOffComponentPricingScheme), hash['pricing_scheme']
+      ) : nil
+      unit_name = hash.key?('unit_name') ? hash['unit_name'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      handle = hash.key?('handle') ? hash['handle'] : SKIP
+      taxable = hash.key?('taxable') ? hash['taxable'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      prices = nil
+      unless hash['prices'].nil?
+        prices = []
+        hash['prices'].each do |structure|
+          prices << (Price.from_hash(structure) if structure)
+        end
+      end
+
+      prices = SKIP unless hash.key?('prices')
+      upgrade_charge =
+        hash.key?('upgrade_charge') ? hash['upgrade_charge'] : SKIP
+      downgrade_credit =
+        hash.key?('downgrade_credit') ? hash['downgrade_credit'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      price_points = nil
+      unless hash['price_points'].nil?
+        price_points = []
+        hash['price_points'].each do |structure|
+          price_points << (ComponentPricePointItem.from_hash(structure) if structure)
+        end
+      end
+
+      price_points = SKIP unless hash.key?('price_points')
+      unit_price = hash.key?('unit_price') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:OnOffComponentUnitPrice), hash['unit_price']
+      ) : SKIP
+      tax_code = hash.key?('tax_code') ? hash['tax_code'] : SKIP
+      hide_date_range_on_invoice =
+        hash.key?('hide_date_range_on_invoice') ? hash['hide_date_range_on_invoice'] : SKIP
+      price_in_cents =
+        hash.key?('price_in_cents') ? hash['price_in_cents'] : SKIP
+      display_on_hosted_page =
+        hash.key?('display_on_hosted_page') ? hash['display_on_hosted_page'] : SKIP
+      allow_fractional_quantities =
+        hash.key?('allow_fractional_quantities') ? hash['allow_fractional_quantities'] : SKIP
+      public_signup_page_ids =
+        hash.key?('public_signup_page_ids') ? hash['public_signup_page_ids'] : SKIP
+
+      # Create object from extracted values.
+      OnOffComponent.new(name,
+                         pricing_scheme,
+                         unit_name,
+                         description,
+                         handle,
+                         taxable,
+                         prices,
+                         upgrade_charge,
+                         downgrade_credit,
+                         price_points,
+                         unit_price,
+                         tax_code,
+                         hide_date_range_on_invoice,
+                         price_in_cents,
+                         display_on_hosted_page,
+                         allow_fractional_quantities,
+                         public_signup_page_ids)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [OnOffComponent | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.name,
+                                ->(val) { val.instance_of? String }) and
+            UnionTypeLookUp.get(:OnOffComponentPricingScheme)
+                           .validate(value.pricing_scheme)
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['name'],
+                              ->(val) { val.instance_of? String }) and
+          UnionTypeLookUp.get(:OnOffComponentPricingScheme)
+                         .validate(value['pricing_scheme'])
+      )
+    end
+  end
+end

data/lib/advanced_billing/models/organization_address.rb

@@ -0,0 +1,123 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # OrganizationAddress Model.
+  class OrganizationAddress < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :street
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :line2
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :city
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :state
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :zip
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :country
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :name
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :phone
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['street'] = 'street'
+      @_hash['line2'] = 'line2'
+      @_hash['city'] = 'city'
+      @_hash['state'] = 'state'
+      @_hash['zip'] = 'zip'
+      @_hash['country'] = 'country'
+      @_hash['name'] = 'name'
+      @_hash['phone'] = 'phone'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        street
+        line2
+        city
+        state
+        zip
+        country
+        name
+        phone
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        street
+        line2
+        city
+        state
+        zip
+        country
+        name
+        phone
+      ]
+    end
+
+    def initialize(street = SKIP, line2 = SKIP, city = SKIP, state = SKIP,
+                   zip = SKIP, country = SKIP, name = SKIP, phone = SKIP)
+      @street = street unless street == SKIP
+      @line2 = line2 unless line2 == SKIP
+      @city = city unless city == SKIP
+      @state = state unless state == SKIP
+      @zip = zip unless zip == SKIP
+      @country = country unless country == SKIP
+      @name = name unless name == SKIP
+      @phone = phone unless phone == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      street = hash.key?('street') ? hash['street'] : SKIP
+      line2 = hash.key?('line2') ? hash['line2'] : SKIP
+      city = hash.key?('city') ? hash['city'] : SKIP
+      state = hash.key?('state') ? hash['state'] : SKIP
+      zip = hash.key?('zip') ? hash['zip'] : SKIP
+      country = hash.key?('country') ? hash['country'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+      phone = hash.key?('phone') ? hash['phone'] : SKIP
+
+      # Create object from extracted values.
+      OrganizationAddress.new(street,
+                              line2,
+                              city,
+                              state,
+                              zip,
+                              country,
+                              name,
+                              phone)
+    end
+  end
+end

data/lib/advanced_billing/models/origin_invoice.rb

@@ -0,0 +1,69 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # OriginInvoice Model.
+  class OriginInvoice < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The UID of the invoice serving as an origin invoice.
+    # @return [String]
+    attr_accessor :uid
+
+    # The number of the invoice serving as an origin invoice.
+    # @return [String]
+    attr_accessor :number
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['uid'] = 'uid'
+      @_hash['number'] = 'number'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        uid
+        number
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(uid = SKIP, number = SKIP)
+      @uid = uid unless uid == SKIP
+      @number = number unless number == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      uid = hash.key?('uid') ? hash['uid'] : SKIP
+      number = hash.key?('number') ? hash['number'] : SKIP
+
+      # Create object from extracted values.
+      OriginInvoice.new(uid,
+                        number)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [OriginInvoice | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+  end
+end

data/lib/advanced_billing/models/overage_pricing.rb

@@ -0,0 +1,87 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # OveragePricing Model.
+  class OveragePricing < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The identifier for the pricing scheme. See [Product
+    # Components](https://help.chargify.com/products/product-components.html)
+    # for an overview of pricing schemes.
+    # @return [PricingScheme]
+    attr_accessor :pricing_scheme
+
+    # The identifier for the pricing scheme. See [Product
+    # Components](https://help.chargify.com/products/product-components.html)
+    # for an overview of pricing schemes.
+    # @return [Array[Price]]
+    attr_accessor :prices
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['pricing_scheme'] = 'pricing_scheme'
+      @_hash['prices'] = 'prices'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        prices
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(pricing_scheme = nil, prices = SKIP)
+      @pricing_scheme = pricing_scheme
+      @prices = prices unless prices == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      pricing_scheme = hash.key?('pricing_scheme') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:OveragePricingPricingScheme), hash['pricing_scheme']
+      ) : nil
+      # Parameter is an array, so we need to iterate through it
+      prices = nil
+      unless hash['prices'].nil?
+        prices = []
+        hash['prices'].each do |structure|
+          prices << (Price.from_hash(structure) if structure)
+        end
+      end
+
+      prices = SKIP unless hash.key?('prices')
+
+      # Create object from extracted values.
+      OveragePricing.new(pricing_scheme,
+                         prices)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [OveragePricing | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return UnionTypeLookUp.get(:OveragePricingPricingScheme)
+                              .validate(value.pricing_scheme)
+      end
+
+      return false unless value.instance_of? Hash
+
+      UnionTypeLookUp.get(:OveragePricingPricingScheme)
+                     .validate(value['pricing_scheme'])
+    end
+  end
+end

data/lib/advanced_billing/models/override_subscription.rb

@@ -0,0 +1,100 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # OverrideSubscription Model.
+  class OverrideSubscription < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Can be used to record an external signup date. Chargify uses this field to
+    # record when a subscription first goes active (either at signup or at trial
+    # end)
+    # @return [String]
+    attr_accessor :activated_at
+
+    # Can be used to record an external cancellation date. Chargify sets this
+    # field automatically when a subscription is canceled, whether by request or
+    # via dunning.
+    # @return [String]
+    attr_accessor :canceled_at
+
+    # Can be used to record a reason for the original cancellation.
+    # @return [String]
+    attr_accessor :cancellation_message
+
+    # Can be used to record an external expiration date. Chargify sets this
+    # field automatically when a subscription expires (ceases billing) after a
+    # prescribed amount of time.
+    # @return [String]
+    attr_accessor :expires_at
+
+    # Can only be used when a subscription is unbilled, which happens when a
+    # future initial billing date is passed at subscription creation. The value
+    # passed must be before the current date and time. Allows you to set when
+    # the period started so mid period component allocations have the correct
+    # proration.
+    # @return [String]
+    attr_accessor :current_period_starts_at
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['activated_at'] = 'activated_at'
+      @_hash['canceled_at'] = 'canceled_at'
+      @_hash['cancellation_message'] = 'cancellation_message'
+      @_hash['expires_at'] = 'expires_at'
+      @_hash['current_period_starts_at'] = 'current_period_starts_at'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        activated_at
+        canceled_at
+        cancellation_message
+        expires_at
+        current_period_starts_at
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(activated_at = SKIP, canceled_at = SKIP,
+                   cancellation_message = SKIP, expires_at = SKIP,
+                   current_period_starts_at = SKIP)
+      @activated_at = activated_at unless activated_at == SKIP
+      @canceled_at = canceled_at unless canceled_at == SKIP
+      @cancellation_message = cancellation_message unless cancellation_message == SKIP
+      @expires_at = expires_at unless expires_at == SKIP
+      @current_period_starts_at = current_period_starts_at unless current_period_starts_at == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      activated_at = hash.key?('activated_at') ? hash['activated_at'] : SKIP
+      canceled_at = hash.key?('canceled_at') ? hash['canceled_at'] : SKIP
+      cancellation_message =
+        hash.key?('cancellation_message') ? hash['cancellation_message'] : SKIP
+      expires_at = hash.key?('expires_at') ? hash['expires_at'] : SKIP
+      current_period_starts_at =
+        hash.key?('current_period_starts_at') ? hash['current_period_starts_at'] : SKIP
+
+      # Create object from extracted values.
+      OverrideSubscription.new(activated_at,
+                               canceled_at,
+                               cancellation_message,
+                               expires_at,
+                               current_period_starts_at)
+    end
+  end
+end