togai_client 1.0.0 → 1.0.1

data/examples/example.rb

@@ -0,0 +1,222 @@
+require 'togai_client'
+
+API_TOKEN = "YOUR_API_TOKEN"
+BASE_PATH = "sandbox-api.togai.com"
+
+##### Convert the above python code to ruby
+
+TogaiClient.configure do |config|
+    config.host = BASE_PATH
+    config.access_token = API_TOKEN
+    config.server_index = nil
+end
+
+# Following example simulates the pricing of an API based SMS service which charges their customers based on region and size of the message.
+# Follow the steps below to create the required entities in Togai, and then ingest an event.
+
+# Step 1: Create an Event Schema to define the event structure, attributes (can be usage value) and dimensions (can be used filters in usage meters i.e country in this case)
+event_schema_api = TogaiClient::EventSchemasApi.new
+create_event_schema_request = TogaiClient::CreateEventSchemaRequest.new(
+    name: "message_sent",
+    attributes: [
+        TogaiClient::EventAttributeSchema.new(
+            name: "sms_id"
+        )
+    ],
+    dimensions: [
+        TogaiClient::DimensionsSchema.new(
+            name: "country"
+        )
+    ]
+)
+
+event_schema = event_schema_api.create_event_schema(create_event_schema_request)
+pp event_schema
+
+
+# Step 2: Activate the Event Schema
+event_schema_api.activate_event_schema(event_schema.name)
+
+# Step 3: Create a Usage Meter to meter the usage with aggregation methods
+usage_meters_api = TogaiClient::UsageMetersApi.new
+create_usage_meter_request = TogaiClient::CreateUsageMeterRequest.new(
+    name: "message_count",
+    type: "COUNTER",
+    aggregation: "COUNT",
+    computations: [
+        TogaiClient::Computation.new(
+            matcher: '''{
+                "==": [
+                    {
+                        "var": "dimensions.country"
+                    },
+                    "US"
+                ]
+            }''',
+            computation: "1"
+        )
+    ]
+)
+usage_meter = usage_meters_api.create_usage_meter(event_schema.name, create_usage_meter_request)
+pp usage_meter
+
+# Step 4: Activate a usage meter
+usage_meters_api.activate_usage_meter(event_schema.name, usage_meter.name)
+
+# Step 5: Create a Price plan to convert the usage into a billable price
+create_price_plan_request = TogaiClient::CreatePricePlanRequest.new(
+    name: "price-plan",
+    price_plan_details: TogaiClient::PricePlanDetails.new(
+        pricing_cycle_config: TogaiClient::PricingCycleConfig.new(
+            interval: "MONTHLY",
+            start_type: "STATIC",
+            start_offset: TogaiClient::PricingCycleConfigStartOffset.new(
+                day_offset: "1",
+                month_offset: "NIL"
+            ),
+            grace_period: 1
+        ),
+        rate_cards: [
+            TogaiClient::RateCard.new(
+                display_name: "SMS charges",
+                pricing_model: TogaiClient::PricingModel::TIERED,
+                rate_config: TogaiClient::RateConfigUsage.new(
+                    usage_meter_name: usage_meter.name,
+                    slabs: [
+                        TogaiClient::SlabUsage.new(
+                            rate: 0.2,
+                            start_after: 0.0,
+                            price_type: TogaiClient::PriceType::PER_UNIT,
+                            order: 1    
+                        ),
+                        TogaiClient::SlabUsage.new(
+                            rate: 0.1,
+                            start_after: 10000.0,
+                            price_type: TogaiClient::PriceType::PER_UNIT,
+                            order: 2
+                        )
+                    ]
+                )
+            )
+        ]
+    )
+)
+price_plan_api = TogaiClient::PricePlansApi.new
+price_plan = price_plan_api.create_price_plan(create_price_plan_request)
+pp price_plan
+
+
+# Step 6: Activate the Price Plan
+price_plan_api.activate_price_plan(price_plan.name)
+
+# Step 7: Create customers to associate price plans
+create_customer_request = TogaiClient::CreateCustomerRequest.new(
+    name: "customer1",
+    id: "1",
+    primary_email: "email@togai.com",
+    billing_address: "221B Baker Street, Marylebone, London NW1 6XE, United Kingdom"
+)
+customers_api = TogaiClient::CustomersApi.new
+customer = customers_api.create_customer(create_customer_request)
+pp customer
+
+# Step 8: Associate the customer/account to the price plan
+associate_price_plan_request = TogaiClient::AssociatePricePlanRequest.new(
+    price_plan_name: price_plan.name,
+    effective_from: Date.today,
+    effective_until: Date.new(9999, 1, 1)
+)
+associate_price_plan_api = TogaiClient::AccountsApi.new
+associate_price_plan = associate_price_plan_api.associate_price_plan(customer.id, customer.id, associate_price_plan_request)
+pp associate_price_plan
+
+# Step 9: Ingest events
+events_api = TogaiClient::EventIngestionApi.new
+event_request = TogaiClient::IngestEventRequest.new(
+    event: TogaiClient::Event.new(
+        id: "random-string" + rand.to_s,
+        event_name: event_schema.name,
+        event_timestamp: DateTime.now,
+        account_id: customer.id,
+        event_attributes: [
+            TogaiClient::EventAttribute.new(
+                attribute_name: "sms_id",
+                attribute_value: "random-string" + rand.to_s
+            )
+        ],
+        dimensions: {
+            "country": "US"
+        }
+    )
+)
+event = events_api.ingest(event_request)
+pp event
+
+sleep(61)
+
+# Step 10: Get the usage metrics 
+now = DateTime.now
+yesterday = DateTime.now - 1
+metrics_api = TogaiClient::MetricsApi.new
+usage_metrics_request = TogaiClient::GetMetricsRequest.new(
+    start_time: yesterday,
+    end_time: now,
+    metric_queries: [
+        TogaiClient::MetricQuery.new(
+            id: "usage-metrics",
+            name: TogaiClient::MetricName::USAGE,
+            aggregation_period: "DAY"
+        )
+    ]
+)
+usage_metrics = metrics_api.get_metrics(get_metrics_request: usage_metrics_request)
+pp usage_metrics
+
+# Step 11: Get the revenue metrics
+# Revenue metrics might take a bit of time to be reflected in the system
+# You can check the docs on the amount of time it takes for events to get processed for revenue.
+revenue_metrics_request = TogaiClient::GetMetricsRequest.new(
+    start_time: yesterday,
+    end_time: now,
+    metric_queries: [
+        TogaiClient::MetricQuery.new(
+            id: "revenue-metrics",
+            name: TogaiClient::MetricName::REVENUE,
+            aggregation_period: "DAY"
+        )
+    ]
+)
+revenue_metrics = metrics_api.get_metrics(get_metrics_request: revenue_metrics_request)
+pp revenue_metrics
+
+# Revenue metrics for a specific customer
+customer_revenue_metrics_request = TogaiClient::GetMetricsRequest.new(
+    start_time: yesterday,
+    end_time: now,
+    metric_queries: [
+        TogaiClient::MetricQuery.new(
+            id: "customer-revenue-metrics",
+            name: TogaiClient::MetricName::REVENUE,
+            aggregation_period: "DAY",
+            filters: [
+                TogaiClient::MetricQueryFilterEntry.new(
+                    field_name: "CUSTOMER_ID",
+                    field_values: [customer.id]
+                )
+            ]
+        )
+    ]
+)
+customer_revenue_metrics = metrics_api.get_metrics(get_metrics_request: customer_revenue_metrics_request)
+pp customer_revenue_metrics
+
+
+
+
+
+
+
+
+
+
+

