modern_treasury 0.1.0.pre.alpha.18 → 0.1.0.pre.alpha.20

data/lib/modern_treasury/models/payment_action_create_response.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    # @see ModernTreasury::Resources::PaymentActions#create
+    class PaymentActionCreateResponse < ModernTreasury::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute actionable_id
+      #   The ID of the associated actionable object.
+      #
+      #   @return [String, nil]
+      required :actionable_id, String, nil?: true
+
+      # @!attribute actionable_type
+      #   The type of the associated actionable object. One of `payment_order`,
+      #   `expected_payment`.
+      #
+      #   @return [String, nil]
+      required :actionable_type, String, nil?: true
+
+      # @!attribute created_at
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute details
+      #   The specifc details of the payment action based on type.
+      #
+      #   @return [Object]
+      required :details, ModernTreasury::Internal::Type::Unknown
+
+      # @!attribute internal_account_id
+      #   The ID of the internal account associated with the payment action.
+      #
+      #   @return [String]
+      required :internal_account_id, String
+
+      # @!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::Internal::Type::Boolean
+
+      # @!attribute object
+      #
+      #   @return [String]
+      required :object, String
+
+      # @!attribute status
+      #   The current status of the payment action. One of `pending`, `processing`,
+      #   `sent`, `cancelled`, or `failed`.
+      #
+      #   @return [String]
+      required :status, String
+
+      # @!attribute type
+      #   The type of the payment action. Determines the action to be taken.
+      #
+      #   @return [String]
+      required :type, String
+
+      # @!attribute updated_at
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!method initialize(id:, actionable_id:, actionable_type:, created_at:, details:, internal_account_id:, live_mode:, object:, status:, type:, updated_at:)
+      #   Some parameter documentations has been truncated, see
+      #   {ModernTreasury::Models::PaymentActionCreateResponse} for more details.
+      #
+      #   @param id [String]
+      #
+      #   @param actionable_id [String, nil] The ID of the associated actionable object.
+      #
+      #   @param actionable_type [String, nil] The type of the associated actionable object. One of `payment_order`,
+      #   `expected\_
+      #
+      #   @param created_at [Time]
+      #
+      #   @param details [Object] The specifc details of the payment action based on type.
+      #
+      #   @param internal_account_id [String] The ID of the internal account associated with the payment action.
+      #
+      #   @param live_mode [Boolean] This field will be true if this object exists in the live environment or false i
+      #
+      #   @param object [String]
+      #
+      #   @param status [String] The current status of the payment action. One of `pending`, `processing`, `sent`
+      #
+      #   @param type [String] The type of the payment action. Determines the action to be taken.
+      #
+      #   @param updated_at [Time]
+    end
+  end
+end

data/lib/modern_treasury/models/payment_action_list_params.rb

