straddle 0.4.0 → 1.0.0

data/lib/straddle/resources/embed/representatives.rb

@@ -1,250 +0,0 @@
-# frozen_string_literal: true
-
-module Straddle
-  module Resources
-    class Embed
-      # Representatives are individuals who have legal authority or significant
-      # responsibility within a business entity associated with a Straddle account. Each
-      # representative undergoes automated verification as part of KYC/KYB compliance.
-      # Use representatives to collect and verify beneficial owners, control persons,
-      # and authorized signers required for account onboarding. Representatives also
-      # determine who can legally operate the account and make important changes.
-      class Representatives
-        # Some parameter documentations has been truncated, see
-        # {Straddle::Models::Embed::RepresentativeCreateParams} for more details.
-        #
-        # Creates a new representative associated with an account. Representatives are
-        # individuals who have legal authority or significant responsibility within the
-        # business.
-        #
-        # @overload create(account_id:, dob:, email:, first_name:, last_name:, mobile_number:, relationship:, ssn_last4:, external_id: nil, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, request_options: {})
-        #
-        # @param account_id [String] Body param: The unique identifier of the account this representative is associat
-        #
-        # @param dob [Date] Body param: Date of birth for the representative in ISO 8601 format (YYYY-MM-DD)
-        #
-        # @param email [String] Body param: The company email address of the representative.
-        #
-        # @param first_name [String] Body param: The first name of the representative.
-        #
-        # @param last_name [String] Body param: The last name of the representative.
-        #
-        # @param mobile_number [String] Body param: The mobile phone number of the representative.
-        #
-        # @param relationship [Straddle::Models::Embed::RepresentativeCreateParams::Relationship] Body param
-        #
-        # @param ssn_last4 [String] Body param: The last 4 digits of the representative's Social Security Number.
-        #
-        # @param external_id [String, nil] Body param: Unique identifier for the representative in your database, used for
-        #
-        # @param metadata [Hash{Symbol=>String}, nil] Body param: Up to 20 additional user-defined key-value pairs. Useful for storing
-        #
-        # @param correlation_id [String] Header param: Optional client generated identifier to trace and debug a series o
-        #
-        # @param idempotency_key [String] Header param: Optional client generated value to use for idempotent requests.
-        #
-        # @param request_id [String] Header param: Optional client generated identifier to trace and debug a request.
-        #
-        # @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}, nil]
-        #
-        # @return [Straddle::Models::Embed::Representative]
-        #
-        # @see Straddle::Models::Embed::RepresentativeCreateParams
-        def create(params)
-          parsed, options = Straddle::Embed::RepresentativeCreateParams.dump_request(params)
-          header_params =
-            {correlation_id: "correlation-id", idempotency_key: "idempotency-key", request_id: "request-id"}
-          @client.request(
-            method: :post,
-            path: "v1/representatives",
-            headers: parsed.slice(*header_params.keys).transform_keys(header_params),
-            body: parsed.except(*header_params.keys),
-            model: Straddle::Embed::Representative,
-            options: options
-          )
-        end
-
-        # Some parameter documentations has been truncated, see
-        # {Straddle::Models::Embed::RepresentativeUpdateParams} for more details.
-        #
-        # Updates an existing representative's information. This can be used to update
-        # personal details, contact information, or the relationship to the account or
-        # organization.
-        #
-        # @overload update(representative_id, dob:, email:, first_name:, last_name:, mobile_number:, relationship:, ssn_last4:, external_id: nil, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, request_options: {})
-        #
-        # @param representative_id [String] Path param
-        #
-        # @param dob [Date] Body param: The date of birth of the representative, in ISO 8601 format (YYYY-MM
-        #
-        # @param email [String] Body param: The email address of the representative.
-        #
-        # @param first_name [String] Body param: The first name of the representative.
-        #
-        # @param last_name [String] Body param: The last name of the representative.
-        #
-        # @param mobile_number [String] Body param: The mobile phone number of the representative.
-        #
-        # @param relationship [Straddle::Models::Embed::RepresentativeUpdateParams::Relationship] Body param
-        #
-        # @param ssn_last4 [String] Body param: The last 4 digits of the representative's Social Security Number.
-        #
-        # @param external_id [String, nil] Body param: Unique identifier for the representative in your database, used for
-        #
-        # @param metadata [Hash{Symbol=>String}, nil] Body param: Up to 20 additional user-defined key-value pairs. Useful for storing
-        #
-        # @param correlation_id [String] Header param: Optional client generated identifier to trace and debug a series o
-        #
-        # @param idempotency_key [String] Header param: Optional client generated value to use for idempotent requests.
-        #
-        # @param request_id [String] Header param: Optional client generated identifier to trace and debug a request.
-        #
-        # @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}, nil]
-        #
-        # @return [Straddle::Models::Embed::Representative]
-        #
-        # @see Straddle::Models::Embed::RepresentativeUpdateParams
-        def update(representative_id, params)
-          parsed, options = Straddle::Embed::RepresentativeUpdateParams.dump_request(params)
-          header_params =
-            {correlation_id: "correlation-id", idempotency_key: "idempotency-key", request_id: "request-id"}
-          @client.request(
-            method: :put,
-            path: ["v1/representatives/%1$s", representative_id],
-            headers: parsed.slice(*header_params.keys).transform_keys(header_params),
-            body: parsed.except(*header_params.keys),
-            model: Straddle::Embed::Representative,
-            options: options
-          )
-        end
-
-        # Some parameter documentations has been truncated, see
-        # {Straddle::Models::Embed::RepresentativeListParams} for more details.
-        #
-        # Returns a list of representatives associated with a specific account or
-        # organization. The representatives are returned sorted by creation date, with the
-        # most recently created representatives appearing first. This endpoint supports
-        # advanced sorting and filtering options.
-        #
-        # @overload list(account_id: nil, level: nil, organization_id: nil, page_number: nil, page_size: nil, platform_id: nil, sort_by: nil, sort_order: nil, correlation_id: nil, request_id: nil, request_options: {})
-        #
-        # @param account_id [String] Query param: The unique identifier of the account to list representatives for.
-        #
-        # @param level [Symbol, Straddle::Models::Embed::RepresentativeListParams::Level] Query param
-        #
-        # @param organization_id [String] Query param
-        #
-        # @param page_number [Integer] Query param: Results page number. Starts at page 1.
-        #
-        # @param page_size [Integer] Query param: Page size. Max value: 1000
-        #
-        # @param platform_id [String] Query param
-        #
-        # @param sort_by [String] Query param: Sort By.
-        #
-        # @param sort_order [Symbol, Straddle::Models::Embed::RepresentativeListParams::SortOrder] Query param: Sort Order.
-        #
-        # @param correlation_id [String] Header param: Optional client generated identifier to trace and debug a series o
-        #
-        # @param request_id [String] Header param: Optional client generated identifier to trace and debug a request.
-        #
-        # @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}, nil]
-        #
-        # @return [Straddle::Internal::PageNumberSchema<Straddle::Models::Embed::RepresentativePaged::Data>]
-        #
-        # @see Straddle::Models::Embed::RepresentativeListParams
-        def list(params = {})
-          query_params =
-            [
-              :account_id,
-              :level,
-              :organization_id,
-              :page_number,
-              :page_size,
-              :platform_id,
-              :sort_by,
-              :sort_order
-            ]
-          parsed, options = Straddle::Embed::RepresentativeListParams.dump_request(params)
-          query = Straddle::Internal::Util.encode_query_params(parsed.slice(*query_params))
-          @client.request(
-            method: :get,
-            path: "v1/representatives",
-            query: query,
-            headers: parsed.except(*query_params).transform_keys(
-              correlation_id: "correlation-id",
-              request_id: "request-id"
-            ),
-            page: Straddle::Internal::PageNumberSchema,
-            model: Straddle::Embed::RepresentativePaged::Data,
-            options: options
-          )
-        end
-
-        # Retrieves the details of an existing representative. Supply the unique
-        # representative ID, and Straddle will return the corresponding representative
-        # information.
-        #
-        # @overload get(representative_id, correlation_id: nil, request_id: nil, request_options: {})
-        #
-        # @param representative_id [String]
-        #
-        # @param correlation_id [String] Optional client generated identifier to trace and debug a series of requests.
-        #
-        # @param request_id [String] Optional client generated identifier to trace and debug a request.
-        #
-        # @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}, nil]
-        #
-        # @return [Straddle::Models::Embed::Representative]
-        #
-        # @see Straddle::Models::Embed::RepresentativeGetParams
-        def get(representative_id, params = {})
-          parsed, options = Straddle::Embed::RepresentativeGetParams.dump_request(params)
-          @client.request(
-            method: :get,
-            path: ["v1/representatives/%1$s", representative_id],
-            headers: parsed.transform_keys(correlation_id: "correlation-id", request_id: "request-id"),
-            model: Straddle::Embed::Representative,
-            options: options
-          )
-        end
-
-        # Retrieves the unmasked details of a representative that has previously been
-        # created. Supply the unique representative ID, and Straddle will return the
-        # corresponding representative information, including sensitive details. This
-        # endpoint requires additional authentication and should be used with caution.
-        #
-        # @overload unmask(representative_id, correlation_id: nil, request_id: nil, request_options: {})
-        #
-        # @param representative_id [String]
-        #
-        # @param correlation_id [String] Optional client generated identifier to trace and debug a series of requests.
-        #
-        # @param request_id [String] Optional client generated identifier to trace and debug a request.
-        #
-        # @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}, nil]
-        #
-        # @return [Straddle::Models::Embed::Representative]
-        #
-        # @see Straddle::Models::Embed::RepresentativeUnmaskParams
-        def unmask(representative_id, params = {})
-          parsed, options = Straddle::Embed::RepresentativeUnmaskParams.dump_request(params)
-          @client.request(
-            method: :get,
-            path: ["v1/representatives/%1$s/unmask", representative_id],
-            headers: parsed.transform_keys(correlation_id: "correlation-id", request_id: "request-id"),
-            model: Straddle::Embed::Representative,
-            options: options
-          )
-        end
-
-        # @api private
-        #
-        # @param client [Straddle::Client]
-        def initialize(client:)
-          @client = client
-        end
-      end
-    end
-  end
-end

