twitter-ads 1.1.0 → 2.0.0

data/lib/twitter-ads/creative/image_conversation_card.rb

@@ -12,26 +12,34 @@ module TwitterAds
 
       attr_reader :account
 
+      property :card_type, read_only: true
+      property :card_uri, read_only: true
+      property :created_at, type: :time, read_only: true
+      property :deleted, type: :bool, read_only: true
       property :id, read_only: true
-      property :preview_url, read_only: true
       property :image, read_only: true
-      property :deleted, type: :bool, read_only: true
-      property :created_at, type: :time, read_only: true
+      property :preview_url, read_only: true
       property :updated_at, type: :time, read_only: true
 
-      property :name
-      property :title
+      property :cover_image_id
       property :first_cta
       property :first_cta_tweet
+      property :fourth_cta
+      property :fourth_cta_tweet
+      property :image_media_id
+      property :name
       property :second_cta
       property :second_cta_tweet
       property :thank_you_text
       property :thank_you_url
-      property :image_media_id
+      property :third_cta
+      property :third_cta_tweet
+      property :title
 
-      RESOURCE_COLLECTION =
-        '/1/accounts/%{account_id}/cards/image_conversation'.freeze # @api private
-      RESOURCE = '/1/accounts/%{account_id}/cards/image_conversation/%{id}'.freeze # @api private
+      RESOURCE_COLLECTION = "/#{TwitterAds::API_VERSION}/" +
+                            'accounts/%{account_id}/cards/image_conversation'.freeze # @api private
+      RESOURCE = "/#{TwitterAds::API_VERSION}/" +
+                 'accounts/%{account_id}/cards/image_conversation/%{id}'.freeze # @api private
 
       def initialize(account)
         @account = account

data/lib/twitter-ads/creative/media_creative.rb

@@ -12,19 +12,21 @@ module TwitterAds
 
       attr_reader :account
 
-      property :id, read_only: true
-      property :deleted, type: :bool, read_only: true
-      property :created_at, type: :time, read_only: true
-      property :updated_at, type: :time, read_only: true
       property :approval_status, read_only: true
+      property :created_at, type: :time, read_only: true
+      property :deleted, type: :bool, read_only: true
+      property :id, read_only: true
       property :serving_status, read_only: true
+      property :updated_at, type: :time, read_only: true
 
-      property :line_item_id
       property :account_media_id
+      property :line_item_id
       property :landing_url
 
-      RESOURCE_COLLECTION = '/1/accounts/%{account_id}/media_creatives'.freeze # @api private
-      RESOURCE = '/1/accounts/%{account_id}/media_creatives/%{id}'.freeze # @api private
+      RESOURCE_COLLECTION = "/#{TwitterAds::API_VERSION}/" +
+                            'accounts/%{account_id}/media_creatives'.freeze # @api private
+      RESOURCE            = "/#{TwitterAds::API_VERSION}/" +
+                            'accounts/%{account_id}/media_creatives/%{id}'.freeze # @api private
 
       def initialize(account)
         @account = account

data/lib/twitter-ads/creative/promoted_account.rb

@@ -23,10 +23,14 @@ module TwitterAds
       property :user_id
       property :paused, type: :bool
 
-      RESOURCE_COLLECTION = '/1/accounts/%{account_id}/promoted_accounts'.freeze # @api private
-      RESOURCE_STATS = '/1/stats/accounts/%{account_id}'.freeze # @api private
-      RESOURCE_ASYNC_STATS = '/1/stats/jobs/accounts/%{account_id}'.freeze # @api private
-      RESOURCE = '/1/accounts/%{account_id}/promoted_accounts/%{id}'.freeze # @api private
+      RESOURCE_COLLECTION  = "/#{TwitterAds::API_VERSION}/" +
+                             'accounts/%{account_id}/promoted_accounts'.freeze # @api private
+      RESOURCE_STATS       = "/#{TwitterAds::API_VERSION}/" +
+                             'stats/accounts/%{account_id}'.freeze # @api private
+      RESOURCE_ASYNC_STATS = "/#{TwitterAds::API_VERSION}/" +
+                             'stats/jobs/accounts/%{account_id}'.freeze # @api private
+      RESOURCE             = "/#{TwitterAds::API_VERSION}/" +
+                             'accounts/%{account_id}/promoted_accounts/%{id}'.freeze # @api private
 
       def initialize(account)
         @account = account