@@ -0,0 +1,157 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    # @see ModernTreasury::Resources::PaymentActions#list
+    class PaymentActionListParams < ModernTreasury::Internal::Type::BaseModel
+      extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
+
+      # @!attribute actionable_id
+      #   The ID of the associated actionable object.
+      #
+      #   @return [String, nil]
+      optional :actionable_id, String
+
+      # @!attribute actionable_type
+      #   The type of the associated actionable object. One of `payment_order`,
+      #   `expected_payment`.
+      #
+      #   @return [String, nil]
+      optional :actionable_type, String
+
+      # @!attribute after_cursor
+      #
+      #   @return [String, nil]
+      optional :after_cursor, String, nil?: true
+
+      # @!attribute created_at
+      #   Filter by `created_at` using comparison operators like `gt` (>), `gte` (>=),
+      #   `lt` (<), `lte` (<=), or `eq` (=) to filter by the created at timestamp. For
+      #   example, `created_at[gte]=2024-01-01T00:00:00Z`
+      #
+      #   @return [ModernTreasury::Models::PaymentActionListParams::CreatedAt, nil]
+      optional :created_at, -> { ModernTreasury::PaymentActionListParams::CreatedAt }
+
+      # @!attribute internal_account_id
+      #   The ID of one of your internal accounts.
+      #
+      #   @return [String, nil]
+      optional :internal_account_id, String
+
+      # @!attribute 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::Internal::Type::HashOf[String]
+
+      # @!attribute per_page
+      #
+      #   @return [Integer, nil]
+      optional :per_page, Integer
+
+      # @!attribute status
+      #   Filter by payment actions of a specific status.
+      #
+      #   @return [Symbol, ModernTreasury::Models::PaymentActionListParams::Status, nil]
+      optional :status, enum: -> { ModernTreasury::PaymentActionListParams::Status }
+
+      # @!attribute type
+      #   The type of payment action.
+      #
+      #   @return [Symbol, ModernTreasury::Models::PaymentActionListParams::Type, nil]
+      optional :type, enum: -> { ModernTreasury::PaymentActionListParams::Type }
+
+      # @!method initialize(actionable_id: nil, actionable_type: nil, after_cursor: nil, created_at: nil, internal_account_id: nil, metadata: nil, per_page: nil, status: nil, type: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {ModernTreasury::Models::PaymentActionListParams} for more details.
+      #
+      #   @param actionable_id [String] The ID of the associated actionable object.
+      #
+      #   @param actionable_type [String] The type of the associated actionable object. One of `payment_order`,
+      #   `expected\_
+      #
+      #   @param after_cursor [String, nil]
+      #
+      #   @param created_at [ModernTreasury::Models::PaymentActionListParams::CreatedAt] Filter by `created_at` using comparison operators like `gt` (>), `gte` (>=), `lt
+      #
+      #   @param internal_account_id [String] The ID of one of your internal accounts.
+      #
+      #   @param metadata [Hash{Symbol=>String}] For example, if you want to query for records with metadata key `Type` and value
+      #
+      #   @param per_page [Integer]
+      #
+      #   @param status [Symbol, ModernTreasury::Models::PaymentActionListParams::Status] Filter by payment actions of a specific status.
+      #
+      #   @param type [Symbol, ModernTreasury::Models::PaymentActionListParams::Type] The type of payment action.
+      #
+      #   @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
+
+      class CreatedAt < ModernTreasury::Internal::Type::BaseModel
+        # @!attribute eq
+        #
+        #   @return [Time, nil]
+        optional :eq, Time
+
+        # @!attribute gt
+        #
+        #   @return [Time, nil]
+        optional :gt, Time
+
+        # @!attribute gte
+        #
+        #   @return [Time, nil]
+        optional :gte, Time
+
+        # @!attribute lt
+        #
+        #   @return [Time, nil]
+        optional :lt, Time
+
+        # @!attribute lte
+        #
+        #   @return [Time, nil]
+        optional :lte, Time
+
+        # @!method initialize(eq: nil, gt: nil, gte: nil, lt: nil, lte: nil)
+        #   Filter by `created_at` using comparison operators like `gt` (>), `gte` (>=),
+        #   `lt` (<), `lte` (<=), or `eq` (=) to filter by the created at timestamp. For
+        #   example, `created_at[gte]=2024-01-01T00:00:00Z`
+        #
+        #   @param eq [Time]
+        #   @param gt [Time]
+        #   @param gte [Time]
+        #   @param lt [Time]
+        #   @param lte [Time]
+      end
+
+      # Filter by payment actions of a specific status.
+      module Status
+        extend ModernTreasury::Internal::Type::Enum
+
+        PENDING = :pending
+        PROCESSABLE = :processable
+        PROCESSING = :processing
+        SENT = :sent
+        FAILED = :failed
+        CANCELLED = :cancelled
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # The type of payment action.
+      module Type
+        extend ModernTreasury::Internal::Type::Enum
+
+        STOP = :stop
+        ISSUE = :issue
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/modern_treasury/models/payment_action_list_response.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    # @see ModernTreasury::Resources::PaymentActions#list
+    class PaymentActionListResponse < ModernTreasury::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute actionable_id
+      #   The ID of the associated actionable object.
+      #
+      #   @return [String, nil]
+      required :actionable_id, String, nil?: true
+
+      # @!attribute actionable_type
+      #   The type of the associated actionable object. One of `payment_order`,
+      #   `expected_payment`.
+      #
+      #   @return [String, nil]
+      required :actionable_type, String, nil?: true
+
+      # @!attribute created_at
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute details
+      #   The specifc details of the payment action based on type.
+      #
+      #   @return [Object]
+      required :details, ModernTreasury::Internal::Type::Unknown
+
+      # @!attribute internal_account_id
+      #   The ID of the internal account associated with the payment action.
+      #
+      #   @return [String]
+      required :internal_account_id, String
+
+      # @!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::Internal::Type::Boolean
+
+      # @!attribute object
+      #
+      #   @return [String]
+      required :object, String
+
+      # @!attribute status
+      #   The current status of the payment action. One of `pending`, `processing`,
+      #   `sent`, `cancelled`, or `failed`.
+      #
+      #   @return [String]
+      required :status, String
+
+      # @!attribute type
+      #   The type of the payment action. Determines the action to be taken.
+      #
+      #   @return [String]
+      required :type, String
+
+      # @!attribute updated_at
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!method initialize(id:, actionable_id:, actionable_type:, created_at:, details:, internal_account_id:, live_mode:, object:, status:, type:, updated_at:)
+      #   Some parameter documentations has been truncated, see
+      #   {ModernTreasury::Models::PaymentActionListResponse} for more details.
+      #
+      #   @param id [String]
+      #
+      #   @param actionable_id [String, nil] The ID of the associated actionable object.
+      #
+      #   @param actionable_type [String, nil] The type of the associated actionable object. One of `payment_order`,
+      #   `expected\_
+      #
+      #   @param created_at [Time]
+      #
+      #   @param details [Object] The specifc details of the payment action based on type.
+      #
+      #   @param internal_account_id [String] The ID of the internal account associated with the payment action.
+      #
+      #   @param live_mode [Boolean] This field will be true if this object exists in the live environment or false i
+      #
+      #   @param object [String]
+      #
+      #   @param status [String] The current status of the payment action. One of `pending`, `processing`, `sent`
+      #
+      #   @param type [String] The type of the payment action. Determines the action to be taken.
+      #
+      #   @param updated_at [Time]
+    end
+  end
+end

