dub 0.2.2.pre.alpha.97 → 0.2.2.pre.alpha.101

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c10e76d036a2d60624dcff35dc6809d51ca32336b23cd93db6fc125bca4f2d96
-  data.tar.gz: ed2c58377588a69081fa97e3729ddc6bfbdd20fa9facacd2f758734c895c75c8
+  metadata.gz: 5649d40ee0fd4cc4703aaf822f578c915d41a0f9703643c43c02dbbfb180be22
+  data.tar.gz: 474cfbfdaa80bf21d83f1abefcc255a354dbb3c6e8089635ef588cbc81307c07
 SHA512:
-  metadata.gz: 2e69f6f1941efe0ee7aaa54adcccd31dce8e5f3de8332ce4cabdf7343c79e84785c3d502fcae8054ee4f6bf0dff77fb7e0ad5aaf34bf1f19648cfeff69ed662e
-  data.tar.gz: 0db66d5d74aa0105a83d8e63b4d689269bb1d4c92df80b28dad39852f351a6c8370622a5a6d1f7c98adc97f4b3e3ee3f17b5921f58a9d8ea3bdd7ceecf23014b
+  metadata.gz: 35631686093e25eeb130d5c896e6e31f31656c0448ca45ad909ab95f747bb8b5c8c503c2e64b4e1032bb0f2750041f1af0c28d2f5860693f3f000f04e87f034d
+  data.tar.gz: 10395c31eec17d77cfe898302d6b3f940e4f50fe40cb6ef4a1852decc6dcdbb5f3dd75cfd02814d298fedfd7d350a5375b0f5c85ea07a664362047a77e5c1910

data/lib/dub.rb

@@ -16,6 +16,7 @@ module OpenApiSDK
   autoload :Track, 'open_api_sdk/track'
   autoload :Customers, 'open_api_sdk/customers'
   autoload :Partners, 'open_api_sdk/partners'
+  autoload :Commissions, 'open_api_sdk/commissions'
   autoload :Workspaces, 'open_api_sdk/workspaces'
   autoload :EmbedTokens, 'open_api_sdk/embed_tokens'
   autoload :QRCodes, 'open_api_sdk/qr_codes'

data/lib/open_api_sdk/commissions.rb

