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

data/lib/post_for_me/models/social_account_create_auth_url_params.rb

@@ -19,21 +19,55 @@ module PostForMe
       #   @return [String, nil]
       optional :external_id, String
 
+      # @!attribute permissions
+      #   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
+      #
+      #   @return [Array<Symbol, PostForMe::Models::SocialAccountCreateAuthURLParams::Permission>, nil]
+      optional :permissions,
+               -> { PostForMe::Internal::Type::ArrayOf[enum: PostForMe::SocialAccountCreateAuthURLParams::Permission] }
+
       # @!attribute platform_data
       #   Additional data needed for the provider
       #
       #   @return [PostForMe::Models::SocialAccountCreateAuthURLParams::PlatformData, nil]
       optional :platform_data, -> { PostForMe::SocialAccountCreateAuthURLParams::PlatformData }
 
-      # @!method initialize(platform:, external_id: nil, platform_data: nil, request_options: {})
+      # @!attribute redirect_url_override
+      #   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.
+      #
+      #   @return [String, nil]
+      optional :redirect_url_override, String
+
+      # @!method initialize(platform:, external_id: nil, permissions: nil, platform_data: nil, redirect_url_override: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {PostForMe::Models::SocialAccountCreateAuthURLParams} for more details.
+      #
       #   @param platform [String] The social account provider
       #
       #   @param external_id [String] Your unique identifier for the social account
       #
+      #   @param permissions [Array<Symbol, PostForMe::Models::SocialAccountCreateAuthURLParams::Permission>] List of permissions you want to allow. Will default to only post permissions. Yo
+      #
       #   @param platform_data [PostForMe::Models::SocialAccountCreateAuthURLParams::PlatformData] Additional data needed for the provider
       #
+      #   @param redirect_url_override [String] Override the default redirect URL for the OAuth flow. If provided, this URL will
+      #
       #   @param request_options [PostForMe::RequestOptions, Hash{Symbol=>Object}]
 
+      module Permission
+        extend PostForMe::Internal::Type::Enum
+
+        POSTS = :posts
+        FEEDS = :feeds
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
       class PlatformData < PostForMe::Internal::Type::BaseModel
         # @!attribute bluesky
         #   Additional data needed for connecting bluesky accounts
@@ -41,6 +75,12 @@ module PostForMe
         #   @return [PostForMe::Models::SocialAccountCreateAuthURLParams::PlatformData::Bluesky, nil]
         optional :bluesky, -> { PostForMe::SocialAccountCreateAuthURLParams::PlatformData::Bluesky }
 
+        # @!attribute facebook
+        #   Additional data for connecting facebook accounts
+        #
+        #   @return [PostForMe::Models::SocialAccountCreateAuthURLParams::PlatformData::Facebook, nil]
+        optional :facebook, -> { PostForMe::SocialAccountCreateAuthURLParams::PlatformData::Facebook }
+
         # @!attribute instagram
         #   Additional data for connecting instagram accounts
         #
@@ -53,14 +93,57 @@ module PostForMe
         #   @return [PostForMe::Models::SocialAccountCreateAuthURLParams::PlatformData::Linkedin, nil]
         optional :linkedin, -> { PostForMe::SocialAccountCreateAuthURLParams::PlatformData::Linkedin }
 