data/lib/twitter-ads/creative/promoted_tweet.rb

@@ -18,15 +18,19 @@ module TwitterAds
       property :created_at, type: :time, read_only: true
       property :updated_at, type: :time, read_only: true
       property :deleted, type: :bool, read_only: true
+      property :entity_status, read_only: true
 
       property :line_item_id
       property :tweet_id
-      property :paused, type: :bool
 
-      RESOURCE_COLLECTION = '/1/accounts/%{account_id}/promoted_tweets'.freeze # @api private
-      RESOURCE_STATS      = '/1/stats/accounts/%{account_id}'.freeze # @api private
-      RESOURCE_ASYNC_STATS = '/1/stats/jobs/accounts/%{account_id}'.freeze # @api private
-      RESOURCE = '/1/accounts/%{account_id}/promoted_tweets/%{id}'.freeze # @api private
+      RESOURCE_COLLECTION  = "/#{TwitterAds::API_VERSION}/" +
+                             'accounts/%{account_id}/promoted_tweets'.freeze # @api private
+      RESOURCE_STATS       = "/#{TwitterAds::API_VERSION}/" +
+                             'stats/accounts/%{account_id}'.freeze # @api private
+      RESOURCE_ASYNC_STATS = "/#{TwitterAds::API_VERSION}/" +
+                             'stats/jobs/accounts/%{account_id}'.freeze # @api private
+      RESOURCE             = "/#{TwitterAds::API_VERSION}/" +
+                             'accounts/%{account_id}/promoted_tweets/%{id}'.freeze # @api private
 
       def initialize(account)
         @account = account
@@ -52,9 +56,7 @@ module TwitterAds
         params[:tweet_ids] = *params.delete(:tweet_id) if params.key?(:tweet_id)
 
         if @id
-          resource = self.class::RESOURCE % { account_id: account.id, id: id }
-          response = Request.new(account.client, :put, resource, params: params).perform
-          from_response(response.body[:data])
+          raise TwitterAds::NotFound.new(nil, 'Method PUT not allowed.', 404)
         else
           resource = self.class::RESOURCE_COLLECTION % { account_id: account.id }
           response = Request.new(account.client, :post, resource, params: params).perform

data/lib/twitter-ads/creative/scheduled_tweet.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+# Copyright (C) 2015 Twitter, Inc.
+
+module TwitterAds
+  module Creative
+
+    class ScheduledTweet
+
+      include TwitterAds::DSL
+      include TwitterAds::Resource
+      include TwitterAds::Persistence
+
+      attr_reader :account
+
+      # read-only
+      property :completed_at, type: :time, read_only: true
+      property :created_at, type: :time, read_only: true
+      property :id, read_only: true
+      property :id_str, read_only: true
+      property :media_keys, read_only: true
+      property :scheduled_status, read_only: true
+      property :tweet_id, read_only: true
+      property :updated_at, type: :time, read_only: true
+      property :user_id, read_only: true
+
+      # writable
+      property :as_user_id
+      property :card_uri
+      property :media_ids
+      property :nullcast, type: :bool
+      property :scheduled_at, type: :time
+      property :text
+
+      RESOURCE_COLLECTION = "/#{TwitterAds::API_VERSION}/" +
+                            'accounts/%{account_id}/scheduled_tweets'.freeze # @api private
+      RESOURCE = "/#{TwitterAds::API_VERSION}/" +
+                 'accounts/%{account_id}/scheduled_tweets/%{id}'.freeze # @api private
+      PREVIEW  = "/#{TwitterAds::API_VERSION}/" +
+                 'accounts/%{account_id}/scheduled_tweets/preview/%{id}'.freeze # @api private
+
+      def preview(account, opts = {})
+        if @id
+          resource = self.class::PREVIEW % { account_id: account.id, id: id }
+          response = TwitterAds::Request.new(account.client, :get, resource, params: opts).perform
+          response.body[:data]
+        end
+      end
+
+      def initialize(account)
+        @account = account
+        self
+      end
+
+    end
+
+  end
+end

