subtain-apimatic-sdk 4.1.1 → 9.1.1

data/lib/advanced_billing/exceptions/single_string_error_response_exception.rb

@@ -0,0 +1,32 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Single String Error Response class.
+  class SingleStringErrorResponseException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :errors
+
+    # The constructor.
+    # @param [String] The reason for raising an exception.
+    # @param [HttpResponse] The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      @errors = hash.key?('errors') ? hash['errors'] : SKIP
+    end
+  end
+end

data/lib/advanced_billing/exceptions/subscription_add_coupon_error_exception.rb

@@ -0,0 +1,42 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Subscription Add Coupon Error class.
+  class SubscriptionAddCouponErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[String]]
+    attr_accessor :codes
+
+    # TODO: Write general description for this method
+    # @return [Array[String]]
+    attr_accessor :coupon_codes
+
+    # TODO: Write general description for this method
+    # @return [Array[String]]
+    attr_accessor :subscription
+
+    # The constructor.
+    # @param [String] The reason for raising an exception.
+    # @param [HttpResponse] The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      @codes = hash.key?('codes') ? hash['codes'] : SKIP
+      @coupon_codes = hash.key?('coupon_codes') ? hash['coupon_codes'] : SKIP
+      @subscription = hash.key?('subscription') ? hash['subscription'] : SKIP
+    end
+  end
+end

data/lib/advanced_billing/exceptions/subscription_component_allocation_error_exception.rb

@@ -0,0 +1,41 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Subscription Component Allocation Error class.
+  class SubscriptionComponentAllocationErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[SubscriptionComponentAllocationErrorItem]]
+    attr_accessor :errors
+
+    # The constructor.
+    # @param [String] The reason for raising an exception.
+    # @param [HttpResponse] The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      # Parameter is an array, so we need to iterate through it
+      @errors = nil
+      unless hash['errors'].nil?
+        @errors = []
+        hash['errors'].each do |structure|
+          @errors << (SubscriptionComponentAllocationErrorItem.from_hash(structure) if structure)
+        end
+      end
+
+      @errors = SKIP unless hash.key?('errors')
+    end
+  end
+end

data/lib/advanced_billing/exceptions/subscription_group_signup_error_response_exception.rb

@@ -0,0 +1,32 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Subscription Group Signup Error Response class.
+  class SubscriptionGroupSignupErrorResponseException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [SubscriptionGroupSignupError]
+    attr_accessor :errors
+
+    # The constructor.
+    # @param [String] The reason for raising an exception.
+    # @param [HttpResponse] The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      @errors = SubscriptionGroupSignupError.from_hash(hash['errors']) if hash['errors']
+    end
+  end
+end

data/lib/advanced_billing/exceptions/subscription_group_update_error_response_exception.rb

@@ -0,0 +1,32 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Subscription Group Update Error Response class.
+  class SubscriptionGroupUpdateErrorResponseException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [SubscriptionGroupUpdateError]
+    attr_accessor :errors
+
+    # The constructor.
+    # @param [String] The reason for raising an exception.
+    # @param [HttpResponse] The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      @errors = SubscriptionGroupUpdateError.from_hash(hash['errors']) if hash['errors']
+    end
+  end
+end

data/lib/advanced_billing/exceptions/subscription_remove_coupon_errors_exception.rb

@@ -0,0 +1,32 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Subscription Remove Coupon Errors class.
+  class SubscriptionRemoveCouponErrorsException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[String]]
+    attr_accessor :subscription
+
+    # The constructor.
+    # @param [String] The reason for raising an exception.
+    # @param [HttpResponse] The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      @subscription = hash.key?('subscription') ? hash['subscription'] : nil
+    end
+  end
+end

data/lib/advanced_billing/exceptions/subscriptions_mrr_error_response_exception.rb

@@ -0,0 +1,32 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Subscriptions Mrr Error Response class.
+  class SubscriptionsMrrErrorResponseException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [AttributeError]
+    attr_accessor :errors
+
+    # The constructor.
+    # @param [String] The reason for raising an exception.
+    # @param [HttpResponse] The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      @errors = AttributeError.from_hash(hash['errors']) if hash['errors']
+    end
+  end
+end

