dodopayments 0.0.1.pre.alpha.0

data/lib/dodopayments/request_options.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  # @api private
+  #
+  # @abstract
+  module RequestParameters
+    # @!parse
+    #   # Options to specify HTTP behaviour for this request.
+    #   # @return [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+    #   attr_accessor :request_options
+
+    # @param mod [Module]
+    def self.included(mod)
+      return unless mod <= Dodopayments::BaseModel
+
+      mod.extend(Dodopayments::RequestParameters::Converter)
+      mod.optional(:request_options, Dodopayments::RequestOptions)
+    end
+
+    # @api private
+    module Converter
+      # @api private
+      #
+      # @param params [Object]
+      #
+      # @return [Array(Object, Hash{Symbol=>Object})]
+      def dump_request(params)
+        case (dumped = dump(params))
+        in Hash
+          [dumped.except(:request_options), dumped[:request_options]]
+        else
+          [dumped, nil]
+        end
+      end
+    end
+  end
+
+  # Specify HTTP behaviour to use for a specific request. These options supplement
+  #   or override those provided at the client level.
+  #
+  #   When making a request, you can pass an actual {RequestOptions} instance, or
+  #   simply pass a Hash with symbol keys matching the attributes on this class.
+  class RequestOptions < Dodopayments::BaseModel
+    # @api private
+    #
+    # @param opts [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+    #
+    # @raise [ArgumentError]
+    def self.validate!(opts)
+      case opts
+      in Dodopayments::RequestOptions | Hash
+        opts.to_h.each_key do |k|
+          unless fields.include?(k)
+            raise ArgumentError.new("Request `opts` keys must be one of #{fields.keys}, got #{k.inspect}")
+          end
+        end
+      else
+        raise ArgumentError.new("Request `opts` must be a Hash or RequestOptions, got #{opts.inspect}")
+      end
+    end
+
+    # @!attribute idempotency_key
+    #   Idempotency key to send with request and all associated retries. Will only be
+    #     sent for write requests.
+    #
+    #   @return [String, nil]
+    optional :idempotency_key, String
+
+    # @!attribute extra_query
+    #   Extra query params to send with the request. These are `.merge`’d into any
+    #     `query` given at the client level.
+    #
+    #   @return [Hash{String=>Array<String>, String, nil}, nil]
+    optional :extra_query, Dodopayments::HashOf[Dodopayments::ArrayOf[String]]
+
+    # @!attribute extra_headers
+    #   Extra headers to send with the request. These are `.merged`’d into any
+    #     `extra_headers` given at the client level.
+    #
+    #   @return [Hash{String=>String, nil}, nil]
+    optional :extra_headers, Dodopayments::HashOf[String, nil?: true]
+
+    # @!attribute extra_body
+    #   Extra data to send with the request. These are deep merged into any data
+    #     generated as part of the normal request.
+    #
+    #   @return [Hash{Symbol=>Object}, nil]
+    optional :extra_body, Dodopayments::HashOf[Dodopayments::Unknown]
+
+    # @!attribute max_retries
+    #   Maximum number of retries to attempt after a failed initial request.
+    #
+    #   @return [Integer, nil]
+    optional :max_retries, Integer
+
+    # @!attribute timeout
+    #   Request timeout in seconds.
+    #
+    #   @return [Float, nil]
+    optional :timeout, Float
+
+    # @!parse
+    #   # Returns a new instance of RequestOptions.
+    #   #
+    #   # @param values [Hash{Symbol=>Object}]
+    #   #
+    #   def initialize(values = {}) = super
+  end
+end

