genius_referrals 0.1.0

data/lib/genius_referrals/resources/products.rb

@@ -0,0 +1,86 @@
+module GeniusReferrals
+  class ProductsResource < Resource
+    # List products for an account.
+    def list(account_slug, page: 1, limit: 10, filter: nil, sort: nil)
+      page('GET',
+           "/accounts/#{esc(account_slug)}/products",
+           params: compact(page: page, limit: limit, filter: filter, sort: sort))
+    end
+
+    # Create a product using the `product` wrapper.
+    def create(account_slug, product)
+      request('POST', "/accounts/#{esc(account_slug)}/products", json: wrapped('product', product))
+    end
+
+    # Retrieve one product.
+    def retrieve(account_slug, product_slug, filter: nil)
+      request('GET',
+              "/accounts/#{esc(account_slug)}/products/#{esc(product_slug)}",
+              params: compact(filter: filter))
+    end
+
+    # Replace a product using the `product` wrapper.
+    def update(account_slug, product_slug, product)
+      request('PUT',
+              "/accounts/#{esc(account_slug)}/products/#{esc(product_slug)}",
+              json: wrapped('product', product))
+    end
+
+    # Patch a product with unwrapped partial fields.
+    def patch(account_slug, product_slug, **fields)
+      request('PATCH', "/accounts/#{esc(account_slug)}/products/#{esc(product_slug)}", json: fields)
+    end
+
+    # Delete one product.
+    def delete(account_slug, product_slug)
+      request('DELETE', "/accounts/#{esc(account_slug)}/products/#{esc(product_slug)}")
+    end
+
+    # List product variants.
+    def variants(account_slug, product_slug, page: 1, limit: 10)
+      page('GET',
+           "/accounts/#{esc(account_slug)}/products/#{esc(product_slug)}/variants",
+           params: { page: page, limit: limit })
+    end
+
+    # Create a product variant.
+    def create_variant(account_slug, product_slug, variant)
+      request('POST',
+              "/accounts/#{esc(account_slug)}/products/#{esc(product_slug)}/variants",
+              json: wrapped('variant', variant))
+    end
+
+    # Retrieve one product variant.
+    def retrieve_variant(account_slug, product_slug, variant_id, filter: nil)
+      request('GET',
+              "/accounts/#{esc(account_slug)}/products/#{esc(product_slug)}/variants/#{esc(variant_id)}",
+              params: compact(filter: filter))
+    end
+
+    # Replace one product variant.
+    def update_variant(account_slug, product_slug, variant_id, variant)
+      request('PUT',
+              "/accounts/#{esc(account_slug)}/products/#{esc(product_slug)}/variants/#{esc(variant_id)}",
+              json: wrapped('variant', variant))
+    end
+
+    # Patch one product variant with unwrapped partial fields.
+    def patch_variant(account_slug, product_slug, variant_id, **fields)
+      request('PATCH',
+              "/accounts/#{esc(account_slug)}/products/#{esc(product_slug)}/variants/#{esc(variant_id)}",
+              json: fields)
+    end
+
+    # Delete one product variant.
+    def delete_variant(account_slug, product_slug, variant_id)
+      request('DELETE', "/accounts/#{esc(account_slug)}/products/#{esc(product_slug)}/variants/#{esc(variant_id)}")
+    end
+
+    # Patch a variant price with the live-doc unwrapped `amount` field.
+    def patch_variant_price(account_slug, product_slug, variant_id, currency_code, amount:)
+      request('PATCH',
+              "/accounts/#{esc(account_slug)}/products/#{esc(product_slug)}/variants/#{esc(variant_id)}/prices/#{esc(currency_code)}",
+              json: { 'amount' => amount })
+    end
+  end
+end

data/lib/genius_referrals/resources/redemption_requests.rb

@@ -0,0 +1,36 @@
+module GeniusReferrals
+  class RedemptionRequestsResource < Resource
+    # List redemption requests for an account.
+    def list(account_slug, page: 1, limit: 10, filter: nil, sort: nil)
+      page('GET',
+           "/accounts/#{esc(account_slug)}/redemption-requests",
+           params: compact(page: page, limit: limit, filter: filter, sort: sort))
+    end
+
+    # Create a redemption request.
+    def create(account_slug, redemption_request)
+      request('POST',
+              "/accounts/#{esc(account_slug)}/redemption-requests",
+              json: wrapped('redemption_request', redemption_request))
+    end
+
+    # Retrieve one redemption request.
+    def retrieve(account_slug, redemption_request_id)
+      request('GET', "/accounts/#{esc(account_slug)}/redemption-requests/#{esc(redemption_request_id)}")
+    end
+
+    # Patch a redemption request with unwrapped partial fields.
+    def patch(account_slug, redemption_request_id, **fields)
+      request('PATCH',
+              "/accounts/#{esc(account_slug)}/redemption-requests/#{esc(redemption_request_id)}",
+              json: fields)
+    end
+
+    # Patch the redemption action endpoint.
+    def redeem(account_slug, redemption_request_id, **fields)
+      request('PATCH',
+              "/accounts/#{esc(account_slug)}/redemption-requests/#{esc(redemption_request_id)}/redemption",
+              json: fields)
+    end
+  end
+end

