orb-apiamtic-sdk 0.0.1

data/lib/api_reference/models/new_floating_unit_with_proration_price.rb

@@ -0,0 +1,336 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # NewFloatingUnitWithProrationPrice Model.
+  class NewFloatingUnitWithProrationPrice < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The pricing model type
+    # @return [String]
+    attr_reader :model_type
+
+    # Configuration for unit_with_proration pricing
+    # @return [UnitWithProrationConfig1]
+    attr_accessor :unit_with_proration_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 for which this price is billed in.
+    # @return [String]
+    attr_accessor :currency
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['model_type'] = 'model_type'
+      @_hash['unit_with_proration_config'] = 'unit_with_proration_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
+    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
+      ]
+    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
+      ]
+    end
+
+    def initialize(unit_with_proration_config:, name:, item_id:, cadence:,
+                   currency:, 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, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @model_type = 'unit_with_proration'
+      @unit_with_proration_config = unit_with_proration_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
+      @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.
+      if hash['unit_with_proration_config']
+        unit_with_proration_config = UnitWithProrationConfig1.from_hash(hash['unit_with_proration_config'])
+      end
+      name = hash.key?('name') ? hash['name'] : nil
+      item_id = hash.key?('item_id') ? hash['item_id'] : nil
+      cadence = hash.key?('cadence') ? hash['cadence'] : nil
+      currency = hash.key?('currency') ? hash['currency'] : 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
+
+      # 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.
+      NewFloatingUnitWithProrationPrice.new(unit_with_proration_config: unit_with_proration_config,
+                                            name: name,
+                                            item_id: item_id,
+                                            cadence: cadence,
+                                            currency: currency,
+                                            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,
+                                            additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [NewFloatingUnitWithProrationPrice | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.model_type,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.unit_with_proration_config,
+                                  ->(val) { UnitWithProrationConfig1.validate(val) },
+                                  is_model_hash: true) and
+            APIHelper.valid_type?(value.name,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.item_id,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.cadence,
+                                  ->(val) { Cadence.validate(val) }) and
+            APIHelper.valid_type?(value.currency,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['model_type'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['unit_with_proration_config'],
+                                ->(val) { UnitWithProrationConfig1.validate(val) },
+                                is_model_hash: true) and
+          APIHelper.valid_type?(value['name'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['item_id'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['cadence'],
+                                ->(val) { Cadence.validate(val) }) and
+          APIHelper.valid_type?(value['currency'],
+                                ->(val) { val.instance_of? String })
+      )
+    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}, unit_with_proration_config:"\
+      " #{@unit_with_proration_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}, 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}, unit_with_proration_config:"\
+      " #{@unit_with_proration_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}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/new_item.rb

@@ -0,0 +1,74 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # NewItem Model.
+  class NewItem < 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
+
+    # The name of the item.
+    # @return [String]
+    attr_accessor :name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['metadata'] = 'metadata'
+      @_hash['name'] = 'name'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        metadata
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        metadata
+      ]
+    end
+
+    def initialize(name:, metadata: SKIP)
+      @metadata = metadata unless metadata == SKIP
+      @name = name
+    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
+      metadata = hash.key?('metadata') ? hash['metadata'] : SKIP
+
+      # Create object from extracted values.
+      NewItem.new(name: name,
+                  metadata: metadata)
+    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}>"
+    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}>"
+    end
+  end
+end

data/lib/api_reference/models/new_license.rb

@@ -0,0 +1,108 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # NewLicense Model.
+  class NewLicense < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :subscription_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :license_type_id
+
+    # The external identifier for the license.
+    # @return [String]
+    attr_accessor :external_license_id
+
+    # The start date of the license. If not provided, defaults to start of day
+    # today in the customer's timezone.
+    # @return [Date]
+    attr_accessor :start_date
+
+    # The end date of the license. If not provided, the license will remain
+    # active until deactivated.
+    # @return [Date]
+    attr_accessor :end_date
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['subscription_id'] = 'subscription_id'
+      @_hash['license_type_id'] = 'license_type_id'
+      @_hash['external_license_id'] = 'external_license_id'
+      @_hash['start_date'] = 'start_date'
+      @_hash['end_date'] = 'end_date'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        start_date
+        end_date
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        start_date
+        end_date
+      ]
+    end
+
+    def initialize(subscription_id:, license_type_id:, external_license_id:,
+                   start_date: SKIP, end_date: SKIP)
+      @subscription_id = subscription_id
+      @license_type_id = license_type_id
+      @external_license_id = external_license_id
+      @start_date = start_date unless start_date == SKIP
+      @end_date = end_date unless end_date == 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.
+      subscription_id =
+        hash.key?('subscription_id') ? hash['subscription_id'] : nil
+      license_type_id =
+        hash.key?('license_type_id') ? hash['license_type_id'] : nil
+      external_license_id =
+        hash.key?('external_license_id') ? hash['external_license_id'] : nil
+      start_date = hash.key?('start_date') ? hash['start_date'] : SKIP
+      end_date = hash.key?('end_date') ? hash['end_date'] : SKIP
+
+      # Create object from extracted values.
+      NewLicense.new(subscription_id: subscription_id,
+                     license_type_id: license_type_id,
+                     external_license_id: external_license_id,
+                     start_date: start_date,
+                     end_date: end_date)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} subscription_id: #{@subscription_id}, license_type_id: #{@license_type_id},"\
+      " external_license_id: #{@external_license_id}, start_date: #{@start_date}, end_date:"\
+      " #{@end_date}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} subscription_id: #{@subscription_id.inspect}, license_type_id:"\
+      " #{@license_type_id.inspect}, external_license_id: #{@external_license_id.inspect},"\
+      " start_date: #{@start_date.inspect}, end_date: #{@end_date.inspect}>"
+    end
+  end
+end

data/lib/api_reference/models/new_license_allocation.rb

@@ -0,0 +1,97 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # NewLicenseAllocation Model.
+  class NewLicenseAllocation < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The currency of the license allocation.
+    # @return [String]
+    attr_accessor :currency
+
+    # The amount of credits granted per active license per cadence.
+    # @return [String]
+    attr_accessor :amount
+
+    # When True, overage beyond the allocation is written off.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :write_off_overage
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['currency'] = 'currency'
+      @_hash['amount'] = 'amount'
+      @_hash['write_off_overage'] = 'write_off_overage'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        write_off_overage
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        write_off_overage
+      ]
+    end
+
+    def initialize(currency:, amount:, write_off_overage: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @currency = currency
+      @amount = amount
+      @write_off_overage = write_off_overage unless write_off_overage == 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.
+      currency = hash.key?('currency') ? hash['currency'] : nil
+      amount = hash.key?('amount') ? hash['amount'] : nil
+      write_off_overage =
+        hash.key?('write_off_overage') ? hash['write_off_overage'] : 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.
+      NewLicenseAllocation.new(currency: currency,
+                               amount: amount,
+                               write_off_overage: write_off_overage,
+                               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} currency: #{@currency}, amount: #{@amount}, write_off_overage:"\
+      " #{@write_off_overage}, 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} currency: #{@currency.inspect}, amount: #{@amount.inspect},"\
+      " write_off_overage: #{@write_off_overage.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end