method-ruby 0.1.0 → 0.2.0

data/lib/method_ruby/models/entities/manual_connect_create_params.rb

@@ -0,0 +1,292 @@
+# frozen_string_literal: true
+
+module MethodRuby
+  module Models
+    module Entities
+      # @see MethodRuby::Resources::Entities::ManualConnect#create
+      class ManualConnectCreateParams < MethodRuby::Internal::Type::BaseModel
+        extend MethodRuby::Internal::Type::RequestParameters::Converter
+        include MethodRuby::Internal::Type::RequestParameters
+
+        # @!attribute entity_id
+        #
+        #   @return [String]
+        required :entity_id, String
+
+        # @!attribute bureau
+        #   The credit bureau source for the manual connect session.
+        #
+        #   @return [Symbol, MethodRuby::Models::Entities::ManualConnectCreateParams::Bureau]
+        required :bureau, enum: -> { MethodRuby::Entities::ManualConnectCreateParams::Bureau }
+
+        # @!attribute tradelines
+        #   List of tradeline objects to manually connect.
+        #
+        #   @return [Array<MethodRuby::Models::Entities::ManualConnectCreateParams::Tradeline>]
+        required :tradelines,
+                 -> { MethodRuby::Internal::Type::ArrayOf[MethodRuby::Entities::ManualConnectCreateParams::Tradeline] }
+
+        # @!attribute method_version
+        #
+        #   @return [Symbol, MethodRuby::Models::Entities::ManualConnectCreateParams::MethodVersion]
+        required :method_version, enum: -> { MethodRuby::Entities::ManualConnectCreateParams::MethodVersion }
+
+        # @!attribute idempotency_key
+        #
+        #   @return [String, nil]
+        optional :idempotency_key, String
+
+        # @!method initialize(entity_id:, bureau:, tradelines:, method_version:, idempotency_key: nil, request_options: {})
+        #   @param entity_id [String]
+        #
+        #   @param bureau [Symbol, MethodRuby::Models::Entities::ManualConnectCreateParams::Bureau] The credit bureau source for the manual connect session.
+        #
+        #   @param tradelines [Array<MethodRuby::Models::Entities::ManualConnectCreateParams::Tradeline>] List of tradeline objects to manually connect.
+        #
+        #   @param method_version [Symbol, MethodRuby::Models::Entities::ManualConnectCreateParams::MethodVersion]
+        #
+        #   @param idempotency_key [String]
+        #
+        #   @param request_options [MethodRuby::RequestOptions, Hash{Symbol=>Object}]
+
+        # The credit bureau source for the manual connect session.
+        module Bureau
+          extend MethodRuby::Internal::Type::Enum
+
+          EQUIFAX = :equifax
+          TRANSUNION = :transunion
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        class Tradeline < MethodRuby::Internal::Type::BaseModel
+          # @!attribute balance
+          #   The current balance of the tradeline.
+          #
+          #   @return [Float, nil]
+          required :balance, Float, nil?: true
+
+          # @!attribute closed_at
+          #   The date the tradeline was closed (YYYY-MM-DD).
+          #
+          #   @return [Date, nil]
+          required :closed_at, Date, nil?: true
+
+          # @!attribute credit_limit
+          #   The credit limit of the tradeline.
+          #
+          #   @return [Float, nil]
+          required :credit_limit, Float, nil?: true
+
+          # @!attribute creditor_code
+          #   The code of the creditor.
+          #
+          #   @return [String, nil]
+          required :creditor_code, String, nil?: true
+
+          # @!attribute creditor_name
+          #   The name of the creditor.
+          #
+          #   @return [String, nil]
+          required :creditor_name, String, nil?: true
+
+          # @!attribute delinquency_charge_off_amount
+          #   The delinquency charge-off amount.
+          #
+          #   @return [Float, nil]
+          required :delinquency_charge_off_amount, Float, nil?: true
+
+          # @!attribute delinquency_first_start_date
+          #   The date of the first delinquency (YYYY-MM-DD).
+          #
+          #   @return [Date, nil]
+          required :delinquency_first_start_date, Date, nil?: true
+
+          # @!attribute designator_code
+          #   The designator code of the tradeline.
+          #
+          #   @return [String, nil]
+          required :designator_code, String, nil?: true
+
+          # @!attribute highest_balance
+          #   The highest balance of the tradeline.
+          #
+          #   @return [Float, nil]
+          required :highest_balance, Float, nil?: true
+
+          # @!attribute last_activity_date
+          #   The date of the last activity (YYYY-MM-DD).
+          #
+          #   @return [Date, nil]
+          required :last_activity_date, Date, nil?: true
+
+          # @!attribute last_payment_amount
+          #   The amount of the last payment.
+          #
+          #   @return [Float, nil]
+          required :last_payment_amount, Float, nil?: true
+
+          # @!attribute last_payment_date
+          #   The date of the last payment (YYYY-MM-DD).
+          #
+          #   @return [Date, nil]
+          required :last_payment_date, Date, nil?: true
+
+          # @!attribute narrative_codes
+          #   Narrative codes associated with the tradeline.
+          #
+          #   @return [Array<MethodRuby::Models::Entities::ManualConnectCreateParams::Tradeline::NarrativeCode>, nil]
+          required :narrative_codes,
+                   -> {
+                     MethodRuby::Internal::Type::ArrayOf[MethodRuby::Entities::ManualConnectCreateParams::Tradeline::NarrativeCode]
+                   },
+                   nil?: true
+
+          # @!attribute next_payment_due_date
+          #   The date the next payment is due (YYYY-MM-DD).
+          #
+          #   @return [Date, nil]
+          required :next_payment_due_date, Date, nil?: true
+
+          # @!attribute next_payment_minimum_amount
+          #   The minimum amount due for the next payment.
+          #
+          #   @return [Float, nil]
+          required :next_payment_minimum_amount, Float, nil?: true
+
+          # @!attribute number
+          #   The account number of the tradeline.
+          #
+          #   @return [String, nil]
+          required :number, String, nil?: true
+
+          # @!attribute opened_at
+          #   The date the tradeline was opened (YYYY-MM-DD).
+          #
+          #   @return [Date, nil]
+          required :opened_at, Date, nil?: true
+
+          # @!attribute past_due_amount
+          #   The past due amount of the tradeline.
+          #
+          #   @return [Float, nil]
+          required :past_due_amount, Float, nil?: true
+
+          # @!attribute payment_history
+          #   The payment history of the tradeline.
+          #
+          #   @return [Array<String>, nil]
+          required :payment_history, MethodRuby::Internal::Type::ArrayOf[String], nil?: true
+
+          # @!attribute portfolio_type_code
+          #   The portfolio type code of the tradeline.
+          #
+          #   @return [String, nil]
+          required :portfolio_type_code, String, nil?: true
+
+          # @!attribute reported_date
+          #   The date the tradeline was reported (YYYY-MM-DD).
+          #
+          #   @return [Date, nil]
+          required :reported_date, Date, nil?: true
+
+          # @!attribute term
+          #   The term of the tradeline in months.
+          #
+          #   @return [Float, nil]
+          required :term, Float, nil?: true
+
+          # @!attribute type_code
+          #   The type code of the tradeline.
+          #
+          #   @return [String, nil]
+          required :type_code, String, nil?: true
+
+          # @!attribute external_id
+          #   An external identifier for the tradeline.
+          #
+          #   @return [String, nil]
+          optional :external_id, String, nil?: true
+
+          # @!method initialize(balance:, closed_at:, credit_limit:, creditor_code:, creditor_name:, delinquency_charge_off_amount:, delinquency_first_start_date:, designator_code:, highest_balance:, last_activity_date:, last_payment_amount:, last_payment_date:, narrative_codes:, next_payment_due_date:, next_payment_minimum_amount:, number:, opened_at:, past_due_amount:, payment_history:, portfolio_type_code:, reported_date:, term:, type_code:, external_id: nil)
+          #   @param balance [Float, nil] The current balance of the tradeline.
+          #
+          #   @param closed_at [Date, nil] The date the tradeline was closed (YYYY-MM-DD).
+          #
+          #   @param credit_limit [Float, nil] The credit limit of the tradeline.
+          #
+          #   @param creditor_code [String, nil] The code of the creditor.
+          #
+          #   @param creditor_name [String, nil] The name of the creditor.
+          #
+          #   @param delinquency_charge_off_amount [Float, nil] The delinquency charge-off amount.
+          #
+          #   @param delinquency_first_start_date [Date, nil] The date of the first delinquency (YYYY-MM-DD).
+          #
+          #   @param designator_code [String, nil] The designator code of the tradeline.
+          #
+          #   @param highest_balance [Float, nil] The highest balance of the tradeline.
+          #
+          #   @param last_activity_date [Date, nil] The date of the last activity (YYYY-MM-DD).
+          #
+          #   @param last_payment_amount [Float, nil] The amount of the last payment.
+          #
+          #   @param last_payment_date [Date, nil] The date of the last payment (YYYY-MM-DD).
+          #
+          #   @param narrative_codes [Array<MethodRuby::Models::Entities::ManualConnectCreateParams::Tradeline::NarrativeCode>, nil] Narrative codes associated with the tradeline.
+          #
+          #   @param next_payment_due_date [Date, nil] The date the next payment is due (YYYY-MM-DD).
+          #
+          #   @param next_payment_minimum_amount [Float, nil] The minimum amount due for the next payment.
+          #
+          #   @param number [String, nil] The account number of the tradeline.
+          #
+          #   @param opened_at [Date, nil] The date the tradeline was opened (YYYY-MM-DD).
+          #
+          #   @param past_due_amount [Float, nil] The past due amount of the tradeline.
+          #
+          #   @param payment_history [Array<String>, nil] The payment history of the tradeline.
+          #
+          #   @param portfolio_type_code [String, nil] The portfolio type code of the tradeline.
+          #
+          #   @param reported_date [Date, nil] The date the tradeline was reported (YYYY-MM-DD).
+          #
+          #   @param term [Float, nil] The term of the tradeline in months.
+          #
+          #   @param type_code [String, nil] The type code of the tradeline.
+          #
+          #   @param external_id [String, nil] An external identifier for the tradeline.
+
+          class NarrativeCode < MethodRuby::Internal::Type::BaseModel
+            # @!attribute code
+            #   The narrative code.
+            #
+            #   @return [String, nil]
+            optional :code, String, nil?: true
+
+            # @!attribute description
+            #   The description of the narrative code.
+            #
+            #   @return [String, nil]
+            optional :description, String, nil?: true
+
+            # @!method initialize(code: nil, description: nil)
+            #   @param code [String, nil] The narrative code.
+            #
+            #   @param description [String, nil] The description of the narrative code.
+          end
+        end
+
+        module MethodVersion
+          extend MethodRuby::Internal::Type::Enum
+
+          METHOD_VERSION_2025_12_01 = :"2025-12-01"
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/method_ruby/models/entities/manual_connect_create_response.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module MethodRuby
+  module Models
+    module Entities
+      # @see MethodRuby::Resources::Entities::ManualConnect#create
+      class ManualConnectCreateResponse < MethodRuby::Internal::Type::BaseModel
+        # @!attribute data
+        #
+        #   @return [Object]
+        required :data, MethodRuby::Internal::Type::Unknown
+
+        # @!attribute message
+        #
+        #   @return [String, nil]
+        required :message, String, nil?: true
+
+        # @!attribute success
+        #   Always `true` for successful responses.
+        #
+        #   @return [Boolean]
+        required :success, MethodRuby::Internal::Type::Boolean
+
+        # @!method initialize(data:, message:, success:)
+        #   @param data [Object]
+        #
+        #   @param message [String, nil]
+        #
+        #   @param success [Boolean] Always `true` for successful responses.
+      end
+    end
+  end
+end

