beehiiv_api 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 49a90588c24186317ba259f464fed06fb2030d09c5eeed4378ed17046eab8b4c
+  data.tar.gz: 57ae3af205d1af0d4d929caa342a5be8e393d530f0519f19f154a35408b466fb
+SHA512:
+  metadata.gz: 0cce6348430346352093e49187747e7353ef65bc5929b350961246ebe223c48c58ee2b13099ac6e039b8a52d5c503f9d5a1ece414616a8a8ee676de324fcdf53
+  data.tar.gz: 3be778c58f7adaf25fd6f0452f0cfb898fbdb27540ef00fe413fdf4ca17e2ce4ae4f5e852937be247598179aaefbace8d41b878397b427287ece98de00561dd8

data/lib/beehiiv_api.rb

@@ -0,0 +1,1181 @@
+# Generated by Sideko (sideko.dev)
+# frozen_string_literal: true
+require 'json'
+require 'http'
+
+class RequestError < StandardError
+  attr_reader :status_code, :method, :url, :data, :response
+
+  def initialize(method, url, response)
+    @status_code = response.status
+    @method = method
+    @url = url
+    begin
+      @data = response.parse
+    rescue
+      @data = nil
+    end
+    @response = response
+
+    super("received #{status_code} from #{method} #{url} with #{message}")
+  end
+end
+
+module AuthProvider
+  def add_auth(http_client, req_kwargs)
+    raise NotImplementedError, "You must implement the 'add_auth' method"
+  end
+end
+
+class AuthBasic
+  include AuthProvider
+
+  attr_accessor :username, :password
+
+  def initialize(username: nil, password: nil)
+    @username = username
+    @password = password
+  end
+
+  def add_auth(http_client, req_kwargs)
+    if !@username.nil? && !@password.nil?
+      http_client = http_client.basic_auth(user: @username, pass: @password)
+    end
+
+    return http_client, req_kwargs
+  end
+end
+
+class AuthBearer
+  include AuthProvider
+
+  attr_accessor :val
+
+  def initialize(val: nil)
+    @val = val
+  end
+
+  def add_auth(http_client, req_kwargs)
+    if !@val.nil?
+      headers = req_kwargs.fetch(:headers, {})
+      headers["Authorization"] = "Bearer " + @val
+      req_kwargs[:headers] = headers
+    end
+
+    return http_client, req_kwargs
+  end
+end
+
+class AuthKeyQuery
+  include AuthProvider
+
+  attr_accessor :query_name, :val
+
+  def initialize(query_name: nil, val: nil)
+    @query_name = query_name
+    @val = val
+  end
+
+  def add_auth(http_client, req_kwargs)
+    if !val.nil?
+      params = req_kwargs.fetch(:params, {})
+      params[query_name] = val
+      req_kwargs[:params] = params
+    end
+
+    return http_client, req_kwargs
+  end
+end
+
+class AuthKeyHeader
+  include AuthProvider
+
+  attr_accessor :header_name, :val
+
+  def initialize(header_name: nil, val: nil)
+    @header_name = header_name
+    @val = val
+  end
+
+  def add_auth(http_client, req_kwargs)
+    if !@val.nil?
+      headers = req_kwargs.fetch(:headers, {})
+      headers[@header_name] = @val
+      req_kwargs[:headers] = headers
+    end
+
+    return http_client, req_kwargs
+  end
+end
+
+class AuthKeyCookie
+  include AuthProvider
+
+  attr_accessor :cookie_name, :val
+
+  def initialize(cookie_name: nil, val: nil)
+    @cookie_name = cookie_name
+    @val = val
+  end
+
+  def add_auth(http_client, req_kwargs)
+    if !@val.nil?
+      http_client = http_client.cookies(@cookie_name => @val)
+    end
+
+    return http_client, req_kwargs
+  end
+end
+
+class Client
+  def initialize(bearer_auth: nil, base_url: 'https://api.beehiiv.com/v2')
+    @_base_url = base_url
+    # register auth providers
+    @_auth = {}
+    @_auth[:"bearerAuth"] = AuthBearer.new(val: bearer_auth)
+  end
+
+  def _client_with_auth(auth_names, **req_kwargs)
+    http_client = HTTP
+    auth_names.each do |auth_name|
+      provider = @_auth[auth_name]
+      http_client, req_kwargs = provider.add_auth(http_client, req_kwargs) if provider
+    end
+    
+    return http_client, req_kwargs
+  end
+
+
+  # Delete a custom field from a publication
+  def delete_publications_publication_id_custom_fields(publication_id, id)
+    _url = @_base_url + "/publications/#{publication_id}/custom_fields/#{id}"
+    _kwargs = {
+      params: {}
+    }
+    _http_client, _req_kwargs = self._client_with_auth(
+      [:"bearerAuth", ],
+      **_kwargs
+    )
+
+    
+    _response = _http_client.delete(
+      _url,
+      
+      **_req_kwargs
+    )
+    if !_response.status.success?
+      raise RequestError.new(
+        method="delete",
+        url=_url,
+        response=_response
+      )
+    end
+
+    return _response.body.empty? ? '' : _response.parse
+  end
+
+  # Delete or Archive a post. Any post that has been confirmed will have it's status changed to `archived`. Posts in the `draft` status will be permenantly deleted.
+  def delete_posts_post_id(publication_id, post_id)
+    _url = @_base_url + "/publications/#{publication_id}/posts/#{post_id}"
+    _kwargs = {
+      params: {}
+    }
+    _http_client, _req_kwargs = self._client_with_auth(
+      [:"bearerAuth", ],
+      **_kwargs
+    )
+
+    
+    _response = _http_client.delete(
+      _url,
+      
+      **_req_kwargs
+    )
+    if !_response.status.success?
+      raise RequestError.new(
+        method="delete",
+        url=_url,
+        response=_response
+      )
+    end
+
+    return _response.body.empty? ? '' : _response.parse
+  end
+
+  # Delete a segment. Deleting the segment does not effect the subscriptions in the segment.
+  def delete_publications_publication_id_segments_segment_id(publication_id, segment_id)
+    _url = @_base_url + "/publications/#{publication_id}/segments/#{segment_id}"
+    _kwargs = {
+      params: {}
+    }
+    _http_client, _req_kwargs = self._client_with_auth(
+      [:"bearerAuth", ],
+      **_kwargs
+    )
+
+    
+    _response = _http_client.delete(
+      _url,
+      
+      **_req_kwargs
+    )
+    if !_response.status.success?
+      raise RequestError.new(
+        method="delete",
+        url=_url,
+        response=_response
+      )
+    end
+
+    return _response.body.empty? ? '' : _response.parse
+  end
+
+  # Delete a subscription.
+  # 
+  # **This cannot be undone** All data associated with the subscription will also be deleted. We recommend unsubscribing when possible instead of deleting.
+  # 
+  # If a premium subscription is deleted they will no longer be billed.
+  def delete_subscriptions_subscription_id(publication_id, subscription_id)
+    _url = @_base_url + "/publications/#{publication_id}/subscriptions/#{subscription_id}"
+    _kwargs = {
+      params: {}
+    }
+    _http_client, _req_kwargs = self._client_with_auth(
+      [:"bearerAuth", ],
+      **_kwargs
+    )
+
+    
+    _response = _http_client.delete(
+      _url,
+      
+      **_req_kwargs
+    )
+    if !_response.status.success?
+      raise RequestError.new(
+        method="delete",
+        url=_url,
+        response=_response
+      )
+    end
+
+    return _response.body.empty? ? '' : _response.parse
+  end
+
+  # Retrieve all publications associated with your API key.
+  def get_publications(direction: nil, expand: nil, limit: nil, order_by: nil, page: nil)
+    _url = @_base_url + "/publications"
+    _kwargs = {
+      params: {}
+    }
+    if direction != nil
+      _kwargs[:params][:"direction"] = direction
+    end
+    if expand != nil
+      _kwargs[:params][:"expand[]"] = expand
+    end
+    if limit != nil
+      _kwargs[:params][:"limit"] = limit
+    end
+    if order_by != nil
+      _kwargs[:params][:"order_by"] = order_by
+    end
+    if page != nil
+      _kwargs[:params][:"page"] = page
+    end
+    _http_client, _req_kwargs = self._client_with_auth(
+      [:"bearerAuth", ],
+      **_kwargs
+    )
+
+    
+    _response = _http_client.get(
+      _url,
+      
+      **_req_kwargs
+    )
+    if !_response.status.success?
+      raise RequestError.new(
+        method="get",
+        url=_url,
+        response=_response
+      )
+    end
+
+    return _response.body.empty? ? '' : _response.parse
+  end
+
+  # Retrieve a single publication
+  def get_publications_publication_id(publication_id, expand: nil)
+    _url = @_base_url + "/publications/#{publication_id}"
+    _kwargs = {
+      params: {}
+    }
+    if expand != nil
+      _kwargs[:params][:"expand[]"] = expand
+    end
+    _http_client, _req_kwargs = self._client_with_auth(
+      [:"bearerAuth", ],
+      **_kwargs
+    )
+
+    
+    _response = _http_client.get(
+      _url,
+      
+      **_req_kwargs
+    )
+    if !_response.status.success?
+      raise RequestError.new(
+        method="get",
+        url=_url,
+        response=_response
+      )
+    end
+
+    return _response.body.empty? ? '' : _response.parse
+  end
+
+  # Returns a list of Subscription Update objects for a publication
+  def get_subscription_updates_for_publiciation(publication_id)
+    _url = @_base_url + "/publications/#{publication_id}/bulk_subscription_updates"
+    _kwargs = {
+      params: {}
+    }
+    _http_client, _req_kwargs = self._client_with_auth(
+      [:"bearerAuth", ],
+      **_kwargs
+    )
+
+    
+    _response = _http_client.get(
+      _url,
+      
+      **_req_kwargs
+    )
+    if !_response.status.success?
+      raise RequestError.new(
+        method="get",
+        url=_url,
+        response=_response
+      )
+    end
+
+    return _response.body.empty? ? '' : _response.parse
+  end
+
+  # Returns a single Subscription Update object for a publication
+  def get_publications_publication_id_subcription_updates_id(publication_id, id)
+    _url = @_base_url + "/publications/#{publication_id}/bulk_subscription_updates/#{id}"
+    _kwargs = {
+      params: {}
+    }
+    _http_client, _req_kwargs = self._client_with_auth(
+      [:"bearerAuth", ],
+      **_kwargs
+    )
+
+    
+    _response = _http_client.get(
+      _url,
+      
+      **_req_kwargs
+    )
+    if !_response.status.success?
+      raise RequestError.new(
+        method="get",
+        url=_url,
+        response=_response
+      )
+    end
+
+    return _response.body.empty? ? '' : _response.parse
+  end
+
+  # Retrieve all custom fields belonging to a specific publication
+  def get_publications_publication_id_custom_fields(publication_id)
+    _url = @_base_url + "/publications/#{publication_id}/custom_fields"
+    _kwargs = {
+      params: {}
+    }
+    _http_client, _req_kwargs = self._client_with_auth(
+      [:"bearerAuth", ],
+      **_kwargs
+    )
+
+    
+    _response = _http_client.get(
+      _url,
+      
+      **_req_kwargs
+    )
+    if !_response.status.success?
+      raise RequestError.new(
+        method="get",
+        url=_url,
+        response=_response
+      )
+    end
+
+    return _response.body.empty? ? '' : _response.parse
+  end
+
+  # View a specific custom field on a publication
+  def get_publications_publication_id_custom_fields_id(publication_id, id)
+    _url = @_base_url + "/publications/#{publication_id}/custom_fields/#{id}"
+    _kwargs = {
+      params: {}
+    }
+    _http_client, _req_kwargs = self._client_with_auth(
+      [:"bearerAuth", ],
+      **_kwargs
+    )
+
+    
+    _response = _http_client.get(
+      _url,
+      
+      **_req_kwargs
+    )
+    if !_response.status.success?
+      raise RequestError.new(
+        method="get",
+        url=_url,
+        response=_response
+      )
+    end
+
+    return _response.body.empty? ? '' : _response.parse
+  end
+
+  # Retrieve all Email Blasts
+  def get_publications_publication_id_email_blasts(publication_id, direction: nil, expand: nil, limit: nil, order_by: nil, page: nil)
+    _url = @_base_url + "/publications/#{publication_id}/email_blasts"
+    _kwargs = {
+      params: {}
+    }
+    if direction != nil
+      _kwargs[:params][:"direction"] = direction
+    end
+    if expand != nil
+      _kwargs[:params][:"expand[]"] = expand
+    end
+    if limit != nil
+      _kwargs[:params][:"limit"] = limit
+    end
+    if order_by != nil
+      _kwargs[:params][:"order_by"] = order_by
+    end
+    if page != nil
+      _kwargs[:params][:"page"] = page
+    end
+    _http_client, _req_kwargs = self._client_with_auth(
+      [:"bearerAuth", ],
+      **_kwargs
+    )
+
+    
+    _response = _http_client.get(
+      _url,
+      
+      **_req_kwargs
+    )
+    if !_response.status.success?
+      raise RequestError.new(
+        method="get",
+        url=_url,
+        response=_response
+      )
+    end
+
+    return _response.body.empty? ? '' : _response.parse
+  end
+
+  # Retrieve an Email Blast
+  def get_publications_publication_id_email_blasts_email_blast_id(publication_id, email_blast_id, expand: nil)
+    _url = @_base_url + "/publications/#{publication_id}/email_blasts/#{email_blast_id}"
+    _kwargs = {
+      params: {}
+    }
+    if expand != nil
+      _kwargs[:params][:"expand[]"] = expand
+    end
+    _http_client, _req_kwargs = self._client_with_auth(
+      [:"bearerAuth", ],
+      **_kwargs
+    )
+
+    
+    _response = _http_client.get(
+      _url,
+      
+      **_req_kwargs
+    )
+    if !_response.status.success?
+      raise RequestError.new(
+        method="get",
+        url=_url,
+        response=_response
+      )
+    end
+
+    return _response.body.empty? ? '' : _response.parse
+  end
+
+  # Retrieve all posts belonging to a specific publication
+  def get_posts(publication_id, audience: nil, content_tags: nil, direction: nil, expand: nil, limit: nil, order_by: nil, page: nil, platform: nil, status: nil)
+    _url = @_base_url + "/publications/#{publication_id}/posts"
+    _kwargs = {
+      params: {}
+    }
+    if audience != nil
+      _kwargs[:params][:"audience"] = audience
+    end
+    if content_tags != nil
+      _kwargs[:params][:"content_tags[]"] = content_tags
+    end
+    if direction != nil
+      _kwargs[:params][:"direction"] = direction
+    end
+    if expand != nil
+      _kwargs[:params][:"expand[]"] = expand
+    end
+    if limit != nil
+      _kwargs[:params][:"limit"] = limit
+    end
+    if order_by != nil
+      _kwargs[:params][:"order_by"] = order_by
+    end
+    if page != nil
+      _kwargs[:params][:"page"] = page
+    end
+    if platform != nil
+      _kwargs[:params][:"platform"] = platform
+    end
+    if status != nil
+      _kwargs[:params][:"status"] = status
+    end
+    _http_client, _req_kwargs = self._client_with_auth(
+      [:"bearerAuth", ],
+      **_kwargs
+    )
+
+    
+    _response = _http_client.get(
+      _url,
+      
+      **_req_kwargs
+    )
+    if !_response.status.success?
+      raise RequestError.new(
+        method="get",
+        url=_url,
+        response=_response
+      )
+    end
+
+    return _response.body.empty? ? '' : _response.parse
+  end
+
+  # Retreive a single Post belonging to a specific publication
+  def get_posts_post_id(publication_id, post_id, expand: nil)
+    _url = @_base_url + "/publications/#{publication_id}/posts/#{post_id}"
+    _kwargs = {
+      params: {}
+    }
+    if expand != nil
+      _kwargs[:params][:"expand[]"] = expand
+    end
+    _http_client, _req_kwargs = self._client_with_auth(
+      [:"bearerAuth", ],
+      **_kwargs
+    )
+
+    
+    _response = _http_client.get(
+      _url,
+      
+      **_req_kwargs
+    )
+    if !_response.status.success?
+      raise RequestError.new(
+        method="get",
+        url=_url,
+        response=_response
+      )
+    end
+
+    return _response.body.empty? ? '' : _response.parse
+  end
+
+  # Retrieve details about the publication's referral program, including milestones and rewards.
+  def get_publications_public_referral_program(publication_id, limit: nil, page: nil)
+    _url = @_base_url + "/publications/#{publication_id}/referral_program"
+    _kwargs = {
+      params: {}
+    }
+    if limit != nil
+      _kwargs[:params][:"limit"] = limit
+    end
+    if page != nil
+      _kwargs[:params][:"page"] = page
+    end
+    _http_client, _req_kwargs = self._client_with_auth(
+      [:"bearerAuth", ],
+      **_kwargs
+    )
+
+    
+    _response = _http_client.get(
+      _url,
+      
+      **_req_kwargs
+    )
+    if !_response.status.success?
+      raise RequestError.new(
+        method="get",
+        url=_url,
+        response=_response
+      )
+    end
+
+    return _response.body.empty? ? '' : _response.parse
+  end
+
+  # Retrieve information about all segments belonging to a specific publication
+  def get_publications_publication_id_segments(publication_id, direction: nil, limit: nil, order_by: nil, page: nil, status: nil, type: nil)
+    _url = @_base_url + "/publications/#{publication_id}/segments"
+    _kwargs = {
+      params: {}
+    }
+    if direction != nil
+      _kwargs[:params][:"direction"] = direction
+    end
+    if limit != nil
+      _kwargs[:params][:"limit"] = limit
+    end
+    if order_by != nil
+      _kwargs[:params][:"order_by"] = order_by
+    end
+    if page != nil
+      _kwargs[:params][:"page"] = page
+    end
+    if status != nil
+      _kwargs[:params][:"status"] = status
+    end
+    if type != nil
+      _kwargs[:params][:"type"] = type
+    end
+    _http_client, _req_kwargs = self._client_with_auth(
+      [:"bearerAuth", ],
+      **_kwargs
+    )
+
+    
+    _response = _http_client.get(
+      _url,
+      
+      **_req_kwargs
+    )
+    if !_response.status.success?
+      raise RequestError.new(
+        method="get",
+        url=_url,
+        response=_response
+      )
+    end
+
+    return _response.body.empty? ? '' : _response.parse
+  end
+
+  # Retrieve a single segment belonging to a specific publication
+  def get_publications_publication_id_segments_segment_id(publication_id, segment_id)
+    _url = @_base_url + "/publications/#{publication_id}/segments/#{segment_id}"
+    _kwargs = {
+      params: {}
+    }
+    _http_client, _req_kwargs = self._client_with_auth(
+      [:"bearerAuth", ],
+      **_kwargs
+    )
+
+    
+    _response = _http_client.get(
+      _url,
+      
+      **_req_kwargs
+    )
+    if !_response.status.success?
+      raise RequestError.new(
+        method="get",
+        url=_url,
+        response=_response
+      )
+    end
+
+    return _response.body.empty? ? '' : _response.parse
+  end
+
+  # List the Subscriber Ids from the most recent calculation of a specific publication.
+  def get_publications_publication_id_segments_segment_id_results(publication_id, segment_id, limit: nil, page: nil)
+    _url = @_base_url + "/publications/#{publication_id}/segments/#{segment_id}/results"
+    _kwargs = {
+      params: {}
+    }
+    if limit != nil
+      _kwargs[:params][:"limit"] = limit
+    end
+    if page != nil
+      _kwargs[:params][:"page"] = page
+    end
+    _http_client, _req_kwargs = self._client_with_auth(
+      [:"bearerAuth", ],
+      **_kwargs
+    )
+
+    
+    _response = _http_client.get(
+      _url,
+      
+      **_req_kwargs
+    )
+    if !_response.status.success?
+      raise RequestError.new(
+        method="get",
+        url=_url,
+        response=_response
+      )
+    end
+
+    return _response.body.empty? ? '' : _response.parse
+  end
+
+  # Retrieve all subscriptions belonging to a specific publication
+  def get_subscriptions(publication_id, direction: nil, email: nil, expand: nil, limit: nil, order_by: nil, page: nil, status: nil, tier: nil)
+    _url = @_base_url + "/publications/#{publication_id}/subscriptions"
+    _kwargs = {
+      params: {}
+    }
+    if direction != nil
+      _kwargs[:params][:"direction"] = direction
+    end
+    if email != nil
+      _kwargs[:params][:"email"] = email
+    end
+    if expand != nil
+      _kwargs[:params][:"expand[]"] = expand
+    end
+    if limit != nil
+      _kwargs[:params][:"limit"] = limit
+    end
+    if order_by != nil
+      _kwargs[:params][:"order_by"] = order_by
+    end
+    if page != nil
+      _kwargs[:params][:"page"] = page
+    end
+    if status != nil
+      _kwargs[:params][:"status"] = status
+    end
+    if tier != nil
+      _kwargs[:params][:"tier"] = tier
+    end
+    _http_client, _req_kwargs = self._client_with_auth(
+      [:"bearerAuth", ],
+      **_kwargs
+    )
+
+    
+    _response = _http_client.get(
+      _url,
+      
+      **_req_kwargs
+    )
+    if !_response.status.success?
+      raise RequestError.new(
+        method="get",
+        url=_url,
+        response=_response
+      )
+    end
+
+    return _response.body.empty? ? '' : _response.parse
+  end
+
+  # Retrieve a single subscription belonging to a specific email address in a specific publication
+  def get_subscriptions_email(publication_id, email, expand: nil)
+    _url = @_base_url + "/publications/#{publication_id}/subscriptions/by_email/#{email}"
+    _kwargs = {
+      params: {}
+    }
+    if expand != nil
+      _kwargs[:params][:"expand[]"] = expand
+    end
+    _http_client, _req_kwargs = self._client_with_auth(
+      [:"bearerAuth", ],
+      **_kwargs
+    )
+
+    
+    _response = _http_client.get(
+      _url,
+      
+      **_req_kwargs
+    )
+    if !_response.status.success?
+      raise RequestError.new(
+        method="get",
+        url=_url,
+        response=_response
+      )
+    end
+
+    return _response.body.empty? ? '' : _response.parse
+  end
+
+  # Retrieve a single subscription belonging to a specific subscriber in a specific publication
+  def get_subscriptions_subscriber_id(publication_id, subscriber_id, expand: nil)
+    _url = @_base_url + "/publications/#{publication_id}/subscriptions/by_subscriber_id/#{subscriber_id}"
+    _kwargs = {
+      params: {}
+    }
+    if expand != nil
+      _kwargs[:params][:"expand[]"] = expand
+    end
+    _http_client, _req_kwargs = self._client_with_auth(
+      [:"bearerAuth", ],
+      **_kwargs
+    )
+
+    
+    _response = _http_client.get(
+      _url,
+      
+      **_req_kwargs
+    )
+    if !_response.status.success?
+      raise RequestError.new(
+        method="get",
+        url=_url,
+        response=_response
+      )
+    end
+
+    return _response.body.empty? ? '' : _response.parse
+  end
+
+  # Retrieve a single subscription belonging to a specific publication
+  def get_subscriptions_subscription_id(publication_id, subscription_id, expand: nil)
+    _url = @_base_url + "/publications/#{publication_id}/subscriptions/#{subscription_id}"
+    _kwargs = {
+      params: {}
+    }
+    if expand != nil
+      _kwargs[:params][:"expand[]"] = expand
+    end
+    _http_client, _req_kwargs = self._client_with_auth(
+      [:"bearerAuth", ],
+      **_kwargs
+    )
+
+    
+    _response = _http_client.get(
+      _url,
+      
+      **_req_kwargs
+    )
+    if !_response.status.success?
+      raise RequestError.new(
+        method="get",
+        url=_url,
+        response=_response
+      )
+    end
+
+    return _response.body.empty? ? '' : _response.parse
+  end
+
+  # Update a custom field on a publication
+  def patch_publications_publication_id_custom_fields_id(data: nil, publication_id, id)
+    _url = @_base_url + "/publications/#{publication_id}/custom_fields/#{id}"
+    _kwargs = {
+      params: {}
+    }
+    _http_client, _req_kwargs = self._client_with_auth(
+      [:"bearerAuth", ],
+      **_kwargs
+    )
+
+    
+    _response = _http_client.patch(
+      _url,
+      json: data,
+      **_req_kwargs
+    )
+    if !_response.status.success?
+      raise RequestError.new(
+        method="patch",
+        url=_url,
+        response=_response
+      )
+    end
+
+    return _response.body.empty? ? '' : _response.parse
+  end
+
+  # Bulk update subscriptions' Status value
+  def patch_subscriptions_bulk_update_status(data: nil, publication_id)
+    _url = @_base_url + "/publications/#{publication_id}/subscriptions"
+    _kwargs = {
+      params: {}
+    }
+    _http_client, _req_kwargs = self._client_with_auth(
+      [:"bearerAuth", ],
+      **_kwargs
+    )
+
+    
+    _response = _http_client.patch(
+      _url,
+      json: data,
+      **_req_kwargs
+    )
+    if !_response.status.success?
+      raise RequestError.new(
+        method="patch",
+        url=_url,
+        response=_response
+      )
+    end
+
+    return _response.body.empty? ? '' : _response.parse
+  end
+
+  # Bulk update subscriptions' field values (standard fields and custom fields)
+  def patch_subscriptions_bulk_actions_bulk_update(data: nil, publication_id)
+    _url = @_base_url + "/publications/#{publication_id}/subscriptions/bulk_actions"
+    _kwargs = {
+      params: {}
+    }
+    _http_client, _req_kwargs = self._client_with_auth(
+      [:"bearerAuth", ],
+      **_kwargs
+    )
+
+    
+    _response = _http_client.patch(
+      _url,
+      json: data,
+      **_req_kwargs
+    )
+    if !_response.status.success?
+      raise RequestError.new(
+        method="patch",
+        url=_url,
+        response=_response
+      )
+    end
+
+    return _response.body.empty? ? '' : _response.parse
+  end
+
+  # Update a subscriber
+  def method_1patch_subscriptions_subscription_id(data, publication_id, subscription_id)
+    _url = @_base_url + "/publications/#{publication_id}/subscriptions/#{subscription_id}"
+    _kwargs = {
+      params: {}
+    }
+    _http_client, _req_kwargs = self._client_with_auth(
+      [:"bearerAuth", ],
+      **_kwargs
+    )
+
+    
+    _response = _http_client.patch(
+      _url,
+      json: data,
+      **_req_kwargs
+    )
+    if !_response.status.success?
+      raise RequestError.new(
+        method="patch",
+        url=_url,
+        response=_response
+      )
+    end
+
+    return _response.body.empty? ? '' : _response.parse
+  end
+
+  # Create a custom field on a publication, for use in subscriptions
+  def post_publications_publication_id_custom_fields(data: nil, publication_id)
+    _url = @_base_url + "/publications/#{publication_id}/custom_fields"
+    _kwargs = {
+      params: {}
+    }
+    _http_client, _req_kwargs = self._client_with_auth(
+      [:"bearerAuth", ],
+      **_kwargs
+    )
+
+    
+    _response = _http_client.post(
+      _url,
+      json: data,
+      **_req_kwargs
+    )
+    if !_response.status.success?
+      raise RequestError.new(
+        method="post",
+        url=_url,
+        response=_response
+      )
+    end
+
+    return _response.body.empty? ? '' : _response.parse
+  end
+
+  # Create new subscriptions for a publication.
+  def post_subscriptions(data, publication_id, sales: nil)
+    _url = @_base_url + "/publications/#{publication_id}/subscriptions"
+    _kwargs = {
+      params: {}
+    }
+    if sales != nil
+      _kwargs[:params][:"sales"] = sales
+    end
+    _http_client, _req_kwargs = self._client_with_auth(
+      [:"bearerAuth", ],
+      **_kwargs
+    )
+
+    
+    _response = _http_client.post(
+      _url,
+      json: data,
+      **_req_kwargs
+    )
+    if !_response.status.success?
+      raise RequestError.new(
+        method="post",
+        url=_url,
+        response=_response
+      )
+    end
+
+    return _response.body.empty? ? '' : _response.parse
+  end
+
+  # Update a custom field on a publication
+  def put_publications_publication_id_custom_fields_id(data: nil, publication_id, id)
+    _url = @_base_url + "/publications/#{publication_id}/custom_fields/#{id}"
+    _kwargs = {
+      params: {}
+    }
+    _http_client, _req_kwargs = self._client_with_auth(
+      [:"bearerAuth", ],
+      **_kwargs
+    )
+
+    
+    _response = _http_client.put(
+      _url,
+      json: data,
+      **_req_kwargs
+    )
+    if !_response.status.success?
+      raise RequestError.new(
+        method="put",
+        url=_url,
+        response=_response
+      )
+    end
+
+    return _response.body.empty? ? '' : _response.parse
+  end
+
+  # Bulk update subscriptions' Status value
+  def put_subscriptions_bulk_update_status(data: nil, publication_id)
+    _url = @_base_url + "/publications/#{publication_id}/subscriptions"
+    _kwargs = {
+      params: {}
+    }
+    _http_client, _req_kwargs = self._client_with_auth(
+      [:"bearerAuth", ],
+      **_kwargs
+    )
+
+    
+    _response = _http_client.put(
+      _url,
+      json: data,
+      **_req_kwargs
+    )
+    if !_response.status.success?
+      raise RequestError.new(
+        method="put",
+        url=_url,
+        response=_response
+      )
+    end
+
+    return _response.body.empty? ? '' : _response.parse
+  end
+
+  # Bulk update subscriptions' field values (standard fields and custom fields)
+  def put_subscriptions_bulk_actions_bulk_update(data: nil, publication_id)
+    _url = @_base_url + "/publications/#{publication_id}/subscriptions/bulk_actions"
+    _kwargs = {
+      params: {}
+    }
+    _http_client, _req_kwargs = self._client_with_auth(
+      [:"bearerAuth", ],
+      **_kwargs
+    )
+
+    
+    _response = _http_client.put(
+      _url,
+      json: data,
+      **_req_kwargs
+    )
+    if !_response.status.success?
+      raise RequestError.new(
+        method="put",
+        url=_url,
+        response=_response
+      )
+    end
+
+    return _response.body.empty? ? '' : _response.parse
+  end
+
+  # Update a subscriber
+  def put_subscriptions_subscription_id(data, publication_id, subscription_id)
+    _url = @_base_url + "/publications/#{publication_id}/subscriptions/#{subscription_id}"
+    _kwargs = {
+      params: {}
+    }
+    _http_client, _req_kwargs = self._client_with_auth(
+      [:"bearerAuth", ],
+      **_kwargs
+    )
+
+    
+    _response = _http_client.put(
+      _url,
+      json: data,
+      **_req_kwargs
+    )
+    if !_response.status.success?
+      raise RequestError.new(
+        method="put",
+        url=_url,
+        response=_response
+      )
+    end
+
+    return _response.body.empty? ? '' : _response.parse
+  end
+
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: beehiiv_api
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Sideko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-01-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.1
+description: |-
+  Swarm public API
+
+  **THE NEWSLETTER PLATFORM BUILT FOR GROWTH.**
+
+  *Built by newsletter people*
+email: team@sideko.dev
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/beehiiv_api.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.5
+signing_key: 
+specification_version: 4
+summary: beehiiv_api 1.0.0
+test_files: []