perata-sdk 0.1.1

data/lib/perata/models.rb

@@ -0,0 +1,527 @@
+# frozen_string_literal: true
+
+# Code generated by sdk/generator. DO NOT EDIT.
+
+module Perata
+  # Card is a resource of Peráta's API.
+  class Card < Model
+    MEMBERS = %i[brand exp_month exp_year last4].freeze
+
+    # @return [String]
+    attr_reader :brand
+
+    # @return [Integer, nil]
+    attr_reader :exp_month
+
+    # @return [Integer, nil]
+    attr_reader :exp_year
+
+    # @return [String, nil]
+    attr_reader :last4
+
+    def initialize(brand:, exp_month:, exp_year:, last4:)
+      @brand = brand
+      @exp_month = exp_month
+      @exp_year = exp_year
+      @last4 = last4
+      freeze
+    end
+
+    # Builds a Card from the API's JSON.
+    def self.from_hash(data)
+      new(
+        brand: data.fetch("brand"),
+        exp_month: data["exp_month"],
+        exp_year: data["exp_year"],
+        last4: data["last4"]
+      )
+    end
+  end
+
+  # Checkout is a resource of Peráta's API.
+  class Checkout < Model
+    MEMBERS = %i[id price_id product_id url].freeze
+
+    # @return [String]
+    attr_reader :id
+
+    # @return [String]
+    attr_reader :price_id
+
+    # @return [String]
+    attr_reader :product_id
+
+    # Endereço para onde o comprador é enviado.
+    # @return [String]
+    attr_reader :url
+
+    def initialize(id:, price_id:, product_id:, url:)
+      @id = id
+      @price_id = price_id
+      @product_id = product_id
+      @url = url
+      freeze
+    end
+
+    # Builds a Checkout from the API's JSON.
+    def self.from_hash(data)
+      new(
+        id: data.fetch("id"),
+        price_id: data.fetch("price_id"),
+        product_id: data.fetch("product_id"),
+        url: data.fetch("url")
+      )
+    end
+  end
+
+  # Customer is a resource of Peráta's API.
+  class Customer < Model
+    MEMBERS = %i[created_at email external_id id name status].freeze
+
+    # @return [String]
+    attr_reader :created_at
+
+    # @return [String]
+    attr_reader :email
+
+    # @return [String]
+    attr_reader :external_id
+
+    # @return [String]
+    attr_reader :id
+
+    # @return [String]
+    attr_reader :name
+
+    # @return [String ("active", "archived")]
+    attr_reader :status
+
+    def initialize(created_at:, email:, external_id:, id:, name:, status:)
+      @created_at = created_at
+      @email = email
+      @external_id = external_id
+      @id = id
+      @name = name
+      @status = status
+      freeze
+    end
+
+    # Builds a Customer from the API's JSON.
+    def self.from_hash(data)
+      new(
+        created_at: data.fetch("created_at"),
+        email: data.fetch("email"),
+        external_id: data.fetch("external_id"),
+        id: data.fetch("id"),
+        name: data.fetch("name"),
+        status: data.fetch("status")
+      )
+    end
+  end
+
+  # Order is a resource of Peráta's API.
+  class Order < Model
+    MEMBERS = %i[amount_cents currency customer_id id paid_at price_id product_id status].freeze
+
+    # @return [Integer]
+    attr_reader :amount_cents
+
+    # @return [String ("BRL")]
+    attr_reader :currency
+
+    # @return [String]
+    attr_reader :customer_id
+
+    # @return [String]
+    attr_reader :id
+
+    # @return [String, nil]
+    attr_reader :paid_at
+
+    # @return [String]
+    attr_reader :price_id
+
+    # @return [String]
+    attr_reader :product_id
+
+    # @return [String ("open", "confirmed", "succeeded", "failed", "expired")]
+    attr_reader :status
+
+    def initialize(amount_cents:, currency:, customer_id:, id:, paid_at:, price_id:, product_id:, status:)
+      @amount_cents = amount_cents
+      @currency = currency
+      @customer_id = customer_id
+      @id = id
+      @paid_at = paid_at
+      @price_id = price_id
+      @product_id = product_id
+      @status = status
+      freeze
+    end
+
+    # Builds a Order from the API's JSON.
+    def self.from_hash(data)
+      new(
+        amount_cents: data.fetch("amount_cents"),
+        currency: data.fetch("currency"),
+        customer_id: data.fetch("customer_id"),
+        id: data.fetch("id"),
+        paid_at: data["paid_at"],
+        price_id: data.fetch("price_id"),
+        product_id: data.fetch("product_id"),
+        status: data.fetch("status")
+      )
+    end
+  end
+
+  # Pagination is a resource of Peráta's API.
+  class Pagination < Model
+    MEMBERS = %i[max_page total_count].freeze
+
+    # @return [Integer]
+    attr_reader :max_page
+
+    # @return [Integer]
+    attr_reader :total_count
+
+    def initialize(max_page:, total_count:)
+      @max_page = max_page
+      @total_count = total_count
+      freeze
+    end
+
+    # Builds a Pagination from the API's JSON.
+    def self.from_hash(data)
+      new(
+        max_page: data.fetch("max_page"),
+        total_count: data.fetch("total_count")
+      )
+    end
+  end
+
+  # Payment is a resource of Peráta's API.
+  class Payment < Model
+    MEMBERS = %i[amount_cents captured_cents checkout_id created_at currency customer_id id method refunded_cents state].freeze
+
+    # @return [Integer]
+    attr_reader :amount_cents
+
+    # @return [Integer]
+    attr_reader :captured_cents
+
+    # @return [String]
+    attr_reader :checkout_id
+
+    # @return [String]
+    attr_reader :created_at
+
+    # @return [String ("BRL")]
+    attr_reader :currency
+
+    # @return [String]
+    attr_reader :customer_id
+
+    # @return [String]
+    attr_reader :id
+
+    # @return [String ("card", "pix", "boleto")]
+    attr_reader :method
+
+    # @return [Integer]
+    attr_reader :refunded_cents
+
+    # @return [String ("unknown", "pending", "authorized", "captured", "refused", "canceled", "refunded", "partially_refunded")]
+    attr_reader :state
+
+    def initialize(amount_cents:, captured_cents:, checkout_id:, created_at:, currency:, customer_id:, id:, method:, refunded_cents:, state:)
+      @amount_cents = amount_cents
+      @captured_cents = captured_cents
+      @checkout_id = checkout_id
+      @created_at = created_at
+      @currency = currency
+      @customer_id = customer_id
+      @id = id
+      @method = method
+      @refunded_cents = refunded_cents
+      @state = state
+      freeze
+    end
+
+    # Builds a Payment from the API's JSON.
+    def self.from_hash(data)
+      new(
+        amount_cents: data.fetch("amount_cents"),
+        captured_cents: data.fetch("captured_cents"),
+        checkout_id: data.fetch("checkout_id"),
+        created_at: data.fetch("created_at"),
+        currency: data.fetch("currency"),
+        customer_id: data.fetch("customer_id"),
+        id: data.fetch("id"),
+        method: data.fetch("method"),
+        refunded_cents: data.fetch("refunded_cents"),
+        state: data.fetch("state")
+      )
+    end
+  end
+
+  # PaymentMethod is a resource of Peráta's API.
+  class PaymentMethod < Model
+    MEMBERS = %i[card created_at customer_id id type].freeze
+
+    # @return [Card]
+    attr_reader :card
+
+    # @return [String]
+    attr_reader :created_at
+
+    # @return [String]
+    attr_reader :customer_id
+
+    # @return [String]
+    attr_reader :id
+
+    # @return [String ("card")]
+    attr_reader :type
+
+    def initialize(card:, created_at:, customer_id:, id:, type:)
+      @card = card
+      @created_at = created_at
+      @customer_id = customer_id
+      @id = id
+      @type = type
+      freeze
+    end
+
+    # Builds a PaymentMethod from the API's JSON.
+    def self.from_hash(data)
+      new(
+        card: Card.from_hash(data.fetch("card")),
+        created_at: data.fetch("created_at"),
+        customer_id: data.fetch("customer_id"),
+        id: data.fetch("id"),
+        type: data.fetch("type")
+      )
+    end
+  end
+
+  # PaymentMethodDetached is a resource of Peráta's API.
+  class PaymentMethodDetached < Model
+    MEMBERS = %i[detached id].freeze
+
+    # @return [Boolean]
+    attr_reader :detached
+
+    # @return [String]
+    attr_reader :id
+
+    def initialize(detached:, id:)
+      @detached = detached
+      @id = id
+      freeze
+    end
+
+    # Builds a PaymentMethodDetached from the API's JSON.
+    def self.from_hash(data)
+      new(
+        detached: data.fetch("detached"),
+        id: data.fetch("id")
+      )
+    end
+  end
+
+  # Price is a resource of Peráta's API.
+  class Price < Model
+    MEMBERS = %i[amount_cents currency id interval product_id status type].freeze
+
+    # Valor em centavos.
+    # @return [Integer]
+    attr_reader :amount_cents
+
+    # @return [String ("BRL")]
+    attr_reader :currency
+
+    # @return [String]
+    attr_reader :id
+
+    # @return [String ("none", "month", "year")]
+    attr_reader :interval
+
+    # @return [String]
+    attr_reader :product_id
+
+    # @return [String ("active", "archived")]
+    attr_reader :status
+
+    # @return [String ("one_time", "recurring")]
+    attr_reader :type
+
+    def initialize(amount_cents:, currency:, id:, interval:, product_id:, status:, type:)
+      @amount_cents = amount_cents
+      @currency = currency
+      @id = id
+      @interval = interval
+      @product_id = product_id
+      @status = status
+      @type = type
+      freeze
+    end
+
+    # Builds a Price from the API's JSON.
+    def self.from_hash(data)
+      new(
+        amount_cents: data.fetch("amount_cents"),
+        currency: data.fetch("currency"),
+        id: data.fetch("id"),
+        interval: data.fetch("interval"),
+        product_id: data.fetch("product_id"),
+        status: data.fetch("status"),
+        type: data.fetch("type")
+      )
+    end
+  end
+
+  # Product is a resource of Peráta's API.
+  class Product < Model
+    MEMBERS = %i[created_at description id name status].freeze
+
+    # @return [String]
+    attr_reader :created_at
+
+    # @return [String]
+    attr_reader :description
+
+    # @return [String]
+    attr_reader :id
+
+    # @return [String]
+    attr_reader :name
+
+    # @return [String ("active", "archived")]
+    attr_reader :status
+
+    def initialize(created_at:, description:, id:, name:, status:)
+      @created_at = created_at
+      @description = description
+      @id = id
+      @name = name
+      @status = status
+      freeze
+    end
+
+    # Builds a Product from the API's JSON.
+    def self.from_hash(data)
+      new(
+        created_at: data.fetch("created_at"),
+        description: data.fetch("description"),
+        id: data.fetch("id"),
+        name: data.fetch("name"),
+        status: data.fetch("status")
+      )
+    end
+  end
+
+  # Refund is a resource of Peráta's API.
+  class Refund < Model
+    MEMBERS = %i[amount_cents id payment_id status].freeze
+
+    # @return [Integer]
+    attr_reader :amount_cents
+
+    # @return [String]
+    attr_reader :id
+
+    # @return [String]
+    attr_reader :payment_id
+
+    # @return [String ("requested", "pending", "unknown", "succeeded", "failed", "canceled")]
+    attr_reader :status
+
+    def initialize(amount_cents:, id:, payment_id:, status:)
+      @amount_cents = amount_cents
+      @id = id
+      @payment_id = payment_id
+      @status = status
+      freeze
+    end
+
+    # Builds a Refund from the API's JSON.
+    def self.from_hash(data)
+      new(
+        amount_cents: data.fetch("amount_cents"),
+        id: data.fetch("id"),
+        payment_id: data.fetch("payment_id"),
+        status: data.fetch("status")
+      )
+    end
+  end
+
+  # Subscription is a resource of Peráta's API.
+  class Subscription < Model
+    MEMBERS = %i[amount_cents cancel_at_period_end currency current_period_end current_period_start customer_id id interval price_id product_id status].freeze
+
+    # @return [Integer]
+    attr_reader :amount_cents
+
+    # @return [Boolean]
+    attr_reader :cancel_at_period_end
+
+    # @return [String ("BRL")]
+    attr_reader :currency
+
+    # @return [String]
+    attr_reader :current_period_end
+
+    # @return [String]
+    attr_reader :current_period_start
+
+    # @return [String]
+    attr_reader :customer_id
+
+    # @return [String]
+    attr_reader :id
+
+    # @return [String]
+    attr_reader :interval
+
+    # @return [String]
+    attr_reader :price_id
+
+    # @return [String]
+    attr_reader :product_id
+
+    # @return [String ("trialing", "active", "past_due", "paused", "canceled")]
+    attr_reader :status
+
+    def initialize(amount_cents:, cancel_at_period_end:, currency:, current_period_end:, current_period_start:, customer_id:, id:, interval:, price_id:, product_id:, status:)
+      @amount_cents = amount_cents
+      @cancel_at_period_end = cancel_at_period_end
+      @currency = currency
+      @current_period_end = current_period_end
+      @current_period_start = current_period_start
+      @customer_id = customer_id
+      @id = id
+      @interval = interval
+      @price_id = price_id
+      @product_id = product_id
+      @status = status
+      freeze
+    end
+
+    # Builds a Subscription from the API's JSON.
+    def self.from_hash(data)
+      new(
+        amount_cents: data.fetch("amount_cents"),
+        cancel_at_period_end: data.fetch("cancel_at_period_end"),
+        currency: data.fetch("currency"),
+        current_period_end: data.fetch("current_period_end"),
+        current_period_start: data.fetch("current_period_start"),
+        customer_id: data.fetch("customer_id"),
+        id: data.fetch("id"),
+        interval: data.fetch("interval"),
+        price_id: data.fetch("price_id"),
+        product_id: data.fetch("product_id"),
+        status: data.fetch("status")
+      )
+    end
+  end
+end

data/lib/perata/page.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Perata
+  # One page of a list, and where the list ends.
+  class Page
+    attr_reader :items, :pagination
+
+    def initialize(items:, pagination:)
+      @items = items.freeze
+      @pagination = pagination
+      freeze
+    end
+
+    # Builds a page from the API's hash, each item through the block.
+    def self.from_hash(data, &item)
+      new(items: (data["items"] || []).map(&item), pagination: Pagination.from_hash(data.fetch("pagination")))
+    end
+
+    # Walks pages from +first+ until the last one, as Polar's SDKs do, yielding
+    # every item; +fetch+ answers the page it is given.
+    def self.iterate(first, &fetch)
+      Enumerator.new do |yielder|
+        page = [first || 1, 1].max
+        loop do
+          result = fetch.call(page)
+          result.items.each { |item| yielder << item }
+          break if page >= result.pagination.max_page
+
+          page += 1
+        end
+      end
+    end
+  end
+end