data/lib/genius_referrals/resources/referrals.rb

@@ -0,0 +1,34 @@
+module GeniusReferrals
+  class ReferralsResource < Resource
+    # List referrals for one advocate.
+    def list(account_slug, advocate_token, page: 1, limit: 10, filter: nil, sort: nil)
+      page('GET',
+           "/accounts/#{esc(account_slug)}/advocates/#{esc(advocate_token)}/referrals",
+           params: compact(page: page, limit: limit, filter: filter, sort: sort))
+    end
+
+    # Create a referral.
+    def create(account_slug, advocate_token, referral)
+      request('POST',
+              "/accounts/#{esc(account_slug)}/advocates/#{esc(advocate_token)}/referrals",
+              json: wrapped('referral', referral))
+    end
+
+    # Retrieve one referral.
+    def retrieve(account_slug, advocate_token, referral_id)
+      request('GET', "/accounts/#{esc(account_slug)}/advocates/#{esc(advocate_token)}/referrals/#{esc(referral_id)}")
+    end
+
+    # Replace one referral.
+    def update(account_slug, advocate_token, referral_id, referral)
+      request('PUT',
+              "/accounts/#{esc(account_slug)}/advocates/#{esc(advocate_token)}/referrals/#{esc(referral_id)}",
+              json: wrapped('referral', referral))
+    end
+
+    # Delete one referral.
+    def delete(account_slug, advocate_token, referral_id)
+      request('DELETE', "/accounts/#{esc(account_slug)}/advocates/#{esc(advocate_token)}/referrals/#{esc(referral_id)}")
+    end
+  end
+end

data/lib/genius_referrals/resources/reports.rb

@@ -0,0 +1,72 @@
+module GeniusReferrals
+  class ReportsResource < Resource
+    # Run the 1099 tax report.
+    def tax_1099(client_slug: nil, account_slug: nil, year: nil)
+      request('GET',
+              '/reports/1099-tax-report',
+              params: compact(client_slug: client_slug, account_slug: account_slug, year: year))
+    end
+
+    # Run the revenue report with accepted live-doc and SDK parameter names.
+    def revenue(account_slug: nil, client_account_slug: nil, start_date: nil, end_date: nil)
+      request('GET',
+              '/reports/revenue',
+              params: compact(account_slug: account_slug,
+                              client_account_slug: client_account_slug,
+                              start_date: start_date,
+                              end_date: end_date))
+    end
+
+    # Run the daily bonuses given report.
+    def bonuses_daily_given(account_slug:, start_date:, end_date:, advocate_token: nil)
+      dated('/reports/bonuses-daily-given', account_slug, start_date, end_date, advocate_token)
+    end
+
+    # Run the bonuses summary per origin report.
+    def bonuses_summary_per_origin(account_slug:, start_date:, end_date:, advocate_token: nil)
+      dated('/reports/bonuses-summary-per-origin', account_slug, start_date, end_date, advocate_token)
+    end
+
+    # Run the click daily participation report.
+    def click_daily_participation(account_slug:, start_date:, end_date:, advocate_token: nil)
+      dated('/reports/click-daily-participation', account_slug, start_date, end_date, advocate_token)
+    end
+
+    # Run the referral daily participation report.
+    def referral_daily_participation(account_slug:, start_date:, end_date:, advocate_token: nil)
+      dated('/reports/referral-daily-participation', account_slug, start_date, end_date, advocate_token)
+    end
+
+    # Run the referrals summary per origin report.
+    def referrals_summary_per_origin(account_slug:, start_date:, end_date:, advocate_token: nil)
+      dated('/reports/referrals-summary-per-origin', account_slug, start_date, end_date, advocate_token)
+    end
+
+    # Run the share daily participation report.
+    def share_daily_participation(account_slug:, start_date:, end_date:, advocate_token: nil)
+      dated('/reports/share-daily-participation', account_slug, start_date, end_date, advocate_token)
+    end
+
+    # Run the top advocates report.
+    def top_advocates(account_slug:, start_date:, end_date:, advocate_token: nil, limit: nil)
+      request('GET',
+              '/reports/top-advocates',
+              params: compact(account_slug: account_slug,
+                              start_date: start_date,
+                              end_date: end_date,
+                              advocate_token: advocate_token,
+                              limit: limit))
+    end
+
+    private
+
+    def dated(path, account_slug, start_date, end_date, advocate_token)
+      request('GET',
+              path,
+              params: compact(account_slug: account_slug,
+                              start_date: start_date,
+                              end_date: end_date,
+                              advocate_token: advocate_token))
+    end
+  end
+end

