yield-sdk 0.5.0 → 0.7.0

data/sig/yield/sdk/modules/customer/payloads/customer_credit_line_info.rbs

@@ -0,0 +1,13 @@
+module Yield
+  module SDK
+    module Customer
+      class CustomerCreditLineInfo
+        attr_reader credit_limit: Money
+        attr_reader amount_available: Money
+
+        def initialize: (credit_limit: Money, amount_available: Money) -> void
+        def self.from_payload: (Hash[Symbol, Object]) -> CustomerCreditLineInfo
+      end
+    end
+  end
+end

data/sig/yield/sdk/modules/customer/payloads/customer_list_payload.rbs

@@ -0,0 +1,16 @@
+module Yield
+  module SDK
+    module Customer
+      type customer_list_params = {
+        ?limit: Integer?,
+        ?after: cursor_like?,
+        ?customer_code: String?,
+        ?extra_system_id: String?,
+      }
+
+      class CustomerListPayload
+        def self.build: (customer_list_params) -> Hash[Symbol, String | Integer | nil]
+      end
+    end
+  end
+end

data/sig/yield/sdk/modules/customer/payloads/customer_row.rbs

@@ -0,0 +1,16 @@
+module Yield
+  module SDK
+    module Customer
+      class CustomerRow
+        attr_reader id: String
+        attr_reader registered_name: String
+        attr_reader trade_name: String?
+        attr_reader customer_code: String?
+        attr_reader credit_line: CustomerCreditLineInfo?
+
+        def initialize: (id: String, registered_name: String, trade_name: String?, customer_code: String?, credit_line: CustomerCreditLineInfo?) -> void
+        def self.from_payload: (Hash[Symbol, Object]) -> CustomerRow
+      end
+    end
+  end
+end

data/sig/yield/sdk/modules/order/payloads/order.rbs

@@ -0,0 +1,30 @@
+module Yield
+  module SDK
+    module Order
+      class Order
+        attr_reader id: String
+        attr_reader order_number: String
+        attr_reader status: OrderStatus::t
+        attr_reader customer: OrderCustomerInfo?
+        attr_reader date: Date
+        attr_reader total_amount: Money
+        attr_reader note: String?
+        attr_reader payment_link: String?
+        attr_reader creation_time: Time
+
+        def initialize: (
+          id: String,
+          order_number: String,
+          status: OrderStatus::t,
+          customer: OrderCustomerInfo?,
+          date: Date,
+          total_amount: Money,
+          note: String?,
+          payment_link: String?,
+          creation_time: Time,
+        ) -> void
+        def self.from_payload: (Hash[Symbol, Object]) -> Order
+      end
+    end
+  end
+end

data/sig/yield/sdk/modules/order/payloads/order_create_payload.rbs

@@ -0,0 +1,15 @@
+module Yield
+  module SDK
+    module Order
+      type order_create_params = {
+        customer_id: String,
+        total_amount: money_like,
+        ?note: String?,
+      }
+
+      class OrderCreatePayload
+        def self.build: (order_create_params) -> Hash[Symbol, Object?]
+      end
+    end
+  end
+end

data/sig/yield/sdk/modules/order/payloads/order_customer_info.rbs

@@ -0,0 +1,15 @@
+module Yield
+  module SDK
+    module Order
+      class OrderCustomerInfo
+        attr_reader id: String
+        attr_reader registered_name: String
+        attr_reader trade_name: String?
+        attr_reader customer_code: String?
+
+        def initialize: (id: String, registered_name: String, trade_name: String?, customer_code: String?) -> void
+        def self.from_payload: (Hash[Symbol, Object]) -> OrderCustomerInfo
+      end
+    end
+  end
+end

data/sig/yield/sdk/modules/order/payloads/order_status.rbs

@@ -0,0 +1,10 @@
+module Yield
+  module SDK
+    module Order
+      module OrderStatus
+        type t = :pending | :confirmed | :fulfilled | :cancelled
+        ALL: Array[t]
+      end
+    end
+  end
+end

