twitter-ads 3.0.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c478e42cfbc201c9d7b1398f4839d3c7ed371516
-  data.tar.gz: 8d095aa46a24e63d4d82d458b3c212374e8af751
+  metadata.gz: 6fb4befdf5ee2d5b88722ae972166970cf2595b6
+  data.tar.gz: 8665ca5d969a1a03f13a8c0dcf57719a1523936a
 SHA512:
-  metadata.gz: a1580a6a6ced69b6697cff139584e179a0d2922aab01d655e836f085f5de8723b93fe57f7d831217493b0108413ff7bebe7c963772e3064115a7e3289e6a97e7
-  data.tar.gz: 77cc29877f848a55e04459c73ca8041769b1ce6043c499e1c2ea6fce5f13d8b48beb319c90e8867a9d696fc3954cbd3053e1c25898c11158a899e8dbf3eaa534
+  metadata.gz: 795e91e3a932600ed0d67c52b74006e8f08819464d51d1a968af96e31c4dbbeb37ccca49e0fcf98014e47fe2ba850f900e855c8fa3dd1dcd618e24cb3aaa7e43
+  data.tar.gz: 369d6ec2a92a433f591b1ed3482a85ff51a4294ab3cfa6be7792a5540b6d93088de737bcbc1f392caaec2bee1c4385b955faf02262835005dd417d17c833ea2f

data/lib/twitter-ads.rb

@@ -69,7 +69,6 @@ require 'twitter-ads/creative/video_app_download_card'
 require 'twitter-ads/creative/video_conversation_card'
 require 'twitter-ads/creative/video_website_card'
 require 'twitter-ads/creative/website_card'
-require 'twitter-ads/creative/video'
 require 'twitter-ads/creative/poll_cards'
 
 require 'twitter-ads/targeting/reach_estimate'
@@ -77,4 +76,7 @@ require 'twitter-ads/targeting/reach_estimate'
 require 'twitter-ads/measurement/web_event_tag'
 require 'twitter-ads/measurement/app_event_tag'
 
+require 'twitter-ads/settings/user'
+require 'twitter-ads/settings/tax'
+
 require 'twitter-ads/legacy.rb'

data/lib/twitter-ads/account.rb

@@ -208,20 +208,6 @@ module TwitterAds
       load_resource(TailoredAudience, id, opts)
     end
 
-    # Returns a collection of videos available to the current account.
-    #
-    # @param id [String] The Video ID value.
-    # @param opts [Hash] A Hash of extended options.
-    # @option opts [Boolean] :with_deleted Indicates if deleted items should be included.
-    # @option opts [String] :sort_by The object param to sort the API response by.
-    #
-    # @since 0.3.0
-    #
-    # @return A Cursor or object instance.
-    def videos(id = nil, opts = {})
-      load_resource(Video, id, opts)
-    end
-
     # Returns the most recent promotable Tweets created by one or more specified Twitter users.
     #
     # @param ids [Array] An Array of Twitter user IDs.

data/lib/twitter-ads/audiences/tailored_audience.rb

@@ -33,6 +33,9 @@ module TwitterAds
                            'accounts/%{account_id}/tailored_audience_changes'.freeze # @api private
     RESOURCE_MEMBERSHIPS = "/#{TwitterAds::API_VERSION}/" +
                            'tailored_audience_memberships'.freeze # @api private
+    RESOURCE_USERS       = "/#{TwitterAds::API_VERSION}/ \
+                           accounts/%{account_id}/tailored_audiences/ \
+                           %{id}/users".freeze # @api private
     # @api private
     GLOBAL_OPT_OUT = "/#{TwitterAds::API_VERSION}/" +
                      'accounts/%{account_id}/tailored_audiences/global_opt_out'.freeze
@@ -86,6 +89,25 @@ module TwitterAds
         end
       end
 
+      # Creates a new tailored audience.
+      #
+      # @example
+      #   audience = TailoredAudience.create_instance(account, 'my list')
+      #
+      # @param account [Account] The account object instance.
+      # @param name [String] The tailored audience name.
+      #
+      # @since 4.0
+      #
+      # @return [TailoredAudience] The newly created tailored audience instance.
+      def create_instance(account, name)
+        audience = new(account)
+        params = { name: name }
+        resource = RESOURCE_COLLECTION % { account_id: account.id }
+        response = Request.new(account.client, :post, resource, params: params).perform
+        audience.from_response(response.body[:data])
+      end
+
       # Updates the global opt-out list for the specified advertiser account.
       #
       # @example
