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

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/social_post.rbi

@@ -256,8 +256,20 @@ module PostForMe
           sig { returns(T.nilable(String)) }
           attr_accessor :location
 
+          # If true will notify YouTube the video is intended for kids, defaults to false
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_accessor :made_for_kids
+
           # Overrides the `media` from the post
-          sig { returns(T.nilable(T::Array[String])) }
+          sig do
+            returns(
+              T.nilable(
+                T::Array[
+                  PostForMe::SocialPost::AccountConfiguration::Configuration::Media
+                ]
+              )
+            )
+          end
           attr_accessor :media
 
           # Post placement for Facebook/Instagram/Threads
@@ -288,8 +300,15 @@ module PostForMe
           end
           attr_writer :poll
 
-          # Sets the privacy status for TikTok (private, public)
-          sig { returns(T.nilable(String)) }
+          # Sets the privacy status for TikTok (private, public), or YouTube (private,
+          # public, unlisted)
+          sig do
+            returns(
+              T.nilable(
+                PostForMe::SocialPost::AccountConfiguration::Configuration::PrivacyStatus::TaggedSymbol
+              )
+            )
+          end
           attr_accessor :privacy_status
 
           # Id of the tweet you want to quote
@@ -334,14 +353,23 @@ module PostForMe
               is_draft: T.nilable(T::Boolean),
               link: T.nilable(String),
               location: T.nilable(String),
-              media: T.nilable(T::Array[String]),
+              made_for_kids: T.nilable(T::Boolean),
+              media:
+                T.nilable(
+                  T::Array[
+                    PostForMe::SocialPost::AccountConfiguration::Configuration::Media::OrHash
+                  ]
+                ),
               placement:
                 T.nilable(
                   PostForMe::SocialPost::AccountConfiguration::Configuration::Placement::OrSymbol
                 ),
               poll:
                 PostForMe::SocialPost::AccountConfiguration::Configuration::Poll::OrHash,