data/lib/method_ruby/models/entities/manual_connect_retrieve_params.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module MethodRuby
+  module Models
+    module Entities
+      # @see MethodRuby::Resources::Entities::ManualConnect#retrieve
+      class ManualConnectRetrieveParams < MethodRuby::Internal::Type::BaseModel
+        extend MethodRuby::Internal::Type::RequestParameters::Converter
+        include MethodRuby::Internal::Type::RequestParameters
+
+        # @!attribute entity_id
+        #
+        #   @return [String]
+        required :entity_id, String
+
+        # @!attribute mcxn_id
+        #
+        #   @return [String]
+        required :mcxn_id, String
+
+        # @!attribute method_version
+        #
+        #   @return [Symbol, MethodRuby::Models::Entities::ManualConnectRetrieveParams::MethodVersion]
+        required :method_version, enum: -> { MethodRuby::Entities::ManualConnectRetrieveParams::MethodVersion }
+
+        # @!method initialize(entity_id:, mcxn_id:, method_version:, request_options: {})
+        #   @param entity_id [String]
+        #   @param mcxn_id [String]
+        #   @param method_version [Symbol, MethodRuby::Models::Entities::ManualConnectRetrieveParams::MethodVersion]
+        #   @param request_options [MethodRuby::RequestOptions, Hash{Symbol=>Object}]
+
+        module MethodVersion
+          extend MethodRuby::Internal::Type::Enum
+
+          METHOD_VERSION_2025_12_01 = :"2025-12-01"
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/method_ruby/models/entities/manual_connect_retrieve_response.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module MethodRuby
+  module Models
+    module Entities
+      # @see MethodRuby::Resources::Entities::ManualConnect#retrieve
+      class ManualConnectRetrieveResponse < MethodRuby::Internal::Type::BaseModel
+        # @!attribute data
+        #
+        #   @return [Object]
+        required :data, MethodRuby::Internal::Type::Unknown
+
+        # @!attribute message
+        #
+        #   @return [String, nil]
+        required :message, String, nil?: true
+
+        # @!attribute success
+        #   Always `true` for successful responses.
+        #
+        #   @return [Boolean]
+        required :success, MethodRuby::Internal::Type::Boolean
+
+        # @!method initialize(data:, message:, success:)
+        #   @param data [Object]
+        #
+        #   @param message [String, nil]
+        #
+        #   @param success [Boolean] Always `true` for successful responses.
+      end
+    end
+  end
+end

