orb-apiamtic-sdk 0.0.1

data/lib/api_reference/models/new_plan.rb

@@ -0,0 +1,210 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # NewPlan Model.
+  class NewPlan < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # User-specified key/value pairs for the resource. Individual keys can be
+    # removed by setting the value to `null`, and the entire metadata mapping
+    # can be cleared by setting `metadata` to `null`.
+    # @return [Hash[String, String]]
+    attr_accessor :metadata
+
+    # User-specified key/value pairs for the resource. Individual keys can be
+    # removed by setting the value to `null`, and the entire metadata mapping
+    # can be cleared by setting `metadata` to `null`.
+    # @return [String]
+    attr_accessor :name
+
+    # An optional user-defined description of the plan.
+    # @return [String]
+    attr_accessor :description
+
+    # Free-form text which is available on the invoice PDF and the Orb invoice
+    # portal.
+    # @return [String]
+    attr_accessor :default_invoice_memo
+
+    # The net terms determines the difference between the invoice date and the
+    # issue date for the invoice. If you intend the invoice to be due on issue,
+    # set this to 0.
+    # @return [Integer]
+    attr_accessor :net_terms
+
+    # An ISO 4217 currency string for invoices generated by subscriptions on
+    # this plan.
+    # @return [String]
+    attr_accessor :currency
+
+    # Prices for this plan. If the plan has phases, this includes prices across
+    # all phases of the plan.
+    # @return [Array[AddPlanPriceParams]]
+    attr_accessor :prices
+
+    # Prices for this plan. If the plan has phases, this includes prices across
+    # all phases of the plan.
+    # @return [String]
+    attr_accessor :external_plan_id
+
+    # The status of the plan to create (either active or draft). If not
+    # specified, this defaults to active.
+    # @return [Status17]
+    attr_accessor :status
+
+    # Configuration of pre-defined phases, each with their own prices and
+    # adjustments. Leave unspecified for plans with a single phase.
+    # @return [Array[NewPlanPhase]]
+    attr_accessor :plan_phases
+
+    # Adjustments for this plan. If the plan has phases, this includes
+    # adjustments across all phases of the plan.
+    # @return [Array[AddPlanAdjustmentParams]]
+    attr_accessor :adjustments
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['metadata'] = 'metadata'
+      @_hash['name'] = 'name'
+      @_hash['description'] = 'description'
+      @_hash['default_invoice_memo'] = 'default_invoice_memo'
+      @_hash['net_terms'] = 'net_terms'
+      @_hash['currency'] = 'currency'
+      @_hash['prices'] = 'prices'
+      @_hash['external_plan_id'] = 'external_plan_id'
+      @_hash['status'] = 'status'
+      @_hash['plan_phases'] = 'plan_phases'
+      @_hash['adjustments'] = 'adjustments'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        metadata
+        description
+        default_invoice_memo
+        net_terms
+        external_plan_id
+        status
+        plan_phases
+        adjustments
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        metadata
+        description
+        default_invoice_memo
+        net_terms
+        external_plan_id
+        plan_phases
+        adjustments
+      ]
+    end
+
+    def initialize(name:, currency:, prices:, metadata: SKIP, description: SKIP,
+                   default_invoice_memo: SKIP, net_terms: SKIP,
+                   external_plan_id: SKIP, status: Status17::ACTIVE,
+                   plan_phases: SKIP, adjustments: SKIP)
+      @metadata = metadata unless metadata == SKIP
+      @name = name
+      @description = description unless description == SKIP
+      @default_invoice_memo = default_invoice_memo unless default_invoice_memo == SKIP
+      @net_terms = net_terms unless net_terms == SKIP
+      @currency = currency
+      @prices = prices
+      @external_plan_id = external_plan_id unless external_plan_id == SKIP
+      @status = status unless status == SKIP
+      @plan_phases = plan_phases unless plan_phases == SKIP
+      @adjustments = adjustments unless adjustments == 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
+      currency = hash.key?('currency') ? hash['currency'] : 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 << (AddPlanPriceParams.from_hash(structure) if structure)
+        end
+      end
+
+      prices = nil unless hash.key?('prices')
+      metadata = hash.key?('metadata') ? hash['metadata'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      default_invoice_memo =
+        hash.key?('default_invoice_memo') ? hash['default_invoice_memo'] : SKIP
+      net_terms = hash.key?('net_terms') ? hash['net_terms'] : SKIP
+      external_plan_id =
+        hash.key?('external_plan_id') ? hash['external_plan_id'] : SKIP
+      status = hash['status'] ||= Status17::ACTIVE
+      # Parameter is an array, so we need to iterate through it
+      plan_phases = nil
+      unless hash['plan_phases'].nil?
+        plan_phases = []
+        hash['plan_phases'].each do |structure|
+          plan_phases << (NewPlanPhase.from_hash(structure) if structure)
+        end
+      end
+
+      plan_phases = SKIP unless hash.key?('plan_phases')
+      # Parameter is an array, so we need to iterate through it
+      adjustments = nil
+      unless hash['adjustments'].nil?
+        adjustments = []
+        hash['adjustments'].each do |structure|
+          adjustments << (AddPlanAdjustmentParams.from_hash(structure) if structure)
+        end
+      end
+
+      adjustments = SKIP unless hash.key?('adjustments')
+
+      # Create object from extracted values.
+      NewPlan.new(name: name,
+                  currency: currency,
+                  prices: prices,
+                  metadata: metadata,
+                  description: description,
+                  default_invoice_memo: default_invoice_memo,
+                  net_terms: net_terms,
+                  external_plan_id: external_plan_id,
+                  status: status,
+                  plan_phases: plan_phases,
+                  adjustments: adjustments)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} metadata: #{@metadata}, name: #{@name}, description: #{@description},"\
+      " default_invoice_memo: #{@default_invoice_memo}, net_terms: #{@net_terms}, currency:"\
+      " #{@currency}, prices: #{@prices}, external_plan_id: #{@external_plan_id}, status:"\
+      " #{@status}, plan_phases: #{@plan_phases}, adjustments: #{@adjustments}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} metadata: #{@metadata.inspect}, name: #{@name.inspect}, description:"\
+      " #{@description.inspect}, default_invoice_memo: #{@default_invoice_memo.inspect},"\
+      " net_terms: #{@net_terms.inspect}, currency: #{@currency.inspect}, prices:"\
+      " #{@prices.inspect}, external_plan_id: #{@external_plan_id.inspect}, status:"\
+      " #{@status.inspect}, plan_phases: #{@plan_phases.inspect}, adjustments:"\
+      " #{@adjustments.inspect}>"
+    end
+  end
+end

