module BWAPI::Client::Brandwatch::PriceStructures

PriceStructures module for brandwatch/pricestructures endpoint

Public Instance Methods

create_price_structure(opts) click to toggle source

Create a new price structure

@param opts [Hash] options Hash of parameters @option opts [Integer] autoDeleteDays Auto delete days of the price structure @option opts [Boolean] autoUpgrade If the price structure can be auto upgraded @option opts [Integer] availableBackfillMonths Available backfill months of the price structure @option opts [Integer] backfillMentionLimit Backfill mention limit of the price structure @option opts [String] backfillMentionLimitPeriod Backfill mention limit period of the price structure @option opts [String] currencyCode Currency code of the price structure @option opts [String] description Description of the price structure @option opts [Boolean] forWebSignUp If the price structure is for web sign up @option opts [Integer] id Id of the price structure @option opts [String] mentionLimitPeriod Mention limit period of the price structure @option opts [String] name Name of the price structure @option opts [String] notes Notes for the price structure @option opts [Array] priceStructureLines Price structure lines belonging to the price structure @option opts [Boolean] resellerAllowed If the price structure is reseller allowed @return [Hash] Newly created price structure

# File lib/bwapi/client/brandwatch/price_structures.rb, line 40
def create_price_structure(opts)
  post 'brandwatch/pricestructures', opts
end
delete_price_structure(price_structure_id) click to toggle source

Delete a price structure

@param price_structure_id [Integer] Id of the price structure @return [Hash] Deleted price structure

# File lib/bwapi/client/brandwatch/price_structures.rb, line 48
def delete_price_structure(price_structure_id)
  delete "brandwatch/pricestructures/#{price_structure_id}"
end
get_client_price_structures(client_id) click to toggle source

Get the price structures available for a client

TODO: Add parameters documentation

# File lib/bwapi/client/brandwatch/price_structures.rb, line 18
def get_client_price_structures(client_id)
  get "/brandwatch/pricestructures/clients/#{client_id}"
end
get_price_structures() click to toggle source

Show available price structures

@return [Array] List of all price structures

# File lib/bwapi/client/brandwatch/price_structures.rb, line 11
def get_price_structures
  get 'brandwatch/pricestructures'
end