method-ruby 0.1.0 → 0.2.0

data/lib/method_ruby/resources/entities/products.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module MethodRuby
+  module Resources
+    class Entities
+      # Products associated with entities
+      class Products
+        # Some parameter documentations has been truncated, see
+        # {MethodRuby::Models::Entities::ProductRetrieveParams} for more details.
+        #
+        # Returns a single entity product by its identifier.
+        #
+        # @overload retrieve(prd_id, entity_id:, method_version:, request_options: {})
+        #
+        # @param prd_id [String] Path param: Unique identifier for the entity product.
+        #
+        # @param entity_id [String] Path param: Unique identifier for the entity.
+        #
+        # @param method_version [Symbol, MethodRuby::Models::Entities::ProductRetrieveParams::MethodVersion] Header param: API version to use for this request. This spec targets `2025-12-01
+        #
+        # @param request_options [MethodRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [MethodRuby::Models::Entities::ProductRetrieveResponse]
+        #
+        # @see MethodRuby::Models::Entities::ProductRetrieveParams
+        def retrieve(prd_id, params)
+          parsed, options = MethodRuby::Entities::ProductRetrieveParams.dump_request(params)
+          entity_id =
+            parsed.delete(:entity_id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :get,
+            path: ["entities/%1$s/products/%2$s", entity_id, prd_id],
+            headers: parsed.transform_keys(method_version: "method-version"),
+            model: MethodRuby::Models::Entities::ProductRetrieveResponse,
+            security: {secret_key: true},
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {MethodRuby::Models::Entities::ProductListParams} for more details.
+        #
+        # Returns a list of products for the specified entity.
+        #
+        # @overload list(entity_id, method_version:, request_options: {})
+        #
+        # @param entity_id [String] Unique identifier for the entity.
+        #
+        # @param method_version [Symbol, MethodRuby::Models::Entities::ProductListParams::MethodVersion] API version to use for this request. This spec targets `2025-12-01`.
+        #
+        # @param request_options [MethodRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [MethodRuby::Models::Entities::ProductListResponse]
+        #
+        # @see MethodRuby::Models::Entities::ProductListParams
+        def list(entity_id, params)
+          parsed, options = MethodRuby::Entities::ProductListParams.dump_request(params)
+          @client.request(
+            method: :get,
+            path: ["entities/%1$s/products", entity_id],
+            headers: parsed.transform_keys(method_version: "method-version"),
+            model: MethodRuby::Models::Entities::ProductListResponse,
+            security: {secret_key: true},
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [MethodRuby::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/method_ruby/resources/entities/subscriptions.rb

@@ -0,0 +1,154 @@
+# frozen_string_literal: true
+
+module MethodRuby
+  module Resources
+    class Entities
+      # Subscriptions for entities
+      class Subscriptions
+        # Some parameter documentations has been truncated, see
+        # {MethodRuby::Models::Entities::SubscriptionCreateParams} for more details.
+        #
+        # Creates a new subscription for the specified entity.
+        #
+        # @overload create(entity_id, enroll:, method_version:, payload: nil, idempotency_key: nil, request_options: {})
+        #
+        # @param entity_id [String] Path param: Unique identifier for the entity.
+        #
+        # @param enroll [Symbol, MethodRuby::Models::Entities::SubscriptionCreateParams::Enroll] Body param: Subscription name to enroll.
+        #
+        # @param method_version [Symbol, MethodRuby::Models::Entities::SubscriptionCreateParams::MethodVersion] Header param: API version to use for this request. This spec targets `2025-12-01
+        #
+        # @param payload [MethodRuby::Models::Entities::SubscriptionCreateParams::Payload, nil] Body param: Optional payload for the subscription. Required when enroll is attri
+        #
+        # @param idempotency_key [String] Header param: Idempotency key for safely retrying a write request. Reuse the sam
+        #
+        # @param request_options [MethodRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [MethodRuby::Models::Entities::SubscriptionCreateResponse]
+        #
+        # @see MethodRuby::Models::Entities::SubscriptionCreateParams
+        def create(entity_id, params)
+          parsed, options = MethodRuby::Entities::SubscriptionCreateParams.dump_request(params)
+          header_params = {method_version: "method-version", idempotency_key: "idempotency-key"}
+          @client.request(
+            method: :post,
+            path: ["entities/%1$s/subscriptions", entity_id],
+            headers: parsed.slice(*header_params.keys).transform_keys(header_params),
+            body: parsed.except(*header_params.keys),
+            model: MethodRuby::Models::Entities::SubscriptionCreateResponse,
+            security: {secret_key: true},
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {MethodRuby::Models::Entities::SubscriptionRetrieveParams} for more details.
+        #
+        # Returns a single entity subscription by its identifier.
+        #
+        # @overload retrieve(sub_id, entity_id:, method_version:, request_options: {})
+        #
+        # @param sub_id [String] Path param: Unique identifier for the entity subscription.
+        #
+        # @param entity_id [String] Path param: Unique identifier for the entity.
+        #
+        # @param method_version [Symbol, MethodRuby::Models::Entities::SubscriptionRetrieveParams::MethodVersion] Header param: API version to use for this request. This spec targets `2025-12-01
+        #
+        # @param request_options [MethodRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [MethodRuby::Models::Entities::SubscriptionRetrieveResponse]
+        #
+        # @see MethodRuby::Models::Entities::SubscriptionRetrieveParams
+        def retrieve(sub_id, params)
+          parsed, options = MethodRuby::Entities::SubscriptionRetrieveParams.dump_request(params)
+          entity_id =
+            parsed.delete(:entity_id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :get,
+            path: ["entities/%1$s/subscriptions/%2$s", entity_id, sub_id],
+            headers: parsed.transform_keys(method_version: "method-version"),
+            model: MethodRuby::Models::Entities::SubscriptionRetrieveResponse,
+            security: {secret_key: true},
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {MethodRuby::Models::Entities::SubscriptionListParams} for more details.
+        #
+        # Returns a list of subscriptions for the specified entity.
+        #
+        # @overload list(entity_id, method_version:, request_options: {})
+        #
+        # @param entity_id [String] Unique identifier for the entity.
+        #
+        # @param method_version [Symbol, MethodRuby::Models::Entities::SubscriptionListParams::MethodVersion] API version to use for this request. This spec targets `2025-12-01`.
+        #
+        # @param request_options [MethodRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [MethodRuby::Models::Entities::SubscriptionListResponse]
+        #
+        # @see MethodRuby::Models::Entities::SubscriptionListParams
+        def list(entity_id, params)
+          parsed, options = MethodRuby::Entities::SubscriptionListParams.dump_request(params)
+          @client.request(
+            method: :get,
+            path: ["entities/%1$s/subscriptions", entity_id],
+            headers: parsed.transform_keys(method_version: "method-version"),
+            model: MethodRuby::Models::Entities::SubscriptionListResponse,
+            security: {secret_key: true},
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {MethodRuby::Models::Entities::SubscriptionDeleteParams} for more details.
+        #
+        # Deletes an entity subscription by its identifier.
+        #
+        # @overload delete(sub_id, entity_id:, method_version:, idempotency_key: nil, request_options: {})
+        #
+        # @param sub_id [String] Path param: Unique identifier for the entity subscription.
+        #
+        # @param entity_id [String] Path param: Unique identifier for the entity.
+        #
+        # @param method_version [Symbol, MethodRuby::Models::Entities::SubscriptionDeleteParams::MethodVersion] Header param: API version to use for this request. This spec targets `2025-12-01
+        #
+        # @param idempotency_key [String] Header param: Idempotency key for safely retrying a write request. Reuse the sam
+        #
+        # @param request_options [MethodRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [MethodRuby::Models::Entities::SubscriptionDeleteResponse]
+        #
+        # @see MethodRuby::Models::Entities::SubscriptionDeleteParams
+        def delete(sub_id, params)
+          parsed, options = MethodRuby::Entities::SubscriptionDeleteParams.dump_request(params)
+          entity_id =
+            parsed.delete(:entity_id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :delete,
+            path: ["entities/%1$s/subscriptions/%2$s", entity_id, sub_id],
+            headers: parsed.transform_keys(
+              method_version: "method-version",
+              idempotency_key: "idempotency-key"
+            ),
+            model: MethodRuby::Models::Entities::SubscriptionDeleteResponse,
+            security: {secret_key: true},
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [MethodRuby::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/method_ruby/resources/entities/vehicles.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+module MethodRuby
+  module Resources
+    class Entities
+      # Vehicle data for entities
+      class Vehicles
+        # Some parameter documentations has been truncated, see
+        # {MethodRuby::Models::Entities::VehicleCreateParams} for more details.
+        #
+        # Searches for vehicles associated with the specified entity.
+        #
+        # @overload create(entity_id, body:, method_version:, idempotency_key: nil, request_options: {})
+        #
+        # @param entity_id [String] Path param: Unique identifier for the entity.
+        #
+        # @param body [Object] Body param: Request body for searching entity vehicles. Treated as a product exe
+        #
+        # @param method_version [Symbol, MethodRuby::Models::Entities::VehicleCreateParams::MethodVersion] Header param: API version to use for this request. This spec targets `2025-12-01
+        #
+        # @param idempotency_key [String] Header param: Idempotency key for safely retrying a write request. Reuse the sam
+        #
+        # @param request_options [MethodRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [MethodRuby::Models::Entities::VehicleCreateResponse]
+        #
+        # @see MethodRuby::Models::Entities::VehicleCreateParams
+        def create(entity_id, params)
+          parsed, options = MethodRuby::Entities::VehicleCreateParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: ["entities/%1$s/vehicles", entity_id],
+            headers: parsed.except(:body).transform_keys(
+              method_version: "method-version",
+              idempotency_key: "idempotency-key"
+            ),
+            body: parsed[:body],
+            model: MethodRuby::Models::Entities::VehicleCreateResponse,
+            security: {secret_key: true},
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {MethodRuby::Models::Entities::VehicleRetrieveParams} for more details.
+        #
+        # Returns a single entity vehicle by its identifier.
+        #
+        # @overload retrieve(vhl_id, entity_id:, method_version:, request_options: {})
+        #
+        # @param vhl_id [String] Path param: Unique identifier for the entity vehicle.
+        #
+        # @param entity_id [String] Path param: Unique identifier for the entity.
+        #
+        # @param method_version [Symbol, MethodRuby::Models::Entities::VehicleRetrieveParams::MethodVersion] Header param: API version to use for this request. This spec targets `2025-12-01
+        #
+        # @param request_options [MethodRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [MethodRuby::Models::Entities::VehicleRetrieveResponse]
+        #
+        # @see MethodRuby::Models::Entities::VehicleRetrieveParams
+        def retrieve(vhl_id, params)
+          parsed, options = MethodRuby::Entities::VehicleRetrieveParams.dump_request(params)
+          entity_id =
+            parsed.delete(:entity_id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :get,
+            path: ["entities/%1$s/vehicles/%2$s", entity_id, vhl_id],
+            headers: parsed.transform_keys(method_version: "method-version"),
+            model: MethodRuby::Models::Entities::VehicleRetrieveResponse,
+            security: {secret_key: true},
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {MethodRuby::Models::Entities::VehicleListParams} for more details.
+        #
+        # Returns a list of vehicles for the specified entity.
+        #
+        # @overload list(entity_id, method_version:, request_options: {})
+        #
+        # @param entity_id [String] Unique identifier for the entity.
+        #
+        # @param method_version [Symbol, MethodRuby::Models::Entities::VehicleListParams::MethodVersion] API version to use for this request. This spec targets `2025-12-01`.
+        #
+        # @param request_options [MethodRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [MethodRuby::Models::Entities::VehicleListResponse]
+        #
+        # @see MethodRuby::Models::Entities::VehicleListParams
+        def list(entity_id, params)
+          parsed, options = MethodRuby::Entities::VehicleListParams.dump_request(params)
+          @client.request(
+            method: :get,
+            path: ["entities/%1$s/vehicles", entity_id],
+            headers: parsed.transform_keys(method_version: "method-version"),
+            model: MethodRuby::Models::Entities::VehicleListResponse,
+            security: {secret_key: true},
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [MethodRuby::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/method_ruby/resources/entities/verification_sessions.rb

@@ -0,0 +1,191 @@
+# frozen_string_literal: true
+
+module MethodRuby
+  module Resources
+    class Entities
+      # Verification sessions for entities
+      class VerificationSessions
+        # Some parameter documentations has been truncated, see
+        # {MethodRuby::Models::Entities::VerificationSessionCreateParams} for more
+        # details.
+        #
+        # Creates a new verification session for the specified entity.
+        #
+        # @overload create(entity_id, method_:, type:, method_version:, byo_kyc: nil, byo_sms: nil, kba: nil, sms: nil, sna: nil, idempotency_key: nil, request_options: {})
+        #
+        # @param entity_id [String] Path param: Unique identifier for the entity.
+        #
+        # @param method_ [Symbol, MethodRuby::Models::Entities::VerificationSessionCreateParams::Method] Body param: The verification method to use.
+        #
+        # @param type [Symbol, MethodRuby::Models::Entities::VerificationSessionCreateParams::Type] Body param: The type of verification to perform.
+        #
+        # @param method_version [Symbol, MethodRuby::Models::Entities::VerificationSessionCreateParams::MethodVersion] Header param: API version to use for this request. This spec targets `2025-12-01
+        #
+        # @param byo_kyc [Object] Body param: BYO KYC-specific options. Required when method is byo_kyc.
+        #
+        # @param byo_sms [MethodRuby::Models::Entities::VerificationSessionCreateParams::ByoSMS] Body param: BYO SMS-specific options. Required when method is byo_sms.
+        #
+        # @param kba [Object] Body param: KBA-specific options. Required when method is kba.
+        #
+        # @param sms [Object] Body param: SMS-specific options. Required when method is sms.
+        #
+        # @param sna [Object] Body param: SNA-specific options. Required when method is sna.
+        #
+        # @param idempotency_key [String] Header param: Idempotency key for safely retrying a write request. Reuse the sam
+        #
+        # @param request_options [MethodRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [MethodRuby::Models::Entities::VerificationSessionCreateResponse]
+        #
+        # @see MethodRuby::Models::Entities::VerificationSessionCreateParams
+        def create(entity_id, params)
+          parsed, options = MethodRuby::Entities::VerificationSessionCreateParams.dump_request(params)
+          header_params = {method_version: "method-version", idempotency_key: "idempotency-key"}
+          @client.request(
+            method: :post,
+            path: ["entities/%1$s/verification_sessions", entity_id],
+            headers: parsed.slice(*header_params.keys).transform_keys(header_params),
+            body: parsed.except(*header_params.keys),
+            model: MethodRuby::Models::Entities::VerificationSessionCreateResponse,
+            security: {secret_key: true},
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {MethodRuby::Models::Entities::VerificationSessionRetrieveParams} for more
+        # details.
+        #
+        # Returns a single entity verification session by its identifier.
+        #
+        # @overload retrieve(evf_id, entity_id:, method_version:, request_options: {})
+        #
+        # @param evf_id [String] Path param: Unique identifier for the entity verification session.
+        #
+        # @param entity_id [String] Path param: Unique identifier for the entity.
+        #
+        # @param method_version [Symbol, MethodRuby::Models::Entities::VerificationSessionRetrieveParams::MethodVersion] Header param: API version to use for this request. This spec targets `2025-12-01
+        #
+        # @param request_options [MethodRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [MethodRuby::Models::Entities::VerificationSessionRetrieveResponse]
+        #
+        # @see MethodRuby::Models::Entities::VerificationSessionRetrieveParams
+        def retrieve(evf_id, params)
+          parsed, options = MethodRuby::Entities::VerificationSessionRetrieveParams.dump_request(params)
+          entity_id =
+            parsed.delete(:entity_id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :get,
+            path: ["entities/%1$s/verification_sessions/%2$s", entity_id, evf_id],
+            headers: parsed.transform_keys(method_version: "method-version"),
+            model: MethodRuby::Models::Entities::VerificationSessionRetrieveResponse,
+            security: {secret_key: true},
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {MethodRuby::Models::Entities::VerificationSessionUpdateParams} for more
+        # details.
+        #
+        # Updates a verification session, for example by submitting an SMS verification
+        # code or KBA answers. The request body shape depends on the verification type and
+        # method.
+        #
+        # @overload update(evf_id, entity_id:, method_:, type:, method_version:, kba: nil, sms: nil, sna: nil, idempotency_key: nil, request_options: {})
+        #
+        # @param evf_id [String] Path param: Unique identifier for the entity verification session.
+        #
+        # @param entity_id [String] Path param: Unique identifier for the entity.
+        #
+        # @param method_ [Symbol, MethodRuby::Models::Entities::VerificationSessionUpdateParams::Method] Body param: The verification method.
+        #
+        # @param type [String] Body param: The verification session type.
+        #
+        # @param method_version [Symbol, MethodRuby::Models::Entities::VerificationSessionUpdateParams::MethodVersion] Header param: API version to use for this request. This spec targets `2025-12-01
+        #
+        # @param kba [MethodRuby::Models::Entities::VerificationSessionUpdateParams::Kba] Body param: KBA verification data.
+        #
+        # @param sms [MethodRuby::Models::Entities::VerificationSessionUpdateParams::SMS] Body param: SMS verification data.
+        #
+        # @param sna [Object] Body param: SNA verification data.
+        #
+        # @param idempotency_key [String] Header param: Idempotency key for safely retrying a write request. Reuse the sam
+        #
+        # @param request_options [MethodRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [MethodRuby::Models::Entities::VerificationSessionUpdateResponse]
+        #
+        # @see MethodRuby::Models::Entities::VerificationSessionUpdateParams
+        def update(evf_id, params)
+          parsed, options = MethodRuby::Entities::VerificationSessionUpdateParams.dump_request(params)
+          entity_id =
+            parsed.delete(:entity_id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          header_params = {method_version: "method-version", idempotency_key: "idempotency-key"}
+          @client.request(
+            method: :put,
+            path: ["entities/%1$s/verification_sessions/%2$s", entity_id, evf_id],
+            headers: parsed.slice(*header_params.keys).transform_keys(header_params),
+            body: parsed.except(*header_params.keys),
+            model: MethodRuby::Models::Entities::VerificationSessionUpdateResponse,
+            security: {secret_key: true},
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {MethodRuby::Models::Entities::VerificationSessionListParams} for more details.
+        #
+        # Returns a list of verification sessions for the specified entity.
+        #
+        # @overload list(entity_id, method_version:, from_date: nil, page: nil, page_cursor: nil, page_limit: nil, to_date: nil, request_options: {})
+        #
+        # @param entity_id [String] Path param: Unique identifier for the entity.
+        #
+        # @param method_version [Symbol, MethodRuby::Models::Entities::VerificationSessionListParams::MethodVersion] Header param: API version to use for this request. This spec targets `2025-12-01
+        #
+        # @param from_date [Date] Query param: Filter results from this date (inclusive, YYYY-MM-DD format).
+        #
+        # @param page [Integer] Query param: Page number for pagination (1-indexed).
+        #
+        # @param page_cursor [String] Query param: Cursor for cursor-based pagination. Use the value from `Pagination-
+        #
+        # @param page_limit [Integer] Query param: Number of items per page.
+        #
+        # @param to_date [Date] Query param: Filter results to this date (inclusive, YYYY-MM-DD format).
+        #
+        # @param request_options [MethodRuby::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [MethodRuby::Models::Entities::VerificationSessionListResponse]
+        #
+        # @see MethodRuby::Models::Entities::VerificationSessionListParams
+        def list(entity_id, params)
+          query_params = [:from_date, :page, :page_cursor, :page_limit, :to_date]
+          parsed, options = MethodRuby::Entities::VerificationSessionListParams.dump_request(params)
+          query = MethodRuby::Internal::Util.encode_query_params(parsed.slice(*query_params))
+          @client.request(
+            method: :get,
+            path: ["entities/%1$s/verification_sessions", entity_id],
+            query: query,
+            headers: parsed.except(*query_params).transform_keys(method_version: "method-version"),
+            model: MethodRuby::Models::Entities::VerificationSessionListResponse,
+            security: {secret_key: true},
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [MethodRuby::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end