data/lib/advanced_billing/exceptions/too_many_management_link_requests_error_exception.rb

@@ -0,0 +1,32 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Too Many Management Link Requests Error class.
+  class TooManyManagementLinkRequestsErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [TooManyManagementLinkRequests]
+    attr_accessor :errors
+
+    # The constructor.
+    # @param [String] The reason for raising an exception.
+    # @param [HttpResponse] The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      @errors = TooManyManagementLinkRequests.from_hash(hash['errors']) if hash['errors']
+    end
+  end
+end

data/lib/advanced_billing/http/auth/basic_auth.rb

@@ -0,0 +1,50 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Utility class for basic authorization.
+  class BasicAuth < CoreLibrary::HeaderAuth
+    include CoreLibrary
+    # Display error message on occurrence of authentication failure.
+    # @returns [String] The oAuth error message.
+    def error_message
+      'BasicAuth: basic_auth_user_name or basic_auth_password is undefined.'
+    end
+
+    # Initialization constructor.
+    def initialize(basic_auth_credentials)
+      auth_params = {}
+      unless basic_auth_credentials.nil? ||
+             basic_auth_credentials.username.nil? ||
+             basic_auth_credentials.password.nil?
+        auth_params['Authorization'] =
+          "Basic #{AuthHelper.get_base64_encoded_value(basic_auth_credentials.username,
+                                                       basic_auth_credentials.password)}"
+      end
+
+      super auth_params
+    end
+  end
+
+  # Data class for BasicAuthCredentials.
+  class BasicAuthCredentials
+    attr_reader :username, :password
+
+    def initialize(username:, password:)
+      raise ArgumentError, 'username cannot be nil' if username.nil?
+      raise ArgumentError, 'password cannot be nil' if password.nil?
+
+      @username = username
+      @password = password
+    end
+
+    def clone_with(username: nil, password: nil)
+      username ||= self.username
+      password ||= self.password
+
+      BasicAuthCredentials.new(username: username, password: password)
+    end
+  end
+end

data/lib/advanced_billing/http/http_call_back.rb

@@ -0,0 +1,10 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # HttpCallBack allows defining callables for pre and post API calls.
+  class HttpCallBack < CoreLibrary::HttpCallback
+  end
+end

data/lib/advanced_billing/http/http_method_enum.rb

@@ -0,0 +1,10 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # HTTP Methods Enumeration.
+  class HttpMethodEnum < CoreLibrary::HttpMethod
+  end
+end

data/lib/advanced_billing/http/http_request.rb

@@ -0,0 +1,10 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Represents a single Http Request.
+  class HttpRequest < CoreLibrary::HttpRequest
+  end
+end

data/lib/advanced_billing/http/http_response.rb

@@ -0,0 +1,10 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Http response received.
+  class HttpResponse < CoreLibrary::HttpResponse
+  end
+end

data/lib/advanced_billing/models/account_balance.rb

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

data/lib/advanced_billing/models/account_balances.rb

@@ -0,0 +1,81 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # AccountBalances Model.
+  class AccountBalances < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The balance, in cents, of the sum of the subscription's  open, payable
+    # invoices.
+    # @return [AccountBalance]
+    attr_accessor :open_invoices
+
+    # The balance, in cents, of the subscription's Pending Discount account.
+    # @return [AccountBalance]
+    attr_accessor :pending_discounts
+
+    # The balance, in cents, of the subscription's Service Credit account.
+    # @return [AccountBalance]
+    attr_accessor :service_credits
+
+    # The balance, in cents, of the subscription's Prepayment account.
+    # @return [AccountBalance]
+    attr_accessor :prepayments
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['open_invoices'] = 'open_invoices'
+      @_hash['pending_discounts'] = 'pending_discounts'
+      @_hash['service_credits'] = 'service_credits'
+      @_hash['prepayments'] = 'prepayments'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        open_invoices
+        pending_discounts
+        service_credits
+        prepayments
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(open_invoices = SKIP, pending_discounts = SKIP,
+                   service_credits = SKIP, prepayments = SKIP)
+      @open_invoices = open_invoices unless open_invoices == SKIP
+      @pending_discounts = pending_discounts unless pending_discounts == SKIP
+      @service_credits = service_credits unless service_credits == SKIP
+      @prepayments = prepayments unless prepayments == 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.
+      open_invoices = AccountBalance.from_hash(hash['open_invoices']) if hash['open_invoices']
+      pending_discounts = AccountBalance.from_hash(hash['pending_discounts']) if
+        hash['pending_discounts']
+      service_credits = AccountBalance.from_hash(hash['service_credits']) if
+        hash['service_credits']
+      prepayments = AccountBalance.from_hash(hash['prepayments']) if hash['prepayments']
+
+      # Create object from extracted values.
+      AccountBalances.new(open_invoices,
+                          pending_discounts,
+                          service_credits,
+                          prepayments)
+    end
+  end
+end

