subtain-apimatic-sdk 4.1.1 → 9.1.1

data/lib/advanced_billing/models/metadata.rb

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

data/lib/advanced_billing/models/metafield.rb

@@ -0,0 +1,112 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Metafield Model.
+  class Metafield < 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
+
+    # the amount of subscriptions this metafield has been applied to in Chargify
+    # @return [Integer]
+    attr_accessor :data_count
+
+    # the amount of subscriptions this metafield has been applied to in Chargify
+    # @return [String]
+    attr_accessor :input_type
+
+    # the amount of subscriptions this metafield has been applied to in Chargify
+    # @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['data_count'] = 'data_count'
+      @_hash['input_type'] = 'input_type'
+      @_hash['enum'] = 'enum'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        name
+        scope
+        data_count
+        input_type
+        enum
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        enum
+      ]
+    end
+
+    def initialize(id = SKIP, name = SKIP, scope = SKIP, data_count = SKIP,
+                   input_type = SKIP, enum = SKIP)
+      @id = id unless id == SKIP
+      @name = name unless name == SKIP
+      @scope = scope unless scope == SKIP
+      @data_count = data_count unless data_count == 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']
+      data_count = hash.key?('data_count') ? hash['data_count'] : SKIP
+      input_type = hash.key?('input_type') ? hash['input_type'] : SKIP
+      enum = hash.key?('enum') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:MetafieldEnum), hash['enum']
+      ) : SKIP
+
+      # Create object from extracted values.
+      Metafield.new(id,
+                    name,
+                    scope,
+                    data_count,
+                    input_type,
+                    enum)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Metafield | 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/metafield_input.rb

@@ -0,0 +1,32 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # 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.
+  class MetafieldInput
+    METAFIELD_INPUT = [
+      # TODO: Write general description for BALANCE_TRACKER
+      BALANCE_TRACKER = 'balance_tracker'.freeze,
+
+      # TODO: Write general description for TEXT
+      TEXT = 'text'.freeze,
+
+      # TODO: Write general description for RADIO
+      RADIO = 'radio'.freeze,
+
+      # TODO: Write general description for DROPDOWN
+      DROPDOWN = 'dropdown'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      METAFIELD_INPUT.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/metafield_scope.rb

@@ -0,0 +1,119 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Warning: When updating a metafield's scope attribute, all scope attributes
+  # must be passed. Partially complete scope attributes will override the
+  # existing settings.
+  class MetafieldScope < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Include (1) or exclude (0) metafields from the csv export.
+    # @return [IncludeOption]
+    attr_accessor :csv
+
+    # Include (1) or exclude (0) metafields from invoices.
+    # @return [IncludeOption]
+    attr_accessor :invoices
+
+    # Include (1) or exclude (0) metafields from statements.
+    # @return [IncludeOption]
+    attr_accessor :statements
+
+    # Include (1) or exclude (0) metafields from the portal.
+    # @return [IncludeOption]
+    attr_accessor :portal
+
+    # Include (1) or exclude (0) metafields from being viewable by your
+    # ecosystem.
+    # @return [IncludeOption]
+    attr_accessor :public_show
+
+    # Include (1) or exclude (0) metafields from being edited by your ecosystem.
+    # @return [IncludeOption]
+    attr_accessor :public_edit
+
+    # Include (1) or exclude (0) metafields from being edited by your ecosystem.
+    # @return [Array[String]]
+    attr_accessor :hosted
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['csv'] = 'csv'
+      @_hash['invoices'] = 'invoices'
+      @_hash['statements'] = 'statements'
+      @_hash['portal'] = 'portal'
+      @_hash['public_show'] = 'public_show'
+      @_hash['public_edit'] = 'public_edit'
+      @_hash['hosted'] = 'hosted'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        csv
+        invoices
+        statements
+        portal
+        public_show
+        public_edit
+        hosted
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(csv = SKIP, invoices = SKIP, statements = SKIP,
+                   portal = SKIP, public_show = SKIP, public_edit = SKIP,
+                   hosted = SKIP)
+      @csv = csv unless csv == SKIP
+      @invoices = invoices unless invoices == SKIP
+      @statements = statements unless statements == SKIP
+      @portal = portal unless portal == SKIP
+      @public_show = public_show unless public_show == SKIP
+      @public_edit = public_edit unless public_edit == SKIP
+      @hosted = hosted unless hosted == 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.
+      csv = hash.key?('csv') ? hash['csv'] : SKIP
+      invoices = hash.key?('invoices') ? hash['invoices'] : SKIP
+      statements = hash.key?('statements') ? hash['statements'] : SKIP
+      portal = hash.key?('portal') ? hash['portal'] : SKIP
+      public_show = hash.key?('public_show') ? hash['public_show'] : SKIP
+      public_edit = hash.key?('public_edit') ? hash['public_edit'] : SKIP
+      hosted = hash.key?('hosted') ? hash['hosted'] : SKIP
+
+      # Create object from extracted values.
+      MetafieldScope.new(csv,
+                         invoices,
+                         statements,
+                         portal,
+                         public_show,
+                         public_edit,
+                         hosted)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [MetafieldScope | 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/metafields.rb

@@ -0,0 +1,103 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Metafields Model.
+  class Metafields < 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.
+      Metafields.new(id,
+                     name,
+                     scope,
+                     input_type,
+                     enum)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Metafields | 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/metafields1.rb

@@ -0,0 +1,103 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Metafields1 Model.
+  class Metafields1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :current_name
+
+    # 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['current_name'] = 'current_name'
+      @_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[
+        current_name
+        name
+        scope
+        input_type
+        enum
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(current_name = SKIP, name = SKIP, scope = SKIP,
+                   input_type = MetafieldInput::TEXT, enum = SKIP)
+      @current_name = current_name unless current_name == 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.
+      current_name = hash.key?('current_name') ? hash['current_name'] : 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.
+      Metafields1.new(current_name,
+                      name,
+                      scope,
+                      input_type,
+                      enum)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Metafields1 | 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