orb-apiamtic-sdk 0.0.1

data/lib/api_reference/models/new_coupon_amount_discount.rb

@@ -0,0 +1,103 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # NewCouponAmountDiscount Model.
+  class NewCouponAmountDiscount < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_reader :discount_type
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :amount_discount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['discount_type'] = 'discount_type'
+      @_hash['amount_discount'] = 'amount_discount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(amount_discount:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @discount_type = 'amount'
+      @amount_discount = amount_discount
+      @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.
+      amount_discount =
+        hash.key?('amount_discount') ? hash['amount_discount'] : nil
+
+      # 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.
+      NewCouponAmountDiscount.new(amount_discount: amount_discount,
+                                  additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [NewCouponAmountDiscount | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.discount_type,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.amount_discount,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['discount_type'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['amount_discount'],
+                                ->(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} discount_type: #{@discount_type}, amount_discount: #{@amount_discount},"\
+      " 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} discount_type: #{@discount_type.inspect}, amount_discount:"\
+      " #{@amount_discount.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/new_coupon_percentage_discount.rb

@@ -0,0 +1,103 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # NewCouponPercentageDiscount Model.
+  class NewCouponPercentageDiscount < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_reader :discount_type
+
+    # TODO: Write general description for this method
+    # @return [Float]
+    attr_accessor :percentage_discount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['discount_type'] = 'discount_type'
+      @_hash['percentage_discount'] = 'percentage_discount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(percentage_discount:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @discount_type = 'percentage'
+      @percentage_discount = percentage_discount
+      @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.
+      percentage_discount =
+        hash.key?('percentage_discount') ? hash['percentage_discount'] : nil
+
+      # 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.
+      NewCouponPercentageDiscount.new(percentage_discount: percentage_discount,
+                                      additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [NewCouponPercentageDiscount | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.discount_type,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.percentage_discount,
+                                  ->(val) { val.instance_of? Float })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['discount_type'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['percentage_discount'],
+                                ->(val) { val.instance_of? Float })
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} discount_type: #{@discount_type}, percentage_discount:"\
+      " #{@percentage_discount}, 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} discount_type: #{@discount_type.inspect}, percentage_discount:"\
+      " #{@percentage_discount.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/new_customer.rb

@@ -0,0 +1,333 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # NewCustomer Model.
+  class NewCustomer < 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 full name of the customer
+    # @return [String]
+    attr_accessor :name
+
+    # A valid customer email, to be used for notifications. When Orb triggers
+    # payment through a payment gateway, this email will be used for any
+    # automatically issued receipts.
+    # @return [String]
+    attr_accessor :email
+
+    # A timezone identifier from the IANA timezone database, such as
+    # `"America/Los_Angeles"`. This defaults to your account's timezone if not
+    # set. This cannot be changed after customer creation.
+    # @return [String]
+    attr_accessor :timezone
+
+    # An optional user-defined ID for this customer resource, used throughout
+    # the system as an alias for this Customer. Use this field to identify a
+    # customer by an existing identifier in your system.
+    # @return [String]
+    attr_accessor :external_customer_id
+
+    # The ID of this customer in an external payments solution, such as Stripe.
+    # This is used for creating charges or invoices in the external system via
+    # Orb.
+    # @return [String]
+    attr_accessor :payment_provider_id
+
+    # This is used for creating charges or invoices in an external system via
+    # Orb. When not in test mode, the connection must first be configured in the
+    # Orb webapp.
+    # @return [PaymentProvider1]
+    attr_accessor :payment_provider
+
+    # This is used for creating charges or invoices in an external system via
+    # Orb. When not in test mode, the connection must first be configured in the
+    # Orb webapp.
+    # @return [AddressInput]
+    attr_accessor :shipping_address
+
+    # This is used for creating charges or invoices in an external system via
+    # Orb. When not in test mode, the connection must first be configured in the
+    # Orb webapp.
+    # @return [AddressInput]
+    attr_accessor :billing_address
+
+    # An ISO 4217 currency string used for the customer's invoices and balance.
+    # If not set at creation time, will be set at subscription creation time.
+    # @return [String]
+    attr_accessor :currency
+
+    # An ISO 4217 currency string used for the customer's invoices and balance.
+    # If not set at creation time, will be set at subscription creation time.
+    # @return [CustomerTaxId]
+    attr_accessor :tax_id
+
+    # Used to determine if invoices for this customer will automatically attempt
+    # to charge a saved payment method, if available. This parameter defaults to
+    # `True` when a payment provider is provided on customer creation.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :auto_collection
+
+    # Used to determine if invoices for this customer will be automatically
+    # issued. If true, invoices will be automatically issued. If false, invoices
+    # will require manual approval. If `null` is specified, the customer's auto
+    # issuance setting will be inherited from the account-level setting.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :auto_issuance
+
+    # Used to determine if invoices for this customer will be automatically
+    # issued. If true, invoices will be automatically issued. If false, invoices
+    # will require manual approval. If `null` is specified, the customer's auto
+    # issuance setting will be inherited from the account-level setting.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :email_delivery
+
+    # Used to determine if invoices for this customer will be automatically
+    # issued. If true, invoices will be automatically issued. If false, invoices
+    # will require manual approval. If `null` is specified, the customer's auto
+    # issuance setting will be inherited from the account-level setting.
+    # @return [Object]
+    attr_accessor :tax_configuration
+
+    # Used to determine if invoices for this customer will be automatically
+    # issued. If true, invoices will be automatically issued. If false, invoices
+    # will require manual approval. If `null` is specified, the customer's auto
+    # issuance setting will be inherited from the account-level setting.
+    # @return [NewReportingConfiguration]
+    attr_accessor :reporting_configuration
+
+    # Used to determine if invoices for this customer will be automatically
+    # issued. If true, invoices will be automatically issued. If false, invoices
+    # will require manual approval. If `null` is specified, the customer's auto
+    # issuance setting will be inherited from the account-level setting.
+    # @return [NewAccountingSyncConfiguration]
+    attr_accessor :accounting_sync_configuration
+
+    # Additional email addresses for this customer. If populated, these email
+    # addresses will be CC'd for customer communications. The total number of
+    # email addresses (including the primary email) cannot exceed 50.
+    # @return [Array[String]]
+    attr_accessor :additional_emails
+
+    # The hierarchical relationships for this customer.
+    # @return [CustomerHierarchyConfig]
+    attr_accessor :hierarchy
+
+    # Payment configuration for the customer, applicable when using Orb
+    # Invoicing with a supported payment provider such as Stripe.
+    # @return [PaymentConfiguration]
+    attr_accessor :payment_configuration
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['metadata'] = 'metadata'
+      @_hash['name'] = 'name'
+      @_hash['email'] = 'email'
+      @_hash['timezone'] = 'timezone'
+      @_hash['external_customer_id'] = 'external_customer_id'
+      @_hash['payment_provider_id'] = 'payment_provider_id'
+      @_hash['payment_provider'] = 'payment_provider'
+      @_hash['shipping_address'] = 'shipping_address'
+      @_hash['billing_address'] = 'billing_address'
+      @_hash['currency'] = 'currency'
+      @_hash['tax_id'] = 'tax_id'
+      @_hash['auto_collection'] = 'auto_collection'
+      @_hash['auto_issuance'] = 'auto_issuance'
+      @_hash['email_delivery'] = 'email_delivery'
+      @_hash['tax_configuration'] = 'tax_configuration'
+      @_hash['reporting_configuration'] = 'reporting_configuration'
+      @_hash['accounting_sync_configuration'] =
+        'accounting_sync_configuration'
+      @_hash['additional_emails'] = 'additional_emails'
+      @_hash['hierarchy'] = 'hierarchy'
+      @_hash['payment_configuration'] = 'payment_configuration'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        metadata
+        timezone
+        external_customer_id
+        payment_provider_id
+        payment_provider
+        shipping_address
+        billing_address
+        currency
+        tax_id
+        auto_collection
+        auto_issuance
+        email_delivery
+        tax_configuration
+        reporting_configuration
+        accounting_sync_configuration
+        additional_emails
+        hierarchy
+        payment_configuration
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        metadata
+        timezone
+        external_customer_id
+        payment_provider_id
+        payment_provider
+        shipping_address
+        billing_address
+        currency
+        tax_id
+        auto_collection
+        auto_issuance
+        email_delivery
+        tax_configuration
+        reporting_configuration
+        accounting_sync_configuration
+        additional_emails
+        hierarchy
+        payment_configuration
+      ]
+    end
+
+    def initialize(name:, email:, metadata: SKIP, timezone: SKIP,
+                   external_customer_id: SKIP, payment_provider_id: SKIP,
+                   payment_provider: SKIP, shipping_address: SKIP,
+                   billing_address: SKIP, currency: SKIP, tax_id: SKIP,
+                   auto_collection: SKIP, auto_issuance: SKIP,
+                   email_delivery: SKIP, tax_configuration: SKIP,
+                   reporting_configuration: SKIP,
+                   accounting_sync_configuration: SKIP, additional_emails: SKIP,
+                   hierarchy: SKIP, payment_configuration: SKIP)
+      @metadata = metadata unless metadata == SKIP
+      @name = name
+      @email = email
+      @timezone = timezone unless timezone == SKIP
+      @external_customer_id = external_customer_id unless external_customer_id == SKIP
+      @payment_provider_id = payment_provider_id unless payment_provider_id == SKIP
+      @payment_provider = payment_provider unless payment_provider == SKIP
+      @shipping_address = shipping_address unless shipping_address == SKIP
+      @billing_address = billing_address unless billing_address == SKIP
+      @currency = currency unless currency == SKIP
+      @tax_id = tax_id unless tax_id == SKIP
+      @auto_collection = auto_collection unless auto_collection == SKIP
+      @auto_issuance = auto_issuance unless auto_issuance == SKIP
+      @email_delivery = email_delivery unless email_delivery == SKIP
+      @tax_configuration = tax_configuration unless tax_configuration == SKIP
+      @reporting_configuration = reporting_configuration unless reporting_configuration == SKIP
+      unless accounting_sync_configuration == SKIP
+        @accounting_sync_configuration =
+          accounting_sync_configuration
+      end
+      @additional_emails = additional_emails unless additional_emails == SKIP
+      @hierarchy = hierarchy unless hierarchy == SKIP
+      @payment_configuration = payment_configuration unless payment_configuration == 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
+      email = hash.key?('email') ? hash['email'] : nil
+      metadata = hash.key?('metadata') ? hash['metadata'] : SKIP
+      timezone = hash.key?('timezone') ? hash['timezone'] : SKIP
+      external_customer_id =
+        hash.key?('external_customer_id') ? hash['external_customer_id'] : SKIP
+      payment_provider_id =
+        hash.key?('payment_provider_id') ? hash['payment_provider_id'] : SKIP
+      payment_provider =
+        hash.key?('payment_provider') ? hash['payment_provider'] : SKIP
+      shipping_address = AddressInput.from_hash(hash['shipping_address']) if
+        hash['shipping_address']
+      billing_address = AddressInput.from_hash(hash['billing_address']) if hash['billing_address']
+      currency = hash.key?('currency') ? hash['currency'] : SKIP
+      tax_id = CustomerTaxId.from_hash(hash['tax_id']) if hash['tax_id']
+      auto_collection =
+        hash.key?('auto_collection') ? hash['auto_collection'] : SKIP
+      auto_issuance = hash.key?('auto_issuance') ? hash['auto_issuance'] : SKIP
+      email_delivery =
+        hash.key?('email_delivery') ? hash['email_delivery'] : SKIP
+      tax_configuration =
+        hash.key?('tax_configuration') ? hash['tax_configuration'] : SKIP
+      if hash['reporting_configuration']
+        reporting_configuration = NewReportingConfiguration.from_hash(hash['reporting_configuration'])
+      end
+      if hash['accounting_sync_configuration']
+        accounting_sync_configuration = NewAccountingSyncConfiguration.from_hash(hash['accounting_sync_configuration'])
+      end
+      additional_emails =
+        hash.key?('additional_emails') ? hash['additional_emails'] : SKIP
+      hierarchy = CustomerHierarchyConfig.from_hash(hash['hierarchy']) if hash['hierarchy']
+      payment_configuration = PaymentConfiguration.from_hash(hash['payment_configuration']) if
+        hash['payment_configuration']
+
+      # Create object from extracted values.
+      NewCustomer.new(name: name,
+                      email: email,
+                      metadata: metadata,
+                      timezone: timezone,
+                      external_customer_id: external_customer_id,
+                      payment_provider_id: payment_provider_id,
+                      payment_provider: payment_provider,
+                      shipping_address: shipping_address,
+                      billing_address: billing_address,
+                      currency: currency,
+                      tax_id: tax_id,
+                      auto_collection: auto_collection,
+                      auto_issuance: auto_issuance,
+                      email_delivery: email_delivery,
+                      tax_configuration: tax_configuration,
+                      reporting_configuration: reporting_configuration,
+                      accounting_sync_configuration: accounting_sync_configuration,
+                      additional_emails: additional_emails,
+                      hierarchy: hierarchy,
+                      payment_configuration: payment_configuration)
+    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}, email: #{@email}, timezone:"\
+      " #{@timezone}, external_customer_id: #{@external_customer_id}, payment_provider_id:"\
+      " #{@payment_provider_id}, payment_provider: #{@payment_provider}, shipping_address:"\
+      " #{@shipping_address}, billing_address: #{@billing_address}, currency: #{@currency},"\
+      " tax_id: #{@tax_id}, auto_collection: #{@auto_collection}, auto_issuance:"\
+      " #{@auto_issuance}, email_delivery: #{@email_delivery}, tax_configuration:"\
+      " #{@tax_configuration}, reporting_configuration: #{@reporting_configuration},"\
+      " accounting_sync_configuration: #{@accounting_sync_configuration}, additional_emails:"\
+      " #{@additional_emails}, hierarchy: #{@hierarchy}, payment_configuration:"\
+      " #{@payment_configuration}>"
+    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}, email:"\
+      " #{@email.inspect}, timezone: #{@timezone.inspect}, external_customer_id:"\
+      " #{@external_customer_id.inspect}, payment_provider_id: #{@payment_provider_id.inspect},"\
+      " payment_provider: #{@payment_provider.inspect}, shipping_address:"\
+      " #{@shipping_address.inspect}, billing_address: #{@billing_address.inspect}, currency:"\
+      " #{@currency.inspect}, tax_id: #{@tax_id.inspect}, auto_collection:"\
+      " #{@auto_collection.inspect}, auto_issuance: #{@auto_issuance.inspect}, email_delivery:"\
+      " #{@email_delivery.inspect}, tax_configuration: #{@tax_configuration.inspect},"\
+      " reporting_configuration: #{@reporting_configuration.inspect},"\
+      " accounting_sync_configuration: #{@accounting_sync_configuration.inspect},"\
+      " additional_emails: #{@additional_emails.inspect}, hierarchy: #{@hierarchy.inspect},"\
+      " payment_configuration: #{@payment_configuration.inspect}>"
+    end
+  end
+end

data/lib/api_reference/models/new_customer_balance_transaction.rb

@@ -0,0 +1,81 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # NewCustomerBalanceTransaction Model.
+  class NewCustomerBalanceTransaction < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :amount
+
+    # TODO: Write general description for this method
+    # @return [Type4]
+    attr_accessor :type
+
+    # An optional description that can be specified around this entry.
+    # @return [String]
+    attr_accessor :description
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['amount'] = 'amount'
+      @_hash['type'] = 'type'
+      @_hash['description'] = 'description'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        description
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        description
+      ]
+    end
+
+    def initialize(amount:, type:, description: SKIP)
+      @amount = amount
+      @type = type
+      @description = description unless description == 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.
+      amount = hash.key?('amount') ? hash['amount'] : nil
+      type = hash.key?('type') ? hash['type'] : nil
+      description = hash.key?('description') ? hash['description'] : SKIP
+
+      # Create object from extracted values.
+      NewCustomerBalanceTransaction.new(amount: amount,
+                                        type: type,
+                                        description: description)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount: #{@amount}, type: #{@type}, description: #{@description}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount: #{@amount.inspect}, type: #{@type.inspect}, description:"\
+      " #{@description.inspect}>"
+    end
+  end
+end