data/sig/yield/sdk/modules/order/self_base_client.rbs

@@ -0,0 +1,12 @@
+module Yield
+  module SDK
+    module Order
+      class BaseClient
+        @api: API::Client
+        def initialize: (API::Client) -> void
+        def fetch: (String) -> API::Result[Order]
+        def create: (order_create_params) -> API::Result[Order]
+      end
+    end
+  end
+end

data/sig/yield/sdk/modules/order/self_client.rbs

@@ -0,0 +1,12 @@
+module Yield
+  module SDK
+    module Order
+      class Client
+        @base: BaseClient
+        def initialize: (BaseClient) -> void
+        def fetch: (String) -> Order
+        def create: (order_create_params) -> Order
+      end
+    end
+  end
+end

data/sig/yield/sdk/modules/self/payloads/self_info.rbs

@@ -0,0 +1,14 @@
+module Yield
+  module SDK
+    module Self
+      class SelfInfo
+        attr_reader id: String
+        attr_reader name: String
+        attr_reader organization: SelfOrganizationInfo
+
+        def initialize: (id: String, name: String, organization: SelfOrganizationInfo) -> void
+        def self.from_payload: (Hash[Symbol, Object]) -> SelfInfo
+      end
+    end
+  end
+end

data/sig/yield/sdk/modules/self/payloads/self_organization_info.rbs

@@ -0,0 +1,14 @@
+module Yield
+  module SDK
+    module Self
+      class SelfOrganizationInfo
+        attr_reader id: String
+        attr_reader registered_name: String
+        attr_reader trade_name: String?
+
+        def initialize: (id: String, registered_name: String, trade_name: String?) -> void
+        def self.from_payload: (Hash[Symbol, Object]) -> SelfOrganizationInfo
+      end
+    end
+  end
+end

data/sig/yield/sdk/modules/self/self_base_client.rbs

@@ -0,0 +1,11 @@
+module Yield
+  module SDK
+    module Self
+      class BaseClient
+        @api: API::Client
+        def initialize: (API::Client) -> void
+        def info: -> API::Result[SelfInfo]
+      end
+    end
+  end
+end

data/sig/yield/sdk/modules/self/self_client.rbs

@@ -0,0 +1,11 @@
+module Yield
+  module SDK
+    module Self
+      class Client
+        @base: BaseClient
+        def initialize: (BaseClient) -> void
+        def info: -> SelfInfo
+      end
+    end
+  end
+end

data/sig/yield/sdk/types/cursor_payload.rbs

@@ -0,0 +1,14 @@
+module Yield
+  module SDK
+    # `& Object` is needed for the `is_a?` method
+    type cursor_like = String | (_EntityInterface & Object) | Page[_EntityInterface]
+
+    interface _EntityInterface
+      def id: -> String
+    end
+
+    class CursorPayload
+      def self.build: (cursor_like) -> String?
+    end
+  end
+end

data/sig/yield/sdk/types/money.rbs

@@ -0,0 +1,12 @@
+module Yield
+  module SDK
+    class Money
+      attr_reader currency_code: Symbol
+      attr_reader value: BigDecimal
+
+      def initialize: (Symbol, BigDecimal) -> void
+        | (currency_code: Symbol, value: BigDecimal) -> void
+      def self.from_payload: (String) -> Money
+    end
+  end
+end

data/sig/yield/sdk/types/money_payload.rbs

@@ -0,0 +1,15 @@
+module Yield
+  module SDK
+    # `& Object` is needed for the `is_a?` method
+    type money_like = String | [Symbol, BigDecimal] | (_MoneyInterface & Object)
+
+    interface _MoneyInterface
+      def currency_code: -> Symbol
+      def value: -> BigDecimal
+    end
+
+    class MoneyPayload
+      def self.build: (money_like) -> String
+    end
+  end
+end

data/sig/yield/sdk/types/page.rbs

