togai_client 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc81928b391a9b5458ef738ee7fa9b1cc3611cd115ad953569d1b5048fc8feca
-  data.tar.gz: 5f58d3db47d442406b093dd252c44d29bcfaa22f1728bdcafcc60527e2d713b3
+  metadata.gz: 4adb52539f4b4197180b8ececdeb49fa6bd6bfaec72b910b062cf6f22702d28e
+  data.tar.gz: eb618bf3364167735e9f3f63290caaf30462689dca028940ca82b491b3bd5bb2
 SHA512:
-  metadata.gz: 4cf26ad623a6ba7cdf900d7fb1ada53bad57f596d7fb0badde3d18cf77b4e78ce9e3fd281ff3db56c4deb0b3fdbb6b4a8c0c833cfa88bc1db18a9a018e422ccf
-  data.tar.gz: 904b2e68a0013bda153bc5af881f391e996d94afc7c6322715e8eac65ad24b285c0e496f1d3c61da70aff64a385b92c5b66ce350d1baa3880e21bec0cd1f059a
+  metadata.gz: c6a7d72bc74183f8d76eb5d734daee92379f8f3d758415eecc13fd8e3c33d9d62556d6a5fc6afc8f455888d49588ddb6f5ee365549194f33a0c1481afc9fd399
+  data.tar.gz: ade5c238dde2e4452ff53188e2aafb822cfec38709191d3b2cdf6520e18b7d38f83a60e679b758a86eeb8734914acaac65f76b4e15075d73479bb70f55b33f19

data/README.md