data/lib/method_ruby/models/entities/product_list_params.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module MethodRuby
+  module Models
+    module Entities
+      # @see MethodRuby::Resources::Entities::Products#list
+      class ProductListParams < MethodRuby::Internal::Type::BaseModel
+        extend MethodRuby::Internal::Type::RequestParameters::Converter
+        include MethodRuby::Internal::Type::RequestParameters
+
+        # @!attribute entity_id
+        #
+        #   @return [String]
+        required :entity_id, String
+
+        # @!attribute method_version
+        #
+        #   @return [Symbol, MethodRuby::Models::Entities::ProductListParams::MethodVersion]
+        required :method_version, enum: -> { MethodRuby::Entities::ProductListParams::MethodVersion }
+
+        # @!method initialize(entity_id:, method_version:, request_options: {})
+        #   @param entity_id [String]
+        #   @param method_version [Symbol, MethodRuby::Models::Entities::ProductListParams::MethodVersion]
+        #   @param request_options [MethodRuby::RequestOptions, Hash{Symbol=>Object}]
+
+        module MethodVersion
+          extend MethodRuby::Internal::Type::Enum
+
+          METHOD_VERSION_2025_12_01 = :"2025-12-01"
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/method_ruby/models/entities/product_list_response.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module MethodRuby
+  module Models
+    module Entities
+      # @see MethodRuby::Resources::Entities::Products#list
+      class ProductListResponse < MethodRuby::Internal::Type::BaseModel
+        # @!attribute data
+        #   Object keyed by product name with EntityProduct values.
+        #
+        #   @return [Object]
+        required :data, MethodRuby::Internal::Type::Unknown
+
+        # @!attribute message
+        #
+        #   @return [String, nil]
+        required :message, String, nil?: true
+
+        # @!attribute success
+        #   Always `true` for successful responses.
+        #
+        #   @return [Boolean]
+        required :success, MethodRuby::Internal::Type::Boolean
+
+        # @!method initialize(data:, message:, success:)
+        #   @param data [Object] Object keyed by product name with EntityProduct values.
+        #
+        #   @param message [String, nil]
+        #
+        #   @param success [Boolean] Always `true` for successful responses.
+      end
+    end
+  end
+end