data/lib/dodopayments/resources/customers/customer_portal.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Resources
+    class Customers
+      class CustomerPortal
+        # @param customer_id [String] Customer Id
+        #
+        # @param params [Dodopayments::Models::Customers::CustomerPortalCreateParams, Hash{Symbol=>Object}] .
+        #
+        #   @option params [Boolean, nil] :send_email If true, will send link to user.
+        #
+        #   @option params [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+        #
+        # @return [nil]
+        def create(customer_id, params = {})
+          parsed, options = Dodopayments::Models::Customers::CustomerPortalCreateParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: ["customers/%0s/customer-portal/session", customer_id],
+            query: parsed,
+            model: NilClass,
+            options: options
+          )
+        end
+
+        # @param client [Dodopayments::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/dodopayments/resources/customers.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Resources
+    class Customers
+      # @return [Dodopayments::Resources::Customers::CustomerPortal]
+      attr_reader :customer_portal
+
+      # @param params [Dodopayments::Models::CustomerCreateParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [String] :email
+      #
+      #   @option params [String] :name
+      #
+      #   @option params [String, nil] :phone_number
+      #
+      #   @option params [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [Dodopayments::Models::Customer]
+      def create(params)
+        parsed, options = Dodopayments::Models::CustomerCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "customers",
+          body: parsed,
+          model: Dodopayments::Models::Customer,
+          options: options
+        )
+      end
+
+      # @param customer_id [String] Customer Id
+      #
+      # @param params [Dodopayments::Models::CustomerRetrieveParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [Dodopayments::Models::Customer]
+      def retrieve(customer_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["customers/%0s", customer_id],
+          model: Dodopayments::Models::Customer,
+          options: params[:request_options]
+        )
+      end
+
+      # @param customer_id [String] Customer Id
+      #
+      # @param params [Dodopayments::Models::CustomerUpdateParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [String, nil] :name
+      #
+      #   @option params [String, nil] :phone_number
+      #
+      #   @option params [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [Dodopayments::Models::Customer]
+      def update(customer_id, params = {})
+        parsed, options = Dodopayments::Models::CustomerUpdateParams.dump_request(params)
+        @client.request(
+          method: :patch,
+          path: ["customers/%0s", customer_id],
+          body: parsed,
+          model: Dodopayments::Models::Customer,
+          options: options
+        )
+      end
+
+      # @param params [Dodopayments::Models::CustomerListParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [Integer, nil] :page_number Page number default is 0
+      #
+      #   @option params [Integer, nil] :page_size Page size default is 10 max is 100
+      #
+      #   @option params [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [Dodopayments::DefaultPageNumberPagination<Dodopayments::Models::Customer>]
+      def list(params = {})
+        parsed, options = Dodopayments::Models::CustomerListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "customers",
+          query: parsed,
+          page: Dodopayments::DefaultPageNumberPagination,
+          model: Dodopayments::Models::Customer,
+          options: options
+        )
+      end
+
+      # @param client [Dodopayments::Client]
+      def initialize(client:)
+        @client = client
+        @customer_portal = Dodopayments::Resources::Customers::CustomerPortal.new(client: client)
+      end
+    end
+  end
+end

data/lib/dodopayments/resources/discounts.rb

