uscreen_api 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dabe74b714b2834a0a01cceebcd32d5a096b447cba13f83064c614ed0037c947
-  data.tar.gz: fdc515202c4df5e64241d9cca0e77d858ed1e0546aba454e02e2ddc58c4b931e
+  metadata.gz: c2726704dcbd621602f5472647621df43e074ff09ccb8d9d45498a49ba4903a3
+  data.tar.gz: 8d94928a74bba4381665c2ebd9bc73d8dcb04204a8e6c72c1e6ba73546300a34
 SHA512:
-  metadata.gz: c01ab1ee8906107d20357b4b38bdb0e4ec4fc9a215e0d03456b337d10acacaa0be70f87f0f10f7c6491819b3cd0eb73a2f8a02ac8a46e048cf2e63eb69f17bcf
-  data.tar.gz: 1457f0bf34035cd21afb5cd8cca69582dba41b9af84ad33024b2e2c85c69106cffab8999a61685d779d0349bc666dc7e12584ab443796246a6216cbe608b198c
+  metadata.gz: cbca6b40d77f39a6f104b458e057da40995b81953a5bc419ac7ec0feaa4fea1468313cfb656a64fa434fd0b373cda970faf451838bcc2ac5391734740b6c033c
+  data.tar.gz: d52532e0437f781e3e22c907f3b876fdba1f14c8660af61f7ebdf6532f6d4e3821b1deeaf5fbf59f0e57ec03a139f04f8c5aed73dff560a648e0388ce095b7a2

data/README.md