data/lib/advanced_billing/models/ach_agreement.rb

@@ -0,0 +1,96 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # (Optional) If passed, the proof of the authorized ACH agreement terms will
+  # be persisted.
+  class ACHAgreement < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # (Required when providing ACH agreement params) The ACH authorization
+    # agreement terms.
+    # @return [String]
+    attr_accessor :agreement_terms
+
+    # (Required when providing ACH agreement params) The first name of the
+    # person authorizing the ACH agreement.
+    # @return [String]
+    attr_accessor :authorizer_first_name
+
+    # (Required when providing ACH agreement params) The last name of the person
+    # authorizing the ACH agreement.
+    # @return [String]
+    attr_accessor :authorizer_last_name
+
+    # (Required when providing ACH agreement params) The IP address of the
+    # person authorizing the ACH agreement.
+    # @return [String]
+    attr_accessor :ip_address
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['agreement_terms'] = 'agreement_terms'
+      @_hash['authorizer_first_name'] = 'authorizer_first_name'
+      @_hash['authorizer_last_name'] = 'authorizer_last_name'
+      @_hash['ip_address'] = 'ip_address'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        agreement_terms
+        authorizer_first_name
+        authorizer_last_name
+        ip_address
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(agreement_terms = SKIP, authorizer_first_name = SKIP,
+                   authorizer_last_name = SKIP, ip_address = SKIP)
+      @agreement_terms = agreement_terms unless agreement_terms == SKIP
+      @authorizer_first_name = authorizer_first_name unless authorizer_first_name == SKIP
+      @authorizer_last_name = authorizer_last_name unless authorizer_last_name == SKIP
+      @ip_address = ip_address unless ip_address == 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.
+      agreement_terms =
+        hash.key?('agreement_terms') ? hash['agreement_terms'] : SKIP
+      authorizer_first_name =
+        hash.key?('authorizer_first_name') ? hash['authorizer_first_name'] : SKIP
+      authorizer_last_name =
+        hash.key?('authorizer_last_name') ? hash['authorizer_last_name'] : SKIP
+      ip_address = hash.key?('ip_address') ? hash['ip_address'] : SKIP
+
+      # Create object from extracted values.
+      ACHAgreement.new(agreement_terms,
+                       authorizer_first_name,
+                       authorizer_last_name,
+                       ip_address)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [ACHAgreement | 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/activate_subscription_request.rb

@@ -0,0 +1,57 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # ActivateSubscriptionRequest Model.
+  class ActivateSubscriptionRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # You may choose how to handle the activation failure. `true` means do not
+    # change the subscription’s state and billing period. `false`  means to
+    # continue through with the activation and enter an end of life state. If
+    # this parameter is omitted or `null` is passed it will default to value set
+    # in the  site settings (default: `true`)
+    # @return [TrueClass | FalseClass]
+    attr_accessor :revert_on_failure
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['revert_on_failure'] = 'revert_on_failure'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        revert_on_failure
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        revert_on_failure
+      ]
+    end
+
+    def initialize(revert_on_failure = SKIP)
+      @revert_on_failure = revert_on_failure unless revert_on_failure == 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.
+      revert_on_failure =
+        hash.key?('revert_on_failure') ? hash['revert_on_failure'] : SKIP
+
+      # Create object from extracted values.
+      ActivateSubscriptionRequest.new(revert_on_failure)
+    end
+  end
+end