@@ -8,7 +8,7 @@ This is an official Ruby client library for using [Togai APIs](https://docs.toga
 
 
 - API version: 1.0
-- Package version: 1.0.0
+- Package version: 1.0.1
 
 ## Installation
 

data/docs/AccountsApi.md

@@ -109,7 +109,7 @@ end
 api_instance = TogaiClient::AccountsApi.new
 customer_id = 'customer_id_example' # String | 
 account_id = 'account_id_example' # String | 
-associate_price_plan_request = TogaiClient::AssociatePricePlanRequest.new({price_plan_name: 'price_plan_name_example'}) # AssociatePricePlanRequest | Payload to associate a price plan to an account
+associate_price_plan_request = TogaiClient::AssociatePricePlanRequest.new({price_plan_name: 'price_plan_name_example', effective_from: Date.today, effective_until: Date.today}) # AssociatePricePlanRequest | Payload to associate a price plan to an account
 
 begin
   # Associate a plan to an account

data/docs/AssociatePricePlanRequest.md

@@ -5,9 +5,9 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **price_plan_name** | **String** | Name of the price plan |  |
-| **effective_from** | **Date** | Date of effectiveness of the association. - Expected only if the account already has a price plan associated with it.  | [optional] |
-| **effective_until** | **Date** | Date until which the association must be effective. - Expected only if effectiveFrom is present.  | [optional] |
-| **rate_card_override** | [**RateCard**](RateCard.md) |  | [optional] |
+| **effective_from** | **Date** | Date of effectiveness of the association. - Expected only if the account already has a price plan associated with it.  |  |
+| **effective_until** | **Date** | Date until which the association must be effective. - Expected only if effectiveFrom is present.  |  |
+| **price_plan_details_override** | [**PricePlanDetailsOverride**](PricePlanDetailsOverride.md) |  | [optional] |
 
 ## Example
 
@@ -18,7 +18,7 @@ instance = TogaiClient::AssociatePricePlanRequest.new(
   price_plan_name: null,
   effective_from: null,
   effective_until: null,
-  rate_card_override: null
+  price_plan_details_override: null
 )
 ```
 

data/docs/Bundle.md

@@ -0,0 +1,22 @@
+# TogaiClient::Bundle
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **display_name** | **String** |  |  |
+| **order** | **Integer** |  |  |
+| **rate_configs** | [**Array<RateConfigBundle>**](RateConfigBundle.md) |  |  |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::Bundle.new(
+  display_name: null,
+  order: null,
+  rate_configs: null
+)
+```
+

data/docs/CreatePricePlanRequest.md

@@ -6,8 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **name** | **String** | Name of the price plan |  |
 | **description** | **String** | Description of price plan | [optional] |
-| **pricing_cycle** | [**PricingCycle**](PricingCycle.md) |  |  |
-| **rate_card** | [**RateCard**](RateCard.md) |  |  |
+| **price_plan_details** | [**PricePlanDetails**](PricePlanDetails.md) |  |  |
 
 ## Example
 
@@ -17,8 +16,7 @@ require 'togai_client'
 instance = TogaiClient::CreatePricePlanRequest.new(
   name: null,
   description: null,
-  pricing_cycle: null,
-  rate_card: null
+  price_plan_details: null
 )
 ```
 

data/docs/EventPipelineInfoPricePlansInner.md

@@ -6,6 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **name** | **String** |  |  |
 | **id** | **String** |  |  |
+| **schedule_id** | **String** |  |  |
 | **cycle_start** | **Date** |  |  |
 | **cycle_end** | **Date** |  |  |
 | **usage_meters** | **Array<String>** |  | [optional] |
@@ -18,6 +19,7 @@ require 'togai_client'
 instance = TogaiClient::EventPipelineInfoPricePlansInner.new(
   name: null,
   id: null,
+  schedule_id: null,
   cycle_start: null,
   cycle_end: null,
   usage_meters: null

data/docs/EventSchemaListData.md

@@ -12,7 +12,7 @@
 | **dimensions** | [**Array<DimensionsSchema>**](DimensionsSchema.md) |  | [optional] |
 | **created_at** | **Time** |  | [optional] |
 | **updated_at** | **Time** |  | [optional] |
-| **associated_usage_meters** | **Array<String>** |  | [optional] |
+| **usage_meters_count** | **Integer** |  | [optional] |
 
 ## Example
 
@@ -28,7 +28,7 @@ instance = TogaiClient::EventSchemaListData.new(
   dimensions: null,
   created_at: null,
   updated_at: null,
-  associated_usage_meters: null
+  usage_meters_count: null
 )
 ```
 

data/docs/EventSchemaListDataAllOf.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **associated_usage_meters** | **Array<String>** |  | [optional] |
+| **usage_meters_count** | **Integer** |  | [optional] |
 
 ## Example
 
@@ -12,7 +12,7 @@
 require 'togai_client'
 
 instance = TogaiClient::EventSchemaListDataAllOf.new(
-  associated_usage_meters: null
+  usage_meters_count: null
 )
 ```
 

data/docs/GetEventResponse.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **events** | [**Array<EventWithStatusAndEventPipelineInfo>**](EventWithStatusAndEventPipelineInfo.md) |  | [optional] |
+| **events** | [**Array<EventWithStatusAndEventPipelineInfo>**](EventWithStatusAndEventPipelineInfo.md) |  |  |
 
 ## Example
 

data/docs/PlanOverride.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **price_plan_name** | **String** |  |  |
-| **override** | [**RateCard**](RateCard.md) |  | [optional] |
+| **price_plan_details_override** | [**PricePlanDetailsOverride**](PricePlanDetailsOverride.md) |  | [optional] |
 | **start_date** | **Time** |  |  |
 | **end_date** | **Time** |  |  |
 
@@ -16,7 +16,7 @@ require 'togai_client'
 
 instance = TogaiClient::PlanOverride.new(
   price_plan_name: null,
-  override: null,
+  price_plan_details_override: null,
   start_date: null,
   end_date: null
 )

data/docs/PricePlan.md

@@ -7,7 +7,6 @@
 | **name** | **String** | Name of the price plan |  |
 | **description** | **String** | Description of price plan | [optional] |
 | **status** | **String** | Status of Price plan |  |
-| **pricing_cycle** | [**PricingCycle**](PricingCycle.md) |  |  |
 | **pricing_schedule** | [**Array<PricingSchedule>**](PricingSchedule.md) |  |  |
 
 ## Example
@@ -19,7 +18,6 @@ instance = TogaiClient::PricePlan.new(
   name: null,
   description: null,
   status: null,
-  pricing_cycle: null,
   pricing_schedule: null
 )
 ```

data/docs/PricePlanDetails.md

@@ -0,0 +1,20 @@
+# TogaiClient::PricePlanDetails
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pricing_cycle_config** | [**PricingCycleConfig**](PricingCycleConfig.md) |  |  |
+| **rate_cards** | [**Array<RateCard>**](RateCard.md) |  |  |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::PricePlanDetails.new(
+  pricing_cycle_config: null,
+  rate_cards: null
+)
+```
+

data/docs/PricePlanDetailsOverride.md

@@ -0,0 +1,20 @@
+# TogaiClient::PricePlanDetailsOverride
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pricing_cycle_config** | [**PricingCycleConfig**](PricingCycleConfig.md) |  | [optional] |
+| **rate_cards** | [**Array<RateCard>**](RateCard.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::PricePlanDetailsOverride.new(
+  pricing_cycle_config: null,
+  rate_cards: null
+)
+```
+

data/docs/PricePlanListData.md

@@ -7,9 +7,8 @@
 | **name** | **String** | Name of the price plan |  |
 | **description** | **String** | Description of price plan | [optional] |
 | **status** | **String** | Status of Price plan |  |
-| **pricing_cycle** | [**PricingCycle**](PricingCycle.md) |  |  |
 | **usage_meters** | **Array<String>** | Usage meters name linked to the price plan |  |
-| **pricing_type** | **String** | Pricing type of the price plan |  |
+| **price_plan_details** | [**PricePlanDetails**](PricePlanDetails.md) |  |  |
 | **created_at** | **Time** |  |  |
 | **updated_at** | **Time** |  |  |
 
@@ -22,9 +21,8 @@ instance = TogaiClient::PricePlanListData.new(
   name: null,
   description: null,
   status: null,
-  pricing_cycle: null,
   usage_meters: null,
-  pricing_type: null,
+  price_plan_details: null,
   created_at: null,
   updated_at: null
 )

data/docs/PricePlanPaginatedResponse.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **data** | [**Array<PricePlanListData>**](PricePlanListData.md) |  | [optional] |
+| **data** | [**Array<PricePlanListData>**](PricePlanListData.md) |  |  |
 | **next_token** | **String** |  | [optional] |
 | **context** | [**PaginationOptions**](PaginationOptions.md) |  | [optional] |
 

data/docs/PricePlansApi.md

@@ -100,7 +100,7 @@ TogaiClient.configure do |config|
 end
 
 api_instance = TogaiClient::PricePlansApi.new
-create_price_plan_request = TogaiClient::CreatePricePlanRequest.new({name: 'name_example', pricing_cycle: TogaiClient::PricingCycle.new({interval: 'MONTHLY', start_type: 'STATIC', start_offset: TogaiClient::PricingCycleStartOffset.new({day_offset: 'day_offset_example', month_offset: 'month_offset_example'}), grace_period: 3}), rate_card: TogaiClient::RateCard.new({type: 'USAGE'})}) # CreatePricePlanRequest | Payload to create price plan
+create_price_plan_request = TogaiClient::CreatePricePlanRequest.new({name: 'name_example', price_plan_details: TogaiClient::PricePlanDetails.new({pricing_cycle_config: TogaiClient::PricingCycleConfig.new({interval: 'MONTHLY', start_type: 'STATIC', start_offset: TogaiClient::PricingCycleConfigStartOffset.new({day_offset: 'day_offset_example', month_offset: 'month_offset_example'}), grace_period: 3}), rate_cards: [TogaiClient::RateCard.new({display_name: 'display_name_example', pricing_model: TogaiClient::PricingModel::TIERED, rate_config: TogaiClient::RateConfigUsage.new({usage_meter_name: 'usage_meter_name_example', slabs: [TogaiClient::SlabUsage.new({rate: 3.56, start_after: 3.56, price_type: TogaiClient::PriceType::FLAT, order: 37})]})})]})}) # CreatePricePlanRequest | Payload to create price plan
 
 begin
   # Create a price plan

data/docs/PriceType.md

@@ -0,0 +1,15 @@
+# TogaiClient::PriceType
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::PriceType.new()
+```
+

data/docs/{PricingCycle.md → PricingCycleConfig.md}

@@ -1,4 +1,4 @@
-# TogaiClient::PricingCycle
+# TogaiClient::PricingCycleConfig
 
 ## Properties
 
@@ -6,7 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **interval** | **String** |  |  |
 | **start_type** | **String** |  |  |
-| **start_offset** | [**PricingCycleStartOffset**](PricingCycleStartOffset.md) |  |  |
+| **start_offset** | [**PricingCycleConfigStartOffset**](PricingCycleConfigStartOffset.md) |  |  |
 | **grace_period** | **Integer** |  |  |
 
 ## Example
@@ -14,7 +14,7 @@
 ```ruby
 require 'togai_client'
 
-instance = TogaiClient::PricingCycle.new(
+instance = TogaiClient::PricingCycleConfig.new(
   interval: null,
   start_type: null,
   start_offset: null,

data/docs/{PricingCycleStartOffset.md → PricingCycleConfigStartOffset.md}

@@ -1,4 +1,4 @@
-# TogaiClient::PricingCycleStartOffset
+# TogaiClient::PricingCycleConfigStartOffset
 
 ## Properties
 
@@ -12,7 +12,7 @@
 ```ruby
 require 'togai_client'
 
-instance = TogaiClient::PricingCycleStartOffset.new(
+instance = TogaiClient::PricingCycleConfigStartOffset.new(
   day_offset: null,
   month_offset: null
 )

data/docs/PricingModel.md

@@ -0,0 +1,15 @@
+# TogaiClient::PricingModel
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::PricingModel.new()
+```
+

data/docs/PricingSchedule.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **rate_payload** | [**RateCard**](RateCard.md) |  | [optional] |
+| **price_plan_details** | [**PricePlanDetails**](PricePlanDetails.md) |  | [optional] |
 | **start_date** | **Time** |  |  |
 | **end_date** | **Time** |  |  |
 
@@ -14,7 +14,7 @@
 require 'togai_client'
 
 instance = TogaiClient::PricingSchedule.new(
-  rate_payload: null,
+  price_plan_details: null,
   start_date: null,
   end_date: null
 )

data/docs/RateCard.md

@@ -4,9 +4,9 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **type** | **String** |  |  |
-| **usage_config** | [**Hash<String, RateCardUsageValue>**](RateCardUsageValue.md) |  | [optional] |
-| **bundle_config** | [**RateCardBundle**](RateCardBundle.md) |  | [optional] |
+| **display_name** | **String** |  |  |
+| **pricing_model** | [**PricingModel**](PricingModel.md) |  |  |
+| **rate_config** | [**RateConfigUsage**](RateConfigUsage.md) |  |  |
 
 ## Example
 
@@ -14,9 +14,9 @@
 require 'togai_client'
 
 instance = TogaiClient::RateCard.new(
-  type: null,
-  usage_config: null,
-  bundle_config: null
+  display_name: null,
+  pricing_model: null,
+  rate_config: null
 )
 ```
 

data/docs/RateCardBundleAggregation.md

@@ -0,0 +1,15 @@
+# TogaiClient::RateCardBundleAggregation
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::RateCardBundleAggregation.new()
+```
+

data/docs/RateCardType.md

@@ -0,0 +1,15 @@
+# TogaiClient::RateCardType
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::RateCardType.new()
+```
+

data/docs/RateConfigBundle.md

@@ -0,0 +1,20 @@
+# TogaiClient::RateConfigBundle
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **usage_meter_name** | **String** |  |  |
+| **slab** | [**SlabBundle**](SlabBundle.md) |  |  |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::RateConfigBundle.new(
+  usage_meter_name: null,
+  slab: null
+)
+```
+

data/docs/RateConfigUsage.md

@@ -0,0 +1,20 @@
+# TogaiClient::RateConfigUsage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **usage_meter_name** | **String** |  |  |
+| **slabs** | [**Array<SlabUsage>**](SlabUsage.md) |  |  |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::RateConfigUsage.new(
+  usage_meter_name: null,
+  slabs: null
+)
+```
+

data/docs/SlabBundle.md

@@ -0,0 +1,24 @@
+# TogaiClient::SlabBundle
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **rate** | **Float** |  |  |
+| **start_after** | **Float** |  |  |
+| **price_type** | [**PriceType**](PriceType.md) |  |  |
+| **config** | **Hash<String, String>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::SlabBundle.new(
+  rate: null,
+  start_after: null,
+  price_type: null,
+  config: null
+)
+```
+

data/docs/{UsageStrategy.md → SlabUsage.md}

@@ -1,4 +1,4 @@
-# TogaiClient::UsageStrategy
+# TogaiClient::SlabUsage
 
 ## Properties
 
@@ -6,6 +6,8 @@
 | ---- | ---- | ----------- | ----- |
 | **rate** | **Float** |  |  |
 | **start_after** | **Float** |  |  |
+| **price_type** | [**PriceType**](PriceType.md) |  |  |
+| **config** | **Hash<String, String>** |  | [optional] |
 | **order** | **Integer** |  |  |
 
 ## Example
@@ -13,9 +15,11 @@
 ```ruby
 require 'togai_client'
 
-instance = TogaiClient::UsageStrategy.new(
+instance = TogaiClient::SlabUsage.new(
   rate: null,
   start_after: null,
+  price_type: null,
+  config: null,
   order: null
 )
 ```

data/docs/UpdatePricePlanRequest.md

@@ -5,8 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **description** | **String** | Description of price plan | [optional] |
-| **pricing_cycle** | [**PricingCycle**](PricingCycle.md) |  | [optional] |
-| **rate_card** | [**RateCard**](RateCard.md) |  | [optional] |
+| **price_plan_details** | [**PricePlanDetailsOverride**](PricePlanDetailsOverride.md) |  | [optional] |
 
 ## Example
 
@@ -15,8 +14,7 @@ require 'togai_client'
 
 instance = TogaiClient::UpdatePricePlanRequest.new(
   description: null,
-  pricing_cycle: null,
-  rate_card: null
+  price_plan_details: null
 )
 ```