amazon-ads 0.1.0 → 0.3.0

data/lib/amazon_ads/errors.rb

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-
-# rbs_inline: enabled
-
-module AmazonAds
-  # Base error class for AmazonAds API errors
-  class Error < StandardError
-    attr_reader :response #: HTTP::Response?
-
-    #: (?String?, ?response: HTTP::Response?) -> void
-    def initialize(message = nil, response: nil)
-      @response = response
-      super(message)
-    end
-  end
-
-  # Raised when authentication fails (401 Unauthorized)
-  class AuthenticationError < Error
-  end
-
-  # Raised when rate limited (429 Too Many Requests)
-  class RateLimitError < Error
-    attr_reader :retry_after #: Integer?
-
-    #: (?String?, ?response: HTTP::Response?, ?retry_after: Integer?) -> void
-    def initialize(message = nil, response: nil, retry_after: nil)
-      @retry_after = retry_after
-      super(message, response: response)
-    end
-  end
-
-  # Raised when resource not found (404 Not Found)
-  class NotFoundError < Error
-  end
-
-  # Raised when request is invalid (400 Bad Request)
-  class BadRequestError < Error
-  end
-
-  # Raised when server error occurs (5xx)
-  class ServerError < Error
-  end
-end

data/sig/generated/amazon_ads/api.rbs

@@ -1,61 +0,0 @@
-# Generated from lib/amazon_ads/api.rb with RBS::Inline
-
-module AmazonAds
-  # Base class for Amazon Ads API clients.
-  # Handles authentication, response parsing, error mapping, and retry logic.
-  class API
-    ENDPOINTS: untyped
-
-    MAX_RETRIES: Integer
-
-    BASE_RETRY_DELAY: Integer
-
-    attr_reader region: Symbol
-
-    attr_reader profile_id: String?
-
-    # : (region: Symbol, ?access_token: String?, ?lwa: LWA?, ?profile_id: String?) -> void
-    def initialize: (region: Symbol, ?access_token: String?, ?lwa: LWA?, ?profile_id: String?) -> void
-
-    private
-
-    # Returns the current access token, refreshing via LWA if needed.
-    # : () -> String
-    def access_token: () -> String
-
-    # : () -> HTTP::Client
-    def http: () -> HTTP::Client
-
-    # : () -> Hash[String, String]
-    def default_headers: () -> Hash[String, String]
-
-    # : () -> String
-    def client_id: () -> String
-
-    # : () -> String
-    def endpoint: () -> String
-
-    # Handles HTTP response, raising appropriate errors or parsing success responses.
-    # : (HTTP::Response) -> untyped
-    def handle_response: (HTTP::Response) -> untyped
-
-    # Executes request with retry logic for rate limiting.
-    # : () { () -> HTTP::Response } -> untyped
-    def with_retry: () { () -> HTTP::Response } -> untyped
-
-    # : (String, ?params: Hash[String, untyped]) -> untyped
-    def get: (String, ?params: Hash[String, untyped]) -> untyped
-
-    # : (String, ?body: Hash[String, untyped]) -> untyped
-    def post: (String, ?body: Hash[String, untyped]) -> untyped
-
-    # : (String, ?body: Hash[String, untyped]) -> untyped
-    def put: (String, ?body: Hash[String, untyped]) -> untyped
-
-    # : (String, ?body: Hash[String, untyped]) -> untyped
-    def patch: (String, ?body: Hash[String, untyped]) -> untyped
-
-    # : (String) -> untyped
-    def delete: (String) -> untyped
-  end
-end

data/sig/generated/amazon_ads/apis/profiles.rbs

@@ -1,20 +0,0 @@
-# Generated from lib/amazon_ads/apis/profiles.rb with RBS::Inline
-
-module AmazonAds
-  # Amazon Ads API - Profiles
-  #
-  # @see https://advertising.amazon.com/API/docs/en-us/reference/profiles
-  class Profiles < API
-    # Gets a list of profiles.
-    # : (?api_program: String?, ?access_level: String?, ?profile_type_filter: String?, ?valid_payment_method_filter: String?) -> untyped
-    def list_profiles: (?api_program: String?, ?access_level: String?, ?profile_type_filter: String?, ?valid_payment_method_filter: String?) -> untyped
-
-    # Update the daily budget for one or more profiles.
-    # : (?body: Hash[String, untyped]) -> untyped
-    def update_profiles: (?body: Hash[String, untyped]) -> untyped
-
-    # Gets a profile specified by identifier.
-    # : (Integer) -> untyped
-    def get_profile_by_id: (Integer) -> untyped
-  end
-end