data/lib/method_ruby/models/entities/product_retrieve_params.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module MethodRuby
+  module Models
+    module Entities
+      # @see MethodRuby::Resources::Entities::Products#retrieve
+      class ProductRetrieveParams < MethodRuby::Internal::Type::BaseModel
+        extend MethodRuby::Internal::Type::RequestParameters::Converter
+        include MethodRuby::Internal::Type::RequestParameters
+
+        # @!attribute entity_id
+        #
+        #   @return [String]
+        required :entity_id, String
+
+        # @!attribute prd_id
+        #
+        #   @return [String]
+        required :prd_id, String
+
+        # @!attribute method_version
+        #
+        #   @return [Symbol, MethodRuby::Models::Entities::ProductRetrieveParams::MethodVersion]
+        required :method_version, enum: -> { MethodRuby::Entities::ProductRetrieveParams::MethodVersion }
+
+        # @!method initialize(entity_id:, prd_id:, method_version:, request_options: {})
+        #   @param entity_id [String]
+        #   @param prd_id [String]
+        #   @param method_version [Symbol, MethodRuby::Models::Entities::ProductRetrieveParams::MethodVersion]
+        #   @param request_options [MethodRuby::RequestOptions, Hash{Symbol=>Object}]
+
+        module MethodVersion
+          extend MethodRuby::Internal::Type::Enum
+
+          METHOD_VERSION_2025_12_01 = :"2025-12-01"
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/method_ruby/models/entities/product_retrieve_response.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module MethodRuby
+  module Models
+    module Entities
+      # @see MethodRuby::Resources::Entities::Products#retrieve
+      class ProductRetrieveResponse < MethodRuby::Internal::Type::BaseModel
+        # @!attribute data
+        #
+        #   @return [Object]
+        required :data, MethodRuby::Internal::Type::Unknown
+
+        # @!attribute message
+        #
+        #   @return [String, nil]
+        required :message, String, nil?: true
+
+        # @!attribute success
+        #   Always `true` for successful responses.
+        #
+        #   @return [Boolean]
+        required :success, MethodRuby::Internal::Type::Boolean
+
+        # @!method initialize(data:, message:, success:)
+        #   @param data [Object]
+        #
+        #   @param message [String, nil]
+        #
+        #   @param success [Boolean] Always `true` for successful responses.
+      end
+    end
+  end
+end