@@ -0,0 +1,154 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Resources
+    class Discounts
+      # If `code` is omitted or empty, a random 16-char uppercase code is generated.
+      #
+      # @param params [Dodopayments::Models::DiscountCreateParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [Integer] :amount The discount amount.
+      #
+      #     - If `discount_type` is **not** `percentage`, `amount` is in **USD cents**. For
+      #       example, `100` means `$1.00`. Only USD is allowed.
+      #     - If `discount_type` **is** `percentage`, `amount` is in **basis points**. For
+      #       example, `540` means `5.4%`.
+      #
+      #     Must be at least 1.
+      #
+      #   @option params [Symbol, Dodopayments::Models::DiscountType] :type
+      #
+      #   @option params [String, nil] :code Optionally supply a code (will be uppercased).
+      #
+      #     - Must be at least 3 characters if provided.
+      #     - If omitted, a random 16-character code is generated.
+      #
+      #   @option params [Time, nil] :expires_at When the discount expires, if ever.
+      #
+      #   @option params [String, nil] :name
+      #
+      #   @option params [Array<String>, nil] :restricted_to List of product IDs to restrict usage (if any).
+      #
+      #   @option params [Integer, nil] :usage_limit How many times this discount can be used (if any). Must be >= 1 if provided.
+      #
+      #   @option params [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [Dodopayments::Models::Discount]
+      def create(params)
+        parsed, options = Dodopayments::Models::DiscountCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "discounts",
+          body: parsed,
+          model: Dodopayments::Models::Discount,
+          options: options
+        )
+      end
+
+      # GET /discounts/{discount_id}
+      #
+      # @param discount_id [String] Discount Id
+      #
+      # @param params [Dodopayments::Models::DiscountRetrieveParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [Dodopayments::Models::Discount]
+      def retrieve(discount_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["discounts/%0s", discount_id],
+          model: Dodopayments::Models::Discount,
+          options: params[:request_options]
+        )
+      end
+
+      # PATCH /discounts/{discount_id}
+      #
+      # @param discount_id [String] Discount Id
+      #
+      # @param params [Dodopayments::Models::DiscountUpdateParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [Integer, nil] :amount If present, update the discount amount:
+      #
+      #     - If `discount_type` is `percentage`, this represents **basis points** (e.g.,
+      #       `540` = `5.4%`).
+      #     - Otherwise, this represents **USD cents** (e.g., `100` = `$1.00`).
+      #
+      #     Must be at least 1 if provided.
+      #
+      #   @option params [String, nil] :code If present, update the discount code (uppercase).
+      #
+      #   @option params [Time, nil] :expires_at
+      #
+      #   @option params [String, nil] :name
+      #
+      #   @option params [Array<String>, nil] :restricted_to If present, replaces all restricted product IDs with this new set. To remove all
+      #     restrictions, send empty array
+      #
+      #   @option params [Symbol, Dodopayments::Models::DiscountType, nil] :type
+      #
+      #   @option params [Integer, nil] :usage_limit
+      #
+      #   @option params [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [Dodopayments::Models::Discount]
+      def update(discount_id, params = {})
+        parsed, options = Dodopayments::Models::DiscountUpdateParams.dump_request(params)
+        @client.request(
+          method: :patch,
+          path: ["discounts/%0s", discount_id],
+          body: parsed,
+          model: Dodopayments::Models::Discount,
+          options: options
+        )
+      end
+
+      # GET /discounts
+      #
+      # @param params [Dodopayments::Models::DiscountListParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [Integer, nil] :page_number Page number (default = 0).
+      #
+      #   @option params [Integer, nil] :page_size Page size (default = 10, max = 100).
+      #
+      #   @option params [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [Dodopayments::DefaultPageNumberPagination<Dodopayments::Models::Discount>]
+      def list(params = {})
+        parsed, options = Dodopayments::Models::DiscountListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "discounts",
+          query: parsed,
+          page: Dodopayments::DefaultPageNumberPagination,
+          model: Dodopayments::Models::Discount,
+          options: options
+        )
+      end
+
+      # DELETE /discounts/{discount_id}
+      #
+      # @param discount_id [String] Discount Id
+      #
+      # @param params [Dodopayments::Models::DiscountDeleteParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [nil]
+      def delete(discount_id, params = {})
+        @client.request(
+          method: :delete,
+          path: ["discounts/%0s", discount_id],
+          model: NilClass,
+          options: params[:request_options]
+        )
+      end
+
+      # @param client [Dodopayments::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/dodopayments/resources/disputes.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Resources
+    class Disputes
+      # @param dispute_id [String] Dispute Id
+      #
+      # @param params [Dodopayments::Models::DisputeRetrieveParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [Dodopayments::Models::Dispute]
+      def retrieve(dispute_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["disputes/%0s", dispute_id],
+          model: Dodopayments::Models::Dispute,
+          options: params[:request_options]
+        )
+      end
+
+      # @param params [Dodopayments::Models::DisputeListParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [Time, nil] :created_at_gte Get events after this created time
+      #
+      #   @option params [Time, nil] :created_at_lte Get events created before this time
+      #
+      #   @option params [String, nil] :customer_id Filter by customer_id
+      #
+      #   @option params [Symbol, Dodopayments::Models::DisputeStage, nil] :dispute_stage Filter by dispute stage
+      #
+      #   @option params [Symbol, Dodopayments::Models::DisputeStatus, nil] :dispute_status Filter by dispute status
+      #
+      #   @option params [Integer, nil] :page_number Page number default is 0
+      #
+      #   @option params [Integer, nil] :page_size Page size default is 10 max is 100
+      #
+      #   @option params [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [Dodopayments::DefaultPageNumberPagination<Dodopayments::Models::Dispute>]
+      def list(params = {})
+        parsed, options = Dodopayments::Models::DisputeListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "disputes",
+          query: parsed,
+          page: Dodopayments::DefaultPageNumberPagination,
+          model: Dodopayments::Models::Dispute,
+          options: options
+        )
+      end
+
+      # @param client [Dodopayments::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/dodopayments/resources/invoices/payments.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Resources
+    class Invoices
+      class Payments
+        # @param payment_id [String]
+        #
+        # @param params [Dodopayments::Models::Invoices::PaymentRetrieveParams, Hash{Symbol=>Object}] .
+        #
+        #   @option params [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+        #
+        # @return [nil]
+        def retrieve(payment_id, params = {})
+          @client.request(
+            method: :get,
+            path: ["invoices/payments/%0s", payment_id],
+            model: NilClass,
+            options: params[:request_options]
+          )
+        end
+
+        # @param client [Dodopayments::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/dodopayments/resources/invoices.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Resources
+    class Invoices
+      # @return [Dodopayments::Resources::Invoices::Payments]
+      attr_reader :payments
+
+      # @param client [Dodopayments::Client]
+      def initialize(client:)
+        @client = client
+        @payments = Dodopayments::Resources::Invoices::Payments.new(client: client)
+      end
+    end
+  end
+end