data/sig/generated/amazon_ads/apis/sponsored_products.rbs

@@ -1,52 +0,0 @@
-# Generated from lib/amazon_ads/apis/sponsored_products.rb with RBS::Inline
-
-module AmazonAds
-  # Amazon Ads API - Sponsored Products
-  #
-  # @see https://advertising.amazon.com/API/docs/en-us/sponsored-products
-  class SponsoredProducts < API
-    # Gets a bid recommendation for an ad group. [PLANNED DEPRECATION 3/27/2024]
-    # : (Numeric) -> untyped
-    def get_ad_group_bid_recommendations: (Numeric) -> untyped
-
-    # Gets a bid recommendation for a keyword. [PLANNED DEPRECATION 3/27/2024]
-    # : (Numeric) -> untyped
-    def get_keyword_bid_recommendations: (Numeric) -> untyped
-
-    # Gets bid recommendations for keywords. [PLANNED DEPRECATION 3/27/2024]
-    # : (?body: Hash[String, untyped]) -> untyped
-    def create_keyword_bid_recommendations: (?body: Hash[String, untyped]) -> untyped
-
-    # Gets suggested keywords for the specified ad group.
-    # : (Numeric, ?max_num_suggestions: Integer?, ?ad_state_filter: String?) -> untyped
-    def get_ad_group_suggested_keywords: (Numeric, ?max_num_suggestions: Integer?, ?ad_state_filter: String?) -> untyped
-
-    # Gets suggested keywords with extended data for the specified ad group.
-    # : (Numeric, ?max_num_suggestions: Integer?, ?suggest_bids: String?, ?ad_state_filter: String?) -> untyped
-    def get_ad_group_suggested_keywords_ex: (Numeric, ?max_num_suggestions: Integer?, ?suggest_bids: String?, ?ad_state_filter: String?) -> untyped
-
-    # Gets suggested keywords for the specified ASIN.
-    # : (String, ?max_num_suggestions: Integer?) -> untyped
-    def get_asin_suggested_keywords: (String, ?max_num_suggestions: Integer?) -> untyped
-
-    # Gets suggested keyword for a specified list of ASINs.
-    # : (?body: Hash[String, untyped]) -> untyped
-    def bulk_get_asin_suggested_keywords: (?body: Hash[String, untyped]) -> untyped
-
-    # Gets a list of bid recommendations for keyword, product, or auto targeting expressions.
-    # : (?body: Hash[String, untyped]) -> untyped
-    def get_bid_recommendations: (?body: Hash[String, untyped]) -> untyped
-
-    # Request a snapshot
-    # : (String, ?body: Hash[String, untyped]) -> untyped
-    def request_snapshot: (String, ?body: Hash[String, untyped]) -> untyped
-
-    # Get the status of a requested snapshot
-    # : (Numeric) -> untyped
-    def get_snapshot_status: (Numeric) -> untyped
-
-    # Download requested snapshot
-    # : (Numeric) -> untyped
-    def download_snapshot: (Numeric) -> untyped
-  end
-end

data/sig/generated/amazon_ads/client.rbs

@@ -1,28 +0,0 @@
-# Generated from lib/amazon_ads/client.rb with RBS::Inline
-
-module AmazonAds
-  # High-level client for Amazon Ads API.
-  # Provides convenient access to all API endpoints with automatic authentication.
-  class Client
-    attr_reader lwa: LWA
-
-    attr_reader region: Symbol
-
-    attr_reader profile_id: String?
-
-    # : (?region: Symbol, ?profile_id: String?, ?lwa: LWA?) -> void
-    def initialize: (?region: Symbol, ?profile_id: String?, ?lwa: LWA?) -> void
-
-    # Access Profiles API
-    # : () -> Profiles
-    def profiles: () -> Profiles
-
-    # Access Sponsored Products API
-    # : () -> SponsoredProducts
-    def sponsored_products: () -> SponsoredProducts
-
-    # Creates a new client with a different profile ID
-    # : (String) -> Client
-    def with_profile: (String) -> Client
-  end
-end