@@ -0,0 +1,298 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+require 'faraday'
+require 'faraday/multipart'
+require 'faraday/retry'
+require 'sorbet-runtime'
+require_relative 'sdk_hooks/hooks'
+require_relative 'utils/retries'
+
+module OpenApiSDK
+  extend T::Sig
+  class Commissions
+    extend T::Sig
+
+
+    sig { params(sdk_config: SDKConfiguration).void }
+    def initialize(sdk_config)
+      @sdk_configuration = sdk_config
+    end
+
+
+    sig { params(request: T.nilable(::OpenApiSDK::Operations::ListCommissionsRequest), timeout_ms: T.nilable(Integer)).returns(::OpenApiSDK::Operations::ListCommissionsResponse) }
+    def list(request, timeout_ms = nil)
+      # list - Get commissions for a program.
+      # Retrieve a list of commissions for a program.
+      url, params = @sdk_configuration.get_server_details
+      base_url = Utils.template_url(url, params)
+      url = "#{base_url}/commissions"
+      headers = {}
+      query_params = Utils.get_query_params(::OpenApiSDK::Operations::ListCommissionsRequest, request)
+      headers['Accept'] = 'application/json'
+      headers['user-agent'] = @sdk_configuration.user_agent
+
+      security = !@sdk_configuration.nil? && !@sdk_configuration.security_source.nil? ? @sdk_configuration.security_source.call : nil
+
+      timeout = (timeout_ms.to_f / 1000) unless timeout_ms.nil?
+      timeout ||= @sdk_configuration.timeout
+
+      connection = @sdk_configuration.client
+
+      hook_ctx = SDKHooks::HookContext.new(
+        base_url: base_url,
+        oauth2_scopes: nil,
+        operation_id: 'listCommissions',
+        security_source: @sdk_configuration.security_source
+      )
+
+      error = T.let(nil, T.nilable(StandardError))
+      r = T.let(nil, T.nilable(Faraday::Response))
+      
+      begin
+        r = connection.get(url) do |req|
+          req.headers.merge!(headers)
+          req.options.timeout = timeout unless timeout.nil?
+          req.params = query_params
+          Utils.configure_request_security(req, security)
+
+          @sdk_configuration.hooks.before_request(
+            hook_ctx: SDKHooks::BeforeRequestHookContext.new(
+              hook_ctx: hook_ctx
+            ),
+            request: req
+          )
+        end
+      rescue StandardError => e
+        error = e
+      ensure
+        if r.nil? || Utils.error_status?(r.status)
+          r = @sdk_configuration.hooks.after_error(
+            error: error,
+            hook_ctx: SDKHooks::AfterErrorHookContext.new(
+              hook_ctx: hook_ctx
+            ),
+            response: r
+          )
+        else
+          r = @sdk_configuration.hooks.after_success(
+            hook_ctx: SDKHooks::AfterSuccessHookContext.new(
+              hook_ctx: hook_ctx
+            ),
+            response: r
+          )
+        end
+        
+        if r.nil?
+          raise error if !error.nil?
+          raise 'no response'
+        end
+      end
+
+      content_type = r.headers.fetch('Content-Type', 'application/octet-stream')
+
+      res = ::OpenApiSDK::Operations::ListCommissionsResponse.new(
+        status_code: r.status, content_type: content_type, raw_response: r
+      )
+      if r.status == 200
+        if Utils.match_content_type(content_type, 'application/json')
+          out = Crystalline.unmarshal_json(JSON.parse(r.env.response_body), T::Array[::OpenApiSDK::Operations::ListCommissionsResponseBody])
+          res.response_bodies = out
+        end
+      elsif r.status == 400
+        if Utils.match_content_type(content_type, 'application/json')
+          out = Crystalline.unmarshal_json(JSON.parse(r.env.response_body), ::OpenApiSDK::Shared::BadRequest)
+          res.bad_request = out
+        end
+      elsif r.status == 401
+        if Utils.match_content_type(content_type, 'application/json')
+          out = Crystalline.unmarshal_json(JSON.parse(r.env.response_body), ::OpenApiSDK::Shared::Unauthorized)
+          res.unauthorized = out
+        end
+      elsif r.status == 403
+        if Utils.match_content_type(content_type, 'application/json')
+          out = Crystalline.unmarshal_json(JSON.parse(r.env.response_body), ::OpenApiSDK::Shared::Forbidden)
+          res.forbidden = out
+        end
+      elsif r.status == 404
+        if Utils.match_content_type(content_type, 'application/json')
+          out = Crystalline.unmarshal_json(JSON.parse(r.env.response_body), ::OpenApiSDK::Shared::NotFound)
+          res.not_found = out
+        end
+      elsif r.status == 409
+        if Utils.match_content_type(content_type, 'application/json')
+          out = Crystalline.unmarshal_json(JSON.parse(r.env.response_body), ::OpenApiSDK::Shared::Conflict)
+          res.conflict = out
+        end
+      elsif r.status == 410
+        if Utils.match_content_type(content_type, 'application/json')
+          out = Crystalline.unmarshal_json(JSON.parse(r.env.response_body), ::OpenApiSDK::Shared::InviteExpired)
+          res.invite_expired = out
+        end
+      elsif r.status == 422
+        if Utils.match_content_type(content_type, 'application/json')
+          out = Crystalline.unmarshal_json(JSON.parse(r.env.response_body), ::OpenApiSDK::Shared::UnprocessableEntity)
+          res.unprocessable_entity = out
+        end
+      elsif r.status == 429
+        if Utils.match_content_type(content_type, 'application/json')
+          out = Crystalline.unmarshal_json(JSON.parse(r.env.response_body), ::OpenApiSDK::Shared::RateLimitExceeded)
+          res.rate_limit_exceeded = out
+        end
+      elsif r.status == 500
+        if Utils.match_content_type(content_type, 'application/json')
+          out = Crystalline.unmarshal_json(JSON.parse(r.env.response_body), ::OpenApiSDK::Shared::InternalServerError)
+          res.internal_server_error = out
+        end
+      end
+
+      res
+    end
+
+
+    sig { params(request: T.nilable(::OpenApiSDK::Operations::UpdateCommissionRequest), timeout_ms: T.nilable(Integer)).returns(::OpenApiSDK::Operations::UpdateCommissionResponse) }
+    def update(request, timeout_ms = nil)
+      # update - Update a commission.
+      # Update an existing commission amount. This is useful for handling refunds (partial or full) or fraudulent sales.
+      url, params = @sdk_configuration.get_server_details
+      base_url = Utils.template_url(url, params)
+      url = Utils.generate_url(
+        ::OpenApiSDK::Operations::UpdateCommissionRequest,
+        base_url,
+        '/commissions/{id}',
+        request
+      )
+      headers = {}
+      req_content_type, data, form = Utils.serialize_request_body(request, :request_body, :json)
+      headers['content-type'] = req_content_type
+
+      if form
+        body = Utils.encode_form(form)
+      elsif Utils.match_content_type(req_content_type, 'application/x-www-form-urlencoded')
+        body = URI.encode_www_form(data)
+      else
+        body = data
+      end
+      headers['Accept'] = 'application/json'
+      headers['user-agent'] = @sdk_configuration.user_agent
+
+      security = !@sdk_configuration.nil? && !@sdk_configuration.security_source.nil? ? @sdk_configuration.security_source.call : nil
+
+      timeout = (timeout_ms.to_f / 1000) unless timeout_ms.nil?
+      timeout ||= @sdk_configuration.timeout
+
+      connection = @sdk_configuration.client
+
+      hook_ctx = SDKHooks::HookContext.new(
+        base_url: base_url,
+        oauth2_scopes: nil,
+        operation_id: 'updateCommission',
+        security_source: @sdk_configuration.security_source
+      )
+
+      error = T.let(nil, T.nilable(StandardError))
+      r = T.let(nil, T.nilable(Faraday::Response))
+      
+      begin
+        r = connection.patch(url) do |req|
+          req.body = body
+          req.headers.merge!(headers)
+          req.options.timeout = timeout unless timeout.nil?
+          Utils.configure_request_security(req, security)
+
+          @sdk_configuration.hooks.before_request(
+            hook_ctx: SDKHooks::BeforeRequestHookContext.new(
+              hook_ctx: hook_ctx
+            ),
+            request: req
+          )
+        end
+      rescue StandardError => e
+        error = e
+      ensure
+        if r.nil? || Utils.error_status?(r.status)
+          r = @sdk_configuration.hooks.after_error(
+            error: error,
+            hook_ctx: SDKHooks::AfterErrorHookContext.new(
+              hook_ctx: hook_ctx
+            ),
+            response: r
+          )
+        else
+          r = @sdk_configuration.hooks.after_success(
+            hook_ctx: SDKHooks::AfterSuccessHookContext.new(
+              hook_ctx: hook_ctx
+            ),
+            response: r
+          )
+        end
+        
+        if r.nil?
+          raise error if !error.nil?
+          raise 'no response'
+        end
+      end
+
+      content_type = r.headers.fetch('Content-Type', 'application/octet-stream')
+
+      res = ::OpenApiSDK::Operations::UpdateCommissionResponse.new(
+        status_code: r.status, content_type: content_type, raw_response: r
+      )
+      if r.status == 200
+        if Utils.match_content_type(content_type, 'application/json')
+          out = Crystalline.unmarshal_json(JSON.parse(r.env.response_body), ::OpenApiSDK::Operations::UpdateCommissionResponseBody)
+          res.object = out
+        end
+      elsif r.status == 400
+        if Utils.match_content_type(content_type, 'application/json')
+          out = Crystalline.unmarshal_json(JSON.parse(r.env.response_body), ::OpenApiSDK::Shared::BadRequest)
+          res.bad_request = out
+        end
+      elsif r.status == 401
+        if Utils.match_content_type(content_type, 'application/json')
+          out = Crystalline.unmarshal_json(JSON.parse(r.env.response_body), ::OpenApiSDK::Shared::Unauthorized)
+          res.unauthorized = out
+        end
+      elsif r.status == 403
+        if Utils.match_content_type(content_type, 'application/json')
+          out = Crystalline.unmarshal_json(JSON.parse(r.env.response_body), ::OpenApiSDK::Shared::Forbidden)
+          res.forbidden = out
+        end
+      elsif r.status == 404
+        if Utils.match_content_type(content_type, 'application/json')
+          out = Crystalline.unmarshal_json(JSON.parse(r.env.response_body), ::OpenApiSDK::Shared::NotFound)
+          res.not_found = out
+        end
+      elsif r.status == 409
+        if Utils.match_content_type(content_type, 'application/json')
+          out = Crystalline.unmarshal_json(JSON.parse(r.env.response_body), ::OpenApiSDK::Shared::Conflict)
+          res.conflict = out
+        end
+      elsif r.status == 410
+        if Utils.match_content_type(content_type, 'application/json')
+          out = Crystalline.unmarshal_json(JSON.parse(r.env.response_body), ::OpenApiSDK::Shared::InviteExpired)
+          res.invite_expired = out
+        end
+      elsif r.status == 422
+        if Utils.match_content_type(content_type, 'application/json')
+          out = Crystalline.unmarshal_json(JSON.parse(r.env.response_body), ::OpenApiSDK::Shared::UnprocessableEntity)
+          res.unprocessable_entity = out
+        end
+      elsif r.status == 429
+        if Utils.match_content_type(content_type, 'application/json')
+          out = Crystalline.unmarshal_json(JSON.parse(r.env.response_body), ::OpenApiSDK::Shared::RateLimitExceeded)
+          res.rate_limit_exceeded = out
+        end
+      elsif r.status == 500
+        if Utils.match_content_type(content_type, 'application/json')
+          out = Crystalline.unmarshal_json(JSON.parse(r.env.response_body), ::OpenApiSDK::Shared::InternalServerError)
+          res.internal_server_error = out
+        end
+      end
+
+      res
+    end
+  end
+end