data/lib/straddle/resources/embed.rb

@@ -1,49 +0,0 @@
-# frozen_string_literal: true
-
-module Straddle
-  module Resources
-    class Embed
-      # Accounts represent businesses using Straddle through your platform. Each account
-      # must complete automated verification before processing payments. Use accounts to
-      # manage your users' payment capabilities, track verification status, and control
-      # access to features. Accounts can be instantly created in sandbox and require
-      # additional verification for production access.
-      # @return [Straddle::Resources::Embed::Accounts]
-      attr_reader :accounts
-
-      # Linked bank accounts connect your platform users' external bank accounts to
-      # Straddle for settlements and payment funding. Each linked account undergoes
-      # automated verification and continuous monitoring. Use linked accounts to manage
-      # where clients receive deposits, fund payouts, and track settlement preferences.
-      # @return [Straddle::Resources::Embed::LinkedBankAccounts]
-      attr_reader :linked_bank_accounts
-
-      # Organizations are a powerful feature in Straddle that allow you to manage
-      # multiple accounts under a single umbrella. This hierarchical structure is
-      # particularly useful for businesses with complex operations, multiple
-      # departments, or legally related entities.
-      # @return [Straddle::Resources::Embed::Organizations]
-      attr_reader :organizations
-
-      # Representatives are individuals who have legal authority or significant
-      # responsibility within a business entity associated with a Straddle account. Each
-      # representative undergoes automated verification as part of KYC/KYB compliance.
-      # Use representatives to collect and verify beneficial owners, control persons,
-      # and authorized signers required for account onboarding. Representatives also
-      # determine who can legally operate the account and make important changes.
-      # @return [Straddle::Resources::Embed::Representatives]
-      attr_reader :representatives
-
-      # @api private
-      #
-      # @param client [Straddle::Client]
-      def initialize(client:)
-        @client = client
-        @accounts = Straddle::Resources::Embed::Accounts.new(client: client)
-        @linked_bank_accounts = Straddle::Resources::Embed::LinkedBankAccounts.new(client: client)
-        @organizations = Straddle::Resources::Embed::Organizations.new(client: client)
-        @representatives = Straddle::Resources::Embed::Representatives.new(client: client)
-      end
-    end
-  end
-end

