straddle 0.4.0 → 1.0.0

data/lib/straddle/models/capability_request.rb

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    class CapabilityRequest < Straddle::Internal::Type::BaseModel
+      # @!attribute id
+      #   Straddle's unique ID for the capability request.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute account_id
+      #   ID of the account associated with the capability request.
+      #
+      #   @return [String]
+      required :account_id, String
+
+      # @!attribute category
+      #   Groups the requested capability. `payment_type` covers `charges` and `payouts`.
+      #   `customer_type` covers `individuals` and `businesses`. `consent_type` covers
+      #   `signed_agreement` and `internet` authorization.
+      #
+      #   @return [Symbol, Straddle::Models::CapabilityRequest::Category]
+      required :category, enum: -> { Straddle::CapabilityRequest::Category }
+
+      # @!attribute created_at
+      #   Date and time when Straddle created the capability request.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute enable
+      #   Whether the request enables or disables the capability.
+      #
+      #   @return [Boolean]
+      required :enable, Straddle::Internal::Type::Boolean
+
+      # @!attribute status
+      #   Status of the capability request.
+      #
+      #   @return [Symbol, Straddle::Models::CapabilityRequest::Status]
+      required :status, enum: -> { Straddle::CapabilityRequest::Status }
+
+      # @!attribute type
+      #   Capability type requested within the category.
+      #
+      #   @return [Symbol, Straddle::Models::CapabilityRequest::Type]
+      required :type, enum: -> { Straddle::CapabilityRequest::Type }
+
+      # @!attribute updated_at
+      #   Date and time of the most recent capability request update.
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!attribute settings
+      #   Limits and other settings requested for the capability.
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :settings, Straddle::Internal::Type::HashOf[Straddle::Internal::Type::Unknown], nil?: true
+
+      # @!method initialize(id:, account_id:, category:, created_at:, enable:, status:, type:, updated_at:, settings: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Straddle::Models::CapabilityRequest} for more details.
+      #
+      #   @param id [String] Straddle's unique ID for the capability request.
+      #
+      #   @param account_id [String] ID of the account associated with the capability request.
+      #
+      #   @param category [Symbol, Straddle::Models::CapabilityRequest::Category] Groups the requested capability. `payment_type` covers `charges` and `payouts`.
+      #
+      #   @param created_at [Time] Date and time when Straddle created the capability request.
+      #
+      #   @param enable [Boolean] Whether the request enables or disables the capability.
+      #
+      #   @param status [Symbol, Straddle::Models::CapabilityRequest::Status] Status of the capability request.
+      #
+      #   @param type [Symbol, Straddle::Models::CapabilityRequest::Type] Capability type requested within the category.
+      #
+      #   @param updated_at [Time] Date and time of the most recent capability request update.
+      #
+      #   @param settings [Hash{Symbol=>Object}, nil] Limits and other settings requested for the capability.
+
+      # Groups the requested capability. `payment_type` covers `charges` and `payouts`.
+      # `customer_type` covers `individuals` and `businesses`. `consent_type` covers
+      # `signed_agreement` and `internet` authorization.
+      #
+      # @see Straddle::Models::CapabilityRequest#category
+      module Category
+        extend Straddle::Internal::Type::Enum
+
+        PAYMENT_TYPE = :payment_type
+        CUSTOMER_TYPE = :customer_type
+        CONSENT_TYPE = :consent_type
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Status of the capability request.
+      #
+      # @see Straddle::Models::CapabilityRequest#status
+      module Status
+        extend Straddle::Internal::Type::Enum
+
+        ACTIVE = :active
+        INACTIVE = :inactive
+        IN_REVIEW = :in_review
+        REJECTED = :rejected
+        APPROVED = :approved
+        REVIEWING = :reviewing
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Capability type requested within the category.
+      #
+      # @see Straddle::Models::CapabilityRequest#type
+      module Type
+        extend Straddle::Internal::Type::Enum
+
+        CHARGES = :charges
+        PAYOUTS = :payouts
+        INDIVIDUALS = :individuals
+        BUSINESSES = :businesses
+        SIGNED_AGREEMENT = :signed_agreement
+        INTERNET = :internet
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/straddle/models/capability_request_create_params.rb