data/lib/twitter-ads/creative/video.rb

@@ -12,22 +12,28 @@ module TwitterAds
 
       attr_reader :account
 
+      property :aspect_ratio, read_only: true
+      property :created_at, type: :time, read_only: true
+      property :deleted, type: :bool, read_only: true
+      property :duration, read_only: true
       property :id, read_only: true
-      property :tweeted, type: :bool, read_only: true
+      property :media_key, read_only: true
+      property :poster_url, read_only: true
+      property :preview_url, read_only: true
       property :ready_to_tweet, type: :bool, read_only: true
-      property :duration, read_only: true
       property :reasons_not_servable, read_only: true
-      property :preview_url, read_only: true
-      property :created_at, type: :time, read_only: true
+      property :tweeted, type: :bool, read_only: true
       property :updated_at, type: :time, read_only: true
-      property :deleted, type: :bool, read_only: true
 
-      property :title
       property :description
+      property :poster_image_media_id
+      property :title
       property :video_media_id
 
-      RESOURCE_COLLECTION = '/1/accounts/%{account_id}/videos'.freeze # @api private
-      RESOURCE            = '/1/accounts/%{account_id}/videos/%{id}'.freeze # @api private
+      RESOURCE_COLLECTION = "/#{TwitterAds::API_VERSION}/" +
+                            'accounts/%{account_id}/videos'.freeze # @api private
+      RESOURCE            = "/#{TwitterAds::API_VERSION}/" +
+                            'accounts/%{account_id}/videos/%{id}'.freeze # @api private
 
       def initialize(account)
         @account = account

data/lib/twitter-ads/creative/video_app_download_card.rb

@@ -12,29 +12,35 @@ module TwitterAds
 
       attr_reader :account
 
+      property :card_type, read_only: true
+      property :card_uri, read_only: true
+      property :created_at, type: :time, read_only: true
+      property :deleted, type: :bool, read_only: true
       property :id, read_only: true
       property :preview_url, read_only: true
-      property :video_url, read_only: true
-      property :video_poster_url, read_only: true
-      property :deleted, type: :bool, read_only: true
-      property :created_at, type: :time, read_only: true
       property :updated_at, type: :time, read_only: true
+      property :video_content_id, read_only: true
+      property :video_hls_url, read_only: true
+      property :video_owner_id, read_only: true
+      property :video_poster_url, read_only: true
+      property :video_url, read_only: true
 
-      property :name
       property :app_country_code
-      property :iphone_app_id
-      property :iphone_deep_link
+      property :app_cta
+      property :image_media_id
       property :ipad_app_id
       property :ipad_deep_link
+      property :iphone_app_id
+      property :iphone_deep_link
       property :googleplay_app_id
       property :googleplay_deep_link
-      property :app_cta
-      property :image_media_id
+      property :name
       property :video_id
 
-      RESOURCE_COLLECTION =
-        '/1/accounts/%{account_id}/cards/video_app_download'.freeze # @api private
-      RESOURCE = '/1/accounts/%{account_id}/cards/video_app_download/%{id}'.freeze # @api private
+      RESOURCE_COLLECTION = "/#{TwitterAds::API_VERSION}/" +
+                            'accounts/%{account_id}/cards/video_app_download'.freeze # @api private
+      RESOURCE = "/#{TwitterAds::API_VERSION}/" +
+                 'accounts/%{account_id}/cards/video_app_download/%{id}'.freeze # @api private
 
       def initialize(account)
         @account = account

data/lib/twitter-ads/creative/video_conversation_card.rb

@@ -12,28 +12,37 @@ module TwitterAds
 
       attr_reader :account
 
+      property :card_type, read_only: true
+      property :card_uri, read_only: true
+      property :created_at, type: :time, read_only: true
+      property :deleted, type: :bool, read_only: true
       property :id, read_only: true
       property :preview_url, read_only: true
+      property :updated_at, type: :time, read_only: true
       property :video_url, read_only: true
       property :video_poster_url, read_only: true
-      property :deleted, type: :bool, read_only: true
-      property :created_at, type: :time, read_only: true
-      property :updated_at, type: :time, read_only: true
 