data/lib/dodopayments/resources/license_key_instances.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Resources
+    class LicenseKeyInstances
+      # @param id [String] License key instance ID
+      #
+      # @param params [Dodopayments::Models::LicenseKeyInstanceRetrieveParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [Dodopayments::Models::LicenseKeyInstance]
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["license_key_instances/%0s", id],
+          model: Dodopayments::Models::LicenseKeyInstance,
+          options: params[:request_options]
+        )
+      end
+
+      # @param id [String] License key instance ID
+      #
+      # @param params [Dodopayments::Models::LicenseKeyInstanceUpdateParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [String] :name
+      #
+      #   @option params [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [Dodopayments::Models::LicenseKeyInstance]
+      def update(id, params)
+        parsed, options = Dodopayments::Models::LicenseKeyInstanceUpdateParams.dump_request(params)
+        @client.request(
+          method: :patch,
+          path: ["license_key_instances/%0s", id],
+          body: parsed,
+          model: Dodopayments::Models::LicenseKeyInstance,
+          options: options
+        )
+      end
+
+      # @param params [Dodopayments::Models::LicenseKeyInstanceListParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [String, nil] :license_key_id Filter by license key ID
+      #
+      #   @option params [Integer, nil] :page_number Page number default is 0
+      #
+      #   @option params [Integer, nil] :page_size Page size default is 10 max is 100
+      #
+      #   @option params [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [Dodopayments::DefaultPageNumberPagination<Dodopayments::Models::LicenseKeyInstance>]
+      def list(params = {})
+        parsed, options = Dodopayments::Models::LicenseKeyInstanceListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "license_key_instances",
+          query: parsed,
+          page: Dodopayments::DefaultPageNumberPagination,
+          model: Dodopayments::Models::LicenseKeyInstance,
+          options: options
+        )
+      end
+
+      # @param client [Dodopayments::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/dodopayments/resources/license_keys.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Resources
+    class LicenseKeys
+      # @param id [String] License key ID
+      #
+      # @param params [Dodopayments::Models::LicenseKeyRetrieveParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [Dodopayments::Models::LicenseKey]
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["license_keys/%0s", id],
+          model: Dodopayments::Models::LicenseKey,
+          options: params[:request_options]
+        )
+      end
+
+      # @param id [String] License key ID
+      #
+      # @param params [Dodopayments::Models::LicenseKeyUpdateParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [Integer, nil] :activations_limit The updated activation limit for the license key. Use `null` to remove the
+      #     limit, or omit this field to leave it unchanged.
+      #
+      #   @option params [Boolean, nil] :disabled Indicates whether the license key should be disabled. A value of `true` disables
+      #     the key, while `false` enables it. Omit this field to leave it unchanged.
+      #
+      #   @option params [Time, nil] :expires_at The updated expiration timestamp for the license key in UTC. Use `null` to
+      #     remove the expiration date, or omit this field to leave it unchanged.
+      #
+      #   @option params [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [Dodopayments::Models::LicenseKey]
+      def update(id, params = {})
+        parsed, options = Dodopayments::Models::LicenseKeyUpdateParams.dump_request(params)
+        @client.request(
+          method: :patch,
+          path: ["license_keys/%0s", id],
+          body: parsed,
+          model: Dodopayments::Models::LicenseKey,
+          options: options
+        )
+      end
+
+      # @param params [Dodopayments::Models::LicenseKeyListParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [String, nil] :customer_id Filter by customer ID
+      #
+      #   @option params [Integer, nil] :page_number Page number default is 0
+      #
+      #   @option params [Integer, nil] :page_size Page size default is 10 max is 100
+      #
+      #   @option params [String, nil] :product_id Filter by product ID
+      #
+      #   @option params [Symbol, Dodopayments::Models::LicenseKeyStatus, nil] :status Filter by license key status
+      #
+      #   @option params [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [Dodopayments::DefaultPageNumberPagination<Dodopayments::Models::LicenseKey>]
+      def list(params = {})
+        parsed, options = Dodopayments::Models::LicenseKeyListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "license_keys",
+          query: parsed,
+          page: Dodopayments::DefaultPageNumberPagination,
+          model: Dodopayments::Models::LicenseKey,
+          options: options
+        )
+      end
+
+      # @param client [Dodopayments::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end