@@ -0,0 +1,235 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # @see Straddle::Resources::CapabilityRequests#create
+    class CapabilityRequestCreateParams < Straddle::Internal::Type::BaseModel
+      extend Straddle::Internal::Type::RequestParameters::Converter
+      include Straddle::Internal::Type::RequestParameters
+
+      # @!attribute account_id
+      #
+      #   @return [String]
+      required :account_id, String
+
+      # @!attribute businesses
+      #   Request to enable or disable payments from businesses.
+      #
+      #   @return [Straddle::Models::CapabilityRequestCreateParams::Businesses, nil]
+      optional :businesses, -> { Straddle::CapabilityRequestCreateParams::Businesses }
+
+      # @!attribute charges
+      #   Requested charge capability and limits.
+      #
+      #   @return [Straddle::Models::CapabilityRequestCreateParams::Charges, nil]
+      optional :charges, -> { Straddle::CapabilityRequestCreateParams::Charges }
+
+      # @!attribute individuals
+      #   Request to enable or disable payments from individuals.
+      #
+      #   @return [Straddle::Models::CapabilityRequestCreateParams::Individuals, nil]
+      optional :individuals, -> { Straddle::CapabilityRequestCreateParams::Individuals }
+
+      # @!attribute internet
+      #   Request to enable or disable internet and mobile payment authorization.
+      #
+      #   @return [Straddle::Models::CapabilityRequestCreateParams::Internet, nil]
+      optional :internet, -> { Straddle::CapabilityRequestCreateParams::Internet }
+
+      # @!attribute payouts
+      #   Requested payout capability and limits.
+      #
+      #   @return [Straddle::Models::CapabilityRequestCreateParams::Payouts, nil]
+      optional :payouts, -> { Straddle::CapabilityRequestCreateParams::Payouts }
+
+      # @!attribute signed_agreement
+      #   Request to enable or disable signed-agreement payment authorization.
+      #
+      #   @return [Straddle::Models::CapabilityRequestCreateParams::SignedAgreement, nil]
+      optional :signed_agreement, -> { Straddle::CapabilityRequestCreateParams::SignedAgreement }
+
+      # @!attribute correlation_id
+      #   Optional client-generated identifier for tracing a series of related requests.
+      #
+      #   @return [String, nil]
+      optional :correlation_id, String
+
+      # @!attribute idempotency_key
+      #   Optional client-generated key for an idempotent request.
+      #
+      #   @return [String, nil]
+      optional :idempotency_key, String
+
+      # @!attribute request_id
+      #   Optional client-generated identifier for tracing one request.
+      #
+      #   @return [String, nil]
+      optional :request_id, String
+
+      # @!method initialize(account_id:, businesses: nil, charges: nil, individuals: nil, internet: nil, payouts: nil, signed_agreement: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, request_options: {})
+      #   @param account_id [String]
+      #
+      #   @param businesses [Straddle::Models::CapabilityRequestCreateParams::Businesses] Request to enable or disable payments from businesses.
+      #
+      #   @param charges [Straddle::Models::CapabilityRequestCreateParams::Charges] Requested charge capability and limits.
+      #
+      #   @param individuals [Straddle::Models::CapabilityRequestCreateParams::Individuals] Request to enable or disable payments from individuals.
+      #
+      #   @param internet [Straddle::Models::CapabilityRequestCreateParams::Internet] Request to enable or disable internet and mobile payment authorization.
+      #
+      #   @param payouts [Straddle::Models::CapabilityRequestCreateParams::Payouts] Requested payout capability and limits.
+      #
+      #   @param signed_agreement [Straddle::Models::CapabilityRequestCreateParams::SignedAgreement] Request to enable or disable signed-agreement payment authorization.
+      #
+      #   @param correlation_id [String] Optional client-generated identifier for tracing a series of related requests.
+      #
+      #   @param idempotency_key [String] Optional client-generated key for an idempotent request.
+      #
+      #   @param request_id [String] Optional client-generated identifier for tracing one request.
+      #
+      #   @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}]
+
+      class Businesses < Straddle::Internal::Type::BaseModel
+        # @!attribute enable
+        #   Whether the request enables or disables the capability.
+        #
+        #   @return [Boolean]
+        required :enable, Straddle::Internal::Type::Boolean
+
+        # @!method initialize(enable:)
+        #   Request to enable or disable payments from businesses.
+        #
+        #   @param enable [Boolean] Whether the request enables or disables the capability.
+      end
+
+      class Charges < Straddle::Internal::Type::BaseModel
+        # @!attribute daily_amount
+        #   Daily charge amount limit in cents.
+        #
+        #   @return [Float]
+        required :daily_amount, Float
+
+        # @!attribute enable
+        #   Whether to enable or disable charges for the account.
+        #
+        #   @return [Boolean]
+        required :enable, Straddle::Internal::Type::Boolean
+
+        # @!attribute max_amount
+        #   Maximum amount in cents for one charge.
+        #
+        #   @return [Float]
+        required :max_amount, Float
+
+        # @!attribute monthly_amount
+        #   Monthly charge amount limit in cents.
+        #
+        #   @return [Float]
+        required :monthly_amount, Float
+
+        # @!attribute monthly_count
+        #   Maximum number of charges per calendar month.
+        #
+        #   @return [Integer]
+        required :monthly_count, Integer
+
+        # @!method initialize(daily_amount:, enable:, max_amount:, monthly_amount:, monthly_count:)
+        #   Requested charge capability and limits.
+        #
+        #   @param daily_amount [Float] Daily charge amount limit in cents.
+        #
+        #   @param enable [Boolean] Whether to enable or disable charges for the account.
+        #
+        #   @param max_amount [Float] Maximum amount in cents for one charge.
+        #
+        #   @param monthly_amount [Float] Monthly charge amount limit in cents.
+        #
+        #   @param monthly_count [Integer] Maximum number of charges per calendar month.
+      end
+
+      class Individuals < Straddle::Internal::Type::BaseModel
+        # @!attribute enable
+        #   Whether the request enables or disables the capability.
+        #
+        #   @return [Boolean]
+        required :enable, Straddle::Internal::Type::Boolean
+
+        # @!method initialize(enable:)
+        #   Request to enable or disable payments from individuals.
+        #
+        #   @param enable [Boolean] Whether the request enables or disables the capability.
+      end
+
+      class Internet < Straddle::Internal::Type::BaseModel
+        # @!attribute enable
+        #   Whether the request enables or disables the capability.
+        #
+        #   @return [Boolean]
+        required :enable, Straddle::Internal::Type::Boolean
+
+        # @!method initialize(enable:)
+        #   Request to enable or disable internet and mobile payment authorization.
+        #
+        #   @param enable [Boolean] Whether the request enables or disables the capability.
+      end
+
+      class Payouts < Straddle::Internal::Type::BaseModel
+        # @!attribute daily_amount
+        #   Daily payout amount limit in cents.
+        #
+        #   @return [Float]
+        required :daily_amount, Float
+
+        # @!attribute enable
+        #   Whether to enable or disable payouts for the account.
+        #
+        #   @return [Boolean]
+        required :enable, Straddle::Internal::Type::Boolean
+
+        # @!attribute max_amount
+        #   Maximum amount in cents for one payout.
+        #
+        #   @return [Float]
+        required :max_amount, Float
+
+        # @!attribute monthly_amount
+        #   Monthly payout amount limit in cents.
+        #
+        #   @return [Float]
+        required :monthly_amount, Float
+
+        # @!attribute monthly_count
+        #   Maximum number of payouts per calendar month.
+        #
+        #   @return [Integer]
+        required :monthly_count, Integer
+
+        # @!method initialize(daily_amount:, enable:, max_amount:, monthly_amount:, monthly_count:)
+        #   Requested payout capability and limits.
+        #
+        #   @param daily_amount [Float] Daily payout amount limit in cents.
+        #
+        #   @param enable [Boolean] Whether to enable or disable payouts for the account.
+        #
+        #   @param max_amount [Float] Maximum amount in cents for one payout.
+        #
+        #   @param monthly_amount [Float] Monthly payout amount limit in cents.
+        #
+        #   @param monthly_count [Integer] Maximum number of payouts per calendar month.
+      end
+
+      class SignedAgreement < Straddle::Internal::Type::BaseModel
+        # @!attribute enable
+        #   Whether the request enables or disables the capability.
+        #
+        #   @return [Boolean]
+        required :enable, Straddle::Internal::Type::Boolean
+
+        # @!method initialize(enable:)
+        #   Request to enable or disable signed-agreement payment authorization.
+        #
+        #   @param enable [Boolean] Whether the request enables or disables the capability.
+      end
+    end
+  end
+end