data/lib/togai_client/models/associate_price_plan_request.rb

@@ -25,7 +25,7 @@ module TogaiClient
     # Date until which the association must be effective. - Expected only if effectiveFrom is present. 
     attr_accessor :effective_until
 
-    attr_accessor :rate_card_override
+    attr_accessor :price_plan_details_override
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
@@ -33,7 +33,7 @@ module TogaiClient
         :'price_plan_name' => :'pricePlanName',
         :'effective_from' => :'effectiveFrom',
         :'effective_until' => :'effectiveUntil',
-        :'rate_card_override' => :'rateCardOverride'
+        :'price_plan_details_override' => :'pricePlanDetailsOverride'
       }
     end
 
@@ -48,7 +48,7 @@ module TogaiClient
         :'price_plan_name' => :'String',
         :'effective_from' => :'Date',
         :'effective_until' => :'Date',
-        :'rate_card_override' => :'RateCard'
+        :'price_plan_details_override' => :'PricePlanDetailsOverride'
       }
     end
 
@@ -85,8 +85,8 @@ module TogaiClient
         self.effective_until = attributes[:'effective_until']
       end
 
-      if attributes.key?(:'rate_card_override')
-        self.rate_card_override = attributes[:'rate_card_override']
+      if attributes.key?(:'price_plan_details_override')
+        self.price_plan_details_override = attributes[:'price_plan_details_override']
       end
     end
 