-        # @!method initialize(bluesky: nil, instagram: nil, linkedin: nil)
+        # @!attribute pinterest
+        #   Additional data for connecting Pinterest accounts
+        #
+        #   @return [PostForMe::Models::SocialAccountCreateAuthURLParams::PlatformData::Pinterest, nil]
+        optional :pinterest, -> { PostForMe::SocialAccountCreateAuthURLParams::PlatformData::Pinterest }
+
+        # @!attribute threads
+        #   Additional data for connecting Threads accounts
+        #
+        #   @return [PostForMe::Models::SocialAccountCreateAuthURLParams::PlatformData::Threads, nil]
+        optional :threads, -> { PostForMe::SocialAccountCreateAuthURLParams::PlatformData::Threads }
+
+        # @!attribute tiktok
+        #   Additional data for connecting TikTok accounts
+        #
+        #   @return [PostForMe::Models::SocialAccountCreateAuthURLParams::PlatformData::Tiktok, nil]
+        optional :tiktok, -> { PostForMe::SocialAccountCreateAuthURLParams::PlatformData::Tiktok }
+
+        # @!attribute tiktok_business
+        #   Additional data for connecting TikTok Business accounts
+        #
+        #   @return [PostForMe::Models::SocialAccountCreateAuthURLParams::PlatformData::TiktokBusiness, nil]
+        optional :tiktok_business,
+                 -> { PostForMe::SocialAccountCreateAuthURLParams::PlatformData::TiktokBusiness }
+
+        # @!attribute youtube
+        #   Additional data for connecting YouTube accounts
+        #
+        #   @return [PostForMe::Models::SocialAccountCreateAuthURLParams::PlatformData::Youtube, nil]
+        optional :youtube, -> { PostForMe::SocialAccountCreateAuthURLParams::PlatformData::Youtube }
+
+        # @!method initialize(bluesky: nil, facebook: nil, instagram: nil, linkedin: nil, pinterest: nil, threads: nil, tiktok: nil, tiktok_business: nil, youtube: nil)
         #   Additional data needed for the provider
         #
         #   @param bluesky [PostForMe::Models::SocialAccountCreateAuthURLParams::PlatformData::Bluesky] Additional data needed for connecting bluesky accounts
         #
+        #   @param facebook [PostForMe::Models::SocialAccountCreateAuthURLParams::PlatformData::Facebook] Additional data for connecting facebook accounts
+        #
         #   @param instagram [PostForMe::Models::SocialAccountCreateAuthURLParams::PlatformData::Instagram] Additional data for connecting instagram accounts
         #
         #   @param linkedin [PostForMe::Models::SocialAccountCreateAuthURLParams::PlatformData::Linkedin] Additional data for connecting linkedin accounts
+        #
+        #   @param pinterest [PostForMe::Models::SocialAccountCreateAuthURLParams::PlatformData::Pinterest] Additional data for connecting Pinterest accounts
+        #
+        #   @param threads [PostForMe::Models::SocialAccountCreateAuthURLParams::PlatformData::Threads] Additional data for connecting Threads accounts
+        #
+        #   @param tiktok [PostForMe::Models::SocialAccountCreateAuthURLParams::PlatformData::Tiktok] Additional data for connecting TikTok accounts
+        #
+        #   @param tiktok_business [PostForMe::Models::SocialAccountCreateAuthURLParams::PlatformData::TiktokBusiness] Additional data for connecting TikTok Business accounts
+        #
+        #   @param youtube [PostForMe::Models::SocialAccountCreateAuthURLParams::PlatformData::Youtube] Additional data for connecting YouTube accounts
 
         # @see PostForMe::Models::SocialAccountCreateAuthURLParams::PlatformData#bluesky
         class Bluesky < PostForMe::Internal::Type::BaseModel
@@ -84,6 +167,27 @@ module PostForMe
           #   @param handle [String] The handle of the account
         end
 
+        # @see PostForMe::Models::SocialAccountCreateAuthURLParams::PlatformData#facebook
+        class Facebook < PostForMe::Internal::Type::BaseModel
+          # @!attribute permission_overrides
+          #   Override the default permissions/scopes requested during OAuth. Default scopes:
+          #   public_profile, pages_show_list, pages_read_engagement, pages_manage_posts,
+          #   business_management
+          #
+          #   @return [Array<Array<Object>>, nil]
+          optional :permission_overrides,
+                   PostForMe::Internal::Type::ArrayOf[PostForMe::Internal::Type::ArrayOf[PostForMe::Internal::Type::Unknown]]
+
+          # @!method initialize(permission_overrides: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {PostForMe::Models::SocialAccountCreateAuthURLParams::PlatformData::Facebook}
+          #   for more details.
+          #
+          #   Additional data for connecting facebook accounts
+          #
+          #   @param permission_overrides [Array<Array<Object>>] Override the default permissions/scopes requested during OAuth. Default scopes:
+        end
+
         # @see PostForMe::Models::SocialAccountCreateAuthURLParams::PlatformData#instagram
         class Instagram < PostForMe::Internal::Type::BaseModel
           # @!attribute connection_type