data/lib/straddle/models/capability_request_created_v1_webhook_event.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    class CapabilityRequestCreatedV1WebhookEvent < Straddle::Internal::Type::BaseModel
+      # @!attribute account_id
+      #   Unique identifier for the account associated with this event.
+      #
+      #   @return [String]
+      required :account_id, String
+
+      # @!attribute data
+      #
+      #   @return [Straddle::Models::CapabilityRequest]
+      required :data, -> { Straddle::CapabilityRequest }
+
+      # @!attribute event_id
+      #   Unique identifier for this event.
+      #
+      #   @return [String]
+      required :event_id, String
+
+      # @!attribute event_type
+      #   Type of this event.
+      #
+      #   @return [String]
+      required :event_type, String
+
+      # @!method initialize(account_id:, data:, event_id:, event_type:)
+      #   @param account_id [String] Unique identifier for the account associated with this event.
+      #
+      #   @param data [Straddle::Models::CapabilityRequest]
+      #
+      #   @param event_id [String] Unique identifier for this event.
+      #
+      #   @param event_type [String] Type of this event.
+    end
+  end
+end

data/lib/straddle/models/capability_request_event_v1_webhook_event.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    class CapabilityRequestEventV1WebhookEvent < Straddle::Internal::Type::BaseModel
+      # @!attribute account_id
+      #   Unique identifier for the account associated with this event.
+      #
+      #   @return [String]
+      required :account_id, String
+
+      # @!attribute data
+      #
+      #   @return [Straddle::Models::CapabilityRequest]
+      required :data, -> { Straddle::CapabilityRequest }
+
+      # @!attribute event_id
+      #   Unique identifier for this event.
+      #
+      #   @return [String]
+      required :event_id, String
+
+      # @!attribute event_type
+      #   Type of this event.
+      #
+      #   @return [String]
+      required :event_type, String
+
+      # @!method initialize(account_id:, data:, event_id:, event_type:)
+      #   @param account_id [String] Unique identifier for the account associated with this event.
+      #
+      #   @param data [Straddle::Models::CapabilityRequest]
+      #
+      #   @param event_id [String] Unique identifier for this event.
+      #
+      #   @param event_type [String] Type of this event.
+    end
+  end
+end