@@ -0,0 +1,20 @@
+module Yield
+  module SDK
+    class Page[T]
+      include Enumerable[T]
+
+      attr_accessor has_more: bool
+      @items: Array[T]
+
+      def initialize: (items: Array[T], has_more: bool) -> void
+      def self.build_with: [E] { (Hash[Symbol, Object]) -> E } -> (^(Hash[Symbol, Object]) -> Page[E])
+
+      def to_a: -> Array[T]
+      def size: -> Integer
+      def length: -> Integer
+      def []: (Integer) -> T?
+      def last: -> T?
+      def each: { (T) -> void } -> Array[T]
+    end
+  end
+end

data/sig/yield/sdk/utils/type_utils.rbs

@@ -0,0 +1,26 @@
+module Yield
+  module SDK
+    module TypeUtils
+      def expect_boolean: (Object) -> bool
+      def expect_integer: (Object) -> Integer
+      def expect_string: (Object) -> String
+      def expect_date: (Object) -> Date
+      def expect_time: (Object) -> Time
+      def expect_variant: [T < Symbol] (Array[T], Object) -> T
+      def expect_record: (Object) -> Hash[Symbol, Object]
+      def expect_list: (Object) -> Array[Object]
+      def expect_record_list: (Object) -> Array[Hash[Symbol, Object]]
+
+      # module_function
+      def self.expect_boolean: (Object) -> bool
+      def self.expect_integer: (Object) -> Integer
+      def self.expect_string: (Object) -> String
+      def self.expect_date: (Object) -> Date
+      def self.expect_time: (Object) -> Time
+      def self.expect_variant: [T < Symbol] (Array[T], Object) -> T
+      def self.expect_record: (Object) -> Hash[Symbol, Object]
+      def self.expect_list: (Object) -> Array[Object]
+      def self.expect_record_list: (Object) -> Array[Hash[Symbol, Object]]
+    end
+  end
+end

data/sig/yield/sdk/version.rbs

@@ -0,0 +1,8 @@
+module Yield
+  module SDK
+    VERSION: String
+
+    def client_version: -> String
+    def self.client_version: -> String # module_function
+  end
+end

data/sig/yield/sdk.rbs

@@ -1,6 +1,4 @@
 module Yield
-  module Sdk
-    VERSION: String
-    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  module SDK
   end
 end

metadata

@@ -1,14 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: yield-sdk
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Yield
 bindir: exe
 cert_chain: []
-date: 2025-05-23 00:00:00.000000000 Z
+date: 2025-06-04 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: backports
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.24'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.24'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -27,15 +41,27 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".standard.yml"
+- ".rubocop.yml"
 - LICENSE
 - README.md
 - Rakefile
+- Steepfile
+- docs/index.md
+- docs/modules/customer.md
+- docs/modules/order.md
+- docs/modules/self.md
 - lib/yield/sdk.rb
 - lib/yield/sdk/api/api_client.rb
+- lib/yield/sdk/api/api_error.rb
+- lib/yield/sdk/api/api_error_details.rb
 - lib/yield/sdk/api/api_result.rb
 - lib/yield/sdk/base_client.rb
 - lib/yield/sdk/client.rb
+- lib/yield/sdk/modules/customer/customer_base_client.rb
+- lib/yield/sdk/modules/customer/customer_client.rb
+- lib/yield/sdk/modules/customer/payloads/customer_credit_line_info.rb
+- lib/yield/sdk/modules/customer/payloads/customer_list_payload.rb
+- lib/yield/sdk/modules/customer/payloads/customer_row.rb
 - lib/yield/sdk/modules/order/order_base_client.rb
 - lib/yield/sdk/modules/order/order_client.rb
 - lib/yield/sdk/modules/order/payloads/order.rb
@@ -46,15 +72,48 @@ files:
 - lib/yield/sdk/modules/self/payloads/self_organization_info.rb
 - lib/yield/sdk/modules/self/self_base_client.rb
 - lib/yield/sdk/modules/self/self_client.rb