@@ -194,6 +216,50 @@ module TwitterAds
       [success_count, total_count]
     end
 
+    # This is a private API and requires whitelisting from Twitter.
+    #
+    # This endpoint will allow partners to add, update and remove users from a given
+    # tailored_audience_id.
+    # The endpoint will also accept multiple user identifier types per user as well.
+    #
+    # @example
+    #   tailored_audience.users(
+    #     account,
+    #     [
+    #       {
+    #         "operation_type": "Update",
+    #         "params": {
+    #           "effective_at": "2018-05-15T00:00:00Z",
+    #           "expires_at": "2019-01-01T07:00:00Z",
+    #           "users": [
+    #             {
+    #               "twitter_id": [
+    #                 "4798b8bbdcf6f2a52e527f46a3d7a7c9aefb541afda03af79c74809ecc6376f3"
+    #               ]
+    #             }
+    #           ]
+    #         }
+    #       }
+    #     ]
+    #   )
+    #
+    # @since 4.0
+    #
+    # @return success_count, total_count
+    def users(params)
+      resource = RESOURCE_USERS % { account_id: account.id, id: id }
+      headers = { 'Content-Type' => 'application/json' }
+      response = TwitterAds::Request.new(account.client,
+                                         :post,
+                                         resource,
+                                         headers: headers,
+                                         body: params.to_json).perform
+      success_count = response.body[:data][:success_count]
+      total_count = response.body[:data][:total_count]
+
+      [success_count, total_count]
+    end
+
     private
 
     def create_audience(name, list_type)

data/lib/twitter-ads/campaign/line_item.rb

@@ -39,6 +39,7 @@ module TwitterAds
     property :advertiser_user_id
     property :bid_type
     property :tracking_tags
+    property :lookalike_expansion
 
     # sdk only
     property :to_delete, type: :bool

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

@@ -12,7 +12,7 @@ module TwitterAds
 
       attr_reader :account
 
-      property :app_country_code, read_only: true
+      property :country_code, read_only: true
       property :app_cta, read_only: true
       property :card_type, read_only: true
       property :card_uri, read_only: true

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

@@ -23,7 +23,7 @@ module TwitterAds
       property :updated_at, type: :time, read_only: true
       property :wide_app_image, read_only: true
 
-      property :app_country_code
+      property :country_code
       property :app_cta
       property :googleplay_app_id
       property :googleplay_deep_link

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

@@ -25,7 +25,7 @@ module TwitterAds
       property :video_poster_url, read_only: true
       property :video_url, read_only: true
 
-      property :app_country_code
+      property :country_code
       property :app_cta
       property :image_media_id
       property :ipad_app_id

data/lib/twitter-ads/enum.rb

@@ -221,5 +221,10 @@ module TwitterAds
       TARGETING_CRITERIA = 'TARGETING_CRITERIA'.freeze
       KEYWORD_AUDIENCE = 'KEYWORD_AUDIENCE'.freeze
     end
+
+    module LookalikeExpansion
+      DEFINED = 'DEFINED'.freeze
+      EXPANDED = 'EXPANDED'.freeze
+    end
   end
 end

data/lib/twitter-ads/settings/tax.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+# Copyright (C) 2015 Twitter, Inc.
+
+module TwitterAds
+  class TaxSettings
+
+    include TwitterAds::DSL
+    include TwitterAds::Resource
+    include TwitterAds::Persistence
+
+    attr_reader :account
+
+    property :address_city
+    property :address_country
+    property :address_email
+    property :address_first_name
+    property :address_last_name
+    property :address_name
+    property :address_postal_code
+    property :address_region
+    property :address_street1
+    property :address_street2
+    property :bill_to
+    property :business_relationship
+    property :client_address_city
+    property :client_address_country
+    property :client_address_email
+    property :client_address_first_name
+    property :client_address_last_name
+    property :client_address_name
+    property :client_address_postal_code
+    property :client_address_region
+    property :client_address_street1
+    property :client_address_street2
+    property :invoice_jurisdiction
+    property :tax_category
+    property :tax_exemption_id
+    property :tax_id
+
+    # sdk only
+    property :to_delete, type: :bool
+
+    RESOURCE = "/#{TwitterAds::API_VERSION}/" +
+               'accounts/%{account_id}/user_settings/%{id}'.freeze # @api private
+
+    def initialize(account)
+      @account = account
+      self
+    end
+
+  end
+end

