subtain-apimatic-sdk 4.1.1 → 9.1.1

data/lib/advanced_billing/models/create_metadata.rb

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

data/lib/advanced_billing/models/create_metadata_request.rb

@@ -0,0 +1,57 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # CreateMetadataRequest Model.
+  class CreateMetadataRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[CreateMetadata]]
+    attr_accessor :metadata
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['metadata'] = 'metadata'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(metadata = nil)
+      @metadata = metadata
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      # Parameter is an array, so we need to iterate through it
+      metadata = nil
+      unless hash['metadata'].nil?
+        metadata = []
+        hash['metadata'].each do |structure|
+          metadata << (CreateMetadata.from_hash(structure) if structure)
+        end
+      end
+
+      metadata = nil unless hash.key?('metadata')
+
+      # Create object from extracted values.
+      CreateMetadataRequest.new(metadata)
+    end
+  end
+end

data/lib/advanced_billing/models/create_metafield.rb

@@ -0,0 +1,103 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # CreateMetafield Model.
+  class CreateMetafield < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Float]
+    attr_accessor :id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :name
+
+    # Warning: When updating a metafield's scope attribute, all scope attributes
+    # must be passed. Partially complete scope attributes will override the
+    # existing settings.
+    # @return [MetafieldScope]
+    attr_accessor :scope
+
+    # Indicates how data should be added to the metafield. For example, a text
+    # type is just a string, so a given metafield of this type can have any
+    # value attached. On the other hand, dropdown and radio have a set of
+    # allowed values that can be input, and appear differently on a Public
+    # Signup Page.
+    # @return [MetafieldInput]
+    attr_accessor :input_type
+
+    # Only applicable when input_type is radio or dropdown
+    # @return [Array[String]]
+    attr_accessor :enum
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['name'] = 'name'
+      @_hash['scope'] = 'scope'
+      @_hash['input_type'] = 'input_type'
+      @_hash['enum'] = 'enum'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        name
+        scope
+        input_type
+        enum
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = SKIP, name = SKIP, scope = SKIP,
+                   input_type = MetafieldInput::TEXT, enum = SKIP)
+      @id = id unless id == SKIP
+      @name = name unless name == SKIP
+      @scope = scope unless scope == SKIP
+      @input_type = input_type unless input_type == SKIP
+      @enum = enum unless enum == 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
+      scope = MetafieldScope.from_hash(hash['scope']) if hash['scope']
+      input_type = hash['input_type'] ||= MetafieldInput::TEXT
+      enum = hash.key?('enum') ? hash['enum'] : SKIP
+
+      # Create object from extracted values.
+      CreateMetafield.new(id,
+                          name,
+                          scope,
+                          input_type,
+                          enum)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CreateMetafield | 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/create_metafields_request.rb

@@ -0,0 +1,64 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # CreateMetafieldsRequest Model.
+  class CreateMetafieldsRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Metafields]
+    attr_accessor :metafields
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['metafields'] = 'metafields'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(metafields = nil)
+      @metafields = metafields
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      metafields = hash.key?('metafields') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:CreateMetafieldsRequestMetafields), hash['metafields']
+      ) : nil
+
+      # Create object from extracted values.
+      CreateMetafieldsRequest.new(metafields)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CreateMetafieldsRequest | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return UnionTypeLookUp.get(:CreateMetafieldsRequestMetafields)
+                              .validate(value.metafields)
+      end
+
+      return false unless value.instance_of? Hash
+
+      UnionTypeLookUp.get(:CreateMetafieldsRequestMetafields)
+                     .validate(value['metafields'])
+    end
+  end
+end

data/lib/advanced_billing/models/create_metered_component.rb

@@ -0,0 +1,65 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # CreateMeteredComponent Model.
+  class CreateMeteredComponent < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [MeteredComponent]
+    attr_accessor :metered_component
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['metered_component'] = 'metered_component'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(metered_component = nil)
+      @metered_component = metered_component
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      metered_component = MeteredComponent.from_hash(hash['metered_component']) if
+        hash['metered_component']
+
+      # Create object from extracted values.
+      CreateMeteredComponent.new(metered_component)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CreateMeteredComponent | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.metered_component,
+                                     ->(val) { MeteredComponent.validate(val) },
+                                     is_model_hash: true)
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['metered_component'],
+                            ->(val) { MeteredComponent.validate(val) },
+                            is_model_hash: true)
+    end
+  end
+end

data/lib/advanced_billing/models/create_multi_invoice_payment.rb