@@ -102,6 +102,14 @@ module TogaiClient
         invalid_properties.push('invalid value for "price_plan_name", the character length must be smaller than or equal to 50.')
       end
 
+      if @effective_from.nil?
+        invalid_properties.push('invalid value for "effective_from", effective_from cannot be nil.')
+      end
+
+      if @effective_until.nil?
+        invalid_properties.push('invalid value for "effective_until", effective_until cannot be nil.')
+      end
+
       invalid_properties
     end
 
@@ -110,6 +118,8 @@ module TogaiClient
     def valid?
       return false if @price_plan_name.nil?
       return false if @price_plan_name.to_s.length > 50
+      return false if @effective_from.nil?
+      return false if @effective_until.nil?
       true
     end
 
@@ -135,7 +145,7 @@ module TogaiClient
           price_plan_name == o.price_plan_name &&
           effective_from == o.effective_from &&
           effective_until == o.effective_until &&
-          rate_card_override == o.rate_card_override
+          price_plan_details_override == o.price_plan_details_override
     end
 
     # @see the `==` method
@@ -147,7 +157,7 @@ module TogaiClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [price_plan_name, effective_from, effective_until, rate_card_override].hash
+      [price_plan_name, effective_from, effective_until, price_plan_details_override].hash
     end
 
     # Builds the object from hash

data/lib/togai_client/models/{bundle_strategy.rb → bundle.rb}

@@ -14,23 +14,20 @@ require 'date'
 require 'time'
 
 module TogaiClient
-  # Represents a pricing strategy (rates + slabs) for bundle price plan
-  class BundleStrategy
-    attr_accessor :name
-
-    attr_accessor :rate
+  # TODO
+  class Bundle
+    attr_accessor :display_name
 
     attr_accessor :order
 
-    attr_accessor :usage_meters
+    attr_accessor :rate_configs
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'name' => :'name',
-        :'rate' => :'rate',
+        :'display_name' => :'displayName',
         :'order' => :'order',
-        :'usage_meters' => :'usageMeters'
+        :'rate_configs' => :'rateConfigs'
       }
     end
 
@@ -42,10 +39,9 @@ module TogaiClient
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'name' => :'String',
-        :'rate' => :'Float',
+        :'display_name' => :'String',
         :'order' => :'Integer',
-        :'usage_meters' => :'Hash<String, BundleStrategyUsageMetersValue>'
+        :'rate_configs' => :'Array<RateConfigBundle>'
       }
     end
 
@@ -59,32 +55,28 @@ module TogaiClient
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
       if (!attributes.is_a?(Hash))
-        fail ArgumentError, "The input argument (attributes) must be a hash in `TogaiClient::BundleStrategy` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `TogaiClient::Bundle` initialize method"
       end
 
       # check to see if the attribute exists and convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h|
         if (!self.class.attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `TogaiClient::BundleStrategy`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `TogaiClient::Bundle`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'name')
-        self.name = attributes[:'name']
-      end
-
-      if attributes.key?(:'rate')
-        self.rate = attributes[:'rate']
+      if attributes.key?(:'display_name')
+        self.display_name = attributes[:'display_name']
       end
 
       if attributes.key?(:'order')
         self.order = attributes[:'order']
       end
 
-      if attributes.key?(:'usage_meters')
-        if (value = attributes[:'usage_meters']).is_a?(Hash)
-          self.usage_meters = value
+      if attributes.key?(:'rate_configs')
+        if (value = attributes[:'rate_configs']).is_a?(Array)
+          self.rate_configs = value
         end
       end
     end
@@ -93,36 +85,20 @@ module TogaiClient
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @name.nil?
-        invalid_properties.push('invalid value for "name", name cannot be nil.')
-      end
-
-      if @name.to_s.length > 50
-        invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 50.')
-      end
-
-      if @name.to_s.length < 3
-        invalid_properties.push('invalid value for "name", the character length must be great than or equal to 3.')
-      end
-
-      if @rate.nil?
-        invalid_properties.push('invalid value for "rate", rate cannot be nil.')
+      if @display_name.nil?
+        invalid_properties.push('invalid value for "display_name", display_name cannot be nil.')
       end
 
       if @order.nil?
         invalid_properties.push('invalid value for "order", order cannot be nil.')
       end
 