-      property :name
-      property :title
+      property :cover_image_id
+      property :cover_video_id
+      property :fourth_cta
+      property :fourth_cta_tweet
+      property :image_media_id
       property :first_cta
       property :first_cta_tweet
+      property :name
       property :second_cta
       property :second_cta_tweet
       property :thank_you_text
       property :thank_you_url
-      property :image_media_id
+      property :third_cta
+      property :third_cta_tweet
+      property :title
       property :video_id
 
-      RESOURCE_COLLECTION =
-        '/1/accounts/%{account_id}/cards/video_conversation'.freeze # @api private
-      RESOURCE = '/1/accounts/%{account_id}/cards/video_conversation/%{id}'.freeze # @api private
+      RESOURCE_COLLECTION = "/#{TwitterAds::API_VERSION}/" +
+                            'accounts/%{account_id}/cards/video_conversation'.freeze # @api private
+      RESOURCE = "/#{TwitterAds::API_VERSION}/" +
+                 'accounts/%{account_id}/cards/video_conversation/%{id}'.freeze # @api private
 
       def initialize(account)
         @account = account

data/lib/twitter-ads/creative/video_website_card.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+# Copyright (C) 2015 Twitter, Inc.
+
+module TwitterAds
+  module Creative
+
+    class VideoWebsiteCard
+
+      include TwitterAds::DSL
+      include TwitterAds::Resource
+      include TwitterAds::Persistence
+
+      attr_reader :account
+
+      property :account_id, read_only: true
+      property :card_type, read_only: true
+      property :card_uri, read_only: true
+      property :created_at, type: :time, read_only: true
+      property :deleted, type: :bool, read_only: true
+      property :id, read_only: true
+      property :preview_url, read_only: true
+      property :updated_at, type: :time, read_only: true
+      property :video_content_id, read_only: true
+      property :video_height, read_only: true
+      property :video_hls_url, read_only: true
+      property :video_owner_id, read_only: true
+      property :video_poster_height, read_only: true
+      property :video_poster_url, read_only: true
+      property :video_poster_width, read_only: true
+      property :video_url, read_only: true
+      property :video_width, read_only: true
+      property :website_display_url, read_only: true
+      property :website_dest_url, read_only: true
+
+      property :name
+      property :title
+      property :video_id
+      property :website_url
+
+      RESOURCE_COLLECTION = "/#{TwitterAds::API_VERSION}/accounts/%{account_id}/cards/video_website"
+                            .freeze # @api private
+      RESOURCE = "/#{TwitterAds::API_VERSION}/" +
+                 'accounts/%{account_id}/cards/video_website/%{id}'.freeze # @api private
+
+      def initialize(account)
+        @account = account
+        self
+      end
+
+    end
+
+  end
+end

data/lib/twitter-ads/creative/website_card.rb

@@ -12,36 +12,34 @@ module TwitterAds
 
       attr_reader :account
 
+      property :card_type, read_only: true
+      property :card_uri, read_only: true
+      property :created_at, type: :time, read_only: true
+      property :deleted, type: :bool, read_only: true
       property :id, read_only: true
+      property :image, read_only: true
+      property :image_display_height, read_only: true
+      property :image_display_width, read_only: true
       property :preview_url, read_only: true
-      property :deleted, type: :bool, read_only: true
-      property :created_at, type: :time, read_only: true
       property :updated_at, type: :time, read_only: true
+      property :website_dest_url, read_only: true
+      property :website_display_url, read_only: true
 
+      property :image_media_id
       property :name
       property :website_title
       property :website_url
-      # @return [String] An enum value for the call-to-action prompt.
-      # @deprecated Please see https://t.co/deprecated-website-card-cta for more info.
-      property :website_cta
-      property :image_media_id
 
-      RESOURCE_COLLECTION = '/1/accounts/%{account_id}/cards/website'.freeze # @api private
-      RESOURCE            = '/1/accounts/%{account_id}/cards/website/%{id}'.freeze # @api private
+      RESOURCE_COLLECTION = "/#{TwitterAds::API_VERSION}/accounts/%{account_id}/cards/website"
+                            .freeze # @api private
+      RESOURCE            = "/#{TwitterAds::API_VERSION}/accounts/%{account_id}/cards/website/%{id}"
+                            .freeze # @api private
 
       def initialize(account)
         @account = account
         self
       end
 