data/lib/open_api_sdk/dub.rb

@@ -16,7 +16,7 @@ module OpenApiSDK
   class Dub
     extend T::Sig
 
-    attr_accessor :links, :analytics, :events, :tags, :folders, :domains, :track, :customers, :partners, :workspaces, :embed_tokens, :qr_codes
+    attr_accessor :links, :analytics, :events, :tags, :folders, :domains, :track, :customers, :partners, :commissions, :workspaces, :embed_tokens, :qr_codes
 
     sig do
       params(
@@ -90,6 +90,7 @@ module OpenApiSDK
       @track = Track.new(@sdk_configuration)
       @customers = Customers.new(@sdk_configuration)
       @partners = Partners.new(@sdk_configuration)
+      @commissions = Commissions.new(@sdk_configuration)
       @workspaces = Workspaces.new(@sdk_configuration)
       @embed_tokens = EmbedTokens.new(@sdk_configuration)
       @qr_codes = QRCodes.new(@sdk_configuration)

data/lib/open_api_sdk/models/operations/createcustomer_partner.rb

@@ -11,13 +11,13 @@ module OpenApiSDK
     class CreateCustomerPartner < ::Crystalline::FieldAugmented
       extend T::Sig
 
-
+      # The partner's email address. Should be a unique value across Dub.
       field :email, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('email') } }