@@ -0,0 +1,134 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # CreateMultiInvoicePayment Model.
+  class CreateMultiInvoicePayment < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A description to be attached to the payment.
+    # @return [String]
+    attr_accessor :memo
+
+    # Additional information related to the payment method (eg. Check #).
+    # @return [String]
+    attr_accessor :details
+
+    # The type of payment method used.
+    # @return [InvoicePaymentMethodType]
+    attr_accessor :method
+
+    # Dollar amount of the sum of the invoices payment (eg. "10.50" => $10.50).
+    # @return [Object]
+    attr_accessor :amount
+
+    # Date reflecting when the payment was received from a customer. Must be in
+    # the past.
+    # @return [String]
+    attr_accessor :received_on
+
+    # Date reflecting when the payment was received from a customer. Must be in
+    # the past.
+    # @return [Array[CreateInvoicePaymentApplication]]
+    attr_accessor :applications
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['memo'] = 'memo'
+      @_hash['details'] = 'details'
+      @_hash['method'] = 'method'
+      @_hash['amount'] = 'amount'
+      @_hash['received_on'] = 'received_on'
+      @_hash['applications'] = 'applications'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        memo
+        details
+        method
+        received_on
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(amount = nil, applications = nil, memo = SKIP,
+                   details = SKIP, method = InvoicePaymentMethodType::OTHER,
+                   received_on = SKIP)
+      @memo = memo unless memo == SKIP
+      @details = details unless details == SKIP
+      @method = method unless method == SKIP
+      @amount = amount
+      @received_on = received_on unless received_on == SKIP
+      @applications = applications
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      amount = hash.key?('amount') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:CreateMultiInvoicePaymentAmount), hash['amount']
+      ) : nil
+      # Parameter is an array, so we need to iterate through it
+      applications = nil
+      unless hash['applications'].nil?
+        applications = []
+        hash['applications'].each do |structure|
+          applications << (CreateInvoicePaymentApplication.from_hash(structure) if structure)
+        end
+      end
+
+      applications = nil unless hash.key?('applications')
+      memo = hash.key?('memo') ? hash['memo'] : SKIP
+      details = hash.key?('details') ? hash['details'] : SKIP
+      method = hash['method'] ||= InvoicePaymentMethodType::OTHER
+      received_on = hash.key?('received_on') ? hash['received_on'] : SKIP
+
+      # Create object from extracted values.
+      CreateMultiInvoicePayment.new(amount,
+                                    applications,
+                                    memo,
+                                    details,
+                                    method,
+                                    received_on)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CreateMultiInvoicePayment | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          UnionTypeLookUp.get(:CreateMultiInvoicePaymentAmount)
+                         .validate(value.amount) and
+            APIHelper.valid_type?(value.applications,
+                                  ->(val) { CreateInvoicePaymentApplication.validate(val) },
+                                  is_model_hash: true,
+                                  is_inner_model_hash: true)
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        UnionTypeLookUp.get(:CreateMultiInvoicePaymentAmount)
+                       .validate(value['amount']) and
+          APIHelper.valid_type?(value['applications'],
+                                ->(val) { CreateInvoicePaymentApplication.validate(val) },
+                                is_model_hash: true,
+                                is_inner_model_hash: true)
+      )
+    end
+  end
+end

data/lib/advanced_billing/models/create_multi_invoice_payment_request.rb

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

data/lib/advanced_billing/models/create_offer.rb

@@ -0,0 +1,116 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # CreateOffer Model.
+  class CreateOffer < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :name
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :handle
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :description
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :product_id
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :product_price_point_id
+
+    # TODO: Write general description for this method
+    # @return [Array[CreateOfferComponent]]
+    attr_accessor :components
+
+    # TODO: Write general description for this method
+    # @return [Array[String]]
+    attr_accessor :coupons
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['handle'] = 'handle'
+      @_hash['description'] = 'description'
+      @_hash['product_id'] = 'product_id'
+      @_hash['product_price_point_id'] = 'product_price_point_id'
+      @_hash['components'] = 'components'
+      @_hash['coupons'] = 'coupons'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        handle
+        description
+        product_id
+        product_price_point_id
+        components
+        coupons
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name = SKIP, handle = SKIP, description = SKIP,
+                   product_id = SKIP, product_price_point_id = SKIP,
+                   components = SKIP, coupons = SKIP)
+      @name = name unless name == SKIP
+      @handle = handle unless handle == SKIP
+      @description = description unless description == SKIP
+      @product_id = product_id unless product_id == SKIP
+      @product_price_point_id = product_price_point_id unless product_price_point_id == SKIP
+      @components = components unless components == SKIP
+      @coupons = coupons unless coupons == 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'] : SKIP
+      handle = hash.key?('handle') ? hash['handle'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      product_id = hash.key?('product_id') ? hash['product_id'] : SKIP
+      product_price_point_id =
+        hash.key?('product_price_point_id') ? hash['product_price_point_id'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      components = nil
+      unless hash['components'].nil?
+        components = []
+        hash['components'].each do |structure|
+          components << (CreateOfferComponent.from_hash(structure) if structure)
+        end
+      end
+
+      components = SKIP unless hash.key?('components')
+      coupons = hash.key?('coupons') ? hash['coupons'] : SKIP
+
+      # Create object from extracted values.
+      CreateOffer.new(name,
+                      handle,
+                      description,
+                      product_id,
+                      product_price_point_id,
+                      components,
+                      coupons)
+    end
+  end
+end