data/lib/api_reference/models/new_plan_bulk_price.rb

@@ -0,0 +1,310 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # NewPlanBulkPrice Model.
+  class NewPlanBulkPrice < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The pricing model type
+    # @return [String]
+    attr_reader :model_type
+
+    # Configuration for bulk pricing
+    # @return [BulkConfig]
+    attr_accessor :bulk_config
+
+    # User-specified key/value pairs for the resource. Individual keys can be
+    # removed by setting the value to `null`, and the entire metadata mapping
+    # can be cleared by setting `metadata` to `null`.
+    # @return [Hash[String, String]]
+    attr_accessor :metadata
+
+    # An alias for the price.
+    # @return [String]
+    attr_accessor :external_price_id
+
+    # The name of the price.
+    # @return [String]
+    attr_accessor :name
+
+    # For dimensional price: specifies a price group and dimension values
+    # @return [NewDimensionalPriceConfiguration]
+    attr_accessor :dimensional_price_configuration
+
+    # The ID of the license type to associate with this price.
+    # @return [String]
+    attr_accessor :license_type_id
+
+    # The id of the billable metric for the price. Only needed if the price is
+    # usage-based.
+    # @return [String]
+    attr_accessor :billable_metric_id
+
+    # The id of the item the price will be associated with.
+    # @return [String]
+    attr_accessor :item_id
+
+    # If the Price represents a fixed cost, the price will be billed in-advance
+    # if this is true, and in-arrears if this is false.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :billed_in_advance
+
+    # If the Price represents a fixed cost, this represents the quantity of
+    # units applied.
+    # @return [Float]
+    attr_accessor :fixed_price_quantity
+
+    # The property used to group this price on an invoice
+    # @return [String]
+    attr_accessor :invoice_grouping_key
+
+    # The cadence to bill for this price on.
+    # @return [Cadence]
+    attr_accessor :cadence
+
+    # For custom cadence: specifies the duration of the billing period in days
+    # or months.
+    # @return [NewBillingCycleConfiguration]
+    attr_accessor :billing_cycle_configuration
+
+    # Within each billing cycle, specifies the cadence at which invoices are
+    # produced. If unspecified, a single invoice is produced per billing cycle.
+    # @return [NewBillingCycleConfiguration]
+    attr_accessor :invoicing_cycle_configuration
+
+    # The per unit conversion rate of the price currency to the invoicing
+    # currency.
+    # @return [Float]
+    attr_accessor :conversion_rate
+
+    # The configuration for the rate of the price currency to the invoicing
+    # currency.
+    # @return [Object]
+    attr_accessor :conversion_rate_config
+
+    # An ISO 4217 currency string, or custom pricing unit identifier, in which
+    # this price is billed.
+    # @return [String]
+    attr_accessor :currency
+
+    # A transient ID that can be used to reference this price when adding
+    # adjustments in the same API call.
+    # @return [String]
+    attr_accessor :reference_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['model_type'] = 'model_type'
+      @_hash['bulk_config'] = 'bulk_config'
+      @_hash['metadata'] = 'metadata'
+      @_hash['external_price_id'] = 'external_price_id'
+      @_hash['name'] = 'name'
+      @_hash['dimensional_price_configuration'] =
+        'dimensional_price_configuration'
+      @_hash['license_type_id'] = 'license_type_id'
+      @_hash['billable_metric_id'] = 'billable_metric_id'
+      @_hash['item_id'] = 'item_id'
+      @_hash['billed_in_advance'] = 'billed_in_advance'
+      @_hash['fixed_price_quantity'] = 'fixed_price_quantity'
+      @_hash['invoice_grouping_key'] = 'invoice_grouping_key'
+      @_hash['cadence'] = 'cadence'
+      @_hash['billing_cycle_configuration'] = 'billing_cycle_configuration'
+      @_hash['invoicing_cycle_configuration'] =
+        'invoicing_cycle_configuration'
+      @_hash['conversion_rate'] = 'conversion_rate'
+      @_hash['conversion_rate_config'] = 'conversion_rate_config'
+      @_hash['currency'] = 'currency'
+      @_hash['reference_id'] = 'reference_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        metadata
+        external_price_id
+        dimensional_price_configuration
+        license_type_id
+        billable_metric_id
+        billed_in_advance
+        fixed_price_quantity
+        invoice_grouping_key
+        billing_cycle_configuration
+        invoicing_cycle_configuration
+        conversion_rate
+        conversion_rate_config
+        currency
+        reference_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        metadata
+        external_price_id
+        dimensional_price_configuration
+        license_type_id
+        billable_metric_id
+        billed_in_advance
+        fixed_price_quantity
+        invoice_grouping_key
+        billing_cycle_configuration
+        invoicing_cycle_configuration
+        conversion_rate
+        conversion_rate_config
+        currency
+        reference_id
+      ]
+    end
+
+    def initialize(bulk_config:, name:, item_id:, cadence:, metadata: SKIP,
+                   external_price_id: SKIP,
+                   dimensional_price_configuration: SKIP, license_type_id: SKIP,
+                   billable_metric_id: SKIP, billed_in_advance: SKIP,
+                   fixed_price_quantity: SKIP, invoice_grouping_key: SKIP,
+                   billing_cycle_configuration: SKIP,
+                   invoicing_cycle_configuration: SKIP, conversion_rate: SKIP,
+                   conversion_rate_config: SKIP, currency: SKIP,
+                   reference_id: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @model_type = 'bulk'
+      @bulk_config = bulk_config
+      @metadata = metadata unless metadata == SKIP
+      @external_price_id = external_price_id unless external_price_id == SKIP
+      @name = name
+      unless dimensional_price_configuration == SKIP
+        @dimensional_price_configuration =
+          dimensional_price_configuration
+      end
+      @license_type_id = license_type_id unless license_type_id == SKIP
+      @billable_metric_id = billable_metric_id unless billable_metric_id == SKIP
+      @item_id = item_id
+      @billed_in_advance = billed_in_advance unless billed_in_advance == SKIP
+      @fixed_price_quantity = fixed_price_quantity unless fixed_price_quantity == SKIP
+      @invoice_grouping_key = invoice_grouping_key unless invoice_grouping_key == SKIP
+      @cadence = cadence
+      unless billing_cycle_configuration == SKIP
+        @billing_cycle_configuration =
+          billing_cycle_configuration
+      end
+      unless invoicing_cycle_configuration == SKIP
+        @invoicing_cycle_configuration =
+          invoicing_cycle_configuration
+      end
+      @conversion_rate = conversion_rate unless conversion_rate == SKIP
+      @conversion_rate_config = conversion_rate_config unless conversion_rate_config == SKIP
+      @currency = currency unless currency == SKIP
+      @reference_id = reference_id unless reference_id == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      bulk_config = BulkConfig.from_hash(hash['bulk_config']) if hash['bulk_config']
+      name = hash.key?('name') ? hash['name'] : nil
+      item_id = hash.key?('item_id') ? hash['item_id'] : nil
+      cadence = hash.key?('cadence') ? hash['cadence'] : nil
+      metadata = hash.key?('metadata') ? hash['metadata'] : SKIP
+      external_price_id =
+        hash.key?('external_price_id') ? hash['external_price_id'] : SKIP
+      if hash['dimensional_price_configuration']
+        dimensional_price_configuration = NewDimensionalPriceConfiguration.from_hash(hash['dimensional_price_configuration'])
+      end
+      license_type_id =
+        hash.key?('license_type_id') ? hash['license_type_id'] : SKIP
+      billable_metric_id =
+        hash.key?('billable_metric_id') ? hash['billable_metric_id'] : SKIP
+      billed_in_advance =
+        hash.key?('billed_in_advance') ? hash['billed_in_advance'] : SKIP
+      fixed_price_quantity =
+        hash.key?('fixed_price_quantity') ? hash['fixed_price_quantity'] : SKIP
+      invoice_grouping_key =
+        hash.key?('invoice_grouping_key') ? hash['invoice_grouping_key'] : SKIP
+      if hash['billing_cycle_configuration']
+        billing_cycle_configuration = NewBillingCycleConfiguration.from_hash(hash['billing_cycle_configuration'])
+      end
+      if hash['invoicing_cycle_configuration']
+        invoicing_cycle_configuration = NewBillingCycleConfiguration.from_hash(hash['invoicing_cycle_configuration'])
+      end
+      conversion_rate =
+        hash.key?('conversion_rate') ? hash['conversion_rate'] : SKIP
+      conversion_rate_config =
+        hash.key?('conversion_rate_config') ? hash['conversion_rate_config'] : SKIP
+      currency = hash.key?('currency') ? hash['currency'] : SKIP
+      reference_id = hash.key?('reference_id') ? hash['reference_id'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      NewPlanBulkPrice.new(bulk_config: bulk_config,
+                           name: name,
+                           item_id: item_id,
+                           cadence: cadence,
+                           metadata: metadata,
+                           external_price_id: external_price_id,
+                           dimensional_price_configuration: dimensional_price_configuration,
+                           license_type_id: license_type_id,
+                           billable_metric_id: billable_metric_id,
+                           billed_in_advance: billed_in_advance,
+                           fixed_price_quantity: fixed_price_quantity,
+                           invoice_grouping_key: invoice_grouping_key,
+                           billing_cycle_configuration: billing_cycle_configuration,
+                           invoicing_cycle_configuration: invoicing_cycle_configuration,
+                           conversion_rate: conversion_rate,
+                           conversion_rate_config: conversion_rate_config,
+                           currency: currency,
+                           reference_id: reference_id,
+                           additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} model_type: #{@model_type}, bulk_config: #{@bulk_config}, metadata:"\
+      " #{@metadata}, external_price_id: #{@external_price_id}, name: #{@name},"\
+      " dimensional_price_configuration: #{@dimensional_price_configuration}, license_type_id:"\
+      " #{@license_type_id}, billable_metric_id: #{@billable_metric_id}, item_id: #{@item_id},"\
+      " billed_in_advance: #{@billed_in_advance}, fixed_price_quantity: #{@fixed_price_quantity},"\
+      " invoice_grouping_key: #{@invoice_grouping_key}, cadence: #{@cadence},"\
+      " billing_cycle_configuration: #{@billing_cycle_configuration},"\
+      " invoicing_cycle_configuration: #{@invoicing_cycle_configuration}, conversion_rate:"\
+      " #{@conversion_rate}, conversion_rate_config: #{@conversion_rate_config}, currency:"\
+      " #{@currency}, reference_id: #{@reference_id}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} model_type: #{@model_type.inspect}, bulk_config: #{@bulk_config.inspect},"\
+      " metadata: #{@metadata.inspect}, external_price_id: #{@external_price_id.inspect}, name:"\
+      " #{@name.inspect}, dimensional_price_configuration:"\
+      " #{@dimensional_price_configuration.inspect}, license_type_id: #{@license_type_id.inspect},"\
+      " billable_metric_id: #{@billable_metric_id.inspect}, item_id: #{@item_id.inspect},"\
+      " billed_in_advance: #{@billed_in_advance.inspect}, fixed_price_quantity:"\
+      " #{@fixed_price_quantity.inspect}, invoice_grouping_key: #{@invoice_grouping_key.inspect},"\
+      " cadence: #{@cadence.inspect}, billing_cycle_configuration:"\
+      " #{@billing_cycle_configuration.inspect}, invoicing_cycle_configuration:"\
+      " #{@invoicing_cycle_configuration.inspect}, conversion_rate: #{@conversion_rate.inspect},"\
+      " conversion_rate_config: #{@conversion_rate_config.inspect}, currency:"\
+      " #{@currency.inspect}, reference_id: #{@reference_id.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end