modern_treasury 0.0.0 → 0.1.0.pre.alpha.15

data/lib/modern_treasury/models/bulk_request_list_params.rb

@@ -0,0 +1,178 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class BulkRequestListParams < ModernTreasury::BaseModel
+      # @!parse
+      #   extend ModernTreasury::RequestParameters::Converter
+      include ModernTreasury::RequestParameters
+
+      # @!attribute [r] action_type
+      #   One of create, or update.
+      #
+      #   @return [Symbol, ModernTreasury::Models::BulkRequestListParams::ActionType, nil]
+      optional :action_type, enum: -> { ModernTreasury::Models::BulkRequestListParams::ActionType }
+
+      # @!parse
+      #   # @return [Symbol, ModernTreasury::Models::BulkRequestListParams::ActionType]
+      #   attr_writer :action_type
+
+      # @!attribute after_cursor
+      #
+      #   @return [String, nil]
+      optional :after_cursor, String, nil?: true
+
+      # @!attribute [r] metadata
+      #   For example, if you want to query for records with metadata key `Type` and value
+      #     `Loan`, the query would be `metadata%5BType%5D=Loan`. This encodes the query
+      #     parameters.
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :metadata, ModernTreasury::HashOf[String]
+
+      # @!parse
+      #   # @return [Hash{Symbol=>String}]
+      #   attr_writer :metadata
+
+      # @!attribute [r] per_page
+      #
+      #   @return [Integer, nil]
+      optional :per_page, Integer
+
+      # @!parse
+      #   # @return [Integer]
+      #   attr_writer :per_page
+
+      # @!attribute [r] resource_type
+      #   One of payment_order, expected_payment, or ledger_transaction.
+      #
+      #   @return [Symbol, ModernTreasury::Models::BulkRequestListParams::ResourceType, nil]
+      optional :resource_type, enum: -> { ModernTreasury::Models::BulkRequestListParams::ResourceType }
+
+      # @!parse
+      #   # @return [Symbol, ModernTreasury::Models::BulkRequestListParams::ResourceType]
+      #   attr_writer :resource_type
+
+      # @!attribute [r] status
+      #   One of pending, processing, or completed.
+      #
+      #   @return [Symbol, ModernTreasury::Models::BulkRequestListParams::Status, nil]
+      optional :status, enum: -> { ModernTreasury::Models::BulkRequestListParams::Status }
+
+      # @!parse
+      #   # @return [Symbol, ModernTreasury::Models::BulkRequestListParams::Status]
+      #   attr_writer :status
+
+      # @!parse
+      #   # @param action_type [Symbol, ModernTreasury::Models::BulkRequestListParams::ActionType]
+      #   # @param after_cursor [String, nil]
+      #   # @param metadata [Hash{Symbol=>String}]
+      #   # @param per_page [Integer]
+      #   # @param resource_type [Symbol, ModernTreasury::Models::BulkRequestListParams::ResourceType]
+      #   # @param status [Symbol, ModernTreasury::Models::BulkRequestListParams::Status]
+      #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(
+      #     action_type: nil,
+      #     after_cursor: nil,
+      #     metadata: nil,
+      #     per_page: nil,
+      #     resource_type: nil,
+      #     status: nil,
+      #     request_options: {},
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+
+      # @abstract
+      #
+      # One of create, or update.
+      #
+      # @example
+      # ```ruby
+      # case action_type
+      # in :create
+      #   # ...
+      # in :update
+      #   # ...
+      # in :delete
+      #   # ...
+      # end
+      # ```
+      class ActionType < ModernTreasury::Enum
+        CREATE = :create
+        UPDATE = :update
+        DELETE = :delete
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   #
+        #   def self.values; end
+      end
+
+      # @abstract
+      #
+      # One of payment_order, expected_payment, or ledger_transaction.
+      #
+      # @example
+      # ```ruby
+      # case resource_type
+      # in :payment_order
+      #   # ...
+      # in :ledger_transaction
+      #   # ...
+      # in :transaction
+      #   # ...
+      # in :expected_payment
+      #   # ...
+      # end
+      # ```
+      class ResourceType < ModernTreasury::Enum
+        PAYMENT_ORDER = :payment_order
+        LEDGER_TRANSACTION = :ledger_transaction
+        TRANSACTION = :transaction
+        EXPECTED_PAYMENT = :expected_payment
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   #
+        #   def self.values; end
+      end
+
+      # @abstract
+      #
+      # One of pending, processing, or completed.
+      #
+      # @example
+      # ```ruby
+      # case status
+      # in :pending
+      #   # ...
+      # in :processing
+      #   # ...
+      # in :completed
+      #   # ...
+      # end
+      # ```
+      class Status < ModernTreasury::Enum
+        PENDING = :pending
+        PROCESSING = :processing
+        COMPLETED = :completed
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   #
+        #   def self.values; end
+      end
+    end
+  end
+end