data/lib/modern_treasury/models/payment_action_retrieve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    # @see ModernTreasury::Resources::PaymentActions#retrieve
+    class PaymentActionRetrieveParams < ModernTreasury::Internal::Type::BaseModel
+      extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/modern_treasury/models/payment_action_retrieve_response.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    # @see ModernTreasury::Resources::PaymentActions#retrieve
+    class PaymentActionRetrieveResponse < ModernTreasury::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute actionable_id
+      #   The ID of the associated actionable object.
+      #
+      #   @return [String, nil]
+      required :actionable_id, String, nil?: true
+
+      # @!attribute actionable_type
+      #   The type of the associated actionable object. One of `payment_order`,
+      #   `expected_payment`.
+      #
+      #   @return [String, nil]
+      required :actionable_type, String, nil?: true
+
+      # @!attribute created_at
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute details
+      #   The specifc details of the payment action based on type.
+      #
+      #   @return [Object]
+      required :details, ModernTreasury::Internal::Type::Unknown
+
+      # @!attribute internal_account_id
+      #   The ID of the internal account associated with the payment action.
+      #
+      #   @return [String]
+      required :internal_account_id, String
+
+      # @!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::Internal::Type::Boolean
+
+      # @!attribute object
+      #
+      #   @return [String]
+      required :object, String
+
+      # @!attribute status
+      #   The current status of the payment action. One of `pending`, `processing`,
+      #   `sent`, `cancelled`, or `failed`.
+      #
+      #   @return [String]
+      required :status, String
+
+      # @!attribute type
+      #   The type of the payment action. Determines the action to be taken.
+      #
+      #   @return [String]
+      required :type, String
+
+      # @!attribute updated_at
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!method initialize(id:, actionable_id:, actionable_type:, created_at:, details:, internal_account_id:, live_mode:, object:, status:, type:, updated_at:)
+      #   Some parameter documentations has been truncated, see
+      #   {ModernTreasury::Models::PaymentActionRetrieveResponse} for more details.
+      #
+      #   @param id [String]
+      #
+      #   @param actionable_id [String, nil] The ID of the associated actionable object.
+      #
+      #   @param actionable_type [String, nil] The type of the associated actionable object. One of `payment_order`,
+      #   `expected\_
+      #
+      #   @param created_at [Time]
+      #
+      #   @param details [Object] The specifc details of the payment action based on type.
+      #
+      #   @param internal_account_id [String] The ID of the internal account associated with the payment action.
+      #
+      #   @param live_mode [Boolean] This field will be true if this object exists in the live environment or false i
+      #
+      #   @param object [String]
+      #
+      #   @param status [String] The current status of the payment action. One of `pending`, `processing`, `sent`
+      #
+      #   @param type [String] The type of the payment action. Determines the action to be taken.
+      #
+      #   @param updated_at [Time]
+    end
+  end
+end

