post-for-me 0.1.0.pre.alpha.10 → 0.1.0.pre.alpha.11

data/rbi/post_for_me/models/social_account_feed_list_params.rbi

@@ -0,0 +1,157 @@
+# typed: strong
+
+module PostForMe
+  module Models
+    class SocialAccountFeedListParams < PostForMe::Internal::Type::BaseModel
+      extend PostForMe::Internal::Type::RequestParameters::Converter
+      include PostForMe::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            PostForMe::SocialAccountFeedListParams,
+            PostForMe::Internal::AnyHash
+          )
+        end
+
+      # Cursor identifying next page of results
+      sig { returns(T.nilable(String)) }
+      attr_reader :cursor
+
+      sig { params(cursor: String).void }
+      attr_writer :cursor
+
+      # Expand additional data in the response. Currently supports: "metrics" to include
+      # post analytics data.
+      sig do
+        returns(
+          T.nilable(
+            T::Array[PostForMe::SocialAccountFeedListParams::Expand::OrSymbol]
+          )
+        )
+      end
+      attr_reader :expand
+
+      sig do
+        params(
+          expand:
+            T::Array[PostForMe::SocialAccountFeedListParams::Expand::OrSymbol]
+        ).void
+      end
+      attr_writer :expand
+
+      # Filter by Post for Me Social Postexternal ID. Multiple values imply OR logic
+      # (e.g., ?external_post_id=xxxxxx&external_post_id=yyyyyy).
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :external_post_id
+
+      sig { params(external_post_id: T::Array[String]).void }
+      attr_writer :external_post_id
+
+      # Number of items to return; Note: some platforms will have different max limits,
+      # in the case the provided limit is over the platform's limit we will return the
+      # max allowed by the platform.
+      sig { returns(T.nilable(Float)) }
+      attr_reader :limit
+
+      sig { params(limit: Float).void }
+      attr_writer :limit
+
+      # Filter by the platform's id(s). Multiple values imply OR logic (e.g.,
+      # ?social_post_id=spr_xxxxxx&social_post_id=spr_yyyyyy).
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :platform_post_id
+
+      sig { params(platform_post_id: T::Array[String]).void }
+      attr_writer :platform_post_id
+
+      # Filter by Post for Me Social Post id(s). Multiple values imply OR logic (e.g.,
+      # ?social_post_id=sp_xxxxxx&social_post_id=sp_yyyyyy).
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :social_post_id
+
+      sig { params(social_post_id: T::Array[String]).void }
+      attr_writer :social_post_id
+
+      sig do
+        params(
+          cursor: String,
+          expand:
+            T::Array[PostForMe::SocialAccountFeedListParams::Expand::OrSymbol],
+          external_post_id: T::Array[String],
+          limit: Float,
+          platform_post_id: T::Array[String],
+          social_post_id: T::Array[String],
+          request_options: PostForMe::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Cursor identifying next page of results
+        cursor: nil,
+        # Expand additional data in the response. Currently supports: "metrics" to include
+        # post analytics data.
+        expand: nil,
+        # Filter by Post for Me Social Postexternal ID. Multiple values imply OR logic
+        # (e.g., ?external_post_id=xxxxxx&external_post_id=yyyyyy).
+        external_post_id: nil,
+        # Number of items to return; Note: some platforms will have different max limits,
+        # in the case the provided limit is over the platform's limit we will return the
+        # max allowed by the platform.
+        limit: nil,
+        # Filter by the platform's id(s). Multiple values imply OR logic (e.g.,
+        # ?social_post_id=spr_xxxxxx&social_post_id=spr_yyyyyy).
+        platform_post_id: nil,
+        # Filter by Post for Me Social Post id(s). Multiple values imply OR logic (e.g.,
+        # ?social_post_id=sp_xxxxxx&social_post_id=sp_yyyyyy).
+        social_post_id: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            cursor: String,
+            expand:
+              T::Array[
+                PostForMe::SocialAccountFeedListParams::Expand::OrSymbol
+              ],
+            external_post_id: T::Array[String],
+            limit: Float,
+            platform_post_id: T::Array[String],
+            social_post_id: T::Array[String],
+            request_options: PostForMe::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      module Expand
+        extend PostForMe::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, PostForMe::SocialAccountFeedListParams::Expand)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        METRICS =
+          T.let(
+            :metrics,
+            PostForMe::SocialAccountFeedListParams::Expand::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              PostForMe::SocialAccountFeedListParams::Expand::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/post_for_me/models/social_account_feed_list_response.rbi

@@ -0,0 +1,110 @@
+# typed: strong
+
+module PostForMe
+  module Models
+    class SocialAccountFeedListResponse < PostForMe::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            PostForMe::Models::SocialAccountFeedListResponse,
+            PostForMe::Internal::AnyHash
+          )
+        end
+
+      sig { returns(T::Array[PostForMe::PlatformPost]) }
+      attr_accessor :data
+
+      sig { returns(PostForMe::Models::SocialAccountFeedListResponse::Meta) }
+      attr_reader :meta
+
+      sig do
+        params(
+          meta: PostForMe::Models::SocialAccountFeedListResponse::Meta::OrHash
+        ).void
+      end
+      attr_writer :meta
+
+      sig do
+        params(
+          data: T::Array[PostForMe::PlatformPost::OrHash],
+          meta: PostForMe::Models::SocialAccountFeedListResponse::Meta::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(data:, meta:)
+      end
+
+      sig do
+        override.returns(
+          {
+            data: T::Array[PostForMe::PlatformPost],
+            meta: PostForMe::Models::SocialAccountFeedListResponse::Meta
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Meta < PostForMe::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              PostForMe::Models::SocialAccountFeedListResponse::Meta,
+              PostForMe::Internal::AnyHash
+            )
+          end
+
+        # Id representing the next page of items
+        sig { returns(String) }
+        attr_accessor :cursor
+
+        # Maximum number of items returned.
+        sig { returns(Float) }
+        attr_accessor :limit
+
+        # URL to the next page of results, or null if none.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :next_
+
+        # Indicates if there are more results or not
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :has_more
+
+        sig { params(has_more: T::Boolean).void }
+        attr_writer :has_more
+
+        sig do
+          params(
+            cursor: String,
+            limit: Float,
+            next_: T.nilable(String),
+            has_more: T::Boolean
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Id representing the next page of items
+          cursor:,
+          # Maximum number of items returned.
+          limit:,
+          # URL to the next page of results, or null if none.
+          next_:,
+          # Indicates if there are more results or not
+          has_more: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              cursor: String,
+              limit: Float,
+              next_: T.nilable(String),
+              has_more: T::Boolean
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/post_for_me/models.rbi

@@ -17,6 +17,8 @@ module PostForMe
 
   PlatformConfigurationsDto = PostForMe::Models::PlatformConfigurationsDto
 
+  PlatformPost = PostForMe::Models::PlatformPost
+
   SocialAccount = PostForMe::Models::SocialAccount
 
   SocialAccountCreateAuthURLParams =
@@ -27,6 +29,8 @@ module PostForMe
   SocialAccountDisconnectParams =
     PostForMe::Models::SocialAccountDisconnectParams
 
+  SocialAccountFeedListParams = PostForMe::Models::SocialAccountFeedListParams
+
   SocialAccountListParams = PostForMe::Models::SocialAccountListParams
 
   SocialAccountRetrieveParams = PostForMe::Models::SocialAccountRetrieveParams

data/rbi/post_for_me/resources/social_account_feeds.rbi

@@ -0,0 +1,51 @@
+# typed: strong
+
+module PostForMe
+  module Resources
+    class SocialAccountFeeds
+      # Get a paginated result for the social account based on the applied filters
+      sig do
+        params(
+          social_account_id: String,
+          cursor: String,
+          expand:
+            T::Array[PostForMe::SocialAccountFeedListParams::Expand::OrSymbol],
+          external_post_id: T::Array[String],
+          limit: Float,
+          platform_post_id: T::Array[String],
+          social_post_id: T::Array[String],
+          request_options: PostForMe::RequestOptions::OrHash
+        ).returns(PostForMe::Models::SocialAccountFeedListResponse)
+      end
+      def list(
+        # Social Account ID
+        social_account_id,
+        # Cursor identifying next page of results
+        cursor: nil,
+        # Expand additional data in the response. Currently supports: "metrics" to include
+        # post analytics data.
+        expand: nil,
+        # Filter by Post for Me Social Postexternal ID. Multiple values imply OR logic
+        # (e.g., ?external_post_id=xxxxxx&external_post_id=yyyyyy).
+        external_post_id: nil,
+        # Number of items to return; Note: some platforms will have different max limits,
+        # in the case the provided limit is over the platform's limit we will return the
+        # max allowed by the platform.
+        limit: nil,
+        # Filter by the platform's id(s). Multiple values imply OR logic (e.g.,
+        # ?social_post_id=spr_xxxxxx&social_post_id=spr_yyyyyy).
+        platform_post_id: nil,
+        # Filter by Post for Me Social Post id(s). Multiple values imply OR logic (e.g.,
+        # ?social_post_id=sp_xxxxxx&social_post_id=sp_yyyyyy).
+        social_post_id: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: PostForMe::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/post_for_me/resources/social_accounts.rbi

@@ -117,8 +117,13 @@ module PostForMe
         params(
           platform: String,
           external_id: String,
+          permissions:
+            T::Array[
+              PostForMe::SocialAccountCreateAuthURLParams::Permission::OrSymbol
+            ],
           platform_data:
             PostForMe::SocialAccountCreateAuthURLParams::PlatformData::OrHash,
+          redirect_url_override: String,
           request_options: PostForMe::RequestOptions::OrHash
         ).returns(PostForMe::Models::SocialAccountCreateAuthURLResponse)
       end
@@ -127,8 +132,16 @@ module PostForMe
         platform:,
         # Your unique identifier for the social account
         external_id: nil,
+        # List of permissions you want to allow. Will default to only post permissions.
+        # You must include the "feeds" permission to request an account feed and metrics
+        permissions: nil,
         # Additional data needed for the provider
         platform_data: nil,
+        # Override the default redirect URL for the OAuth flow. If provided, this URL will
+        # be used instead of our redirect URL. Make sure this URL is included in your
+        # app's authorized redirect urls. This override will not work when using our
+        # system credientals.
+        redirect_url_override: nil,
         request_options: {}
       )
       end

data/sig/post_for_me/client.rbs

@@ -18,6 +18,8 @@ module PostForMe
 
     attr_reader social_accounts: PostForMe::Resources::SocialAccounts
 
+    attr_reader social_account_feeds: PostForMe::Resources::SocialAccountFeeds
+
     private def auth_headers: -> ::Hash[String, String]
 
     def initialize: (