-
+      # The partner's unique ID on Dub.
       field :id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('id') } }
-
+      # The partner's avatar image.
       field :image, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('image') } }
-
+      # The partner's full legal name.
       field :name, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('name') } }
 
 

data/lib/open_api_sdk/models/operations/createpartner_responsebody.rb

@@ -11,50 +11,62 @@ module OpenApiSDK
     class CreatePartnerResponseBody < ::Crystalline::FieldAugmented
       extend T::Sig
 
-
+      # The total number of clicks on the partner's links.
       field :clicks, ::Float, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('clicks') } }
-
+      # The partner's country (required for tax purposes).
       field :country, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('country') } }
-
+      # The date when the partner was created on Dub.
       field :created_at, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('createdAt') } }
-
+      # The total earnings/commissions accrued by the partner's links.
       field :earnings, ::Float, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('earnings') } }
-
+      # The partner's email address. Should be a unique value across Dub.
       field :email, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('email') } }
-
+      # The partner's unique ID on Dub.
       field :id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('id') } }
-
+      # The partner's avatar image.
       field :image, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('image') } }
-
+      # The partner's Instagram username (e.g. `johndoe`).
+      field :instagram, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('instagram') } }
+      # The total number of leads generated by the partner's links.
       field :leads, ::Float, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('leads') } }