+- lib/yield/sdk/types/cursor_payload.rb
 - lib/yield/sdk/types/money.rb
 - lib/yield/sdk/types/money_payload.rb
-- lib/yield/sdk/utils.rb
+- lib/yield/sdk/types/page.rb
+- lib/yield/sdk/utils/type_utils.rb
 - lib/yield/sdk/version.rb
+- sig/vendor/faraday.rbs
 - sig/yield/sdk.rbs
-homepage: https://www.paywithyield.com
+- sig/yield/sdk/api/api_client.rbs
+- sig/yield/sdk/api/api_error.rbs
+- sig/yield/sdk/api/api_error_details.rbs
+- sig/yield/sdk/api/api_result.rbs
+- sig/yield/sdk/base_client.rbs
+- sig/yield/sdk/client.rbs
+- sig/yield/sdk/modules/customer/customer_base_client.rbs
+- sig/yield/sdk/modules/customer/customer_client.rbs
+- sig/yield/sdk/modules/customer/payloads/customer_credit_line_info.rbs
+- sig/yield/sdk/modules/customer/payloads/customer_list_payload.rbs
+- sig/yield/sdk/modules/customer/payloads/customer_row.rbs
+- sig/yield/sdk/modules/order/payloads/order.rbs
+- sig/yield/sdk/modules/order/payloads/order_create_payload.rbs
+- sig/yield/sdk/modules/order/payloads/order_customer_info.rbs
+- sig/yield/sdk/modules/order/payloads/order_status.rbs
+- sig/yield/sdk/modules/order/self_base_client.rbs
+- sig/yield/sdk/modules/order/self_client.rbs
+- sig/yield/sdk/modules/self/payloads/self_info.rbs
+- sig/yield/sdk/modules/self/payloads/self_organization_info.rbs
+- sig/yield/sdk/modules/self/self_base_client.rbs
+- sig/yield/sdk/modules/self/self_client.rbs
+- sig/yield/sdk/types/cursor_payload.rbs
+- sig/yield/sdk/types/money.rbs
+- sig/yield/sdk/types/money_payload.rbs
+- sig/yield/sdk/types/page.rbs
+- sig/yield/sdk/utils/type_utils.rbs
+- sig/yield/sdk/version.rbs
+homepage: https://github.com/yield-tech/sdk-ruby/blob/main/README.md
 licenses:
 - Apache-2.0
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/yield-tech/sdk-ruby/blob/main/README.md
+  source_code_uri: https://github.com/yield-tech/sdk-ruby
+  documentation_uri: https://github.com/yield-tech/sdk-ruby/blob/main/README.md
 rdoc_options: []
 require_paths:
 - lib
@@ -62,7 +121,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.2.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/.standard.yml

@@ -1,3 +0,0 @@
-# For available configuration options, see:
-#   https://github.com/testdouble/standard
-ruby_version: 3.2

data/lib/yield/sdk/utils.rb

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-module Yield
-  module SDK
-    module Utils
-      module_function
-
-      def assert_boolean(data)
-        raise ArgumentError, "Expected Boolean, got #{data.class}" unless data == true || data == false
-        data
-      end
-
-      def assert_integer(data)
-        raise ArgumentError, "Expected Integer, got #{data.class}" unless data.is_a?(Integer)
-        data
-      end
-
-      def assert_string(data)
-        raise ArgumentError, "Expected String, got #{data.class}" unless data.is_a?(String)
-        data
-      end
-
-      def self.assert_variant(variants, data)
-        raise ArgumentError, "Expected String, got #{data.class}" unless data.is_a?(String)
-        symbol = data.downcase.to_sym
-        raise ArgumentError, "Invalid variant: \"#{data}\"" unless variants.include?(symbol)
-        symbol
-      end
-
-      def self.assert_hash(data)
-        raise ArgumentError, "Expected Hash, got #{data.class}" unless data.is_a?(Hash)
-        data
-      end
-    end
-  end
-end