data/lib/twitter-ads/settings/user.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+# Copyright (C) 2015 Twitter, Inc.
+
+module TwitterAds
+  class UserSettings
+
+    include TwitterAds::DSL
+    include TwitterAds::Resource
+    include TwitterAds::Persistence
+
+    attr_reader :account
+
+    property :notification_email
+    property :contact_phone
+    property :contact_phone_extension
+    property :subscribed_email_types
+    property :user_id
+
+    # sdk only
+    property :to_delete, type: :bool
+
+    RESOURCE = "/#{TwitterAds::API_VERSION}/" +
+               'accounts/%{account_id}/user_settings/%{id}'.freeze # @api private
+
+    def initialize(account)
+      @account = account
+      self
+    end
+
+  end
+end

data/lib/twitter-ads/version.rb

@@ -2,5 +2,5 @@
 # Copyright (C) 2015 Twitter, Inc.
 
 module TwitterAds
-  VERSION = '3.0.0'.freeze
+  VERSION = '4.0.0'.freeze
 end

data/spec/twitter-ads/account_spec.rb

@@ -275,41 +275,4 @@ describe TwitterAds::Account do
 
   end
 
-  describe '#videos' do
-
-    let!(:video_id) { 'd5e3ae4d-34c4-4f49-894e-0c17735916a4' }
-
-    before(:each) do
-      resource_collection = "#{ADS_API}/accounts/#{account.id}/videos"
-      stub_fixture(:get, :videos_all, resource_collection)
-
-      resource = "#{ADS_API}/accounts/#{account.id}/videos/#{video_id}"
-      stub_fixture(:get, :videos_load, /#{resource}\?.*/)
-    end
-
-    context 'with an id specified' do
-
-      it 'successfully loads the specified video' do
-        result = account.videos(video_id)
-        expect(result).not_to be_nil
-        expect(result.class).to eq(TwitterAds::Video)
-        expect(result.id).to eq(video_id)
-      end
-
-    end
-
-    context 'without an id specified' do
-
-      it 'succesfully returns a cursor with all videos' do
-        result = account.videos
-        expect(result.to_a.size).to eq(3)
-        expect(result.class).to eq(TwitterAds::Cursor)
-        expect(result.first.class).to eq(TwitterAds::Video)
-        expect(result.first.id).to eq(video_id)
-      end
-
-    end
-
-  end
-
 end

data/spec/twitter-ads/creative/image_app_download_card_spec.rb

@@ -27,7 +27,7 @@ describe TwitterAds::Creative::ImageAppDownloadCard do
 
   write = %w(
     name
-    app_country_code
+    country_code
     iphone_app_id
     iphone_deep_link
     ipad_app_id

data/spec/twitter-ads/creative/video_app_download_card_spec.rb

@@ -26,7 +26,7 @@ describe TwitterAds::Creative::VideoAppDownloadCard do
   read  = %w(id preview_url video_url video_poster_url deleted created_at updated_at)
   write = %w(
     name
-    app_country_code
+    country_code
     iphone_app_id
     iphone_deep_link
     ipad_app_id

data/twitter-ads.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
   s.version     = TwitterAds::VERSION
   s.platform    = Gem::Platform::RUBY
   s.licenses    = ['MIT']
-  s.authors     = ['John Babich', 'Tushar Bhushan', 'Juan Shishido']
+  s.authors     = ['Brandon Black', 'John Babich', 'Jacob Petrie']
   s.email       = ['twitterdev-ads@twitter.com']
   s.homepage    = 'https://github.com/twitterdev/twitter-ruby-ads-sdk'
   s.description = 'The officially supported Twitter Ads API SDK for Ruby.'

metadata

@@ -1,38 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: twitter-ads
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 4.0.0
 platform: ruby
 authors:
+- Brandon Black
 - John Babich
-- Tushar Bhushan
-- Juan Shishido
+- Jacob Petrie
 autorequire: 
 bindir: bin
-cert_chain:
-- |
-  -----BEGIN CERTIFICATE-----
-  MIIDgDCCAmigAwIBAgIBATANBgkqhkiG9w0BAQUFADBDMRMwEQYDVQQDDAphZHNh
-  cGktZGV2MRcwFQYKCZImiZPyLGQBGRYHdHdpdHRlcjETMBEGCgmSJomT8ixkARkW
-  A2NvbTAeFw0xODAzMjIxNDU1NDNaFw0xOTAzMjIxNDU1NDNaMEMxEzARBgNVBAMM
-  CmFkc2FwaS1kZXYxFzAVBgoJkiaJk/IsZAEZFgd0d2l0dGVyMRMwEQYKCZImiZPy
-  LGQBGRYDY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAvc9MVtVP
-  iFcis6l0AVMhrz6PY2q6phws6rXDVlnfJ6YoCzKVaZQ7/F7rNccgBRm3e1YtfSMS
-  Rbi6utXIyvi5w6f05R8ete2aI1mzocoErsg179ohrp9NCE1kkfX+1LV/HbFPhmcm
-  KjbmBisAhcAz2SHUk+GBq8fbfKj+jv/K0WpsCinZtd38s96dBIiWK/o+evpSCXIo
-  OwCwP+rxj9m3R6ZbyhFmagfMl3bTk8Xw+UZwc1GgCOJwODVqHMV7/ryyX6IY/Wbu
-  Xw7hQ/4+dMs3xumArhfjQG/3ocHLo4jFScXJ0JYY+b1fW7b0EuvTAEoIcUctNz8o
-  R+ptZC3y2GQ2BQIDAQABo38wfTAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNV
-  HQ4EFgQU/NBrOwjh8uJx/JrAN0FA9dy+RsIwIQYDVR0RBBowGIEWYWRzYXBpLWRl
-  dkB0d2l0dGVyLmNvbTAhBgNVHRIEGjAYgRZhZHNhcGktZGV2QHR3aXR0ZXIuY29t
-  MA0GCSqGSIb3DQEBBQUAA4IBAQAHgAKu94Ix68zuH9+sd89YLpj/bQKyrsW/YZMK
-  JOIbklJGn2xzipuOnaiWCnetm4twROdmVqz+eu7DPFpVRuh8yd72/w5xO8GPBihs
-  WiE4Wn2nS83n6szuSHtz+Osuwnpwi+IGcRaUU5k0ql4wzq0ThxfV1JLp1rYhioWn
-  AwnieA4MlAGo5XyxOBSfgWz6J7qsG9iyvbMMSzn81PX0bUz0n0F1W4A+GPnn62/C
-  6/42oM9SP/6CMxevv7dmeQsbzuQWezV1EvcgHn8ITnFH9JXY8ZfDXPVyqvxPjeFH
-  gs09+Abi4upZUoQi8GBp5k0sYT1f3aGIpxtuAJtahWypI+LI
-  -----END CERTIFICATE-----
-date: 2018-03-22 00:00:00.000000000 Z
+cert_chain: []
+date: 2019-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -113,7 +91,6 @@ files:
 - lib/twitter-ads/creative/promoted_account.rb
 - lib/twitter-ads/creative/promoted_tweet.rb
 - lib/twitter-ads/creative/scheduled_tweet.rb
-- lib/twitter-ads/creative/video.rb
 - lib/twitter-ads/creative/video_app_download_card.rb
 - lib/twitter-ads/creative/video_conversation_card.rb
 - lib/twitter-ads/creative/video_website_card.rb
@@ -132,6 +109,8 @@ files:
 - lib/twitter-ads/resources/dsl.rb
 - lib/twitter-ads/resources/persistence.rb
 - lib/twitter-ads/resources/resource.rb
+- lib/twitter-ads/settings/tax.rb
+- lib/twitter-ads/settings/user.rb
 - lib/twitter-ads/targeting/reach_estimate.rb
 - lib/twitter-ads/targeting_criteria/app_store_category.rb
 - lib/twitter-ads/targeting_criteria/behavior.rb
@@ -191,8 +170,6 @@ files:
 - spec/twitter-ads/creative/promoted_tweet_spec.rb
 - spec/twitter-ads/creative/video_app_download_card_spec.rb
 - spec/twitter-ads/creative/video_conversation_card_spec.rb
-- spec/twitter-ads/creative/video_legacy_spec.rb
-- spec/twitter-ads/creative/video_spec.rb
 - spec/twitter-ads/creative/website_card_spec.rb
 - spec/twitter-ads/cursor_spec.rb
 - spec/twitter-ads/http/ton_upload_spec.rb
@@ -238,7 +215,6 @@ test_files:
 - spec/twitter-ads/campaign/tweet_spec.rb
 - spec/twitter-ads/creative/account_media_spec.rb
 - spec/twitter-ads/creative/website_card_spec.rb
-- spec/twitter-ads/creative/video_legacy_spec.rb
 - spec/twitter-ads/creative/video_app_download_card_spec.rb
 - spec/twitter-ads/creative/media_creative_spec.rb
 - spec/twitter-ads/creative/promoted_tweet_spec.rb
@@ -246,7 +222,6 @@ test_files:
 - spec/twitter-ads/creative/video_conversation_card_spec.rb
 - spec/twitter-ads/creative/promoted_account_spec.rb
 - spec/twitter-ads/creative/image_app_download_card_spec.rb
-- spec/twitter-ads/creative/video_spec.rb
 - spec/twitter-ads/utils_spec.rb
 - spec/shared/properties.rb
 - spec/support/helpers.rb

data.tar.gz.sig

@@ -1,2 +0,0 @@
-x��*��DT��/�"x�ݰ�%��qR�Pf �:;S�ƛ��J�Y�e<�]�D��۬p��b
��Wi�$[���vBF0����E�����E�	6�#�F�@�t���.�VY쮼��T��@���yp�Sݸ��۪{�>���Mh�
-�G�`�r����'v�#��W���!��A�MW����5�n��%�o]|���;���h��E��B"���IcosT�΁"7\r^bݠ�+?���

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

@@ -1,49 +0,0 @@
-# frozen_string_literal: true
-# Copyright (C) 2015 Twitter, Inc.
-
-module TwitterAds
-  module Creative
-
-    class Video
-
-      include TwitterAds::DSL
-      include TwitterAds::Resource
-      include TwitterAds::Persistence
-
-      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 :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 :reasons_not_servable, read_only: true
-      property :tweeted, type: :bool, read_only: true
-      property :updated_at, type: :time, read_only: true
-
-      property :description
-      property :poster_image_media_id
-      property :title
-      property :video_media_id
-
-      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
-        self
-      end
-
-    end
-
-  end
-end
-
-# TODO: legacy namespace support, to be removed in v1.0.0 (next major)
-TwitterAds::Video = TwitterAds::Creative::Video

data/spec/twitter-ads/creative/video_legacy_spec.rb

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-# Copyright (C) 2015 Twitter, Inc.
-
-require 'spec_helper'
-
-describe TwitterAds::Video do
-
-  before(:each) do
-    stub_fixture(:get, :accounts_all, "#{ADS_API}/accounts")
-    stub_fixture(:get, :accounts_load, "#{ADS_API}/accounts/2iqph")
-  end
-
-  let(:client) do
-    Client.new(
-      Faker::Lorem.characters(15),
-      Faker::Lorem.characters(40),
-      "123456-#{Faker::Lorem.characters(40)}",
-      Faker::Lorem.characters(40)
-    )
-  end
-
-  let(:account) { client.accounts.first }
-
-  # check model properties
-  subject { described_class.new(account) }
-
-  read = %w(
-    id
-    tweeted
-    ready_to_tweet
-    duration
-    reasons_not_servable
-    preview_url
-    created_at
-    updated_at
-    deleted
-  )
-
-  write = %w(title description video_media_id)
-
-  include_examples 'object property check', read, write
-
-end

data/spec/twitter-ads/creative/video_spec.rb

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-# Copyright (C) 2015 Twitter, Inc.
-
-require 'spec_helper'
-
-describe TwitterAds::Creative::Video do
-
-  before(:each) do
-    stub_fixture(:get, :accounts_all, "#{ADS_API}/accounts")
-    stub_fixture(:get, :accounts_load, "#{ADS_API}/accounts/2iqph")
-  end
-
-  let(:client) do
-    Client.new(
-      Faker::Lorem.characters(15),
-      Faker::Lorem.characters(40),
-      "123456-#{Faker::Lorem.characters(40)}",
-      Faker::Lorem.characters(40)
-    )
-  end
-
-  let(:account) { client.accounts.first }
-
-  # check model properties
-  subject { described_class.new(account) }
-
-  read = %w(
-    id
-    tweeted
-    ready_to_tweet
-    duration
-    reasons_not_servable
-    preview_url
-    created_at
-    updated_at
-    deleted
-  )
-
-  write = %w(title description video_media_id)
-
-  include_examples 'object property check', read, write
-
-end