@@ -15,7 +15,35 @@ gem install uscreen_api
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+require "uscreen_api"
+
+client = UscreenAPI::Client.new(api_key: ENV["USCREEN_API_KEY"])
+
+client.customers.list(page: 1)
+client.customers.create(email: "joe@example.com", name: "Joe Shmoe", skip_invite: true)
+client.customers.get(id: "joe@example.com")
+client.customers.grant_access(id: 123, product_id: 456, product_type: "recurring")
+client.customers.create_subscription(id: 123, product_id: 789)
+client.contents.list(content_type: "video", include: "author")
+client.analytics.video_views(user_id: 123)
+```
+
+Supported resources, matching the [Publisher API](https://www.uscreen.io/api/publisher.html):
+
+| Resource | Methods |
+| --- | --- |
+| `customers` | `list`, `create`, `get`, `update`, `tokenized_url`, `accesses`, `access`, `grant_access`, `revoke_access`, `subscription`, `create_subscription`, `cancel_subscription` |
+| `groups` | `list`, `create`, `delete`, `members`, `add_member`, `remove_member` |
+| `contents` | `list`, `get`, `playlist_items`, `playlist_item`, `publish`, `unpublish`, `schedule` |
+| `programs` (legacy alias of contents) | `list`, `get`, `chapters`, `chapter` |
+| `videos` | `list`, `get` |
+| `offers` | `list`, `get` |
+| `invoices` | `list`, `get` |
+| `email_topics` | `list` |
+| `analytics` | `video_views`, `total_watch_time`, `video_views_summary` |
+
+Errors raise subclasses of `UscreenAPI::Errors::Error`: `Unauthorized` (401), `NotFound` (404), `UnprocessableEntity` (422). Customer endpoints raise `UserNotFound` / `UserNotCreated`, which subclass `NotFound` / `UnprocessableEntity`.
 
 ## Development
 

data/lib/uscreen_api/analytics.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module UscreenAPI
+  class Analytics < Base
+    PATH = "analytics/videos/views"
+
+    # Get details on video views for a user, video, collection or live event. Default range: last 12 months.
+    # @param page [Integer] Page number
+    # @param per_page [Integer] Number of results per page (default 10, max 100)
+    # @param user_id [String] User ID or Email
+    # @param content_id [String] Video, Collection or Live Event ID
+    # @param from [String] Starting date and time, formatted in RFC 3339. Must be within last 12 months. Example: 2023-01-01T00:00:00Z
+    # @param to [String] Ending date and time, formatted in RFC 3339. Example: 2023-01-01T00:00:00Z
+    def video_views(page: nil, per_page: nil, user_id: nil, content_id: nil, from: nil, to: nil)
+      request(:get, PATH, params: {
+        page: page,
+        per_page: per_page,
+        user_id: user_id,
+        content_id: content_id,
+        from: from,
+        to: to
+      })
+    end
+
+    # Get the total video watch time for a user, video, collection or live event. Default range: last 12 months.
+    # @param user_id [String] User ID or Email
+    # @param content_id [String] Video, Collection or Live Event ID
+    # @param from [String] Starting date and time, formatted in RFC 3339. Must be within last 12 months. Example: 2023-01-01T00:00:00Z
+    # @param to [String] Ending date and time, formatted in RFC 3339. Example: 2023-01-01T00:00:00Z
+    def total_watch_time(user_id: nil, content_id: nil, from: nil, to: nil)
+      request(:get, "#{PATH}/total_watch_time", params: {user_id: user_id, content_id: content_id, from: from, to: to})
+    end
+
+    # Get video view counts and total watch time grouped by user and video. Default range: last 12 months.
+    # @param page [Integer] Page number
+    # @param per_page [Integer] Number of results per page (default 50, max 100)
+    # @param from [String] Starting date and time, formatted in RFC 3339. Must be within last 12 months. Example: 2023-01-01T00:00:00Z
+    # @param to [String] Ending date and time, formatted in RFC 3339. Example: 2023-01-01T00:00:00Z
+    def video_views_summary(page: nil, per_page: nil, from: nil, to: nil)
+      request(:get, "#{PATH}/summary", params: {page: page, per_page: per_page, from: from, to: to})
+    end
+  end
+end

data/lib/uscreen_api/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module UscreenAPI
   class Base
     attr_reader :client
@@ -8,11 +10,37 @@ module UscreenAPI
 
     private
 
+    # Perform a request and return the parsed response body.
+    # Keys with nil values are dropped from params and body so optional arguments are only sent when given.
+    def request(method, path, params: {}, body: nil)
+      response = client.connection.public_send(method, path) do |req|
+        req.params.update(compact(params))
+        req.body = compact(body) if body
+      end
+
+      handle_errors(response.status, response.body)
+
+      response.body
+    end
+
+    def compact(hash)
+      hash.reject { |_, value| value.nil? }
+    end
+
+    def not_found_error
+      UscreenAPI::Errors::NotFound
+    end
+
+    def unprocessable_entity_error
+      UscreenAPI::Errors::UnprocessableEntity
+    end
+
     def handle_errors(status, body)
       case status
       when 401 then raise UscreenAPI::Errors::Unauthorized.new(body)
-      when 404 then raise UscreenAPI::Errors::UserNotFound.new(body)
-      when 422 then raise UscreenAPI::Errors::UserNotCreated.new(body)
+      when 404 then raise not_found_error.new(body)
+      when 422 then raise unprocessable_entity_error.new(body)
+      when 400..599 then raise UscreenAPI::Errors::Error.new(body)
       end
     end
   end

data/lib/uscreen_api/client.rb

@@ -4,20 +4,55 @@ require "faraday"
 
 module UscreenAPI
   class Client
-    attr_reader :api_key
+    attr_reader :api_key, :adapter
 
     BASE_URL = "https://www.uscreen.io/publisher_api/v1/"
 
-    def initialize(api_key:)
+    # @param api_key [String] Publisher API key
+    # @param adapter [Symbol, Array] Faraday adapter, optionally followed by its arguments. Example: [:test, stubs]
+    def initialize(api_key:, adapter: Faraday.default_adapter)
       @api_key = api_key
+      @adapter = adapter
+    end
+
+    def analytics
+      @analytics ||= UscreenAPI::Analytics.new(client: self)
+    end
+
+    def contents
+      @contents ||= UscreenAPI::Contents.new(client: self)
     end
 
     def customers
       @customers ||= UscreenAPI::Customers.new(client: self)
     end
 
+    def email_topics
+      @email_topics ||= UscreenAPI::EmailTopics.new(client: self)
+    end
+
+    def groups
+      @groups ||= UscreenAPI::Groups.new(client: self)
+    end
+
+    def invoices
+      @invoices ||= UscreenAPI::Invoices.new(client: self)
+    end
+
+    def offers
+      @offers ||= UscreenAPI::Offers.new(client: self)
+    end
+
+    def programs
+      @programs ||= UscreenAPI::Programs.new(client: self)
+    end
+
+    def videos
+      @videos ||= UscreenAPI::Videos.new(client: self)
+    end
+
     def connection
-      @connection = Faraday.new(
+      @connection ||= Faraday.new(
         url: BASE_URL,
         headers: {
           "Content-Type": "application/json",
@@ -26,6 +61,7 @@ module UscreenAPI
       ) do |f|
         f.request(:json)
         f.response(:json)
+        f.adapter(*Array(adapter))
       end
     end
   end

data/lib/uscreen_api/contents.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module UscreenAPI
+  class Contents < Base
+    PATH = "contents"
+
+    # Get paginated list of contents (videos, collections and live events)
+    # @param page [Integer] Page number
+    # @param include [String] Comma-separated list of relationships to include. Available relationships: author.
+    # @param from [String] Starting date and time for the filter range, formatted in RFC 3339. Example: 2023-01-01T00:00:00Z
+    # @param to [String] Ending date and time for the filter range, formatted in RFC 3339. Example: 2023-01-01T00:00:00Z
+    # @param content_type [String] Filter by content type. Can be collection|live_event|video
+    def list(page: nil, include: nil, from: nil, to: nil, content_type: nil)
+      request(:get, PATH, params: {page: page, include: include, from: from, to: to, content_type: content_type})
+    end
+
+    # Get content information (video, collection or live event)
+    # @param id [String] Content ID
+    # @param include [String] Comma-separated list of relationships to include. Available relationships: author.
+    def get(id:, include: nil)
+      request(:get, "#{PATH}/#{id}", params: {include: include})
+    end
+
+    # Get list of playlist items (formerly known as chapters) and file resources
+    # @param id [String] Content ID
+    def playlist_items(id:)
+      request(:get, "#{PATH}/#{id}/playlist_items")
+    end
+
+    # Get a playlist item (formerly known as chapter)
+    # @param id [String] Content ID
+    # @param playlist_item_id [String] Playlist item ID
+    def playlist_item(id:, playlist_item_id:)
+      request(:get, "#{PATH}/#{id}/playlist_items/#{playlist_item_id}")
+    end
+
+    # Publish a video, collection or live event
+    # @param id [String] Content ID
+    # @param event_launch_datetime [String] Live events only. Launch date and time in the future, formatted in RFC 3339. Example: 2025-06-01T12:00:00Z
+    def publish(id:, event_launch_datetime: nil)
+      request(:post, "#{PATH}/#{id}/visibility/publish", params: {event_launch_datetime: event_launch_datetime})
+    end
+
+    # Unpublish a video, collection or live event
+    # @param id [String] Content ID
+    def unpublish(id:)
+      request(:post, "#{PATH}/#{id}/visibility/unpublish")
+    end
+
+    # Schedule a video or collection for future publication
+    # @param id [String] Content ID
+    # @param scheduled_datetime [String] Publication date and time in the future, formatted in RFC 3339. Example: 2025-06-01T12:00:00Z
+    # @param schedule_published [Boolean] Allow scheduling content that is currently published. It will be unpublished and scheduled.
+    def schedule(id:, scheduled_datetime:, schedule_published: nil)
+      request(:post, "#{PATH}/#{id}/visibility/schedule", params: {
+        scheduled_datetime: scheduled_datetime,
+        schedule_published: schedule_published
+      })
+    end
+  end
+end

data/lib/uscreen_api/customers.rb

@@ -15,28 +15,21 @@ module UscreenAPI
       to: nil,
       date_field: nil
     )
-      response = client.connection.get(PATH) do |req|
-        req.params = {}
-
-        req.params["page"] = page if page
-        req.params["from"] = from if from
-        req.params["to"] = to if to
-        req.params["date_field"] = date_field if date_field
-      end
-
-      handle_errors(response.status, response.body)
-
-      response.body
+      request(:get, PATH, params: {page: page, from: from, to: to, date_field: date_field})
     end
 
     # Invite a new customer
-    # @param email [String] Customer email
+    # @param email [String] Customer email. Should be unique
     # @param name [String] Customer name
-    # @param password [String] Customer password
-    # @param payment_user_id [String] Payment user ID
-    # @param skip_invite [Boolean] Skip invite email
-    # @param opted_in_for_news_and_updates [Boolean] Opted in for news and updates
-    # @param custom_fields [Hash] Custom fields
+    # @param password [String] Password (8 characters minimum). Generated automatically if blank.
+    # @param payment_user_id [String] Stripe User ID, for matching Stripe accounts
+    # @param skip_invite [Boolean] Skip the platform invite email
+    # @param opted_in_for_news_and_updates [Boolean] Opted in for news and update emails
+    # @param opted_in_for_community_updates [Boolean] Opted in for community update emails
+    # @param legacy_id [String] External identifier used to reference this customer in third-party systems
+    # @param tags [Array<String>] Tag names to assign to the customer (lowercase letters, numbers and dashes)
+    # @param unsubscribed_topic_ids [Array<Integer>] Email topic IDs to unsubscribe the customer from
+    # @param custom_fields [Hash] Custom fields. Example: { field_1: "value" }
     def create(
       email:,
       name:,
@@ -44,71 +37,73 @@ module UscreenAPI
       payment_user_id: nil,
       skip_invite: nil,
       opted_in_for_news_and_updates: nil,
+      opted_in_for_community_updates: nil,
+      legacy_id: nil,
+      tags: nil,
+      unsubscribed_topic_ids: nil,
       custom_fields: {}
     )
-      response = client.connection.post(PATH) do |req|
-        req.body = {
-          email: email,
-          name: name
-        }
-        req.body["password"] = password if password
-        req.body["payment_user_id"] = payment_user_id if payment_user_id
-        req.body["skip_invite"] = skip_invite if skip_invite
-        req.body["opted_in_for_news_and_updates"] = opted_in_for_news_and_updates if opted_in_for_news_and_updates
-
-        custom_fields.each { |key, value| req.body[key] = value } if custom_fields.any?
-      end
-
-      handle_errors(response.status, response.body)
-
-      response.body
+      request(:post, PATH, body: {
+        email: email,
+        name: name,
+        password: password,
+        payment_user_id: payment_user_id,
+        skip_invite: skip_invite,
+        opted_in_for_news_and_updates: opted_in_for_news_and_updates,
+        opted_in_for_community_updates: opted_in_for_community_updates,
+        legacy_id: legacy_id,
+        tags: tags,
+        unsubscribed_topic_ids: unsubscribed_topic_ids,
+        **custom_fields
+      })
     end
 
     # Get a customer information
     # @param id [Integer] Customer ID or Email
     def get(id:)
-      response = client.connection.get("#{PATH}/#{id}")
-
-      handle_errors(response.status, response.body)
-
-      response.body
+      request(:get, "#{PATH}/#{id}")
     end
 
     # Update a customer information
     # @param id [Integer] Customer ID or Email
     # @param email [String] New customer email
     # @param name [String] New customer name
-    # @param password [String] New customer password
-    # @param custom_fields [Hash] Custom fields
+    # @param password [String] New customer password (8 characters minimum)
+    # @param payment_user_id [String] Stripe Customer ID
+    # @param opted_in_for_news_and_updates [Boolean] Receive marketing emails
+    # @param opted_in_for_community_updates [Boolean] Receive community update emails
+    # @param tags [Array<String>] Tag names to assign to the customer. Replaces existing tags.
+    # @param unsubscribed_topic_ids [Array<Integer>] Email topic IDs to unsubscribe the customer from
+    # @param custom_fields [Hash] Custom fields. Example: { field_1: "value" }
     def update(
       id:,
       email: nil,
       name: nil,
       password: nil,
+      payment_user_id: nil,
+      opted_in_for_news_and_updates: nil,
+      opted_in_for_community_updates: nil,
+      tags: nil,
+      unsubscribed_topic_ids: nil,
       custom_fields: {}
     )
-      response = client.connection.put("#{PATH}/#{id}") do |req|
-        req.body = {}
-
-        req.body["email"] = email if email
-        req.body["name"] = name if name
-        req.body["password"] = password if password
-
-        custom_fields.each { |key, value| req.body[key] = value } if custom_fields.any?
-      end
-
-      handle_errors(response.status, response.body)
-
-      response.body
+      request(:put, "#{PATH}/#{id}", body: {
+        email: email,
+        name: name,
+        password: password,
+        payment_user_id: payment_user_id,
+        opted_in_for_news_and_updates: opted_in_for_news_and_updates,
+        opted_in_for_community_updates: opted_in_for_community_updates,
+        tags: tags,
+        unsubscribed_topic_ids: unsubscribed_topic_ids,
+        **custom_fields
+      })
     end
 
     # Generates a Single Sign-On link for a customer
     # @param id [Integer] Customer ID or Email
     def tokenized_url(id:)
-      response = client.connection.post("#{PATH}/#{id}/tokenized_url")
-      handle_errors(response.status, response.body)
-
-      response.body
+      request(:post, "#{PATH}/#{id}/tokenized_url")
     end
 
     # Get paginated list of accesses for a customer
@@ -122,37 +117,38 @@ module UscreenAPI
       from: nil,
       to: nil
     )
-      response = client.connection.get("#{PATH}/#{id}/accesses")
-      handle_errors(response.status, response.body)
+      request(:get, "#{PATH}/#{id}/accesses", params: {page: page, from: from, to: to})
+    end
 
-      response.body
+    # Get access by ID
+    # @param id [Integer] Customer ID or Email
+    # @param access_id [Integer] Access ID
+    def access(id:, access_id:)
+      request(:get, "#{PATH}/#{id}/accesses/#{access_id}")
     end
 
     # Grant access to a customer
     # @param id [Integer] Customer ID or Email
     # @param product_id [Integer] Product ID
     # @param product_type [String] Uscreen system product type. Can be a program|recurring|rent|freebie|fixed_price
-    # @param perform_action_at [String] Seconds since the Epoch. Next perform action needed in case of rent or recurring product types. System will add next due automatically in case of a blank field. example: 2024-07-05T13:47:52Z
+    # @param perform_action_at [String] Next perform action needed in case of rent or recurring product types. System will add next due automatically in case of a blank field. Omit when with_manual_billing is true. Example: 2024-07-05T13:47:52Z
     # @param with_manual_billing [Boolean] Allows you to process billing outside the Uscreen platform. Default false.
+    # @param skip_automations [Boolean] Skip automation enrollment (e.g. bundle_assigned). Default false.
     def grant_access(
       id:,
       product_id:,
-      product_type:,
+      product_type: nil,
       perform_action_at: nil,
-      with_manual_billing: false
+      with_manual_billing: false,
+      skip_automations: nil
     )
-      response = client.connection.post("#{PATH}/#{id}/accesses") do |req|
-        req.body = {
-          product_id: product_id,
-          product_type: product_type,
-          with_manual_billing: with_manual_billing
-        }
-        req.body["perform_action_at"] = perform_action_at if perform_action_at
-      end
-
-      handle_errors(response.status, response.body)
-
-      response.body
+      request(:post, "#{PATH}/#{id}/accesses", body: {
+        product_id: product_id,
+        product_type: product_type,
+        perform_action_at: perform_action_at,
+        with_manual_billing: with_manual_billing,
+        skip_automations: skip_automations
+      })
     end
 
     # Revoke access by ID
@@ -162,10 +158,56 @@ module UscreenAPI
       id:,
       access_id:
     )
-      response = client.connection.delete("#{PATH}/#{id}/accesses/#{access_id}")
-      handle_errors(response.status, response.body)
+      request(:delete, "#{PATH}/#{id}/accesses/#{access_id}")
+    end
+
+    # Get a customer's active subscription. Returns nil if the customer has no active subscription.
+    # @param id [Integer] Customer ID or Email
+    def subscription(id:)
+      request(:get, "#{PATH}/#{id}/subscription")
+    end
+
+    # Create a subscription for a customer
+    # @param id [Integer] Customer ID or Email
+    # @param product_id [Integer] Subscription plan ID
+    # @param with_manual_billing [Boolean] Process billing outside the Uscreen platform. Default false.
+    # @param perform_action_at [Integer] Unix timestamp for the next billing/renewal date. Omit when with_manual_billing is true.
+    # @param currency [String] Three-letter currency code (ISO 4217). Must be one of the store's configured currencies.
+    # @param cover_fees [Boolean] Add transaction fees to the subscription price, covered by the customer
+    # @param skip_automations [Boolean] Skip automation enrollment (e.g. subscription_assigned). Default false.
+    def create_subscription(
+      id:,
+      product_id:,
+      with_manual_billing: nil,
+      perform_action_at: nil,
+      currency: nil,
+      cover_fees: nil,
+      skip_automations: nil
+    )
+      request(:post, "#{PATH}/#{id}/subscription", body: {
+        product_id: product_id,
+        with_manual_billing: with_manual_billing,
+        perform_action_at: perform_action_at,
+        currency: currency,
+        cover_fees: cover_fees,
+        skip_automations: skip_automations
+      })
+    end
+
+    # Cancel a customer's active subscription
+    # @param id [Integer] Customer ID or Email
+    def cancel_subscription(id:)
+      request(:delete, "#{PATH}/#{id}/subscription")
+    end
+
+    private
+
+    def not_found_error
+      UscreenAPI::Errors::UserNotFound
+    end
 
-      response.body
+    def unprocessable_entity_error
+      UscreenAPI::Errors::UserNotCreated
     end
   end
 end

data/lib/uscreen_api/email_topics.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module UscreenAPI
+  class EmailTopics < Base
+    PATH = "email_topics"
+
+    # Get the list of email topics
+    # @param page [Integer] Page number
+    def list(page: nil)
+      request(:get, PATH, params: {page: page})
+    end
+  end
+end

data/lib/uscreen_api/errors.rb

@@ -1,9 +1,16 @@
 # frozen_string_literal: true
 
 module UscreenAPI::Errors
-  class UserNotFound < StandardError; end
+  class Error < StandardError; end
 
-  class UserNotCreated < StandardError; end
+  class Unauthorized < Error; end
 
-  class Unauthorized < StandardError; end
+  class NotFound < Error; end
+
+  class UnprocessableEntity < Error; end
+
+  # Raised by customer endpoints. Kept for backwards compatibility.
+  class UserNotFound < NotFound; end
+
+  class UserNotCreated < UnprocessableEntity; end
 end

data/lib/uscreen_api/groups.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module UscreenAPI
+  class Groups < Base
+    PATH = "groups"
+
+    # Get paginated list of groups
+    # @param page [Integer] Page number
+    # @param from [String] Starting date and time for the filter range, formatted in RFC 3339. Example: 2023-01-01T00:00:00Z
+    # @param to [String] Ending date and time for the filter range, formatted in RFC 3339. Example: 2023-01-01T00:00:00Z
+    # @param date_field [String] Date field to filter by. Available fields: created_at, updated_at. Default: created_at.
+    def list(page: nil, from: nil, to: nil, date_field: nil)
+      request(:get, PATH, params: {page: page, from: from, to: to, date_field: date_field})
+    end
+
+    # Create a new group
+    # @param name [String] Group name
+    # @param billing_email [String] Billing email for the group
+    # @param plan_id [Integer] Subscription Plan ID associated with the group
+    # @param number_of_seats [Integer] Number of seats in the group. No seat limit if not provided.
+    def create(name:, billing_email:, plan_id:, number_of_seats: nil)
+      request(:post, PATH, body: {
+        name: name,
+        billing_email: billing_email,
+        plan_id: plan_id,
+        number_of_seats: number_of_seats
+      })
+    end
+
+    # Delete a group
+    # @param id [Integer] Group ID
+    def delete(id:)
+      request(:delete, "#{PATH}/#{id}")
+    end
+
+    # Get paginated list of group members
+    # @param id [Integer] Group ID
+    # @param page [Integer] Page number
+    # @param from [String] Starting date and time for the filter range, formatted in RFC 3339. Example: 2023-01-01T00:00:00Z
+    # @param to [String] Ending date and time for the filter range, formatted in RFC 3339. Example: 2023-01-01T00:00:00Z
+    # @param date_field [String] Date field to filter by. Available fields: created_at, updated_at. Default: created_at.
+    def members(id:, page: nil, from: nil, to: nil, date_field: nil)
+      request(:get, "#{PATH}/#{id}/members", params: {page: page, from: from, to: to, date_field: date_field})
+    end
+
+    # Add a member to a group
+    # @param id [Integer] Group ID
+    # @param email [String] Member's email address
+    # @param name [String] Member's full name
+    # @param role [String] Member's role in the group. Can be member|manager
+    # @param skip_automations [Boolean] Skip automation enrollment (e.g. lead_created). Default false.
+    def add_member(id:, email:, name:, role: "member", skip_automations: nil)
+      request(:post, "#{PATH}/#{id}/members", body: {
+        email: email,
+        name: name,
+        role: role,
+        skip_automations: skip_automations
+      })
+    end
+
+    # Remove a member from a group
+    # @param id [Integer] Group ID
+    # @param user_id [Integer] User ID
+    def remove_member(id:, user_id:)
+      request(:delete, "#{PATH}/#{id}/members/#{user_id}")
+    end
+  end
+end

data/lib/uscreen_api/invoices.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module UscreenAPI
+  class Invoices < Base
+    PATH = "invoices"
+
+    # Get paginated list of invoices
+    # @param page [Integer] Page number
+    # @param from [String] Starting date and time for the filter range, formatted in RFC 3339. Example: 2023-01-01T00:00:00Z
+    # @param to [String] Ending date and time for the filter range, formatted in RFC 3339. Example: 2023-01-01T00:00:00Z
+    # @param date_field [String] Date field to filter by. Available fields: created_at, updated_at. Default: created_at.
+    def list(page: nil, from: nil, to: nil, date_field: nil)
+      request(:get, PATH, params: {page: page, from: from, to: to, date_field: date_field})
+    end
+
+    # Get invoice by ID
+    # @param id [String] Invoice ID
+    def get(id:)
+      request(:get, "#{PATH}/#{id}")
+    end
+  end
+end

data/lib/uscreen_api/offers.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module UscreenAPI
+  class Offers < Base
+    PATH = "offers"
+
+    # Get paginated list of offers
+    # @param page [Integer] Page number
+    # @param from [String] Starting date and time for the filter range, formatted in RFC 3339. Example: 2023-01-01T00:00:00Z
+    # @param to [String] Ending date and time for the filter range, formatted in RFC 3339. Example: 2023-01-01T00:00:00Z
+    def list(page: nil, from: nil, to: nil)
+      request(:get, PATH, params: {page: page, from: from, to: to})
+    end
+
+    # Get an offer information
+    # @param id [String] Offer ID
+    def get(id:)
+      request(:get, "#{PATH}/#{id}")
+    end
+  end
+end

data/lib/uscreen_api/programs.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module UscreenAPI
+  # Programs are the legacy name for contents. Prefer UscreenAPI::Contents.
+  class Programs < Base
+    PATH = "programs"
+
+    # Get paginated list of programs
+    # @param page [Integer] Page number
+    # @param include [String] Comma-separated list of relationships to include. Available relationships: author.
+    # @param from [String] Starting date and time for the filter range, formatted in RFC 3339. Example: 2023-01-01T00:00:00Z
+    # @param to [String] Ending date and time for the filter range, formatted in RFC 3339. Example: 2023-01-01T00:00:00Z
+    # @param content_type [String] Filter by content type. Can be collection|live_event|video
+    def list(page: nil, include: nil, from: nil, to: nil, content_type: nil)
+      request(:get, PATH, params: {page: page, include: include, from: from, to: to, content_type: content_type})
+    end
+
+    # Get a program information
+    # @param id [String] Program ID
+    # @param include [String] Comma-separated list of relationships to include. Available relationships: author.
+    def get(id:, include: nil)
+      request(:get, "#{PATH}/#{id}", params: {include: include})
+    end
+
+    # Get list of chapters
+    # @param id [String] Program ID
+    def chapters(id:)
+      request(:get, "#{PATH}/#{id}/chapters")
+    end
+
+    # Get a chapter
+    # @param id [String] Program ID
+    # @param chapter_id [String] Chapter ID
+    def chapter(id:, chapter_id:)
+      request(:get, "#{PATH}/#{id}/chapters/#{chapter_id}")
+    end
+  end
+end

data/lib/uscreen_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module UscreenAPI
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/lib/uscreen_api/videos.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module UscreenAPI
+  class Videos < Base
+    PATH = "videos"
+
+    # Get paginated list of videos
+    # @param page [Integer] Page number
+    # @param include [String] Comma-separated list of relationships to include. Available relationships: author.
+    # @param from [String] Starting date and time for the filter range, formatted in RFC 3339. Example: 2023-01-01T00:00:00Z
+    # @param to [String] Ending date and time for the filter range, formatted in RFC 3339. Example: 2023-01-01T00:00:00Z
+    def list(page: nil, include: nil, from: nil, to: nil)
+      request(:get, PATH, params: {page: page, include: include, from: from, to: to})
+    end
+
+    # Get video by ID
+    # @param id [String] Video ID
+    # @param include [String] Comma-separated list of relationships to include. Available relationships: author.
+    def get(id:, include: nil)
+      request(:get, "#{PATH}/#{id}", params: {include: include})
+    end
+  end
+end

data/lib/uscreen_api.rb

@@ -3,8 +3,16 @@
 require_relative "uscreen_api/version"
 
 module UscreenAPI
+  autoload :Analytics, "uscreen_api/analytics"
   autoload :Base, "uscreen_api/base"
   autoload :Client, "uscreen_api/client"
+  autoload :Contents, "uscreen_api/contents"
   autoload :Customers, "uscreen_api/customers"
+  autoload :EmailTopics, "uscreen_api/email_topics"
   autoload :Errors, "uscreen_api/errors"
+  autoload :Groups, "uscreen_api/groups"
+  autoload :Invoices, "uscreen_api/invoices"
+  autoload :Offers, "uscreen_api/offers"
+  autoload :Programs, "uscreen_api/programs"
+  autoload :Videos, "uscreen_api/videos"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: uscreen_api
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Andrei Bondarev
 bindir: exe
 cert_chain: []
-date: 2025-01-08 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -61,11 +61,19 @@ files:
 - LICENSE.txt
 - README.md
 - lib/uscreen_api.rb
+- lib/uscreen_api/analytics.rb
 - lib/uscreen_api/base.rb
 - lib/uscreen_api/client.rb
+- lib/uscreen_api/contents.rb
 - lib/uscreen_api/customers.rb
+- lib/uscreen_api/email_topics.rb
 - lib/uscreen_api/errors.rb
+- lib/uscreen_api/groups.rb
+- lib/uscreen_api/invoices.rb
+- lib/uscreen_api/offers.rb
+- lib/uscreen_api/programs.rb
 - lib/uscreen_api/version.rb
+- lib/uscreen_api/videos.rb
 - sig/uscreen_api.rbs
 homepage: https://github.com/andreibondarev/uscreen_api
 licenses:
@@ -81,14 +89,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Uscreen.tv Publisher API client
 test_files: []