data/lib/modern_treasury/models/bulk_request_retrieve_params.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class BulkRequestRetrieveParams < ModernTreasury::BaseModel
+      # @!parse
+      #   extend ModernTreasury::RequestParameters::Converter
+      include ModernTreasury::RequestParameters
+
+      # @!parse
+      #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(request_options: {}, **) = super
+
+      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+    end
+  end
+end

data/lib/modern_treasury/models/bulk_result.rb

@@ -0,0 +1,323 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class BulkResult < ModernTreasury::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute entity
+      #   An object with type as indicated by `entity_type`. This is the result object
+      #     that is generated by performing the requested action on the provided input
+      #     `request_params`.
+      #
+      #   @return [ModernTreasury::Models::PaymentOrder, ModernTreasury::Models::ExpectedPayment, ModernTreasury::Models::LedgerTransaction, ModernTreasury::Models::Transaction, ModernTreasury::Models::BulkResult::Entity::BulkError]
+      required :entity, union: -> { ModernTreasury::Models::BulkResult::Entity }
+
+      # @!attribute entity_id
+      #   Unique identifier for the result entity object.
+      #
+      #   @return [String]
+      required :entity_id, String
+
+      # @!attribute entity_type
+      #   The type of the result entity object. For a successful bulk result, this is the
+      #     same as the `resource_type` of the bulk request. For a failed bulk result, this
+      #     is always bulk_error
+      #
+      #   @return [Symbol, ModernTreasury::Models::BulkResult::EntityType]
+      required :entity_type, enum: -> { ModernTreasury::Models::BulkResult::EntityType }
+
+      # @!attribute live_mode
+      #   This field will be true if this object exists in the live environment or false
+      #     if it exists in the test environment.
+      #
+      #   @return [Boolean]
+      required :live_mode, ModernTreasury::BooleanModel
+
+      # @!attribute object
+      #
+      #   @return [String]
+      required :object, String
+
+      # @!attribute request_id
+      #   Unique identifier for the request that created this bulk result. This is the ID
+      #     of the bulk request when `request_type` is bulk_request
+      #
+      #   @return [String]
+      required :request_id, String
+
+      # @!attribute request_params
+      #   An optional object that contains the provided input params for the request that
+      #     created this result. This is an item in the `resources` array for the
+      #     bulk_request
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      required :request_params, ModernTreasury::HashOf[String], nil?: true
+
+      # @!attribute request_type
+      #   The type of the request that created this result. bulk_request is the only
+      #     supported `request_type`
+      #
+      #   @return [Symbol, ModernTreasury::Models::BulkResult::RequestType]
+      required :request_type, enum: -> { ModernTreasury::Models::BulkResult::RequestType }
+
+      # @!attribute status
+      #   One of successful or failed.
+      #
+      #   @return [Symbol, ModernTreasury::Models::BulkResult::Status]
+      required :status, enum: -> { ModernTreasury::Models::BulkResult::Status }
+
+      # @!attribute updated_at
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!parse
+      #   # @param id [String]
+      #   # @param created_at [Time]
+      #   # @param entity [ModernTreasury::Models::PaymentOrder, ModernTreasury::Models::ExpectedPayment, ModernTreasury::Models::LedgerTransaction, ModernTreasury::Models::Transaction, ModernTreasury::Models::BulkResult::Entity::BulkError]
+      #   # @param entity_id [String]
+      #   # @param entity_type [Symbol, ModernTreasury::Models::BulkResult::EntityType]
+      #   # @param live_mode [Boolean]
+      #   # @param object [String]
+      #   # @param request_id [String]
+      #   # @param request_params [Hash{Symbol=>String}, nil]
+      #   # @param request_type [Symbol, ModernTreasury::Models::BulkResult::RequestType]
+      #   # @param status [Symbol, ModernTreasury::Models::BulkResult::Status]
+      #   # @param updated_at [Time]
+      #   #
+      #   def initialize(
+      #     id:,
+      #     created_at:,
+      #     entity:,
+      #     entity_id:,
+      #     entity_type:,
+      #     live_mode:,
+      #     object:,
+      #     request_id:,
+      #     request_params:,
+      #     request_type:,
+      #     status:,
+      #     updated_at:,
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+
+      # @abstract
+      #
+      # An object with type as indicated by `entity_type`. This is the result object
+      #   that is generated by performing the requested action on the provided input
+      #   `request_params`.
+      #
+      # @example
+      # ```ruby
+      # case entity
+      # in ModernTreasury::Models::PaymentOrder
+      #   # ...
+      # in ModernTreasury::Models::ExpectedPayment
+      #   # ...
+      # in ModernTreasury::Models::LedgerTransaction
+      #   # ...
+      # in ModernTreasury::Models::Transaction
+      #   # ...
+      # in ModernTreasury::Models::BulkResult::Entity::BulkError
+      #   # ...
+      # end
+      # ```
+      class Entity < ModernTreasury::Union
+        variant -> { ModernTreasury::Models::PaymentOrder }
+
+        variant -> { ModernTreasury::Models::ExpectedPayment }
+
+        variant -> { ModernTreasury::Models::LedgerTransaction }
+
+        variant -> { ModernTreasury::Models::Transaction }
+
+        variant -> { ModernTreasury::Models::BulkResult::Entity::BulkError }
+
+        class BulkError < ModernTreasury::BaseModel
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute created_at
+          #
+          #   @return [Time]
+          required :created_at, Time
+
+          # @!attribute live_mode
+          #   This field will be true if this object exists in the live environment or false
+          #     if it exists in the test environment.
+          #
+          #   @return [Boolean]
+          required :live_mode, ModernTreasury::BooleanModel
+
+          # @!attribute object
+          #
+          #   @return [String]
+          required :object, String
+
+          # @!attribute request_errors
+          #
+          #   @return [Array<ModernTreasury::Models::BulkResult::Entity::BulkError::RequestError>]
+          required :request_errors,
+                   -> { ModernTreasury::ArrayOf[ModernTreasury::Models::BulkResult::Entity::BulkError::RequestError] }
+
+          # @!attribute updated_at
+          #
+          #   @return [Time]
+          required :updated_at, Time
+
+          # @!parse
+          #   # @param id [String]
+          #   # @param created_at [Time]
+          #   # @param live_mode [Boolean]
+          #   # @param object [String]
+          #   # @param request_errors [Array<ModernTreasury::Models::BulkResult::Entity::BulkError::RequestError>]
+          #   # @param updated_at [Time]
+          #   #
+          #   def initialize(id:, created_at:, live_mode:, object:, request_errors:, updated_at:, **) = super
+
+          # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+
+          class RequestError < ModernTreasury::BaseModel
+            # @!attribute [r] code
+            #
+            #   @return [String, nil]
+            optional :code, String
+
+            # @!parse
+            #   # @return [String]
+            #   attr_writer :code
+
+            # @!attribute [r] message
+            #
+            #   @return [String, nil]
+            optional :message, String
+
+            # @!parse
+            #   # @return [String]
+            #   attr_writer :message
+
+            # @!attribute [r] parameter
+            #
+            #   @return [String, nil]
+            optional :parameter, String
+
+            # @!parse
+            #   # @return [String]
+            #   attr_writer :parameter
+
+            # @!parse
+            #   # @param code [String]
+            #   # @param message [String]
+            #   # @param parameter [String]
+            #   #
+            #   def initialize(code: nil, message: nil, parameter: nil, **) = super
+
+            # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+          end
+        end
+      end
+
+      # @abstract
+      #
+      # The type of the result entity object. For a successful bulk result, this is the
+      #   same as the `resource_type` of the bulk request. For a failed bulk result, this
+      #   is always bulk_error
+      #
+      # @example
+      # ```ruby
+      # case entity_type
+      # in :payment_order
+      #   # ...
+      # in :ledger_transaction
+      #   # ...
+      # in :transaction
+      #   # ...
+      # in :expected_payment
+      #   # ...
+      # in :bulk_error
+      #   # ...
+      # end
+      # ```
+      class EntityType < ModernTreasury::Enum
+        PAYMENT_ORDER = :payment_order
+        LEDGER_TRANSACTION = :ledger_transaction
+        TRANSACTION = :transaction
+        EXPECTED_PAYMENT = :expected_payment
+        BULK_ERROR = :bulk_error
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   #
+        #   def self.values; end
+      end
+
+      # @abstract
+      #
+      # The type of the request that created this result. bulk_request is the only
+      #   supported `request_type`
+      #
+      # @example
+      # ```ruby
+      # case request_type
+      # in :bulk_request
+      #   # ...
+      # end
+      # ```
+      class RequestType < ModernTreasury::Enum
+        BULK_REQUEST = :bulk_request
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   #
+        #   def self.values; end
+      end
+
+      # @abstract
+      #
+      # One of successful or failed.
+      #
+      # @example
+      # ```ruby
+      # case status
+      # in :pending
+      #   # ...
+      # in :successful
+      #   # ...
+      # in :failed
+      #   # ...
+      # end
+      # ```
+      class Status < ModernTreasury::Enum
+        PENDING = :pending
+        SUCCESSFUL = :successful
+        FAILED = :failed
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   #
+        #   def self.values; end
+      end
+    end
+  end
+end