-              privacy_status: T.nilable(String),
+              privacy_status:
+                T.nilable(
+                  PostForMe::SocialPost::AccountConfiguration::Configuration::PrivacyStatus::OrSymbol
+                ),
               quote_tweet_id: String,
               reply_settings:
                 T.nilable(
@@ -383,13 +411,16 @@ module PostForMe
             # Page id with a location that you want to tag the image or video with (Instagram
             # and Facebook)
             location: nil,
+            # If true will notify YouTube the video is intended for kids, defaults to false
+            made_for_kids: nil,
             # Overrides the `media` from the post
             media: nil,
             # Post placement for Facebook/Instagram/Threads
             placement: nil,
             # Poll options for the twitter
             poll: nil,
-            # Sets the privacy status for TikTok (private, public)
+            # Sets the privacy status for TikTok (private, public), or YouTube (private,
+            # public, unlisted)
             privacy_status: nil,
             # Id of the tweet you want to quote
             quote_tweet_id: nil,
@@ -419,14 +450,23 @@ module PostForMe
                 is_draft: T.nilable(T::Boolean),
                 link: T.nilable(String),
                 location: T.nilable(String),
-                media: T.nilable(T::Array[String]),
+                made_for_kids: T.nilable(T::Boolean),
+                media:
+                  T.nilable(
+                    T::Array[
+                      PostForMe::SocialPost::AccountConfiguration::Configuration::Media
+                    ]
+                  ),
                 placement:
                   T.nilable(
                     PostForMe::SocialPost::AccountConfiguration::Configuration::Placement::TaggedSymbol
                   ),
                 poll:
                   PostForMe::SocialPost::AccountConfiguration::Configuration::Poll,
-                privacy_status: T.nilable(String),
+                privacy_status:
+                  T.nilable(
+                    PostForMe::SocialPost::AccountConfiguration::Configuration::PrivacyStatus::TaggedSymbol
+                  ),
                 quote_tweet_id: String,
                 reply_settings:
                   T.nilable(
@@ -440,6 +480,245 @@ module PostForMe
           def to_hash
           end
 
+          class Media < PostForMe::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  PostForMe::SocialPost::AccountConfiguration::Configuration::Media,
+                  PostForMe::Internal::AnyHash
+                )
+              end
+
+            # Public URL of the media
+            sig { returns(String) }
+            attr_accessor :url
+
+            # List of tags to attach to the media
+            sig do
+              returns(
+                T.nilable(
+                  T::Array[
+                    PostForMe::SocialPost::AccountConfiguration::Configuration::Media::Tag
+                  ]
+                )
+              )
+            end
+            attr_accessor :tags
+
+            # Timestamp in milliseconds of frame to use as thumbnail for the media
+            sig { returns(T.nilable(T.anything)) }
+            attr_accessor :thumbnail_timestamp_ms
+
+            # Public URL of the thumbnail for the media
+            sig { returns(T.nilable(T.anything)) }
+            attr_accessor :thumbnail_url
+
+            sig do
+              params(
+                url: String,
+                tags:
+                  T.nilable(
+                    T::Array[
+                      PostForMe::SocialPost::AccountConfiguration::Configuration::Media::Tag::OrHash
+                    ]
+                  ),
+                thumbnail_timestamp_ms: T.nilable(T.anything),
+                thumbnail_url: T.nilable(T.anything)
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # Public URL of the media
+              url:,
+              # List of tags to attach to the media
+              tags: nil,
+              # Timestamp in milliseconds of frame to use as thumbnail for the media
+              thumbnail_timestamp_ms: nil,
+              # Public URL of the thumbnail for the media
+              thumbnail_url: nil
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  url: String,
+                  tags:
+                    T.nilable(
+                      T::Array[
+                        PostForMe::SocialPost::AccountConfiguration::Configuration::Media::Tag
+                      ]
+                    ),
+                  thumbnail_timestamp_ms: T.nilable(T.anything),
+                  thumbnail_url: T.nilable(T.anything)
+                }
+              )
+            end
+            def to_hash
+            end
+
+            class Tag < PostForMe::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    PostForMe::SocialPost::AccountConfiguration::Configuration::Media::Tag,
+                    PostForMe::Internal::AnyHash
+                  )
+                end
+
+              # Facebook User ID, Instagram Username or Instagram product id to tag
+              sig { returns(String) }
+              attr_accessor :id
+
+              # The platform for the tags
+              sig do
+                returns(
+                  PostForMe::SocialPost::AccountConfiguration::Configuration::Media::Tag::Platform::TaggedSymbol
+                )
+              end
+              attr_accessor :platform
+
+              # The type of tag, user to tag accounts, product to tag products (only supported
+              # for instagram)
+              sig do
+                returns(
+                  PostForMe::SocialPost::AccountConfiguration::Configuration::Media::Tag::Type::TaggedSymbol
+                )
+              end
+              attr_accessor :type
+
+              # Percentage distance from left edge of the image, Not required for videos or
+              # stories
+              sig { returns(T.nilable(Float)) }
+              attr_reader :x
+
+              sig { params(x: Float).void }
+              attr_writer :x
+
+              # Percentage distance from top edge of the image, Not required for videos or
+              # stories
+              sig { returns(T.nilable(Float)) }
+              attr_reader :y_
+
+              sig { params(y_: Float).void }
+              attr_writer :y_
+
+              sig do
+                params(
+                  id: String,
+                  platform:
+                    PostForMe::SocialPost::AccountConfiguration::Configuration::Media::Tag::Platform::OrSymbol,
+                  type:
+                    PostForMe::SocialPost::AccountConfiguration::Configuration::Media::Tag::Type::OrSymbol,
+                  x: Float,
+                  y_: Float
+                ).returns(T.attached_class)
+              end
+              def self.new(
+                # Facebook User ID, Instagram Username or Instagram product id to tag
+                id:,
+                # The platform for the tags
+                platform:,
+                # The type of tag, user to tag accounts, product to tag products (only supported
+                # for instagram)
+                type:,
+                # Percentage distance from left edge of the image, Not required for videos or
+                # stories
+                x: nil,
+                # Percentage distance from top edge of the image, Not required for videos or
+                # stories
+                y_: nil
+              )
+              end
+
+              sig do
+                override.returns(
+                  {
+                    id: String,
+                    platform:
+                      PostForMe::SocialPost::AccountConfiguration::Configuration::Media::Tag::Platform::TaggedSymbol,
+                    type:
+                      PostForMe::SocialPost::AccountConfiguration::Configuration::Media::Tag::Type::TaggedSymbol,
+                    x: Float,
+                    y_: Float
+                  }
+                )
+              end
+              def to_hash
+              end
+
+              # The platform for the tags
+              module Platform
+                extend PostForMe::Internal::Type::Enum
+
+                TaggedSymbol =
+                  T.type_alias do
+                    T.all(
+                      Symbol,
+                      PostForMe::SocialPost::AccountConfiguration::Configuration::Media::Tag::Platform
+                    )
+                  end
+                OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+                FACEBOOK =
+                  T.let(
+                    :facebook,
+                    PostForMe::SocialPost::AccountConfiguration::Configuration::Media::Tag::Platform::TaggedSymbol
+                  )
+                INSTAGRAM =
+                  T.let(
+                    :instagram,
+                    PostForMe::SocialPost::AccountConfiguration::Configuration::Media::Tag::Platform::TaggedSymbol
+                  )
+
+                sig do
+                  override.returns(
+                    T::Array[
+                      PostForMe::SocialPost::AccountConfiguration::Configuration::Media::Tag::Platform::TaggedSymbol
+                    ]
+                  )
+                end
+                def self.values
+                end
+              end
+
+              # The type of tag, user to tag accounts, product to tag products (only supported
+              # for instagram)
+              module Type
+                extend PostForMe::Internal::Type::Enum
+
+                TaggedSymbol =
+                  T.type_alias do
+                    T.all(
+                      Symbol,
+                      PostForMe::SocialPost::AccountConfiguration::Configuration::Media::Tag::Type
+                    )
+                  end
+                OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+                USER =
+                  T.let(
+                    :user,
+                    PostForMe::SocialPost::AccountConfiguration::Configuration::Media::Tag::Type::TaggedSymbol
+                  )
+                PRODUCT =
+                  T.let(
+                    :product,
+                    PostForMe::SocialPost::AccountConfiguration::Configuration::Media::Tag::Type::TaggedSymbol
+                  )
+
+                sig do
+                  override.returns(
+                    T::Array[
+                      PostForMe::SocialPost::AccountConfiguration::Configuration::Media::Tag::Type::TaggedSymbol
+                    ]
+                  )
+                end
+                def self.values
+                end
+              end
+            end
+          end
+
           # Post placement for Facebook/Instagram/Threads
           module Placement
             extend PostForMe::Internal::Type::Enum