data/lib/straddle/resources/reports.rb

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-module Straddle
-  module Resources
-    class Reports
-      # @overload create_total_customers_by_status(correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
-      #
-      # @param correlation_id [String] Optional client generated identifier to trace and debug a series of requests.
-      #
-      # @param request_id [String] Optional client generated identifier to trace and debug a request.
-      #
-      # @param straddle_account_id [String] For use by platforms to specify an account id and set scope of a request.
-      #
-      # @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [Straddle::Models::ReportCreateTotalCustomersByStatusResponse]
-      #
-      # @see Straddle::Models::ReportCreateTotalCustomersByStatusParams
-      def create_total_customers_by_status(params = {})
-        parsed, options = Straddle::ReportCreateTotalCustomersByStatusParams.dump_request(params)
-        @client.request(
-          method: :post,
-          path: "v1/reports/total_customers_by_status",
-          headers: parsed.transform_keys(
-            correlation_id: "correlation-id",
-            request_id: "request-id",
-            straddle_account_id: "straddle-account-id"
-          ),
-          model: Straddle::Models::ReportCreateTotalCustomersByStatusResponse,
-          options: options
-        )
-      end
-
-      # @api private
-      #
-      # @param client [Straddle::Client]
-      def initialize(client:)
-        @client = client
-      end
-    end
-  end
-end