-
+      # The partner's LinkedIn username (e.g. `johndoe`).
+      field :linkedin, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('linkedin') } }
+      # The partner's referral links in this program.
       field :links, T::Array[::OpenApiSDK::Operations::CreatePartnerLink], { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('links') } }
-
+      # The partner's full legal name.
       field :name, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('name') } }
-
+      # The date when the partner enabled payouts.
       field :payouts_enabled_at, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('payoutsEnabledAt') } }
-
+      # The partner's PayPal email (for receiving payouts via PayPal).
       field :paypal_email, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('paypalEmail') } }
-
+      # The program's unique ID on Dub.
       field :program_id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('programId') } }
-
+      # The total amount of sales (in cents) generated by the partner's links.
       field :sale_amount, ::Float, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('saleAmount') } }
-
+      # The total number of sales generated by the partner's links.
       field :sales, ::Float, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('sales') } }
-
-      field :status, ::OpenApiSDK::Operations::Status, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('status'), 'decoder': Utils.enum_from_string(::OpenApiSDK::Operations::Status, false) } }
-
+      # The status of the partner's enrollment in the program.
+      field :status, ::OpenApiSDK::Operations::CreatePartnerStatus, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('status'), 'decoder': Utils.enum_from_string(::OpenApiSDK::Operations::CreatePartnerStatus, false) } }
+      # The partner's Stripe Connect ID (for receiving payouts via Stripe).
       field :stripe_connect_id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('stripeConnectId') } }
-
+      # The partner's unique ID within your database. Can be useful for associating the partner with a user in your database and retrieving/update their data in the future.
       field :tenant_id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tenantId') } }
-
+      # The partner's TikTok username (e.g. `johndoe`).
+      field :tiktok, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tiktok') } }
+      # The partner's Twitter username (e.g. `johndoe`).
+      field :twitter, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('twitter') } }
+      # The partner's website URL (including the https protocol).
+      field :website, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('website') } }
+      # The partner's YouTube channel username (e.g. `johndoe`).
+      field :youtube, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('youtube') } }
+      # If the partner submitted an application to join the program, this is the ID of the application.
       field :application_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('applicationId') } }
-
+      # A brief description of the partner and their background.
       field :description, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('description') } }
 
 
-      sig { params(clicks: ::Float, country: ::String, created_at: ::String, earnings: ::Float, email: ::String, id: ::String, image: ::String, leads: ::Float, links: T::Array[::OpenApiSDK::Operations::CreatePartnerLink], name: ::String, payouts_enabled_at: ::String, paypal_email: ::String, program_id: ::String, sale_amount: ::Float, sales: ::Float, status: ::OpenApiSDK::Operations::Status, stripe_connect_id: ::String, tenant_id: ::String, application_id: T.nilable(::String), description: T.nilable(::String)).void }
-      def initialize(clicks: nil, country: nil, created_at: nil, earnings: nil, email: nil, id: nil, image: nil, leads: nil, links: nil, name: nil, payouts_enabled_at: nil, paypal_email: nil, program_id: nil, sale_amount: nil, sales: nil, status: nil, stripe_connect_id: nil, tenant_id: nil, application_id: nil, description: nil)
+      sig { params(clicks: ::Float, country: ::String, created_at: ::String, earnings: ::Float, email: ::String, id: ::String, image: ::String, instagram: ::String, leads: ::Float, linkedin: ::String, links: T::Array[::OpenApiSDK::Operations::CreatePartnerLink], name: ::String, payouts_enabled_at: ::String, paypal_email: ::String, program_id: ::String, sale_amount: ::Float, sales: ::Float, status: ::OpenApiSDK::Operations::CreatePartnerStatus, stripe_connect_id: ::String, tenant_id: ::String, tiktok: ::String, twitter: ::String, website: ::String, youtube: ::String, application_id: T.nilable(::String), description: T.nilable(::String)).void }
+      def initialize(clicks: nil, country: nil, created_at: nil, earnings: nil, email: nil, id: nil, image: nil, instagram: nil, leads: nil, linkedin: nil, links: nil, name: nil, payouts_enabled_at: nil, paypal_email: nil, program_id: nil, sale_amount: nil, sales: nil, status: nil, stripe_connect_id: nil, tenant_id: nil, tiktok: nil, twitter: nil, website: nil, youtube: nil, application_id: nil, description: nil)
         @clicks = clicks
         @country = country
         @created_at = created_at
