Module: BWAPI::Client::Brandwatch::PriceStructures

Includes:
Clients
Included in:
BWAPI::Client::Brandwatch
Defined in:
lib/bwapi/client/brandwatch/price_structures.rb,
lib/bwapi/client/brandwatch/price_structures/clients.rb

Overview

PriceStructures module for brandwatch/pricestructures endpoint

Defined Under Namespace

Modules: Clients

Instance Method Summary collapse

Instance Method Details

#create_price_structure(opts) ⇒ Hash

Create a new price structure

Parameters:

  • opts (Hash) —

    options Hash of parameters

Options Hash (opts):

  • autoDeleteDays (Integer) —

    Auto delete days of the price structure

  • autoUpgrade (Boolean) —

    If the price structure can be auto upgraded

  • availableBackfillMonths (Integer) —

    Available backfill months of the price structure

  • backfillMentionLimit (Integer) —

    Backfill mention limit of the price structure

  • backfillMentionLimitPeriod (String) —

    Backfill mention limit period of the price structure

  • currencyCode (String) —

    Currency code of the price structure

  • description (String) —

    Description of the price structure

  • forWebSignUp (Boolean) —

    If the price structure is for web sign up

  • id (Integer) —

    Id of the price structure

  • mentionLimitPeriod (String) —

    Mention limit period of the price structure

  • name (String) —

    Name of the price structure

  • notes (String) —

    Notes for the price structure

  • priceStructureLines (Array) —

    Price structure lines belonging to the price structure

  • resellerAllowed (Boolean) —

    If the price structure is reseller allowed

Returns:

  • (Hash) —

    Newly created price structure



40
41
42
 
# 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) ⇒ Hash

Delete a price structure

Parameters:

  • price_structure_id (Integer) —

    Id of the price structure

Returns:

  • (Hash) —

    Deleted price structure



48
49
50
 
# 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) ⇒ Object

Get the price structures available for a client

TODO: Add parameters documentation



18
19
20
 
# 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 ⇒ Array

Show available price structures

Returns:

  • (Array) —

    List of all price structures



11
12
13
 
# File 'lib/bwapi/client/brandwatch/price_structures.rb', line 11

def get_price_structures
  get 'brandwatch/pricestructures'
end