data/lib/method_ruby/models/entities/subscription_create_params.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+module MethodRuby
+  module Models
+    module Entities
+      # @see MethodRuby::Resources::Entities::Subscriptions#create
+      class SubscriptionCreateParams < MethodRuby::Internal::Type::BaseModel
+        extend MethodRuby::Internal::Type::RequestParameters::Converter
+        include MethodRuby::Internal::Type::RequestParameters
+
+        # @!attribute entity_id
+        #
+        #   @return [String]
+        required :entity_id, String
+
+        # @!attribute enroll
+        #   Subscription name to enroll.
+        #
+        #   @return [Symbol, MethodRuby::Models::Entities::SubscriptionCreateParams::Enroll]
+        required :enroll, enum: -> { MethodRuby::Entities::SubscriptionCreateParams::Enroll }
+
+        # @!attribute method_version
+        #
+        #   @return [Symbol, MethodRuby::Models::Entities::SubscriptionCreateParams::MethodVersion]
+        required :method_version, enum: -> { MethodRuby::Entities::SubscriptionCreateParams::MethodVersion }
+
+        # @!attribute payload
+        #   Optional payload for the subscription. Required when enroll is attribute.
+        #
+        #   @return [MethodRuby::Models::Entities::SubscriptionCreateParams::Payload, nil]
+        optional :payload, -> { MethodRuby::Entities::SubscriptionCreateParams::Payload }, nil?: true
+
+        # @!attribute idempotency_key
+        #
+        #   @return [String, nil]
+        optional :idempotency_key, String
+
+        # @!method initialize(entity_id:, enroll:, method_version:, payload: nil, idempotency_key: nil, request_options: {})
+        #   @param entity_id [String]
+        #
+        #   @param enroll [Symbol, MethodRuby::Models::Entities::SubscriptionCreateParams::Enroll] Subscription name to enroll.
+        #
+        #   @param method_version [Symbol, MethodRuby::Models::Entities::SubscriptionCreateParams::MethodVersion]
+        #
+        #   @param payload [MethodRuby::Models::Entities::SubscriptionCreateParams::Payload, nil] Optional payload for the subscription. Required when enroll is attribute.
+        #
+        #   @param idempotency_key [String]
+        #
+        #   @param request_options [MethodRuby::RequestOptions, Hash{Symbol=>Object}]
+
+        # Subscription name to enroll.
+        module Enroll
+          extend MethodRuby::Internal::Type::Enum
+
+          ATTRIBUTE = :attribute
+          CONNECT = :connect
+          CREDIT_SCORE = :credit_score
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        module MethodVersion
+          extend MethodRuby::Internal::Type::Enum
+
+          METHOD_VERSION_2025_12_01 = :"2025-12-01"
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        class Payload < MethodRuby::Internal::Type::BaseModel
+          # @!attribute attributes
+          #   Attributes configuration for the subscription.
+          #
+          #   @return [MethodRuby::Models::Entities::SubscriptionCreateParams::Payload::Attributes, nil]
+          optional :attributes, -> { MethodRuby::Entities::SubscriptionCreateParams::Payload::Attributes }
+
+          # @!method initialize(attributes: nil)
+          #   Optional payload for the subscription. Required when enroll is attribute.
+          #
+          #   @param attributes [MethodRuby::Models::Entities::SubscriptionCreateParams::Payload::Attributes] Attributes configuration for the subscription.
+
+          # @see MethodRuby::Models::Entities::SubscriptionCreateParams::Payload#attributes
+          class Attributes < MethodRuby::Internal::Type::BaseModel
+            # @!attribute requested_attributes
+            #   List of attribute names to request.
+            #
+            #   @return [Array<String>, nil]
+            optional :requested_attributes, MethodRuby::Internal::Type::ArrayOf[String]
+
+            # @!method initialize(requested_attributes: nil)
+            #   Attributes configuration for the subscription.
+            #
+            #   @param requested_attributes [Array<String>] List of attribute names to request.
+          end
+        end
+      end
+    end
+  end
+end

data/lib/method_ruby/models/entities/subscription_create_response.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module MethodRuby
+  module Models
+    module Entities
+      # @see MethodRuby::Resources::Entities::Subscriptions#create
+      class SubscriptionCreateResponse < MethodRuby::Internal::Type::BaseModel
+        # @!attribute data
+        #
+        #   @return [Object]
+        required :data, MethodRuby::Internal::Type::Unknown
+
+        # @!attribute message
+        #
+        #   @return [String, nil]
+        required :message, String, nil?: true
+
+        # @!attribute success
+        #   Always `true` for successful responses.
+        #
+        #   @return [Boolean]
+        required :success, MethodRuby::Internal::Type::Boolean
+
+        # @!method initialize(data:, message:, success:)
+        #   @param data [Object]
+        #
+        #   @param message [String, nil]
+        #
+        #   @param success [Boolean] Always `true` for successful responses.
+      end
+    end
+  end
+end