@@ -62,7 +74,9 @@ module OpenApiSDK
         @email = email
         @id = id
         @image = image
+        @instagram = instagram
         @leads = leads
+        @linkedin = linkedin
         @links = links
         @name = name
         @payouts_enabled_at = payouts_enabled_at
@@ -73,6 +87,10 @@ module OpenApiSDK
         @status = status
         @stripe_connect_id = stripe_connect_id
         @tenant_id = tenant_id
+        @tiktok = tiktok
+        @twitter = twitter
+        @website = website
+        @youtube = youtube
         @application_id = application_id
         @description = description
       end

data/lib/open_api_sdk/models/operations/createpartner_status.rb

@@ -0,0 +1,22 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module OpenApiSDK
+  module Operations
+  
+    # CreatePartnerStatus - The status of the partner's enrollment in the program.
+    class CreatePartnerStatus < T::Enum
+      enums do
+        PENDING = new('pending')
+        APPROVED = new('approved')
+        REJECTED = new('rejected')
+        INVITED = new('invited')
+        DECLINED = new('declined')
+        BANNED = new('banned')
+      end
+    end
+  end
+end

data/lib/open_api_sdk/models/operations/getcustomer_partner.rb

@@ -11,13 +11,13 @@ module OpenApiSDK
     class GetCustomerPartner < ::Crystalline::FieldAugmented
       extend T::Sig
 
-
+      # The partner's email address. Should be a unique value across Dub.
       field :email, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('email') } }
-
+      # The partner's unique ID on Dub.
       field :id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('id') } }
-
+      # The partner's avatar image.
       field :image, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('image') } }
-
+      # The partner's full legal name.
       field :name, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('name') } }
 
 

data/lib/open_api_sdk/models/operations/getcustomers_partner.rb

@@ -11,13 +11,13 @@ module OpenApiSDK
     class GetCustomersPartner < ::Crystalline::FieldAugmented
       extend T::Sig
 
-
+      # The partner's email address. Should be a unique value across Dub.
       field :email, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('email') } }
-
+      # The partner's unique ID on Dub.
       field :id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('id') } }
-
+      # The partner's avatar image.
       field :image, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('image') } }
-
+      # The partner's full legal name.
       field :name, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('name') } }
 
 

data/lib/open_api_sdk/models/operations/listcommissions_queryparam_interval.rb

@@ -0,0 +1,25 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module OpenApiSDK
+  module Operations
+  
+    # ListCommissionsQueryParamInterval - The interval to retrieve commissions for.
+    class ListCommissionsQueryParamInterval < T::Enum
+      enums do
+        TWENTY_FOURH = new('24h')
+        SEVEND = new('7d')
+        THIRTYD = new('30d')
+        NINETYD = new('90d')
+        ONEY = new('1y')
+        MTD = new('mtd')
+        QTD = new('qtd')
+        YTD = new('ytd')
+        ALL = new('all')
+      end
+    end
+  end
+end

data/lib/open_api_sdk/models/operations/listcommissions_queryparam_sortby.rb

@@ -0,0 +1,18 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module OpenApiSDK
+  module Operations
+  
+    # ListCommissionsQueryParamSortBy - The field to sort the list of commissions by.
+    class ListCommissionsQueryParamSortBy < T::Enum
+      enums do
+        CREATED_AT = new('createdAt')
+        AMOUNT = new('amount')
+      end
+    end
+  end
+end

data/lib/open_api_sdk/models/operations/listcommissions_queryparam_sortorder.rb

@@ -0,0 +1,18 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module OpenApiSDK
+  module Operations
+  
+    # ListCommissionsQueryParamSortOrder - The sort order for the list of commissions.
+    class ListCommissionsQueryParamSortOrder < T::Enum
+      enums do
+        ASC = new('asc')
+        DESC = new('desc')
+      end
+    end
+  end
+end