-      if @order > 10
-        invalid_properties.push('invalid value for "order", must be smaller than or equal to 10.')
-      end
-
-      if @order < 1
-        invalid_properties.push('invalid value for "order", must be greater than or equal to 1.')
+      if @rate_configs.nil?
+        invalid_properties.push('invalid value for "rate_configs", rate_configs cannot be nil.')
       end
 
-      if @usage_meters.nil?
-        invalid_properties.push('invalid value for "usage_meters", usage_meters cannot be nil.')
+      if @rate_configs.length < 1
+        invalid_properties.push('invalid value for "rate_configs", number of items must be greater than or equal to 1.')
       end
 
       invalid_properties
@@ -131,51 +107,25 @@ module TogaiClient
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      return false if @name.nil?
-      return false if @name.to_s.length > 50
-      return false if @name.to_s.length < 3
-      return false if @rate.nil?
+      return false if @display_name.nil?
       return false if @order.nil?
-      return false if @order > 10
-      return false if @order < 1
-      return false if @usage_meters.nil?
+      return false if @rate_configs.nil?
+      return false if @rate_configs.length < 1
       true
     end
 
     # Custom attribute writer method with validation
-    # @param [Object] name Value to be assigned
-    def name=(name)
-      if name.nil?
-        fail ArgumentError, 'name cannot be nil'
-      end
-
-      if name.to_s.length > 50
-        fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 50.'
-      end
-
-      if name.to_s.length < 3
-        fail ArgumentError, 'invalid value for "name", the character length must be great than or equal to 3.'
-      end
-
-      @name = name
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] order Value to be assigned
-    def order=(order)
-      if order.nil?
-        fail ArgumentError, 'order cannot be nil'
-      end
-
-      if order > 10
-        fail ArgumentError, 'invalid value for "order", must be smaller than or equal to 10.'
+    # @param [Object] rate_configs Value to be assigned
+    def rate_configs=(rate_configs)
+      if rate_configs.nil?
+        fail ArgumentError, 'rate_configs cannot be nil'
       end
 
-      if order < 1
-        fail ArgumentError, 'invalid value for "order", must be greater than or equal to 1.'
+      if rate_configs.length < 1
+        fail ArgumentError, 'invalid value for "rate_configs", number of items must be greater than or equal to 1.'
       end
 
-      @order = order
+      @rate_configs = rate_configs
     end
 
     # Checks equality by comparing each attribute.
@@ -183,10 +133,9 @@ module TogaiClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          name == o.name &&
-          rate == o.rate &&
+          display_name == o.display_name &&
           order == o.order &&
-          usage_meters == o.usage_meters
+          rate_configs == o.rate_configs
     end
 
     # @see the `==` method
@@ -198,7 +147,7 @@ module TogaiClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, rate, order, usage_meters].hash
+      [display_name, order, rate_configs].hash
     end
 
     # Builds the object from hash

data/lib/togai_client/models/create_customer_request.rb

@@ -139,10 +139,6 @@ module TogaiClient
         invalid_properties.push('invalid value for "billing_address", the character length must be smaller than or equal to 1000.')
       end
 
-      if @billing_address.to_s.length < 50
-        invalid_properties.push('invalid value for "billing_address", the character length must be great than or equal to 50.')
-      end
-
       invalid_properties
     end
 
@@ -158,7 +154,6 @@ module TogaiClient
       return false if @primary_email.to_s.length > 255
       return false if @billing_address.nil?
       return false if @billing_address.to_s.length > 1000
-      return false if @billing_address.to_s.length < 50
       true
     end
 
@@ -219,10 +214,6 @@ module TogaiClient
         fail ArgumentError, 'invalid value for "billing_address", the character length must be smaller than or equal to 1000.'
       end
 
-      if billing_address.to_s.length < 50
-        fail ArgumentError, 'invalid value for "billing_address", the character length must be great than or equal to 50.'
-      end
-
       @billing_address = billing_address
     end
 

data/lib/togai_client/models/create_customer_response.rb

@@ -138,10 +138,6 @@ module TogaiClient
         invalid_properties.push('invalid value for "billing_address", the character length must be smaller than or equal to 1000.')
       end
 
-      if @billing_address.to_s.length < 50
-        invalid_properties.push('invalid value for "billing_address", the character length must be great than or equal to 50.')
-      end
-
       invalid_properties
     end
 
@@ -157,7 +153,6 @@ module TogaiClient
       return false if @primary_email.to_s.length > 255
       return false if @billing_address.nil?
       return false if @billing_address.to_s.length > 1000
