straddle 0.1.0.pre.alpha.1

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

@@ -0,0 +1,233 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Resources
+    class Embed
+      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, correlation_id: 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 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::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", 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, correlation_id: 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 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::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", 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 = {})
+          parsed, options = Straddle::Embed::RepresentativeListParams.dump_request(params)
+          query_params =
+            [
+              :account_id,
+              :level,
+              :organization_id,
+              :page_number,
+              :page_size,
+              :platform_id,
+              :sort_by,
+              :sort_order
+            ]
+          @client.request(
+            method: :get,
+            path: "v1/representatives",
+            query: parsed.slice(*query_params),
+            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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Resources
+    class Embed
+      # @return [Straddle::Resources::Embed::Accounts]
+      attr_reader :accounts
+
+      # @return [Straddle::Resources::Embed::LinkedBankAccounts]
+      attr_reader :linked_bank_accounts
+
+      # @return [Straddle::Resources::Embed::Organizations]
+      attr_reader :organizations
+
+      # @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/funding_events.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Resources
+    class FundingEvents
+      # Some parameter documentations has been truncated, see
+      # {Straddle::Models::FundingEventListParams} for more details.
+      #
+      # Retrieves a list of funding events for your account. This endpoint supports
+      # advanced sorting and filtering options.
+      #
+      # @overload list(created_from: nil, created_to: nil, direction: nil, event_type: nil, page_number: nil, page_size: nil, sort_by: nil, sort_order: nil, trace_number: nil, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      #
+      # @param created_from [Date, nil] Query param: The start date of the range to filter by using the `YYYY-MM-DD` for
+      #
+      # @param created_to [Date, nil] Query param: The end date of the range to filter by using the `YYYY-MM-DD` forma
+      #
+      # @param direction [Symbol, Straddle::Models::FundingEventListParams::Direction] Query param: Describes the direction of the funding event from the perspective o
+      #
+      # @param event_type [Symbol, Straddle::Models::FundingEventListParams::EventType] Query param: The funding event types describes the direction and reason for the
+      #
+      # @param page_number [Integer] Query param: Results page number. Starts at page 1.
+      #
+      # @param page_size [Integer] Query param: Results page size. Max value: 1000
+      #
+      # @param sort_by [Symbol, Straddle::Models::FundingEventListParams::SortBy] Query param: The field to sort the results by.
+      #
+      # @param sort_order [Symbol, Straddle::Models::FundingEventListParams::SortOrder] Query param: The order in which to sort the results.
+      #
+      # @param trace_number [String, nil] Query param: Trace number.
+      #
+      # @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 straddle_account_id [String] Header param: For use by platforms to specify an account id and set scope of a r
+      #
+      # @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Straddle::Internal::PageNumberSchema<Straddle::Models::FundingEventSummaryPagedV1::Data>]
+      #
+      # @see Straddle::Models::FundingEventListParams
+      def list(params = {})
+        parsed, options = Straddle::FundingEventListParams.dump_request(params)
+        query_params =
+          [
+            :created_from,
+            :created_to,
+            :direction,
+            :event_type,
+            :page_number,
+            :page_size,
+            :sort_by,
+            :sort_order,
+            :trace_number
+          ]
+        @client.request(
+          method: :get,
+          path: "v1/funding_events",
+          query: parsed.slice(*query_params),
+          headers: parsed.except(*query_params).transform_keys(
+            correlation_id: "correlation-id",
+            request_id: "request-id",
+            straddle_account_id: "straddle-account-id"
+          ),
+          page: Straddle::Internal::PageNumberSchema,
+          model: Straddle::FundingEventSummaryPagedV1::Data,
+          options: options
+        )
+      end
+
+      # Retrieves the details of an existing funding event. Supply the unique funding
+      # event `id`, and Straddle will return the individual transaction items that make
+      # up the funding event.
+      #
+      # @overload get(id, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      #
+      # @param 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 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::FundingEventSummaryItemV1]
+      #
+      # @see Straddle::Models::FundingEventGetParams
+      def get(id, params = {})
+        parsed, options = Straddle::FundingEventGetParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: ["v1/funding_events/%1$s", id],
+          headers: parsed.transform_keys(
+            correlation_id: "correlation-id",
+            request_id: "request-id",
+            straddle_account_id: "straddle-account-id"
+          ),
+          model: Straddle::FundingEventSummaryItemV1,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Straddle::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/straddle/resources/paykeys.rb

@@ -0,0 +1,207 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Resources
+    class Paykeys
+      # Some parameter documentations has been truncated, see
+      # {Straddle::Models::PaykeyListParams} for more details.
+      #
+      # Returns a list of paykeys associated with a Straddle account. This endpoint
+      # supports advanced sorting and filtering options.
+      #
+      # @overload list(customer_id: nil, page_number: nil, page_size: nil, sort_by: nil, sort_order: nil, source: nil, status: nil, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      #
+      # @param customer_id [String] Query param: Filter paykeys by related customer ID.
+      #
+      # @param page_number [Integer] Query param: Page number for paginated results. Starts at 1.
+      #
+      # @param page_size [Integer] Query param: Number of results per page. Maximum: 1000.
+      #
+      # @param sort_by [Symbol, Straddle::Models::PaykeyListParams::SortBy] Query param:
+      #
+      # @param sort_order [Symbol, Straddle::Models::PaykeyListParams::SortOrder] Query param:
+      #
+      # @param source [Array<Symbol, Straddle::Models::PaykeyListParams::Source>] Query param: Filter paykeys by their source.
+      #
+      # @param status [Array<Symbol, Straddle::Models::PaykeyListParams::Status>] Query param: Filter paykeys by their current status.
+      #
+      # @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 straddle_account_id [String] Header param: For use by platforms to specify an account id and set scope of a r
+      #
+      # @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Straddle::Internal::PageNumberSchema<Straddle::Models::PaykeySummaryPagedV1::Data>]
+      #
+      # @see Straddle::Models::PaykeyListParams
+      def list(params = {})
+        parsed, options = Straddle::PaykeyListParams.dump_request(params)
+        query_params = [:customer_id, :page_number, :page_size, :sort_by, :sort_order, :source, :status]
+        @client.request(
+          method: :get,
+          path: "v1/paykeys",
+          query: parsed.slice(*query_params),
+          headers: parsed.except(*query_params).transform_keys(
+            correlation_id: "correlation-id",
+            request_id: "request-id",
+            straddle_account_id: "straddle-account-id"
+          ),
+          page: Straddle::Internal::PageNumberSchema,
+          model: Straddle::PaykeySummaryPagedV1::Data,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Straddle::Models::PaykeyCancelParams} for more details.
+      #
+      # @overload cancel(id, reason: nil, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      #
+      # @param id [String] Path param:
+      #
+      # @param reason [String, nil] Body param:
+      #
+      # @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 straddle_account_id [String] Header param: For use by platforms to specify an account id and set scope of a r
+      #
+      # @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Straddle::Models::PaykeyV1]
+      #
+      # @see Straddle::Models::PaykeyCancelParams
+      def cancel(id, params = {})
+        parsed, options = Straddle::PaykeyCancelParams.dump_request(params)
+        header_params =
+          {
+            correlation_id: "correlation-id",
+            request_id: "request-id",
+            straddle_account_id: "straddle-account-id"
+          }
+        @client.request(
+          method: :put,
+          path: ["v1/paykeys/%1$s/cancel", id],
+          headers: parsed.slice(*header_params.keys).transform_keys(header_params),
+          body: parsed.except(*header_params.keys),
+          model: Straddle::PaykeyV1,
+          options: options
+        )
+      end
+
+      # Retrieves the details of an existing paykey. Supply the unique paykey `id` and
+      # Straddle will return the corresponding paykey record , including the `paykey`
+      # token value and masked bank account details.
+      #
+      # @overload get(id, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      #
+      # @param 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 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::PaykeyV1]
+      #
+      # @see Straddle::Models::PaykeyGetParams
+      def get(id, params = {})
+        parsed, options = Straddle::PaykeyGetParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: ["v1/paykeys/%1$s", id],
+          headers: parsed.transform_keys(
+            correlation_id: "correlation-id",
+            request_id: "request-id",
+            straddle_account_id: "straddle-account-id"
+          ),
+          model: Straddle::PaykeyV1,
+          options: options
+        )
+      end
+
+      # Retrieves the details of a paykey that has previously been created, including
+      # unmasked bank account fields. Supply the unique paykey ID that was returned from
+      # your previous request, and Straddle will return the corresponding paykey
+      # information.
+      #
+      # @overload reveal(id, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      #
+      # @param 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 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::PaykeyRevealResponse]
+      #
+      # @see Straddle::Models::PaykeyRevealParams
+      def reveal(id, params = {})
+        parsed, options = Straddle::PaykeyRevealParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: ["v1/paykeys/%1$s/reveal", id],
+          headers: parsed.transform_keys(
+            correlation_id: "correlation-id",
+            request_id: "request-id",
+            straddle_account_id: "straddle-account-id"
+          ),
+          model: Straddle::Models::PaykeyRevealResponse,
+          options: options
+        )
+      end
+
+      # Retrieves the unmasked details of an existing paykey. Supply the unique paykey
+      # `id` and Straddle will return the corresponding paykey record, including the
+      # unmasked bank account details. This endpoint needs to be enabled by Straddle for
+      # your account and should only be used when absolutely necessary.
+      #
+      # @overload unmasked(id, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      #
+      # @param 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 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::PaykeyUnmaskedV1]
+      #
+      # @see Straddle::Models::PaykeyUnmaskedParams
+      def unmasked(id, params = {})
+        parsed, options = Straddle::PaykeyUnmaskedParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: ["v1/paykeys/%1$s/unmasked", id],
+          headers: parsed.transform_keys(
+            correlation_id: "correlation-id",
+            request_id: "request-id",
+            straddle_account_id: "straddle-account-id"
+          ),
+          model: Straddle::PaykeyUnmaskedV1,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Straddle::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end