data/lib/open_api_sdk/models/operations/listcommissions_request.rb

@@ -0,0 +1,60 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module OpenApiSDK
+  module Operations
+  
+
+    class ListCommissionsRequest < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+      # Filter the list of commissions by the associated customer.
+      field :customer_id, T.nilable(::String), { 'query_param': { 'field_name': 'customerId', 'style': 'form', 'explode': true } }
+      # The end date of the date range to filter the commissions by.
+      field :end_, T.nilable(::String), { 'query_param': { 'field_name': 'end', 'style': 'form', 'explode': true } }
+      # The interval to retrieve commissions for.
+      field :interval, T.nilable(::OpenApiSDK::Operations::ListCommissionsQueryParamInterval), { 'query_param': { 'field_name': 'interval', 'style': 'form', 'explode': true } }
+      # Filter the list of commissions by the associated invoice. Since invoiceId is unique on a per-program basis, this will only return one commission per invoice.
+      field :invoice_id, T.nilable(::String), { 'query_param': { 'field_name': 'invoiceId', 'style': 'form', 'explode': true } }
+      # The page number for pagination.
+      field :page, T.nilable(::Float), { 'query_param': { 'field_name': 'page', 'style': 'form', 'explode': true } }
+      # The number of items per page.
+      field :page_size, T.nilable(::Float), { 'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': true } }
+      # Filter the list of commissions by the associated partner.
+      field :partner_id, T.nilable(::String), { 'query_param': { 'field_name': 'partnerId', 'style': 'form', 'explode': true } }
+      # Filter the list of commissions by the associated payout.
+      field :payout_id, T.nilable(::String), { 'query_param': { 'field_name': 'payoutId', 'style': 'form', 'explode': true } }
+      # The field to sort the list of commissions by.
+      field :sort_by, T.nilable(::OpenApiSDK::Operations::ListCommissionsQueryParamSortBy), { 'query_param': { 'field_name': 'sortBy', 'style': 'form', 'explode': true } }
+      # The sort order for the list of commissions.
+      field :sort_order, T.nilable(::OpenApiSDK::Operations::ListCommissionsQueryParamSortOrder), { 'query_param': { 'field_name': 'sortOrder', 'style': 'form', 'explode': true } }
+      # The start date of the date range to filter the commissions by.
+      field :start, T.nilable(::String), { 'query_param': { 'field_name': 'start', 'style': 'form', 'explode': true } }
+      # Filter the list of commissions by their corresponding status.
+      field :status, T.nilable(::OpenApiSDK::Operations::QueryParamStatus), { 'query_param': { 'field_name': 'status', 'style': 'form', 'explode': true } }
+
+      field :type, T.nilable(::OpenApiSDK::Operations::Type), { 'query_param': { 'field_name': 'type', 'style': 'form', 'explode': true } }
+
+
+      sig { params(customer_id: T.nilable(::String), end_: T.nilable(::String), interval: T.nilable(::OpenApiSDK::Operations::ListCommissionsQueryParamInterval), invoice_id: T.nilable(::String), page: T.nilable(::Float), page_size: T.nilable(::Float), partner_id: T.nilable(::String), payout_id: T.nilable(::String), sort_by: T.nilable(::OpenApiSDK::Operations::ListCommissionsQueryParamSortBy), sort_order: T.nilable(::OpenApiSDK::Operations::ListCommissionsQueryParamSortOrder), start: T.nilable(::String), status: T.nilable(::OpenApiSDK::Operations::QueryParamStatus), type: T.nilable(::OpenApiSDK::Operations::Type)).void }
+      def initialize(customer_id: nil, end_: nil, interval: nil, invoice_id: nil, page: nil, page_size: nil, partner_id: nil, payout_id: nil, sort_by: nil, sort_order: nil, start: nil, status: nil, type: nil)
+        @customer_id = customer_id
+        @end_ = end_
+        @interval = interval
+        @invoice_id = invoice_id
+        @page = page
+        @page_size = page_size
+        @partner_id = partner_id
+        @payout_id = payout_id
+        @sort_by = sort_by
+        @sort_order = sort_order
+        @start = start
+        @status = status
+        @type = type
+      end
+    end
+  end
+end