@@ -94,7 +198,17 @@ module PostForMe
           required :connection_type,
                    enum: -> { PostForMe::SocialAccountCreateAuthURLParams::PlatformData::Instagram::ConnectionType }
 
-          # @!method initialize(connection_type:)
+          # @!attribute permission_overrides
+          #   Override the default permissions/scopes requested during OAuth. Default
+          #   instagram scopes: instagram_business_basic, instagram_business_content_publish.
+          #   Default facebook scopes: instagram_basic, instagram_content_publish,
+          #   pages_show_list, public_profile, business_management
+          #
+          #   @return [Array<Array<Object>>, nil]
+          optional :permission_overrides,
+                   PostForMe::Internal::Type::ArrayOf[PostForMe::Internal::Type::ArrayOf[PostForMe::Internal::Type::Unknown]]
+
+          # @!method initialize(connection_type:, permission_overrides: nil)
           #   Some parameter documentations has been truncated, see
           #   {PostForMe::Models::SocialAccountCreateAuthURLParams::PlatformData::Instagram}
           #   for more details.
@@ -102,6 +216,8 @@ module PostForMe
           #   Additional data for connecting instagram accounts
           #
           #   @param connection_type [Symbol, PostForMe::Models::SocialAccountCreateAuthURLParams::PlatformData::Instagram::ConnectionType] The type of connection; instagram for using login with instagram, facebook for u
+          #
+          #   @param permission_overrides [Array<Array<Object>>] Override the default permissions/scopes requested during OAuth. Default instagra
 
           # The type of connection; instagram for using login with instagram, facebook for
           # using login with facebook.
@@ -121,24 +237,38 @@ module PostForMe
         # @see PostForMe::Models::SocialAccountCreateAuthURLParams::PlatformData#linkedin
         class Linkedin < PostForMe::Internal::Type::BaseModel
           # @!attribute connection_type
-          #   The type of connection; personal for posting on behalf of the user only,
-          #   organization for posting on behalf of both an organization and the user
+          #   The type of connection; If using our provided credentials always use
+          #   "organization". If using your own crednetials then only use "organization" if
+          #   you are using the Community API
           #
           #   @return [Symbol, PostForMe::Models::SocialAccountCreateAuthURLParams::PlatformData::Linkedin::ConnectionType]
           required :connection_type,
                    enum: -> { PostForMe::SocialAccountCreateAuthURLParams::PlatformData::Linkedin::ConnectionType }
 
-          # @!method initialize(connection_type:)
+          # @!attribute permission_overrides
+          #   Override the default permissions/scopes requested during OAuth. Default personal
+          #   scopes: openid, w_member_social, profile, email. Default organization scopes:
+          #   r_basicprofile, w_member_social, r_organization_social, w_organization_social,
+          #   rw_organization_admin
+          #
+          #   @return [Array<Array<Object>>, nil]
+          optional :permission_overrides,
+                   PostForMe::Internal::Type::ArrayOf[PostForMe::Internal::Type::ArrayOf[PostForMe::Internal::Type::Unknown]]
+
+          # @!method initialize(connection_type:, permission_overrides: nil)
           #   Some parameter documentations has been truncated, see
           #   {PostForMe::Models::SocialAccountCreateAuthURLParams::PlatformData::Linkedin}
           #   for more details.
           #
           #   Additional data for connecting linkedin accounts
           #