data/lib/modern_treasury/models/bulk_result_list_params.rb

@@ -0,0 +1,190 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class BulkResultListParams < ModernTreasury::BaseModel
+      # @!parse
+      #   extend ModernTreasury::RequestParameters::Converter
+      include ModernTreasury::RequestParameters
+
+      # @!attribute after_cursor
+      #
+      #   @return [String, nil]
+      optional :after_cursor, String, nil?: true
+
+      # @!attribute [r] entity_id
+      #   Unique identifier for the result entity object.
+      #
+      #   @return [String, nil]
+      optional :entity_id, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :entity_id
+
+      # @!attribute [r] entity_type
+      #   The type of the request that created this result. bulk_request is the only
+      #     supported `request_type`
+      #
+      #   @return [Symbol, ModernTreasury::Models::BulkResultListParams::EntityType, nil]
+      optional :entity_type, enum: -> { ModernTreasury::Models::BulkResultListParams::EntityType }
+
+      # @!parse
+      #   # @return [Symbol, ModernTreasury::Models::BulkResultListParams::EntityType]
+      #   attr_writer :entity_type
+
+      # @!attribute [r] per_page
+      #
+      #   @return [Integer, nil]
+      optional :per_page, Integer
+
+      # @!parse
+      #   # @return [Integer]
+      #   attr_writer :per_page
+
+      # @!attribute [r] request_id
+      #   Unique identifier for the request that created this bulk result. This is the ID
+      #     of the bulk request when `request_type` is bulk_request
+      #
+      #   @return [String, nil]
+      optional :request_id, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :request_id
+
+      # @!attribute [r] request_type
+      #   The type of the request that created this result. bulk_request is the only
+      #     supported `request_type`
+      #
+      #   @return [Symbol, ModernTreasury::Models::BulkResultListParams::RequestType, nil]
+      optional :request_type, enum: -> { ModernTreasury::Models::BulkResultListParams::RequestType }
+
+      # @!parse
+      #   # @return [Symbol, ModernTreasury::Models::BulkResultListParams::RequestType]
+      #   attr_writer :request_type
+
+      # @!attribute [r] status
+      #   One of successful or failed.
+      #
+      #   @return [Symbol, ModernTreasury::Models::BulkResultListParams::Status, nil]
+      optional :status, enum: -> { ModernTreasury::Models::BulkResultListParams::Status }
+
+      # @!parse
+      #   # @return [Symbol, ModernTreasury::Models::BulkResultListParams::Status]
+      #   attr_writer :status
+
+      # @!parse
+      #   # @param after_cursor [String, nil]
+      #   # @param entity_id [String]
+      #   # @param entity_type [Symbol, ModernTreasury::Models::BulkResultListParams::EntityType]
+      #   # @param per_page [Integer]
+      #   # @param request_id [String]
+      #   # @param request_type [Symbol, ModernTreasury::Models::BulkResultListParams::RequestType]
+      #   # @param status [Symbol, ModernTreasury::Models::BulkResultListParams::Status]
+      #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(
+      #     after_cursor: nil,
+      #     entity_id: nil,
+      #     entity_type: nil,
+      #     per_page: nil,
+      #     request_id: nil,
+      #     request_type: nil,
+      #     status: nil,
+      #     request_options: {},
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+
+      # @abstract
+      #
+      # The type of the request that created this result. bulk_request is the only
+      #   supported `request_type`
+      #
+      # @example
+      # ```ruby
+      # case entity_type
+      # in :payment_order
+      #   # ...
+      # in :ledger_transaction
+      #   # ...
+      # in :transaction
+      #   # ...
+      # in :expected_payment
+      #   # ...
+      # in :bulk_error
+      #   # ...
+      # end
+      # ```
+      class EntityType < ModernTreasury::Enum
+        PAYMENT_ORDER = :payment_order
+        LEDGER_TRANSACTION = :ledger_transaction
+        TRANSACTION = :transaction
+        EXPECTED_PAYMENT = :expected_payment
+        BULK_ERROR = :bulk_error
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   #
+        #   def self.values; end
+      end
+
+      # @abstract
+      #
+      # The type of the request that created this result. bulk_request is the only
+      #   supported `request_type`
+      #
+      # @example
+      # ```ruby
+      # case request_type
+      # in :bulk_request
+      #   # ...
+      # end
+      # ```
+      class RequestType < ModernTreasury::Enum
+        BULK_REQUEST = :bulk_request
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   #
+        #   def self.values; end
+      end
+
+      # @abstract
+      #
+      # One of successful or failed.
+      #
+      # @example
+      # ```ruby
+      # case status
+      # in :pending
+      #   # ...
+      # in :successful
+      #   # ...
+      # in :failed
+      #   # ...
+      # end
+      # ```
+      class Status < ModernTreasury::Enum
+        PENDING = :pending
+        SUCCESSFUL = :successful
+        FAILED = :failed
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   #
+        #   def self.values; end
+      end
+    end
+  end
+end