-      return false if @billing_address.to_s.length < 50
       true
     end
 
@@ -218,10 +213,6 @@ module TogaiClient
         fail ArgumentError, 'invalid value for "billing_address", the character length must be smaller than or equal to 1000.'
       end
 
-      if billing_address.to_s.length < 50
-        fail ArgumentError, 'invalid value for "billing_address", the character length must be great than or equal to 50.'
-      end
-
       @billing_address = billing_address
     end
 

data/lib/togai_client/models/create_price_plan_request.rb

@@ -22,17 +22,14 @@ module TogaiClient
     # Description of price plan
     attr_accessor :description
 
-    attr_accessor :pricing_cycle
-
-    attr_accessor :rate_card
+    attr_accessor :price_plan_details
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'name' => :'name',
         :'description' => :'description',
-        :'pricing_cycle' => :'pricingCycle',
-        :'rate_card' => :'rateCard'
+        :'price_plan_details' => :'pricePlanDetails'
       }
     end
 
@@ -46,8 +43,7 @@ module TogaiClient
       {
         :'name' => :'String',
         :'description' => :'String',
-        :'pricing_cycle' => :'PricingCycle',
-        :'rate_card' => :'RateCard'
+        :'price_plan_details' => :'PricePlanDetails'
       }
     end
 
@@ -80,12 +76,8 @@ module TogaiClient
         self.description = attributes[:'description']
       end
 
-      if attributes.key?(:'pricing_cycle')
-        self.pricing_cycle = attributes[:'pricing_cycle']
-      end
-
-      if attributes.key?(:'rate_card')
-        self.rate_card = attributes[:'rate_card']
+      if attributes.key?(:'price_plan_details')
+        self.price_plan_details = attributes[:'price_plan_details']
       end
     end
 
@@ -105,12 +97,8 @@ module TogaiClient
         invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 255.')
       end
 
-      if @pricing_cycle.nil?
-        invalid_properties.push('invalid value for "pricing_cycle", pricing_cycle cannot be nil.')
-      end
-
-      if @rate_card.nil?
-        invalid_properties.push('invalid value for "rate_card", rate_card cannot be nil.')
+      if @price_plan_details.nil?
+        invalid_properties.push('invalid value for "price_plan_details", price_plan_details cannot be nil.')
       end
 
       invalid_properties
@@ -122,8 +110,7 @@ module TogaiClient
       return false if @name.nil?
       return false if @name.to_s.length > 50
       return false if !@description.nil? && @description.to_s.length > 255
-      return false if @pricing_cycle.nil?
-      return false if @rate_card.nil?
+      return false if @price_plan_details.nil?
       true
     end
 
@@ -158,8 +145,7 @@ module TogaiClient
       self.class == o.class &&
           name == o.name &&
           description == o.description &&
-          pricing_cycle == o.pricing_cycle &&
-          rate_card == o.rate_card
+          price_plan_details == o.price_plan_details
     end
 
     # @see the `==` method
@@ -171,7 +157,7 @@ module TogaiClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, description, pricing_cycle, rate_card].hash
+      [name, description, price_plan_details].hash
     end
 
     # Builds the object from hash

data/lib/togai_client/models/customer.rb

@@ -178,10 +178,6 @@ module TogaiClient
         invalid_properties.push('invalid value for "billing_address", the character length must be smaller than or equal to 1000.')
       end
 
-      if @billing_address.to_s.length < 50
-        invalid_properties.push('invalid value for "billing_address", the character length must be great than or equal to 50.')
-      end
-
       if @status.nil?
         invalid_properties.push('invalid value for "status", status cannot be nil.')
       end
@@ -209,7 +205,6 @@ module TogaiClient
       return false if @primary_email.to_s.length > 255
       return false if @billing_address.nil?
       return false if @billing_address.to_s.length > 1000
-      return false if @billing_address.to_s.length < 50
       return false if @status.nil?
       status_validator = EnumAttributeValidator.new('String', ["ACTIVE", "ARCHIVED"])
       return false unless status_validator.valid?(@status)
@@ -275,10 +270,6 @@ module TogaiClient
         fail ArgumentError, 'invalid value for "billing_address", the character length must be smaller than or equal to 1000.'
       end
 
-      if billing_address.to_s.length < 50
-        fail ArgumentError, 'invalid value for "billing_address", the character length must be great than or equal to 50.'
-      end
-
       @billing_address = billing_address
     end