@@ -593,6 +872,47 @@ module PostForMe
             end
           end
 
+          # Sets the privacy status for TikTok (private, public), or YouTube (private,
+          # public, unlisted)
+          module PrivacyStatus
+            extend PostForMe::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  PostForMe::SocialPost::AccountConfiguration::Configuration::PrivacyStatus
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            PUBLIC =
+              T.let(
+                :public,
+                PostForMe::SocialPost::AccountConfiguration::Configuration::PrivacyStatus::TaggedSymbol
+              )
+            PRIVATE =
+              T.let(
+                :private,
+                PostForMe::SocialPost::AccountConfiguration::Configuration::PrivacyStatus::TaggedSymbol
+              )
+            UNLISTED =
+              T.let(
+                :unlisted,
+                PostForMe::SocialPost::AccountConfiguration::Configuration::PrivacyStatus::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  PostForMe::SocialPost::AccountConfiguration::Configuration::PrivacyStatus::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
           # Who can reply to the tweet
           module ReplySettings
             extend PostForMe::Internal::Type::Enum

data/rbi/post_for_me/models/social_post_list_params.rbi

@@ -50,6 +50,13 @@ module PostForMe
       end
       attr_writer :platform
 
+      # Filter by social account ID. Multiple values imply OR logic.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :social_account_id
+
+      sig { params(social_account_id: T::Array[String]).void }
+      attr_writer :social_account_id
+
       # Filter by post status. Multiple values imply OR logic.
       sig do
         returns(
@@ -72,6 +79,7 @@ module PostForMe
           offset: Float,
           platform:
             T::Array[PostForMe::SocialPostListParams::Platform::OrSymbol],
+          social_account_id: T::Array[String],
           status: T::Array[PostForMe::SocialPostListParams::Status::OrSymbol],
           request_options: PostForMe::RequestOptions::OrHash
         ).returns(T.attached_class)
@@ -85,6 +93,8 @@ module PostForMe
         offset: nil,
         # Filter by platforms. Multiple values imply OR logic.
         platform: nil,
+        # Filter by social account ID. Multiple values imply OR logic.
+        social_account_id: nil,
         # Filter by post status. Multiple values imply OR logic.
         status: nil,
         request_options: {}
@@ -99,6 +109,7 @@ module PostForMe
             offset: Float,
             platform:
               T::Array[PostForMe::SocialPostListParams::Platform::OrSymbol],
+            social_account_id: T::Array[String],
             status: T::Array[PostForMe::SocialPostListParams::Status::OrSymbol],
             request_options: PostForMe::RequestOptions
           }