data/lib/straddle/models/capability_request_list.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # @see Straddle::Resources::CapabilityRequests#create
+    class CapabilityRequestList < Straddle::Internal::Type::BaseModel
+      # @!attribute data
+      #   Capability requests returned for this page.
+      #
+      #   @return [Array<Straddle::Models::CapabilityRequest>]
+      required :data, -> { Straddle::Internal::Type::ArrayOf[Straddle::CapabilityRequest] }
+
+      # @!attribute meta
+      #   Metadata for an API request and a page of results.
+      #
+      #   @return [Straddle::Models::PageMetadata]
+      required :meta, -> { Straddle::PageMetadata }
+
+      # @!attribute response_type
+      #   Indicates how the response content is structured.
+      #
+      #   - `object` means `data` contains one JSON object.
+      #   - `array` means `data` contains an array of objects.
+      #   - `error` means `error` contains error details.
+      #   - `none` means the response has no data.
+      #
+      #   @return [Symbol, Straddle::Models::CapabilityRequestList::ResponseType]
+      required :response_type, enum: -> { Straddle::CapabilityRequestList::ResponseType }
+
+      # @!method initialize(data:, meta:, response_type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Straddle::Models::CapabilityRequestList} for more details.
+      #
+      #   @param data [Array<Straddle::Models::CapabilityRequest>] Capability requests returned for this page.
+      #
+      #   @param meta [Straddle::Models::PageMetadata] Metadata for an API request and a page of results.
+      #
+      #   @param response_type [Symbol, Straddle::Models::CapabilityRequestList::ResponseType] Indicates how the response content is structured.
+
+      # Indicates how the response content is structured.
+      #
+      # - `object` means `data` contains one JSON object.
+      # - `array` means `data` contains an array of objects.
+      # - `error` means `error` contains error details.
+      # - `none` means the response has no data.
+      #
+      # @see Straddle::Models::CapabilityRequestList#response_type
+      module ResponseType
+        extend Straddle::Internal::Type::Enum
+
+        OBJECT = :object
+        ARRAY = :array
+        ERROR = :error
+        NONE = :none
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/straddle/models/capability_request_list_params.rb

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # @see Straddle::Resources::CapabilityRequests#list
+    class CapabilityRequestListParams < Straddle::Internal::Type::BaseModel
+      extend Straddle::Internal::Type::RequestParameters::Converter
+      include Straddle::Internal::Type::RequestParameters
+
+      # @!attribute account_id
+      #
+      #   @return [String]
+      required :account_id, String
+
+      # @!attribute category
+      #   Capability category to return.
+      #
+      #   @return [Symbol, Straddle::Models::CapabilityRequestListParams::Category, nil]
+      optional :category, enum: -> { Straddle::CapabilityRequestListParams::Category }
+
+      # @!attribute page_number
+      #   Page number. Defaults to `1`.
+      #
+      #   @return [Integer, nil]
+      optional :page_number, Integer
+
+      # @!attribute page_size
+      #   Number of results per page. Defaults to `100`. Maximum `1000`.
+      #
+      #   @return [Integer, nil]
+      optional :page_size, Integer
+
+      # @!attribute sort_by
+      #   Field used to sort results. Defaults to `id`.
+      #
+      #   @return [String, nil]
+      optional :sort_by, String
+
+      # @!attribute sort_order
+      #   Sort direction. Defaults to `asc`.
+      #
+      #   @return [Symbol, Straddle::Models::CapabilityRequestListParams::SortOrder, nil]
+      optional :sort_order, enum: -> { Straddle::CapabilityRequestListParams::SortOrder }
+
+      # @!attribute status
+      #   Capability request status to return.
+      #
+      #   @return [Symbol, Straddle::Models::CapabilityRequestListParams::Status, nil]
+      optional :status, enum: -> { Straddle::CapabilityRequestListParams::Status }
+
+      # @!attribute type
+      #   Capability type to return.
+      #
+      #   @return [Symbol, Straddle::Models::CapabilityRequestListParams::Type, nil]
+      optional :type, enum: -> { Straddle::CapabilityRequestListParams::Type }
+
+      # @!attribute correlation_id
+      #   Optional client-generated identifier for tracing a series of related requests.
+      #
+      #   @return [String, nil]
+      optional :correlation_id, String
+
+      # @!attribute request_id
+      #   Optional client-generated identifier for tracing one request.
+      #
+      #   @return [String, nil]
+      optional :request_id, String
+
+      # @!method initialize(account_id:, category: nil, page_number: nil, page_size: nil, sort_by: nil, sort_order: nil, status: nil, type: nil, correlation_id: nil, request_id: nil, request_options: {})
+      #   @param account_id [String]
+      #
+      #   @param category [Symbol, Straddle::Models::CapabilityRequestListParams::Category] Capability category to return.
+      #
+      #   @param page_number [Integer] Page number. Defaults to `1`.
+      #
+      #   @param page_size [Integer] Number of results per page. Defaults to `100`. Maximum `1000`.
+      #
+      #   @param sort_by [String] Field used to sort results. Defaults to `id`.
+      #
+      #   @param sort_order [Symbol, Straddle::Models::CapabilityRequestListParams::SortOrder] Sort direction. Defaults to `asc`.
+      #
+      #   @param status [Symbol, Straddle::Models::CapabilityRequestListParams::Status] Capability request status to return.
+      #
+      #   @param type [Symbol, Straddle::Models::CapabilityRequestListParams::Type] Capability type to return.
+      #
+      #   @param correlation_id [String] Optional client-generated identifier for tracing a series of related requests.
+      #
+      #   @param request_id [String] Optional client-generated identifier for tracing one request.
+      #
+      #   @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}]
+
+      module Category
+        extend Straddle::Internal::Type::Enum
+
+        PAYMENT_TYPE = :payment_type
+        CUSTOMER_TYPE = :customer_type
+        CONSENT_TYPE = :consent_type
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      module SortOrder
+        extend Straddle::Internal::Type::Enum
+
+        ASC = :asc
+        DESC = :desc
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      module Status
+        extend Straddle::Internal::Type::Enum
+
+        ACTIVE = :active
+        INACTIVE = :inactive
+        IN_REVIEW = :in_review
+        REJECTED = :rejected
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      module Type
+        extend Straddle::Internal::Type::Enum
+
+        CHARGES = :charges
+        PAYOUTS = :payouts
+        INDIVIDUALS = :individuals
+        BUSINESSES = :businesses
+        SIGNED_AGREEMENT = :signed_agreement
+        INTERNET = :internet
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end