data/lib/genius_referrals/resources/root.rb

@@ -0,0 +1,8 @@
+module GeniusReferrals
+  class RootResource < Resource
+    # Retrieve API root links.
+    def retrieve
+      request('GET', '/')
+    end
+  end
+end

data/lib/genius_referrals/resources/tags.rb

@@ -0,0 +1,35 @@
+module GeniusReferrals
+  class TagsResource < Resource
+    # List tags.
+    def list(account_slug, page: 1, limit: 10, filter: nil, sort: nil)
+      page('GET',
+           "/accounts/#{esc(account_slug)}/tags",
+           params: compact(page: page, limit: limit, filter: filter, sort: sort))
+    end
+
+    # Create a tag.
+    def create(account_slug, tag)
+      request('POST', "/accounts/#{esc(account_slug)}/tags", json: wrapped('tag', tag))
+    end
+
+    # Retrieve one tag.
+    def retrieve(account_slug, tag_slug)
+      request('GET', "/accounts/#{esc(account_slug)}/tags/#{esc(tag_slug)}")
+    end
+
+    # Replace one tag.
+    def update(account_slug, tag_slug, tag)
+      request('PUT', "/accounts/#{esc(account_slug)}/tags/#{esc(tag_slug)}", json: wrapped('tag', tag))
+    end
+
+    # Patch a tag with unwrapped partial fields.
+    def patch(account_slug, tag_slug, **fields)
+      request('PATCH', "/accounts/#{esc(account_slug)}/tags/#{esc(tag_slug)}", json: fields)
+    end
+
+    # Delete one tag.
+    def delete(account_slug, tag_slug)
+      request('DELETE', "/accounts/#{esc(account_slug)}/tags/#{esc(tag_slug)}")
+    end
+  end
+end

data/lib/genius_referrals/resources/utilities.rb

@@ -0,0 +1,58 @@
+module GeniusReferrals
+  class UtilitiesResource < Resource
+    # List bonus redemption methods.
+    def bonus_redemption_methods(page: 1, limit: 10)
+      page('GET', '/utilities/bonuses-redemption-methods', params: { page: page, limit: limit })
+    end
+
+    # Retrieve one bonus redemption method.
+    def bonus_redemption_method(slug)
+      request('GET', "/utilities/bonuses-redemption-methods/#{esc(slug)}")
+    end
+
+    # List currencies.
+    def currencies(page: 1, limit: 10)
+      page('GET', '/utilities/currencies', params: { page: page, limit: limit })
+    end
+
+    # Retrieve one currency.
+    def currency(code)
+      request('GET', "/utilities/currencies/#{esc(code)}")
+    end
+
+    # List utility payment methods.
+    def payment_methods(page: 1, limit: 10)
+      page('GET', '/utilities/payment-methods', params: { page: page, limit: limit })
+    end
+
+    # List redemption request actions.
+    def redemption_request_actions(page: 1, limit: 10)
+      page('GET', '/utilities/redemption-request-actions', params: { page: page, limit: limit })
+    end
+
+    # Retrieve one redemption request action.
+    def redemption_request_action(slug)
+      request('GET', "/utilities/redemption-request-actions/#{esc(slug)}")
+    end
+
+    # List redemption request statuses.
+    def redemption_request_statuses(page: 1, limit: 10)
+      page('GET', '/utilities/redemption-request-statuses', params: { page: page, limit: limit })
+    end
+
+    # Retrieve one redemption request status.
+    def redemption_request_status(slug)
+      request('GET', "/utilities/redemption-request-statuses/#{esc(slug)}")
+    end
+
+    # List referral origins.
+    def referral_origins(page: 1, limit: 10)
+      page('GET', '/utilities/referral-origins', params: { page: page, limit: limit })
+    end
+
+    # Retrieve one referral origin.
+    def referral_origin(slug)
+      request('GET', "/utilities/referral-origins/#{esc(slug)}")
+    end
+  end
+end

data/lib/genius_referrals/resources/vouchers.rb