data/sig/generated/amazon_ads/configuration.rbs

@@ -1,24 +0,0 @@
-# Generated from lib/amazon_ads/configuration.rb with RBS::Inline
-
-module AmazonAds
-  # Configuration for the AmazonAds library.
-  # Centralizes settings for authentication and API access.
-  class Configuration
-    attr_accessor client_id: String?
-
-    attr_accessor client_secret: String?
-
-    attr_accessor refresh_token: String?
-
-    attr_accessor region: Symbol
-
-    attr_accessor profile_id: String?
-
-    # : () -> void
-    def initialize: () -> void
-
-    # Builds an LWA instance from the configuration.
-    # : () -> LWA
-    def lwa: () -> LWA
-  end
-end

data/sig/generated/amazon_ads/errors.rbs

@@ -1,35 +0,0 @@
-# Generated from lib/amazon_ads/errors.rb with RBS::Inline
-
-module AmazonAds
-  # Base error class for AmazonAds API errors
-  class Error < StandardError
-    attr_reader response: HTTP::Response?
-
-    # : (?String?, ?response: HTTP::Response?) -> void
-    def initialize: (?String?, ?response: HTTP::Response?) -> void
-  end
-
-  # Raised when authentication fails (401 Unauthorized)
-  class AuthenticationError < Error
-  end
-
-  # Raised when rate limited (429 Too Many Requests)
-  class RateLimitError < Error
-    attr_reader retry_after: Integer?
-
-    # : (?String?, ?response: HTTP::Response?, ?retry_after: Integer?) -> void
-    def initialize: (?String?, ?response: HTTP::Response?, ?retry_after: Integer?) -> void
-  end
-
-  # Raised when resource not found (404 Not Found)
-  class NotFoundError < Error
-  end
-
-  # Raised when request is invalid (400 Bad Request)
-  class BadRequestError < Error
-  end
-
-  # Raised when server error occurs (5xx)
-  class ServerError < Error
-  end
-end

data/sig/generated/amazon_ads/lwa.rbs

@@ -1,39 +0,0 @@
-# Generated from lib/amazon_ads/lwa.rb with RBS::Inline
-
-module AmazonAds
-  # Requests Login with Amazon (LWA) access tokens for the Amazon Ads API.
-  # Handles token caching and automatic refresh when tokens expire.
-  #
-  # @see https://advertising.amazon.com/API/docs/en-us/info/api-overview
-  class LWA
-    URL: String
-
-    TOKEN_EXPIRY_BUFFER: Integer
-
-    attr_reader client_id: String
-
-    attr_reader client_secret: String
-
-    attr_reader refresh_token: String
-
-    # : (?client_id: String, ?client_secret: String, ?refresh_token: String) -> void
-    def initialize: (?client_id: String, ?client_secret: String, ?refresh_token: String) -> void
-
-    # Returns a valid access token, refreshing if necessary.
-    # : () -> String
-    def access_token: () -> String
-
-    # Forces a token refresh regardless of expiry.
-    # : () -> String
-    def refresh!: () -> String
-
-    # Returns true if the token is expired or not yet fetched.
-    # : () -> bool
-    def token_expired?: () -> bool
-
-    private
-
-    # : () -> Hash[String, String]
-    def params: () -> Hash[String, String]
-  end
-end

data/sig/generated/amazon_ads.rbs

@@ -1,16 +0,0 @@
-# Generated from lib/amazon_ads.rb with RBS::Inline
-
-# Amazon Ads API client for Ruby
-module AmazonAds
-  # Returns the global configuration object.
-  # : () -> Configuration
-  def self.configuration: () -> Configuration
-
-  # Configures the AmazonAds library.
-  # : () { (Configuration) -> void } -> void
-  def self.configure: () { (Configuration) -> void } -> void
-
-  # Resets the configuration to defaults.
-  # : () -> void
-  def self.reset_configuration!: () -> void
-end