data/manifest.yaml

@@ -1,17 +0,0 @@
-dependencies:
-  - English
-  - base64
-  - cgi
-  - date
-  - erb
-  - etc
-  - json
-  - net/http
-  - openssl
-  - pathname
-  - rbconfig
-  - securerandom
-  - set
-  - stringio
-  - time
-  - uri

data/rbi/straddle/internal/page_number_schema.rbi

@@ -1,79 +0,0 @@
-# typed: strong
-
-module Straddle
-  module Internal
-    class PageNumberSchema
-      include Straddle::Internal::Type::BasePage
-
-      Elem = type_member
-
-      sig { returns(T.nilable(T::Array[Elem])) }
-      attr_accessor :data
-
-      sig { returns(Meta) }
-      attr_accessor :meta
-
-      # @api private
-      sig { returns(String) }
-      def inspect
-      end
-
-      class Meta < Straddle::Internal::Type::BaseModel
-        OrHash = T.type_alias { T.any(Meta, Straddle::Internal::AnyHash) }
-
-        sig { returns(T.nilable(Integer)) }
-        attr_reader :max_page_size
-
-        sig { params(max_page_size: Integer).void }
-        attr_writer :max_page_size
-
-        sig { returns(T.nilable(Integer)) }
-        attr_reader :page_number
-
-        sig { params(page_number: Integer).void }
-        attr_writer :page_number
-
-        sig { returns(T.nilable(Integer)) }
-        attr_reader :page_size
-
-        sig { params(page_size: Integer).void }
-        attr_writer :page_size
-
-        sig { returns(T.nilable(Integer)) }
-        attr_reader :total_items
-
-        sig { params(total_items: Integer).void }
-        attr_writer :total_items
-
-        sig do
-          params(
-            max_page_size: Integer,
-            page_number: Integer,
-            page_size: Integer,
-            total_items: Integer
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          max_page_size: nil,
-          page_number: nil,
-          page_size: nil,
-          total_items: nil
-        )
-        end
-
-        sig do
-          override.returns(
-            {
-              max_page_size: Integer,
-              page_number: Integer,
-              page_size: Integer,
-              total_items: Integer
-            }
-          )
-        end
-        def to_hash
-        end
-      end
-    end
-  end
-end