subtain-apimatic-sdk 4.1.1 → 9.1.2

data/lib/advanced_billing/models/signup_proforma_preview_response.rb

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

data/lib/advanced_billing/models/site.rb

@@ -0,0 +1,212 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Site Model.
+  class Site < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :name
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :subdomain
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :currency
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :seller_id
+
+    # TODO: Write general description for this method
+    # @return [Array[String]]
+    attr_accessor :non_primary_currencies
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :relationship_invoicing_enabled
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :customer_hierarchy_enabled
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :whopays_enabled
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :whopays_default_payer
+
+    # TODO: Write general description for this method
+    # @return [AllocationSettings]
+    attr_accessor :allocation_settings
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :default_payment_collection_method
+
+    # TODO: Write general description for this method
+    # @return [OrganizationAddress]
+    attr_accessor :organization_address
+
+    # TODO: Write general description for this method
+    # @return [TaxConfiguration]
+    attr_accessor :tax_configuration
+
+    # TODO: Write general description for this method
+    # @return [NetTerms]
+    attr_accessor :net_terms
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :test
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['name'] = 'name'
+      @_hash['subdomain'] = 'subdomain'
+      @_hash['currency'] = 'currency'
+      @_hash['seller_id'] = 'seller_id'
+      @_hash['non_primary_currencies'] = 'non_primary_currencies'
+      @_hash['relationship_invoicing_enabled'] =
+        'relationship_invoicing_enabled'
+      @_hash['customer_hierarchy_enabled'] = 'customer_hierarchy_enabled'
+      @_hash['whopays_enabled'] = 'whopays_enabled'
+      @_hash['whopays_default_payer'] = 'whopays_default_payer'
+      @_hash['allocation_settings'] = 'allocation_settings'
+      @_hash['default_payment_collection_method'] =
+        'default_payment_collection_method'
+      @_hash['organization_address'] = 'organization_address'
+      @_hash['tax_configuration'] = 'tax_configuration'
+      @_hash['net_terms'] = 'net_terms'
+      @_hash['test'] = 'test'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        name
+        subdomain
+        currency
+        seller_id
+        non_primary_currencies
+        relationship_invoicing_enabled
+        customer_hierarchy_enabled
+        whopays_enabled
+        whopays_default_payer
+        allocation_settings
+        default_payment_collection_method
+        organization_address
+        tax_configuration
+        net_terms
+        test
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = SKIP, name = SKIP, subdomain = SKIP, currency = SKIP,
+                   seller_id = SKIP, non_primary_currencies = SKIP,
+                   relationship_invoicing_enabled = SKIP,
+                   customer_hierarchy_enabled = SKIP, whopays_enabled = SKIP,
+                   whopays_default_payer = SKIP, allocation_settings = SKIP,
+                   default_payment_collection_method = SKIP,
+                   organization_address = SKIP, tax_configuration = SKIP,
+                   net_terms = SKIP, test = SKIP)
+      @id = id unless id == SKIP
+      @name = name unless name == SKIP
+      @subdomain = subdomain unless subdomain == SKIP
+      @currency = currency unless currency == SKIP
+      @seller_id = seller_id unless seller_id == SKIP
+      @non_primary_currencies = non_primary_currencies unless non_primary_currencies == SKIP
+      unless relationship_invoicing_enabled == SKIP
+        @relationship_invoicing_enabled =
+          relationship_invoicing_enabled
+      end
+      unless customer_hierarchy_enabled == SKIP
+        @customer_hierarchy_enabled =
+          customer_hierarchy_enabled
+      end
+      @whopays_enabled = whopays_enabled unless whopays_enabled == SKIP
+      @whopays_default_payer = whopays_default_payer unless whopays_default_payer == SKIP
+      @allocation_settings = allocation_settings unless allocation_settings == SKIP
+      unless default_payment_collection_method == SKIP
+        @default_payment_collection_method =
+          default_payment_collection_method
+      end
+      @organization_address = organization_address unless organization_address == SKIP
+      @tax_configuration = tax_configuration unless tax_configuration == SKIP
+      @net_terms = net_terms unless net_terms == SKIP
+      @test = test unless test == 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.
+      id = hash.key?('id') ? hash['id'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+      subdomain = hash.key?('subdomain') ? hash['subdomain'] : SKIP
+      currency = hash.key?('currency') ? hash['currency'] : SKIP
+      seller_id = hash.key?('seller_id') ? hash['seller_id'] : SKIP
+      non_primary_currencies =
+        hash.key?('non_primary_currencies') ? hash['non_primary_currencies'] : SKIP
+      relationship_invoicing_enabled =
+        hash.key?('relationship_invoicing_enabled') ? hash['relationship_invoicing_enabled'] : SKIP
+      customer_hierarchy_enabled =
+        hash.key?('customer_hierarchy_enabled') ? hash['customer_hierarchy_enabled'] : SKIP
+      whopays_enabled =
+        hash.key?('whopays_enabled') ? hash['whopays_enabled'] : SKIP
+      whopays_default_payer =
+        hash.key?('whopays_default_payer') ? hash['whopays_default_payer'] : SKIP
+      allocation_settings = AllocationSettings.from_hash(hash['allocation_settings']) if
+        hash['allocation_settings']
+      default_payment_collection_method =
+        hash.key?('default_payment_collection_method') ? hash['default_payment_collection_method'] : SKIP
+      organization_address = OrganizationAddress.from_hash(hash['organization_address']) if
+        hash['organization_address']
+      tax_configuration = TaxConfiguration.from_hash(hash['tax_configuration']) if
+        hash['tax_configuration']
+      net_terms = NetTerms.from_hash(hash['net_terms']) if hash['net_terms']
+      test = hash.key?('test') ? hash['test'] : SKIP
+
+      # Create object from extracted values.
+      Site.new(id,
+               name,
+               subdomain,
+               currency,
+               seller_id,
+               non_primary_currencies,
+               relationship_invoicing_enabled,
+               customer_hierarchy_enabled,
+               whopays_enabled,
+               whopays_default_payer,
+               allocation_settings,
+               default_payment_collection_method,
+               organization_address,
+               tax_configuration,
+               net_terms,
+               test)
+    end
+  end
+end

data/lib/advanced_billing/models/site_response.rb

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

data/lib/advanced_billing/models/site_statistics.rb

@@ -0,0 +1,171 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # SiteStatistics Model.
+  class SiteStatistics < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :total_subscriptions
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :subscriptions_today
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :total_revenue
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :revenue_today
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :revenue_this_month
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :revenue_this_year
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :total_canceled_subscriptions
+
+    # TODO: Write general description for this method
+    # @return [Float]
+    attr_accessor :total_active_subscriptions
+
+    # TODO: Write general description for this method
+    # @return [Float]
+    attr_accessor :total_past_due_subscriptions
+
+    # TODO: Write general description for this method
+    # @return [Float]
+    attr_accessor :total_unpaid_subscriptions
+
+    # TODO: Write general description for this method
+    # @return [Float]
+    attr_accessor :total_dunning_subscriptions
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['total_subscriptions'] = 'total_subscriptions'
+      @_hash['subscriptions_today'] = 'subscriptions_today'
+      @_hash['total_revenue'] = 'total_revenue'
+      @_hash['revenue_today'] = 'revenue_today'
+      @_hash['revenue_this_month'] = 'revenue_this_month'
+      @_hash['revenue_this_year'] = 'revenue_this_year'
+      @_hash['total_canceled_subscriptions'] = 'total_canceled_subscriptions'
+      @_hash['total_active_subscriptions'] = 'total_active_subscriptions'
+      @_hash['total_past_due_subscriptions'] = 'total_past_due_subscriptions'
+      @_hash['total_unpaid_subscriptions'] = 'total_unpaid_subscriptions'
+      @_hash['total_dunning_subscriptions'] = 'total_dunning_subscriptions'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        total_subscriptions
+        subscriptions_today
+        total_revenue
+        revenue_today
+        revenue_this_month
+        revenue_this_year
+        total_canceled_subscriptions
+        total_active_subscriptions
+        total_past_due_subscriptions
+        total_unpaid_subscriptions
+        total_dunning_subscriptions
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(total_subscriptions = SKIP, subscriptions_today = SKIP,
+                   total_revenue = SKIP, revenue_today = SKIP,
+                   revenue_this_month = SKIP, revenue_this_year = SKIP,
+                   total_canceled_subscriptions = SKIP,
+                   total_active_subscriptions = SKIP,
+                   total_past_due_subscriptions = SKIP,
+                   total_unpaid_subscriptions = SKIP,
+                   total_dunning_subscriptions = SKIP)
+      @total_subscriptions = total_subscriptions unless total_subscriptions == SKIP
+      @subscriptions_today = subscriptions_today unless subscriptions_today == SKIP
+      @total_revenue = total_revenue unless total_revenue == SKIP
+      @revenue_today = revenue_today unless revenue_today == SKIP
+      @revenue_this_month = revenue_this_month unless revenue_this_month == SKIP
+      @revenue_this_year = revenue_this_year unless revenue_this_year == SKIP
+      unless total_canceled_subscriptions == SKIP
+        @total_canceled_subscriptions =
+          total_canceled_subscriptions
+      end
+      unless total_active_subscriptions == SKIP
+        @total_active_subscriptions =
+          total_active_subscriptions
+      end
+      unless total_past_due_subscriptions == SKIP
+        @total_past_due_subscriptions =
+          total_past_due_subscriptions
+      end
+      unless total_unpaid_subscriptions == SKIP
+        @total_unpaid_subscriptions =
+          total_unpaid_subscriptions
+      end
+      unless total_dunning_subscriptions == SKIP
+        @total_dunning_subscriptions =
+          total_dunning_subscriptions
+      end
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      total_subscriptions =
+        hash.key?('total_subscriptions') ? hash['total_subscriptions'] : SKIP
+      subscriptions_today =
+        hash.key?('subscriptions_today') ? hash['subscriptions_today'] : SKIP
+      total_revenue = hash.key?('total_revenue') ? hash['total_revenue'] : SKIP
+      revenue_today = hash.key?('revenue_today') ? hash['revenue_today'] : SKIP
+      revenue_this_month =
+        hash.key?('revenue_this_month') ? hash['revenue_this_month'] : SKIP
+      revenue_this_year =
+        hash.key?('revenue_this_year') ? hash['revenue_this_year'] : SKIP
+      total_canceled_subscriptions =
+        hash.key?('total_canceled_subscriptions') ? hash['total_canceled_subscriptions'] : SKIP
+      total_active_subscriptions =
+        hash.key?('total_active_subscriptions') ? hash['total_active_subscriptions'] : SKIP
+      total_past_due_subscriptions =
+        hash.key?('total_past_due_subscriptions') ? hash['total_past_due_subscriptions'] : SKIP
+      total_unpaid_subscriptions =
+        hash.key?('total_unpaid_subscriptions') ? hash['total_unpaid_subscriptions'] : SKIP
+      total_dunning_subscriptions =
+        hash.key?('total_dunning_subscriptions') ? hash['total_dunning_subscriptions'] : SKIP
+
+      # Create object from extracted values.
+      SiteStatistics.new(total_subscriptions,
+                         subscriptions_today,
+                         total_revenue,
+                         revenue_today,
+                         revenue_this_month,
+                         revenue_this_year,
+                         total_canceled_subscriptions,
+                         total_active_subscriptions,
+                         total_past_due_subscriptions,
+                         total_unpaid_subscriptions,
+                         total_dunning_subscriptions)
+    end
+  end
+end

data/lib/advanced_billing/models/site_summary.rb

@@ -0,0 +1,87 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # SiteSummary Model.
+  class SiteSummary < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :seller_name
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :site_name
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :site_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :site_currency
+
+    # TODO: Write general description for this method
+    # @return [SiteStatistics]
+    attr_accessor :stats
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['seller_name'] = 'seller_name'
+      @_hash['site_name'] = 'site_name'
+      @_hash['site_id'] = 'site_id'
+      @_hash['site_currency'] = 'site_currency'
+      @_hash['stats'] = 'stats'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        seller_name
+        site_name
+        site_id
+        site_currency
+        stats
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(seller_name = SKIP, site_name = SKIP, site_id = SKIP,
+                   site_currency = SKIP, stats = SKIP)
+      @seller_name = seller_name unless seller_name == SKIP
+      @site_name = site_name unless site_name == SKIP
+      @site_id = site_id unless site_id == SKIP
+      @site_currency = site_currency unless site_currency == SKIP
+      @stats = stats unless stats == 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.
+      seller_name = hash.key?('seller_name') ? hash['seller_name'] : SKIP
+      site_name = hash.key?('site_name') ? hash['site_name'] : SKIP
+      site_id = hash.key?('site_id') ? hash['site_id'] : SKIP
+      site_currency = hash.key?('site_currency') ? hash['site_currency'] : SKIP
+      stats = SiteStatistics.from_hash(hash['stats']) if hash['stats']
+
+      # Create object from extracted values.
+      SiteSummary.new(seller_name,
+                      site_name,
+                      site_id,
+                      site_currency,
+                      stats)
+    end
+  end
+end

data/lib/advanced_billing/models/snap_day.rb

@@ -0,0 +1,21 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Use for subscriptions with product eligible for calendar billing only. Value
+  # can be 1-28 or 'end'.
+  class SnapDay
+    SNAP_DAY = [
+      # TODO: Write general description for ENUM_END
+      ENUM_END = 'end'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SNAP_DAY.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/sorting_direction.rb

@@ -0,0 +1,23 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Used for sorting results.
+  class SortingDirection
+    SORTING_DIRECTION = [
+      # TODO: Write general description for ASC
+      ASC = 'asc'.freeze,
+
+      # TODO: Write general description for DESC
+      DESC = 'desc'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SORTING_DIRECTION.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/status.rb

@@ -0,0 +1,37 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # The current status of the invoice. See [Invoice
+  # Statuses](https://chargify.zendesk.com/hc/en-us/articles/4407737494171#line-
+  # item-breakdowns) for more.
+  class Status
+    STATUS = [
+      # TODO: Write general description for DRAFT
+      DRAFT = 'draft'.freeze,
+
+      # TODO: Write general description for OPEN
+      OPEN = 'open'.freeze,
+
+      # TODO: Write general description for PAID
+      PAID = 'paid'.freeze,
+
+      # TODO: Write general description for PENDING
+      PENDING = 'pending'.freeze,
+
+      # TODO: Write general description for VOIDED
+      VOIDED = 'voided'.freeze,
+
+      # TODO: Write general description for CANCELED
+      CANCELED = 'canceled'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      STATUS.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/status1.rb

@@ -0,0 +1,23 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Status1.
+  class Status1
+    STATUS1 = [
+      # TODO: Write general description for DRAFT
+      DRAFT = 'draft'.freeze,
+
+      # TODO: Write general description for OPEN
+      OPEN = 'open'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      STATUS1.include?(value)
+    end
+  end
+end