-      # Overload for CTA deprecation warning.
-      # @private
-      def website_cta=(value)
-        TwitterAds::Utils.deprecated(
-          "#{self.class}#website_cta", refer: 'https://t.co/deprecated-website-card-cta')
-        @website_cta = value
-      end
-
     end
 
   end

data/lib/twitter-ads/enum.rb

@@ -110,9 +110,22 @@ module TwitterAds
       ORGANIC_TWEET      = 'ORGANIC_TWEET'.freeze
     end
 
+    module EntityStatus
+      ACTIVE = 'ACTIVE'.freeze
+      DRAFT  = 'DRAFT'.freeze
+      PAUSED = 'PAUSED'.freeze
+    end
+
     module CreativeType
-      BANNER       = 'BANNER'.freeze
-      INTERSTITIAL = 'INTERSTITIAL'.freeze
+      BANNER                        = 'BANNER'.freeze
+      INTERSTITIAL                  = 'INTERSTITIAL'.freeze
+      PREROLL                       = 'PREROLL'.freeze
+      VAST_PREROLL                  = 'VAST_PREROLL'.freeze
+      MEDIUM_RECTANGLE              = 'MEDIUM_RECTANGLE'.freeze
+      BANNER_TABLET                 = 'BANNER_TABLET'.freeze
+      INTERSTITIAL_LANDSCAPE        = 'INTERSTITIAL_LANDSCAPE'.freeze
+      INTERSTITIAL_TABLET           = 'INTERSTITIAL_TABLET'.freeze
+      INTERSTITIAL_LANDSCAPE_TABLET = 'INTERSTITIAL_LANDSCAPE_TABLET'.freeze
     end
 
     module Optimizations
@@ -127,20 +140,26 @@ module TwitterAds
     end
 
     module AgeBucket
-      AGE_13_TO_17 = 'AGE_13_TO_17'.freeze
-      AGE_18_TO_24 = 'AGE_18_TO_24'.freeze
-      AGE_25_TO_34 = 'AGE_25_TO_34'.freeze
-      AGE_35_TO_44 = 'AGE_35_TO_44'.freeze
-      AGE_45_TO_54 = 'AGE_45_TO_54'.freeze
-      AGE_55_TO_64 = 'AGE_55_TO_64'.freeze
-      AGE_OVER_65  = 'AGE_OVER_65'.freeze
-    end
-
-    module AgeBucketCoarse
+      AGE_13_TO_24 = 'AGE_13_TO_24'.freeze
+      AGE_13_TO_34 = 'AGE_13_TO_34'.freeze
+      AGE_13_TO_49 = 'AGE_13_TO_49'.freeze
+      AGE_13_TO_54 = 'AGE_13_TO_54'.freeze
+      AGE_OVER_13  = 'AGE_OVER_13'.freeze
       AGE_18_TO_34 = 'AGE_18_TO_34'.freeze
       AGE_18_TO_49 = 'AGE_18_TO_49'.freeze
-      AGE_25_TO_54 = 'AGE_25_TO_54'.freeze
+      AGE_18_TO_54 = 'AGE_18_TO_54'.freeze
+      AGE_OVER_18  = 'AGE_OVER_18'.freeze
+      AGE_21_TO_34 = 'AGE_21_TO_34'.freeze
+      AGE_21_TO_49 = 'AGE_21_TO_49'.freeze
+      AGE_21_TO_54 = 'AGE_21_TO_54'.freeze
       AGE_OVER_21  = 'AGE_OVER_21'.freeze
+      AGE_25_TO_49 = 'AGE_25_TO_49'.freeze
+      AGE_25_TO_54 = 'AGE_25_TO_54'.freeze
+      AGE_OVER_25  = 'AGE_OVER_25'.freeze
+      AGE_35_TO_49 = 'AGE_35_TO_49'.freeze
+      AGE_35_TO_54 = 'AGE_35_TO_54'.freeze
+      AGE_OVER_35  = 'AGE_OVER_35'.freeze
+      AGE_OVER_50  = 'AGE_OVER_50'.freeze
     end
 
     module Events