post-for-me 0.1.0.pre.alpha.3

data/lib/post_for_me/resources/media.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module PostForMe
+  module Resources
+    class Media
+      # To upload media to attach to your post, make a `POST` request to the
+      # `/media/create-upload-url` endpoint.
+      #
+      # You'll receive the public url of your media item (which can be used when making
+      # a post) and will include an `upload_url` which is a signed URL of the storage
+      # location for uploading your file to.
+      #
+      # This URL is unique and publicly signed for a short time, so make sure to upload
+      # your files in a timely manner.
+      #
+      # **Example flow using JavaScript and the Fetch API:**
+      #
+      # **Request an upload URL**
+      #
+      # ```js
+      # // Step 1: Request an upload URL from your API
+      # const response = await fetch(
+      #   "https://api.postforme.dev/v1/media/create-upload-url",
+      #   {
+      #     method: "POST",
+      #     headers: {
+      #       "Content-Type": "application/json",
+      #     },
+      #   }
+      # );
+      #
+      # const { media_url, upload_url } = await response.json();
+      # ```
+      #
+      # **Upload your file to the signed URL**
+      #
+      # ```js
+      # // Step 2: Upload your file to the signed URL
+      # const file = /* your File or Blob object, e.g., from an <input type="file"> */;
+      # await fetch(upload_url, {
+      #   method: 'PUT',
+      #   headers: {
+      #     'Content-Type': 'image/jpeg'
+      #   },
+      #   body: file
+      # });
+      # ```
+      #
+      # **Use the `media_url` when creating your post**
+      #
+      #     ```js
+      #     // Step 3: Use the `media_url` when creating your post
+      #     const response = await fetch('https://api.postforme.dev/v1/social-posts', {
+      #       method: 'POST',
+      #       headers: {
+      #         'Content-Type': 'application/json'
+      #       },
+      #       body: JSON.stringify({
+      #         social_accounts: ['spc_...', ...],
+      #         caption: 'My caption',
+      #         media: [
+      #           {
+      #             url: media_url
+      #           }
+      #         ]
+      #       })
+      #     });
+      #     ```
+      #
+      # @overload create_upload_url(request_options: {})
+      #
+      # @param request_options [PostForMe::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [PostForMe::Models::MediaCreateUploadURLResponse]
+      #
+      # @see PostForMe::Models::MediaCreateUploadURLParams
+      def create_upload_url(params = {})
+        @client.request(
+          method: :post,
+          path: "v1/media/create-upload-url",
+          model: PostForMe::Models::MediaCreateUploadURLResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [PostForMe::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/post_for_me/resources/social_accounts.rb

@@ -0,0 +1,143 @@
+# frozen_string_literal: true
+
+module PostForMe
+  module Resources
+    class SocialAccounts
+      # Get social account by ID
+      #
+      # @overload retrieve(id, request_options: {})
+      #
+      # @param id [String] Social Account ID
+      #
+      # @param request_options [PostForMe::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [PostForMe::Models::SocialAccount]
+      #
+      # @see PostForMe::Models::SocialAccountRetrieveParams
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["v1/social-accounts/%1$s", id],
+          model: PostForMe::SocialAccount,
+          options: params[:request_options]
+        )
+      end
+
+      # Update social account
+      #
+      # @overload update(id, external_id: nil, username: nil, request_options: {})
+      #
+      # @param id [String] Social Account ID
+      #
+      # @param external_id [String] The platform's external id of the social account
+      #
+      # @param username [String] The platform's username of the social account
+      #
+      # @param request_options [PostForMe::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [PostForMe::Models::SocialAccount]
+      #
+      # @see PostForMe::Models::SocialAccountUpdateParams
+      def update(id, params = {})
+        parsed, options = PostForMe::SocialAccountUpdateParams.dump_request(params)
+        @client.request(
+          method: :patch,
+          path: ["v1/social-accounts/%1$s", id],
+          body: parsed,
+          model: PostForMe::SocialAccount,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {PostForMe::Models::SocialAccountListParams} for more details.
+      #
+      # Get a paginated result for social accounts based on the applied filters
+      #
+      # @overload list(id: nil, external_id: nil, limit: nil, offset: nil, platform: nil, username: nil, request_options: {})
+      #
+      # @param id [Array<String>] Filter by id(s). Multiple values imply OR logic (e.g., ?id=spc_xxxxxx&id=spc_yyy
+      #
+      # @param external_id [Array<String>] Filter by externalId(s). Multiple values imply OR logic (e.g., ?externalId=test&
+      #
+      # @param limit [Float] Number of items to return
+      #
+      # @param offset [Float] Number of items to skip
+      #
+      # @param platform [Array<String>] Filter by platform(s). Multiple values imply OR logic (e.g., ?platform=x&platfor
+      #
+      # @param username [Array<String>] Filter by username(s). Multiple values imply OR logic (e.g., ?username=test&user
+      #
+      # @param request_options [PostForMe::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [PostForMe::Models::SocialAccountListResponse]
+      #
+      # @see PostForMe::Models::SocialAccountListParams
+      def list(params = {})
+        parsed, options = PostForMe::SocialAccountListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "v1/social-accounts",
+          query: parsed,
+          model: PostForMe::Models::SocialAccountListResponse,
+          options: options
+        )
+      end
+
+      # Generates a URL that initiates the authentication flow for a user's social media
+      # account. When visited, the user is redirected to the selected social platform's
+      # login/authorization page. Upon successful authentication, they are redirected
+      # back to your application
+      #
+      # @overload create_auth_url(platform:, platform_data: nil, request_options: {})
+      #
+      # @param platform [String] The social account provider
+      #
+      # @param platform_data [PostForMe::Models::SocialAccountCreateAuthURLParams::PlatformData] Additional data needed for the provider
+      #
+      # @param request_options [PostForMe::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [PostForMe::Models::SocialAccountCreateAuthURLResponse]
+      #
+      # @see PostForMe::Models::SocialAccountCreateAuthURLParams
+      def create_auth_url(params)
+        parsed, options = PostForMe::SocialAccountCreateAuthURLParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "v1/social-accounts/auth-url",
+          body: parsed,
+          model: PostForMe::Models::SocialAccountCreateAuthURLResponse,
+          options: options
+        )
+      end
+
+      # Disconnecting an account with remove all auth tokens and mark the account as
+      # disconnected. The record of the account will be kept and can be retrieved and
+      # reconnected by the owner of the account.
+      #
+      # @overload disconnect(id, request_options: {})
+      #
+      # @param id [String]
+      # @param request_options [PostForMe::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [PostForMe::Models::SocialAccountDisconnectResponse]
+      #
+      # @see PostForMe::Models::SocialAccountDisconnectParams
+      def disconnect(id, params = {})
+        @client.request(
+          method: :post,
+          path: ["v1/social-accounts/%1$s/disconnect", id],
+          model: PostForMe::Models::SocialAccountDisconnectResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [PostForMe::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/post_for_me/resources/social_post_results.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module PostForMe
+  module Resources
+    class SocialPostResults
+      # Get post result by ID
+      #
+      # @overload retrieve(id, request_options: {})
+      #
+      # @param id [String] Post Result ID
+      #
+      # @param request_options [PostForMe::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [PostForMe::Models::SocialPostResult]
+      #
+      # @see PostForMe::Models::SocialPostResultRetrieveParams
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["v1/social-post-results/%1$s", id],
+          model: PostForMe::SocialPostResult,
+          options: params[:request_options]
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {PostForMe::Models::SocialPostResultListParams} for more details.
+      #
+      # Get a paginated result for post results based on the applied filters
+      #
+      # @overload list(limit: nil, offset: nil, platform: nil, post_id: nil, request_options: {})
+      #
+      # @param limit [Float] Number of items to return
+      #
+      # @param offset [Float] Number of items to skip
+      #
+      # @param platform [Array<String>] Filter by platform(s). Multiple values imply OR logic (e.g., ?platform=x&platfor
+      #
+      # @param post_id [Array<String>] Filter by post IDs. Multiple values imply OR logic (e.g., ?post_id=123&post_id=4
+      #
+      # @param request_options [PostForMe::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [PostForMe::Models::SocialPostResultListResponse]
+      #
+      # @see PostForMe::Models::SocialPostResultListParams
+      def list(params = {})
+        parsed, options = PostForMe::SocialPostResultListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "v1/social-post-results",
+          query: parsed,
+          model: PostForMe::Models::SocialPostResultListResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [PostForMe::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/post_for_me/resources/social_posts.rb

@@ -0,0 +1,164 @@
+# frozen_string_literal: true
+
+module PostForMe
+  module Resources
+    class SocialPosts
+      # Some parameter documentations has been truncated, see
+      # {PostForMe::Models::SocialPostCreateParams} for more details.
+      #
+      # Create Post
+      #
+      # @overload create(caption:, social_accounts:, account_configurations: nil, external_id: nil, is_draft: nil, media: nil, platform_configurations: nil, scheduled_at: nil, request_options: {})
+      #
+      # @param caption [String] Caption text for the post
+      #
+      # @param social_accounts [Array<String>] Array of social account IDs for posting
+      #
+      # @param account_configurations [Array<PostForMe::Models::CreateSocialPost::AccountConfiguration>, nil] Account-specific configurations for the post
+      #
+      # @param external_id [String, nil] Array of social account IDs for posting
+      #
+      # @param is_draft [Boolean, nil] If isDraft is set then the post will not be processed
+      #
+      # @param media [Array<PostForMe::Models::CreateSocialPost::Media>, nil] Array of media URLs associated with the post
+      #
+      # @param platform_configurations [PostForMe::Models::CreateSocialPost::PlatformConfigurations, nil] Platform-specific configurations for the post
+      #
+      # @param scheduled_at [Time, nil] Scheduled date and time for the post, setting to null or undefined will post ins
+      #
+      # @param request_options [PostForMe::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [PostForMe::Models::SocialPost]
+      #
+      # @see PostForMe::Models::SocialPostCreateParams
+      def create(params)
+        parsed, options = PostForMe::SocialPostCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "v1/social-posts",
+          body: parsed,
+          model: PostForMe::SocialPost,
+          options: options
+        )
+      end
+
+      # Get Post by ID
+      #
+      # @overload retrieve(id, request_options: {})
+      #
+      # @param id [String] Post ID
+      #
+      # @param request_options [PostForMe::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [PostForMe::Models::SocialPost]
+      #
+      # @see PostForMe::Models::SocialPostRetrieveParams
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["v1/social-posts/%1$s", id],
+          model: PostForMe::SocialPost,
+          options: params[:request_options]
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {PostForMe::Models::SocialPostUpdateParams} for more details.
+      #
+      # Update Post
+      #
+      # @overload update(id, caption:, social_accounts:, account_configurations: nil, external_id: nil, is_draft: nil, media: nil, platform_configurations: nil, scheduled_at: nil, request_options: {})
+      #
+      # @param id [String] Post ID
+      #
+      # @param caption [String] Caption text for the post
+      #
+      # @param social_accounts [Array<String>] Array of social account IDs for posting
+      #
+      # @param account_configurations [Array<PostForMe::Models::CreateSocialPost::AccountConfiguration>, nil] Account-specific configurations for the post
+      #
+      # @param external_id [String, nil] Array of social account IDs for posting
+      #
+      # @param is_draft [Boolean, nil] If isDraft is set then the post will not be processed
+      #
+      # @param media [Array<PostForMe::Models::CreateSocialPost::Media>, nil] Array of media URLs associated with the post
+      #
+      # @param platform_configurations [PostForMe::Models::CreateSocialPost::PlatformConfigurations, nil] Platform-specific configurations for the post
+      #
+      # @param scheduled_at [Time, nil] Scheduled date and time for the post, setting to null or undefined will post ins
+      #
+      # @param request_options [PostForMe::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [PostForMe::Models::SocialPost]
+      #
+      # @see PostForMe::Models::SocialPostUpdateParams
+      def update(id, params)
+        parsed, options = PostForMe::SocialPostUpdateParams.dump_request(params)
+        @client.request(
+          method: :put,
+          path: ["v1/social-posts/%1$s", id],
+          body: parsed,
+          model: PostForMe::SocialPost,
+          options: options
+        )
+      end
+
+      # Get a paginated result for posts based on the applied filters
+      #
+      # @overload list(external_id: nil, limit: nil, offset: nil, platform: nil, status: nil, request_options: {})
+      #
+      # @param external_id [Array<String>] Filter by external ID. Multiple values imply OR logic.
+      #
+      # @param limit [Float] Number of items to return
+      #
+      # @param offset [Float] Number of items to skip
+      #
+      # @param platform [Array<Symbol, PostForMe::Models::SocialPostListParams::Platform>] Filter by platforms. Multiple values imply OR logic.
+      #
+      # @param status [Array<Symbol, PostForMe::Models::SocialPostListParams::Status>] Filter by post status. Multiple values imply OR logic.
+      #
+      # @param request_options [PostForMe::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [PostForMe::Models::SocialPostListResponse]
+      #
+      # @see PostForMe::Models::SocialPostListParams
+      def list(params = {})
+        parsed, options = PostForMe::SocialPostListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "v1/social-posts",
+          query: parsed,
+          model: PostForMe::Models::SocialPostListResponse,
+          options: options
+        )
+      end
+
+      # Delete Post
+      #
+      # @overload delete(id, request_options: {})
+      #
+      # @param id [String] Post ID
+      #
+      # @param request_options [PostForMe::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [PostForMe::Models::SocialPostDeleteResponse]
+      #
+      # @see PostForMe::Models::SocialPostDeleteParams
+      def delete(id, params = {})
+        @client.request(
+          method: :delete,
+          path: ["v1/social-posts/%1$s", id],
+          model: PostForMe::Models::SocialPostDeleteResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [PostForMe::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/post_for_me/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module PostForMe
+  VERSION = "0.1.0.pre.alpha.3"
+end

data/lib/post_for_me.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+# Standard libraries.
+# rubocop:disable Lint/RedundantRequireStatement
+require "English"
+require "cgi"
+require "date"
+require "erb"
+require "etc"
+require "json"
+require "net/http"
+require "pathname"
+require "rbconfig"
+require "securerandom"
+require "set"
+require "stringio"
+require "time"
+require "uri"
+# rubocop:enable Lint/RedundantRequireStatement
+
+# We already ship the preferred sorbet manifests in the package itself.
+# `tapioca` currently does not offer us a way to opt out of unnecessary compilation.
+if Object.const_defined?(:Tapioca) &&
+   caller.chain([$PROGRAM_NAME]).chain(ARGV).any?(/tapioca/) &&
+   ARGV.none?(/dsl/)
+  return
+end
+
+# Gems.
+require "connection_pool"
+
+# Package files.
+require_relative "post_for_me/version"
+require_relative "post_for_me/internal/util"
+require_relative "post_for_me/internal/type/converter"
+require_relative "post_for_me/internal/type/unknown"
+require_relative "post_for_me/internal/type/boolean"
+require_relative "post_for_me/internal/type/file_input"
+require_relative "post_for_me/internal/type/enum"
+require_relative "post_for_me/internal/type/union"
+require_relative "post_for_me/internal/type/array_of"
+require_relative "post_for_me/internal/type/hash_of"
+require_relative "post_for_me/internal/type/base_model"
+require_relative "post_for_me/internal/type/base_page"
+require_relative "post_for_me/internal/type/request_parameters"
+require_relative "post_for_me/internal"
+require_relative "post_for_me/request_options"
+require_relative "post_for_me/file_part"
+require_relative "post_for_me/errors"
+require_relative "post_for_me/internal/transport/base_client"
+require_relative "post_for_me/internal/transport/pooled_net_requester"
+require_relative "post_for_me/client"
+require_relative "post_for_me/models/create_social_post"
+require_relative "post_for_me/models/media_create_upload_url_params"
+require_relative "post_for_me/models/media_create_upload_url_response"
+require_relative "post_for_me/models/social_account"
+require_relative "post_for_me/models/social_account_create_auth_url_params"
+require_relative "post_for_me/models/social_account_create_auth_url_response"
+require_relative "post_for_me/models/social_account_disconnect_params"
+require_relative "post_for_me/models/social_account_disconnect_response"
+require_relative "post_for_me/models/social_account_list_params"
+require_relative "post_for_me/models/social_account_list_response"
+require_relative "post_for_me/models/social_account_retrieve_params"
+require_relative "post_for_me/models/social_account_update_params"
+require_relative "post_for_me/models/social_post"
+require_relative "post_for_me/models/social_post_create_params"
+require_relative "post_for_me/models/social_post_delete_params"
+require_relative "post_for_me/models/social_post_delete_response"
+require_relative "post_for_me/models/social_post_list_params"
+require_relative "post_for_me/models/social_post_list_response"
+require_relative "post_for_me/models/social_post_result"
+require_relative "post_for_me/models/social_post_result_list_params"
+require_relative "post_for_me/models/social_post_result_list_response"
+require_relative "post_for_me/models/social_post_result_retrieve_params"
+require_relative "post_for_me/models/social_post_retrieve_params"
+require_relative "post_for_me/models/social_post_update_params"
+require_relative "post_for_me/models/tiktok_configuration"
+require_relative "post_for_me/models"
+require_relative "post_for_me/resources/media"
+require_relative "post_for_me/resources/social_accounts"
+require_relative "post_for_me/resources/social_post_results"
+require_relative "post_for_me/resources/social_posts"

data/manifest.yaml

@@ -0,0 +1,15 @@
+dependencies:
+  - English
+  - cgi
+  - date
+  - erb
+  - etc
+  - json
+  - net/http
+  - pathname
+  - rbconfig
+  - securerandom
+  - set
+  - stringio
+  - time
+  - uri

data/rbi/post_for_me/client.rbi

@@ -0,0 +1,58 @@
+# typed: strong
+
+module PostForMe
+  class Client < PostForMe::Internal::Transport::BaseClient
+    DEFAULT_MAX_RETRIES = 2
+
+    DEFAULT_TIMEOUT_IN_SECONDS = T.let(60.0, Float)
+
+    DEFAULT_INITIAL_RETRY_DELAY = T.let(0.5, Float)
+
+    DEFAULT_MAX_RETRY_DELAY = T.let(8.0, Float)
+
+    sig { returns(String) }
+    attr_reader :api_key
+
+    sig { returns(PostForMe::Resources::Media) }
+    attr_reader :media
+
+    sig { returns(PostForMe::Resources::SocialPosts) }
+    attr_reader :social_posts
+
+    sig { returns(PostForMe::Resources::SocialPostResults) }
+    attr_reader :social_post_results
+
+    sig { returns(PostForMe::Resources::SocialAccounts) }
+    attr_reader :social_accounts
+
+    # @api private
+    sig { override.returns(T::Hash[String, String]) }
+    private def auth_headers
+    end
+
+    # Creates and returns a new client for interacting with the API.
+    sig do
+      params(
+        api_key: T.nilable(String),
+        base_url: T.nilable(String),
+        max_retries: Integer,
+        timeout: Float,
+        initial_retry_delay: Float,
+        max_retry_delay: Float
+      ).returns(T.attached_class)
+    end
+    def self.new(
+      # Defaults to `ENV["POST_FOR_ME_API_KEY"]`
+      api_key: ENV["POST_FOR_ME_API_KEY"],
+      # Override the default base URL for the API, e.g.,
+      # `"https://api.example.com/v2/"`. Defaults to `ENV["POST_FOR_ME_BASE_URL"]`
+      base_url: ENV["POST_FOR_ME_BASE_URL"],
+      # Max number of retries to attempt after a failed retryable request.
+      max_retries: PostForMe::Client::DEFAULT_MAX_RETRIES,
+      timeout: PostForMe::Client::DEFAULT_TIMEOUT_IN_SECONDS,
+      initial_retry_delay: PostForMe::Client::DEFAULT_INITIAL_RETRY_DELAY,
+      max_retry_delay: PostForMe::Client::DEFAULT_MAX_RETRY_DELAY
+    )
+    end
+  end
+end