data/lib/modern_treasury/models/payment_action_update_params.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    # @see ModernTreasury::Resources::PaymentActions#update
+    class PaymentActionUpdateParams < ModernTreasury::Internal::Type::BaseModel
+      extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
+
+      # @!attribute status
+      #   Optional. Set the status of the payment action to `cancelled` to cancel the
+      #   payment action. This will only work if the payment action is in a `pending`
+      #   state.
+      #
+      #   @return [Symbol, ModernTreasury::Models::PaymentActionUpdateParams::Status]
+      required :status, enum: -> { ModernTreasury::PaymentActionUpdateParams::Status }
+
+      # @!method initialize(status:, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {ModernTreasury::Models::PaymentActionUpdateParams} for more details.
+      #
+      #   @param status [Symbol, ModernTreasury::Models::PaymentActionUpdateParams::Status] Optional. Set the status of the payment action to `cancelled` to cancel the paym
+      #
+      #   @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
+
+      # Optional. Set the status of the payment action to `cancelled` to cancel the
+      # payment action. This will only work if the payment action is in a `pending`
+      # state.
+      module Status
+        extend ModernTreasury::Internal::Type::Enum
+
+        PENDING = :pending
+        PROCESSABLE = :processable
+        PROCESSING = :processing
+        SENT = :sent
+        FAILED = :failed
+        CANCELLED = :cancelled
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/modern_treasury/models/payment_action_update_response.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    # @see ModernTreasury::Resources::PaymentActions#update
+    class PaymentActionUpdateResponse < ModernTreasury::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute actionable_id
+      #   The ID of the associated actionable object.
+      #
+      #   @return [String, nil]
+      required :actionable_id, String, nil?: true
+
+      # @!attribute actionable_type
+      #   The type of the associated actionable object. One of `payment_order`,
+      #   `expected_payment`.
+      #
+      #   @return [String, nil]
+      required :actionable_type, String, nil?: true
+
+      # @!attribute created_at
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute details
+      #   The specifc details of the payment action based on type.
+      #
+      #   @return [Object]
+      required :details, ModernTreasury::Internal::Type::Unknown
+
+      # @!attribute internal_account_id
+      #   The ID of the internal account associated with the payment action.
+      #
+      #   @return [String]
+      required :internal_account_id, String
+
+      # @!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::Internal::Type::Boolean
+
+      # @!attribute object
+      #
+      #   @return [String]
+      required :object, String
+
+      # @!attribute status
+      #   The current status of the payment action. One of `pending`, `processing`,
+      #   `sent`, `cancelled`, or `failed`.
+      #
+      #   @return [String]
+      required :status, String
+
+      # @!attribute type
+      #   The type of the payment action. Determines the action to be taken.
+      #
+      #   @return [String]
+      required :type, String
+
+      # @!attribute updated_at
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!method initialize(id:, actionable_id:, actionable_type:, created_at:, details:, internal_account_id:, live_mode:, object:, status:, type:, updated_at:)
+      #   Some parameter documentations has been truncated, see
+      #   {ModernTreasury::Models::PaymentActionUpdateResponse} for more details.
+      #
+      #   @param id [String]
+      #
+      #   @param actionable_id [String, nil] The ID of the associated actionable object.
+      #
+      #   @param actionable_type [String, nil] The type of the associated actionable object. One of `payment_order`,
+      #   `expected\_
+      #
+      #   @param created_at [Time]
+      #
+      #   @param details [Object] The specifc details of the payment action based on type.
+      #
+      #   @param internal_account_id [String] The ID of the internal account associated with the payment action.
+      #
+      #   @param live_mode [Boolean] This field will be true if this object exists in the live environment or false i
+      #
+      #   @param object [String]
+      #
+      #   @param status [String] The current status of the payment action. One of `pending`, `processing`, `sent`
+      #
+      #   @param type [String] The type of the payment action. Determines the action to be taken.
+      #
+      #   @param updated_at [Time]
+    end
+  end
+end