-          #   @param connection_type [Symbol, PostForMe::Models::SocialAccountCreateAuthURLParams::PlatformData::Linkedin::ConnectionType] The type of connection; personal for posting on behalf of the user only, organiz
+          #   @param connection_type [Symbol, PostForMe::Models::SocialAccountCreateAuthURLParams::PlatformData::Linkedin::ConnectionType] The type of connection; If using our provided credentials always use "organizati
+          #
+          #   @param permission_overrides [Array<Array<Object>>] Override the default permissions/scopes requested during OAuth. Default personal
 
-          # The type of connection; personal for posting on behalf of the user only,
-          # organization for posting on behalf of both an organization and the user
+          # The type of connection; If using our provided credentials always use
+          # "organization". If using your own crednetials then only use "organization" if
+          # you are using the Community API
           #
           # @see PostForMe::Models::SocialAccountCreateAuthURLParams::PlatformData::Linkedin#connection_type
           module ConnectionType
@@ -151,6 +281,112 @@ module PostForMe
             #   @return [Array<Symbol>]
           end
         end
+
+        # @see PostForMe::Models::SocialAccountCreateAuthURLParams::PlatformData#pinterest
+        class Pinterest < PostForMe::Internal::Type::BaseModel
+          # @!attribute permission_overrides
+          #   Override the default permissions/scopes requested during OAuth. Default scopes:
+          #   boards:read, boards:write, pins:read, pins:write, user_accounts:read
+          #
+          #   @return [Array<Array<Object>>, nil]
+          optional :permission_overrides,
+                   PostForMe::Internal::Type::ArrayOf[PostForMe::Internal::Type::ArrayOf[PostForMe::Internal::Type::Unknown]]
+
+          # @!method initialize(permission_overrides: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {PostForMe::Models::SocialAccountCreateAuthURLParams::PlatformData::Pinterest}
+          #   for more details.
+          #
+          #   Additional data for connecting Pinterest accounts
+          #
+          #   @param permission_overrides [Array<Array<Object>>] Override the default permissions/scopes requested during OAuth. Default scopes:
+        end
+
+        # @see PostForMe::Models::SocialAccountCreateAuthURLParams::PlatformData#threads
+        class Threads < PostForMe::Internal::Type::BaseModel
+          # @!attribute permission_overrides
+          #   Override the default permissions/scopes requested during OAuth. Default scopes:
+          #   threads_basic, threads_content_publish
+          #
+          #   @return [Array<Array<Object>>, nil]
+          optional :permission_overrides,
+                   PostForMe::Internal::Type::ArrayOf[PostForMe::Internal::Type::ArrayOf[PostForMe::Internal::Type::Unknown]]
+
+          # @!method initialize(permission_overrides: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {PostForMe::Models::SocialAccountCreateAuthURLParams::PlatformData::Threads} for
+          #   more details.
+          #
+          #   Additional data for connecting Threads accounts
+          #
+          #   @param permission_overrides [Array<Array<Object>>] Override the default permissions/scopes requested during OAuth. Default scopes:
+        end
+
+        # @see PostForMe::Models::SocialAccountCreateAuthURLParams::PlatformData#tiktok
+        class Tiktok < PostForMe::Internal::Type::BaseModel
+          # @!attribute permission_overrides
+          #   Override the default permissions/scopes requested during OAuth. Default scopes:
+          #   user.info.basic, video.list, video.upload, video.publish
+          #
+          #   @return [Array<Array<Object>>, nil]
+          optional :permission_overrides,
+                   PostForMe::Internal::Type::ArrayOf[PostForMe::Internal::Type::ArrayOf[PostForMe::Internal::Type::Unknown]]
+
+          # @!method initialize(permission_overrides: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {PostForMe::Models::SocialAccountCreateAuthURLParams::PlatformData::Tiktok} for
+          #   more details.
+          #
+          #   Additional data for connecting TikTok accounts
+          #
+          #   @param permission_overrides [Array<Array<Object>>] Override the default permissions/scopes requested during OAuth. Default scopes:
+        end
+
+        # @see PostForMe::Models::SocialAccountCreateAuthURLParams::PlatformData#tiktok_business
+        class TiktokBusiness < PostForMe::Internal::Type::BaseModel
+          # @!attribute permission_overrides
+          #   Override the default permissions/scopes requested during OAuth. Default scopes:
+          #   user.info.basic, user.info.username, user.info.stats, user.info.profile,
+          #   user.account.type, user.insights, video.list, video.insights, comment.list,
+          #   comment.list.manage, video.publish, video.upload, biz.spark.auth,
+          #   discovery.search.words
+          #
+          #   @return [Array<Array<Object>>, nil]
+          optional :permission_overrides,
+                   PostForMe::Internal::Type::ArrayOf[PostForMe::Internal::Type::ArrayOf[PostForMe::Internal::Type::Unknown]]
+
+          # @!method initialize(permission_overrides: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {PostForMe::Models::SocialAccountCreateAuthURLParams::PlatformData::TiktokBusiness}
+          #   for more details.
+          #
+          #   Additional data for connecting TikTok Business accounts
+          #
+          #   @param permission_overrides [Array<Array<Object>>] Override the default permissions/scopes requested during OAuth. Default scopes:
+        end
+
+        # @see PostForMe::Models::SocialAccountCreateAuthURLParams::PlatformData#youtube
+        class Youtube < PostForMe::Internal::Type::BaseModel
+          # @!attribute permission_overrides
+          #   Override the default permissions/scopes requested during OAuth. Default scopes:
+          #   https://www.googleapis.com/auth/youtube.force-ssl,
+          #   https://www.googleapis.com/auth/youtube.upload,
+          #   https://www.googleapis.com/auth/youtube.readonly,
+          #   https://www.googleapis.com/auth/userinfo.profile
+          #
+          #   @return [Array<Array<Object>>, nil]
+          optional :permission_overrides,
+                   PostForMe::Internal::Type::ArrayOf[PostForMe::Internal::Type::ArrayOf[PostForMe::Internal::Type::Unknown]]
+
+          # @!method initialize(permission_overrides: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {PostForMe::Models::SocialAccountCreateAuthURLParams::PlatformData::Youtube} for
+          #   more details.
+          #
+          #   Additional data for connecting YouTube accounts
+          #
+          #   @param permission_overrides [Array<Array<Object>>] Override the default permissions/scopes requested during OAuth. Default scopes:
+        end
       end
     end
   end