@@ -0,0 +1,33 @@
+module GeniusReferrals
+  class VouchersResource < Resource
+    # List vouchers.
+    def list(account_slug, page: 1, limit: 10)
+      page('GET', "/accounts/#{esc(account_slug)}/vouchers", params: { page: page, limit: limit })
+    end
+
+    # Create a voucher.
+    def create(account_slug, voucher)
+      request('POST', "/accounts/#{esc(account_slug)}/vouchers", json: wrapped('voucher', voucher))
+    end
+
+    # List voucher denominations for a currency.
+    def denominations(account_slug, currency_code)
+      request('GET', "/accounts/#{esc(account_slug)}/vouchers-denominations/#{esc(currency_code)}")
+    end
+
+    # Retrieve one voucher.
+    def retrieve(account_slug, voucher_id)
+      request('GET', "/accounts/#{esc(account_slug)}/vouchers/#{esc(voucher_id)}")
+    end
+
+    # Patch a voucher with unwrapped partial fields.
+    def patch(account_slug, voucher_id, **fields)
+      request('PATCH', "/accounts/#{esc(account_slug)}/vouchers/#{esc(voucher_id)}", json: fields)
+    end
+
+    # Delete one voucher.
+    def delete(account_slug, voucher_id)
+      request('DELETE', "/accounts/#{esc(account_slug)}/vouchers/#{esc(voucher_id)}")
+    end
+  end
+end

data/lib/genius_referrals/resources/widgets_packages.rb

@@ -0,0 +1,94 @@
+module GeniusReferrals
+  class WidgetsPackagesResource < Resource
+    # List widgets packages.
+    def list(account_slug, page: 1, limit: 10)
+      page('GET', "/accounts/#{esc(account_slug)}/widgets-packages", params: { page: page, limit: limit })
+    end
+
+    # Create a widgets package.
+    def create(account_slug, widgets_package)
+      request('POST',
+              "/accounts/#{esc(account_slug)}/widgets-packages",
+              json: wrapped('widgets_package', widgets_package))
+    end
+
+    # Retrieve one widgets package.
+    def retrieve(account_slug, widgets_package_slug)
+      request('GET', "/accounts/#{esc(account_slug)}/widgets-packages/#{esc(widgets_package_slug)}")
+    end
+
+    # Replace one widgets package.
+    def update(account_slug, widgets_package_slug, widgets_package)
+      request('PUT',
+              "/accounts/#{esc(account_slug)}/widgets-packages/#{esc(widgets_package_slug)}",
+              json: wrapped('widgets_package', widgets_package))
+    end
+
+    # Delete one widgets package.
+    def delete(account_slug, widgets_package_slug)
+      request('DELETE', "/accounts/#{esc(account_slug)}/widgets-packages/#{esc(widgets_package_slug)}")
+    end
+
+    # List widgets inside a package.
+    def widgets(account_slug, widgets_package_slug, page: 1, limit: 10, filter: nil)
+      page('GET',
+           "/accounts/#{esc(account_slug)}/widgets-packages/#{esc(widgets_package_slug)}/widgets",
+           params: compact(page: page, limit: limit, filter: filter))
+    end
+
+    # Create a widget.
+    def create_widget(account_slug, widgets_package_slug, widget)
+      request('POST',
+              "/accounts/#{esc(account_slug)}/widgets-packages/#{esc(widgets_package_slug)}/widgets",
+              json: wrapped('widget', widget))
+    end
+
+    # Retrieve one widget.
+    def retrieve_widget(account_slug, widgets_package_slug, widget_id, filter: nil)
+      request('GET',
+              "/accounts/#{esc(account_slug)}/widgets-packages/#{esc(widgets_package_slug)}/widgets/#{esc(widget_id)}",
+              params: compact(filter: filter))
+    end
+
+    # Replace one widget.
+    def update_widget(account_slug, widgets_package_slug, widget_id, widget)
+      request('PUT',
+              "/accounts/#{esc(account_slug)}/widgets-packages/#{esc(widgets_package_slug)}/widgets/#{esc(widget_id)}",
+              json: wrapped('widget', widget))
+    end
+
+    # Patch a widget with unwrapped partial fields.
+    def patch_widget(account_slug, widgets_package_slug, widget_id, **fields)
+      request('PATCH',
+              "/accounts/#{esc(account_slug)}/widgets-packages/#{esc(widgets_package_slug)}/widgets/#{esc(widget_id)}",
+              json: fields)
+    end
+
+    # List widget translations from the accepted SDK route text.
+    def translations(account_slug, widgets_package_slug, widget_id, page: 1, limit: 10)
+      page('GET',
+           "/accounts/#{esc(account_slug)}/widgets-packages/#{esc(widgets_package_slug)}/widgets/#{esc(widget_id)}/translations",
+           params: { page: page, limit: limit })
+    end
+
+    # Create a widget translation using the live-doc `widget` wrapper.
+    def create_translation(account_slug, widgets_package_slug, widget_id, widget)
+      request('POST',
+              "/accounts/#{esc(account_slug)}/widgets-packages/#{esc(widgets_package_slug)}/widgets/#{esc(widget_id)}/translations",
+              json: wrapped('widget', widget))
+    end
+
+    # Retrieve one widget translation from the accepted SDK route text.
+    def retrieve_translation(account_slug, widgets_package_slug, widget_id, locale)
+      request('GET',
+              "/accounts/#{esc(account_slug)}/widgets-packages/#{esc(widgets_package_slug)}/widgets/#{esc(widget_id)}/translations/#{esc(locale)}")
+    end
+
+    # Patch a widget translation with unwrapped partial fields.
+    def patch_translation(account_slug, widgets_package_slug, widget_id, locale, **fields)
+      request('PATCH',
+              "/accounts/#{esc(account_slug)}/widgets-packages/#{esc(widgets_package_slug)}/widgets/#{esc(widget_id)}/translations/#{esc(locale)}",
+              json: fields)
+    end
+  end
+end

data/lib/genius_referrals/resources.rb

@@ -0,0 +1,14 @@
+require_relative 'resources/accounts'
+require_relative 'resources/advocates'
+require_relative 'resources/authentications'
+require_relative 'resources/bonuses'
+require_relative 'resources/campaigns'
+require_relative 'resources/products'
+require_relative 'resources/redemption_requests'
+require_relative 'resources/referrals'
+require_relative 'resources/reports'
+require_relative 'resources/root'
+require_relative 'resources/tags'
+require_relative 'resources/utilities'
+require_relative 'resources/vouchers'
+require_relative 'resources/widgets_packages'

data/lib/genius_referrals/response.rb

@@ -0,0 +1,34 @@
+module GeniusReferrals
+  APIResponse = Struct.new(:code, :data, :raw, keyword_init: true) do
+    # Build a response envelope from the public API `{code, data}` shape.
+    def self.from_api(payload)
+      if payload.is_a?(Hash) && payload.key?('code') && payload.key?('data')
+        new(code: payload['code'], data: payload['data'], raw: payload)
+      else
+        new(code: nil, data: payload, raw: payload)
+      end
+    end
+  end
+
+  Page = Struct.new(:results, :page, :limit, :total, :raw, keyword_init: true) do
+    # Build a pagination wrapper from the standard list response shape.
+    def self.from_api(payload)
+      envelope = APIResponse.from_api(payload)
+      data = envelope.data
+
+      if data.is_a?(Hash)
+        new(
+          results: data['results'] || [],
+          page: data['page'],
+          limit: data['limit'],
+          total: data['total'],
+          raw: payload
+        )
+      elsif data.is_a?(Array)
+        new(results: data, page: nil, limit: nil, total: nil, raw: payload)
+      else
+        new(results: [], page: nil, limit: nil, total: nil, raw: payload)
+      end
+    end
+  end
+end

data/lib/genius_referrals/transport.rb

@@ -0,0 +1,30 @@
+require 'net/http'
+require 'stringio'
+require 'uri'
+
+module GeniusReferrals
+  TransportResponse = Struct.new(:status_code, :headers, :body, keyword_init: true)
+
+  class NetHTTPTransport
+    # Send one HTTP request using Ruby stdlib Net::HTTP.
+    def request(method, url, headers:, body:, timeout:)
+      uri = URI(url)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = uri.scheme == 'https'
+      http.open_timeout = timeout
+      http.read_timeout = timeout
+
+      request_class = Net::HTTP.const_get(method.capitalize)
+      request = request_class.new(uri)
+      headers.each { |key, value| request[key] = value }
+      request.body = body if body
+
+      response = http.request(request)
+      TransportResponse.new(
+        status_code: response.code.to_i,
+        headers: response.each_header.to_h,
+        body: response.body.to_s
+      )
+    end
+  end
+end

data/lib/genius_referrals/version.rb

@@ -0,0 +1,3 @@
+module GeniusReferrals
+  VERSION = '0.1.0'
+end

data/lib/genius_referrals.rb

@@ -0,0 +1,7 @@
+require_relative 'genius_referrals/version'
+require_relative 'genius_referrals/errors'
+require_relative 'genius_referrals/response'
+require_relative 'genius_referrals/transport'
+require_relative 'genius_referrals/resource'
+require_relative 'genius_referrals/resources'
+require_relative 'genius_referrals/client'