data/lib/post_for_me/models/social_account_feed_list_params.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module PostForMe
+  module Models
+    # @see PostForMe::Resources::SocialAccountFeeds#list
+    class SocialAccountFeedListParams < PostForMe::Internal::Type::BaseModel
+      extend PostForMe::Internal::Type::RequestParameters::Converter
+      include PostForMe::Internal::Type::RequestParameters
+
+      # @!attribute cursor
+      #   Cursor identifying next page of results
+      #
+      #   @return [String, nil]
+      optional :cursor, String
+
+      # @!attribute expand
+      #   Expand additional data in the response. Currently supports: "metrics" to include
+      #   post analytics data.
+      #
+      #   @return [Array<Symbol, PostForMe::Models::SocialAccountFeedListParams::Expand>, nil]
+      optional :expand,
+               -> { PostForMe::Internal::Type::ArrayOf[enum: PostForMe::SocialAccountFeedListParams::Expand] }
+
+      # @!attribute external_post_id
+      #   Filter by Post for Me Social Postexternal ID. Multiple values imply OR logic
+      #   (e.g., ?external_post_id=xxxxxx&external_post_id=yyyyyy).
+      #
+      #   @return [Array<String>, nil]
+      optional :external_post_id, PostForMe::Internal::Type::ArrayOf[String]
+
+      # @!attribute limit
+      #   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.
+      #
+      #   @return [Float, nil]
+      optional :limit, Float
+
+      # @!attribute platform_post_id
+      #   Filter by the platform's id(s). Multiple values imply OR logic (e.g.,
+      #   ?social_post_id=spr_xxxxxx&social_post_id=spr_yyyyyy).
+      #
+      #   @return [Array<String>, nil]
+      optional :platform_post_id, PostForMe::Internal::Type::ArrayOf[String]
+
+      # @!attribute social_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).
+      #
+      #   @return [Array<String>, nil]
+      optional :social_post_id, PostForMe::Internal::Type::ArrayOf[String]
+
+      # @!method initialize(cursor: nil, expand: nil, external_post_id: nil, limit: nil, platform_post_id: nil, social_post_id: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {PostForMe::Models::SocialAccountFeedListParams} for more details.
+      #
+      #   @param cursor [String] Cursor identifying next page of results
+      #
+      #   @param expand [Array<Symbol, PostForMe::Models::SocialAccountFeedListParams::Expand>] Expand additional data in the response. Currently supports: "metrics" to include
+      #
+      #   @param external_post_id [Array<String>] Filter by Post for Me Social Postexternal ID. Multiple values imply OR logic (e.
+      #
+      #   @param limit [Float] Number of items to return; Note: some platforms will have different max limits,
+      #
+      #   @param platform_post_id [Array<String>] Filter by the platform's id(s). Multiple values imply OR logic (e.g., ?social_po
+      #
+      #   @param social_post_id [Array<String>] Filter by Post for Me Social Post id(s). Multiple values imply OR logic (e.g., ?
+      #
+      #   @param request_options [PostForMe::RequestOptions, Hash{Symbol=>Object}]
+
+      module Expand
+        extend PostForMe::Internal::Type::Enum
+
+        METRICS = :metrics
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/post_for_me/models/social_account_feed_list_response.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module PostForMe
+  module Models
+    # @see PostForMe::Resources::SocialAccountFeeds#list
+    class SocialAccountFeedListResponse < PostForMe::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Array<PostForMe::Models::PlatformPost>]
+      required :data, -> { PostForMe::Internal::Type::ArrayOf[PostForMe::PlatformPost] }
+
+      # @!attribute meta
+      #
+      #   @return [PostForMe::Models::SocialAccountFeedListResponse::Meta]
+      required :meta, -> { PostForMe::Models::SocialAccountFeedListResponse::Meta }
+
+      # @!method initialize(data:, meta:)
+      #   @param data [Array<PostForMe::Models::PlatformPost>]
+      #   @param meta [PostForMe::Models::SocialAccountFeedListResponse::Meta]
+
+      # @see PostForMe::Models::SocialAccountFeedListResponse#meta
+      class Meta < PostForMe::Internal::Type::BaseModel
+        # @!attribute cursor
+        #   Id representing the next page of items
+        #
+        #   @return [String]
+        required :cursor, String
+
+        # @!attribute limit
+        #   Maximum number of items returned.
+        #
+        #   @return [Float]
+        required :limit, Float
+
+        # @!attribute next_
+        #   URL to the next page of results, or null if none.
+        #
+        #   @return [String, nil]
+        required :next_, String, api_name: :next, nil?: true
+
+        # @!attribute has_more
+        #   Indicates if there are more results or not
+        #
+        #   @return [Boolean, nil]
+        optional :has_more, PostForMe::Internal::Type::Boolean
+
+        # @!method initialize(cursor:, limit:, next_:, has_more: nil)
+        #   @param cursor [String] Id representing the next page of items
+        #
+        #   @param limit [Float] Maximum number of items returned.
+        #
+        #   @param next_ [String, nil] URL to the next page of results, or null if none.
+        #
+        #   @param has_more [Boolean] Indicates if there are more results or not
+      end
+    end
+  end
+end