togai_client 1.0.1 → 1.0.2

data/docs/CustomersApi.md

@@ -1,10 +1,11 @@
 # TogaiClient::CustomersApi
 
-All URIs are relative to *https://sandbox-api.togai.com*
+All URIs are relative to *https://api.togai.com*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
 | [**create_customer**](CustomersApi.md#create_customer) | **POST** /customers | Create a customer |
+| [**create_customer_contact**](CustomersApi.md#create_customer_contact) | **POST** /customers/{customer_id}/contacts | Create a contact for the customer |
 | [**delete_customer**](CustomersApi.md#delete_customer) | **DELETE** /customers/{customer_id} | Delete a customer |
 | [**get_customer**](CustomersApi.md#get_customer) | **GET** /customers/{customer_id} | Get a customer |
 | [**get_customers**](CustomersApi.md#get_customers) | **GET** /customers | List customers |
@@ -17,7 +18,7 @@ All URIs are relative to *https://sandbox-api.togai.com*
 
 Create a customer
 
-Create a customer and a default account corresponding to it
+This API let’s you to create customers and corresponding accounts.
 
 ### Examples
 
@@ -31,7 +32,7 @@ TogaiClient.configure do |config|
 end
 
 api_instance = TogaiClient::CustomersApi.new
-create_customer_request = TogaiClient::CreateCustomerRequest.new({id: 'id_example', name: 'name_example', primary_email: 'primary_email_example', billing_address: 'billing_address_example'}) # CreateCustomerRequest | Payload to create customer
+create_customer_request = TogaiClient::CreateCustomerRequest.new({id: '01BX5ZZKBKACTAV9WEVGEMMVRZ', name: 'ACME Enterprise', primary_email: 'admin@example.com', address: TogaiClient::Address.new}) # CreateCustomerRequest | Payload to create customer
 
 begin
   # Create a customer
@@ -80,13 +81,84 @@ end
 - **Accept**: application/json
 
 
+## create_customer_contact
+
+> <CreateCustomerContactResponse> create_customer_contact(customer_id, create_customer_contact_request)
+
+Create a contact for the customer
+
+This API let’s you to create a contact for the customer
+
+### Examples
+
+```ruby
+require 'time'
+require 'togai_client'
+# setup authorization
+TogaiClient.configure do |config|
+  # Configure Bearer authorization (Bearer <credential>): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = TogaiClient::CustomersApi.new
+customer_id = '01BX5ZZKBKACTAV9WEVGEMMVRZ' # String | 
+create_customer_contact_request = TogaiClient::CreateCustomerContactRequest.new({name: 'name_example', email: 'email_example'}) # CreateCustomerContactRequest | Payload to create a contact for a customer
+
+begin
+  # Create a contact for the customer
+  result = api_instance.create_customer_contact(customer_id, create_customer_contact_request)
+  p result
+rescue TogaiClient::ApiError => e
+  puts "Error when calling CustomersApi->create_customer_contact: #{e}"
+end
+```
+
+#### Using the create_customer_contact_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateCustomerContactResponse>, Integer, Hash)> create_customer_contact_with_http_info(customer_id, create_customer_contact_request)
+
+```ruby
+begin
+  # Create a contact for the customer
+  data, status_code, headers = api_instance.create_customer_contact_with_http_info(customer_id, create_customer_contact_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateCustomerContactResponse>
+rescue TogaiClient::ApiError => e
+  puts "Error when calling CustomersApi->create_customer_contact_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **customer_id** | **String** |  |  |
+| **create_customer_contact_request** | [**CreateCustomerContactRequest**](CreateCustomerContactRequest.md) | Payload to create a contact for a customer |  |
+
+### Return type
+
+[**CreateCustomerContactResponse**](CreateCustomerContactResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
 ## delete_customer
 
 > <BaseSuccessResponse> delete_customer(customer_id)
 
 Delete a customer
 
-Delete a customer by id
+This API let’s you to delete a customer using customer_id.
 
 ### Examples
 
@@ -100,7 +172,7 @@ TogaiClient.configure do |config|
 end
 
 api_instance = TogaiClient::CustomersApi.new
-customer_id = 'customer_id_example' # String | 
+customer_id = '01BX5ZZKBKACTAV9WEVGEMMVRZ' # String | 
 
 begin
   # Delete a customer
@@ -155,7 +227,7 @@ end
 
 Get a customer
 
-Get a customer by id
+Get customer information using customer_id.
 
 ### Examples
 
@@ -169,7 +241,7 @@ TogaiClient.configure do |config|
 end
 
 api_instance = TogaiClient::CustomersApi.new
-customer_id = 'customer_id_example' # String | 
+customer_id = '01BX5ZZKBKACTAV9WEVGEMMVRZ' # String | 
 
 begin
   # Get a customer
@@ -224,7 +296,7 @@ end
 
 List customers
 
-List customers with pagination and sort
+Returns a list of customers with pagination and sort.
 
 ### Examples
 
@@ -239,8 +311,8 @@ end
 
 api_instance = TogaiClient::CustomersApi.new
 opts = {
-  next_token: 'eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEyMywgInNvcnRPcmRlciI6ICJhc2MifQ==', # String | 
-  page_size: '10' # String | 
+  next_token: 'eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEwMCwgInNvcnRPcmRlciI6ICJhc2MifQ==', # String | 
+  page_size: 10 # Float | 
 }
 
 begin
@@ -275,7 +347,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **next_token** | **String** |  | [optional] |
-| **page_size** | **String** |  | [optional] |
+| **page_size** | **Float** |  | [optional] |
 
 ### Return type
 
@@ -297,7 +369,7 @@ end
 
 Update a customer
 
-Update a customer by id
+This API let’s you to update a customer’s information using customer_id.
 
 ### Examples
 
@@ -311,7 +383,7 @@ TogaiClient.configure do |config|
 end
 
 api_instance = TogaiClient::CustomersApi.new
-customer_id = 'customer_id_example' # String | 
+customer_id = '01BX5ZZKBKACTAV9WEVGEMMVRZ' # String | 
 update_customer_request = TogaiClient::UpdateCustomerRequest.new # UpdateCustomerRequest | Payload to update customer
 
 begin

data/docs/Dependency.md

@@ -0,0 +1,22 @@
+# TogaiClient::Dependency
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** |  |  |
+| **key** | **String** |  |  |
+| **name** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::Dependency.new(
+  type: null,
+  key: null,
+  name: null
+)
+```
+

data/docs/EditAccountScheduleRequest.md

@@ -0,0 +1,18 @@
+# TogaiClient::EditAccountScheduleRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **edits** | [**Array<UpdateAccountScheduleV2Request>**](UpdateAccountScheduleV2Request.md) |  |  |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::EditAccountScheduleRequest.new(
+  edits: null
+)
+```
+

data/docs/EditPricingScheduleRequest.md

@@ -0,0 +1,18 @@
+# TogaiClient::EditPricingScheduleRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **edits** | [**Array<UpdatePricingScheduleRequest>**](UpdatePricingScheduleRequest.md) |  |  |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::EditPricingScheduleRequest.new(
+  edits: null
+)
+```
+

data/docs/EnrichedField.md

@@ -0,0 +1,22 @@
+# TogaiClient::EnrichedField
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  |  |
+| **type** | **String** |  |  |
+| **value** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::EnrichedField.new(
+  name: null,
+  type: null,
+  value: null
+)
+```
+

data/docs/EnrichmentDependency.md

@@ -0,0 +1,24 @@
+# TogaiClient::EnrichmentDependency
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key** | **String** |  |  |
+| **type** | **String** |  |  |
+| **name** | **String** |  | [optional] |
+| **value** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::EnrichmentDependency.new(
+  key: null,
+  type: null,
+  name: null,
+  value: null
+)
+```
+

data/docs/Enrichments.md

@@ -0,0 +1,20 @@
+# TogaiClient::Enrichments
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **dependencies** | [**Array<Dependency>**](Dependency.md) |  | [optional] |
+| **fields** | [**Array<Field>**](Field.md) |  |  |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::Enrichments.new(
+  dependencies: null,
+  fields: null
+)
+```
+

data/docs/EntitlementOverageConfig.md

@@ -0,0 +1,22 @@
+# TogaiClient::EntitlementOverageConfig
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **mode** | **String** | Mode to get the entitlement overages for the entitlement overage rate cards - CUSTOM: Use the entitlement overages provided in the request - LOOKUP_CYCLE: Use the entitlement overages of a given account for the specified cycle  |  |
+| **custom** | [**Array<EntitlementOverageEntry>**](EntitlementOverageEntry.md) | Quantity of entitlement overages, this will be considered if mode is CUSTOM | [optional] |
+| **lookup_cycle** | [**EntitlementOverageConfigLookupCycle**](EntitlementOverageConfigLookupCycle.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::EntitlementOverageConfig.new(
+  mode: null,
+  custom: null,
+  lookup_cycle: null
+)
+```
+

data/docs/EntitlementOverageConfigLookupCycle.md

@@ -0,0 +1,20 @@
+# TogaiClient::EntitlementOverageConfigLookupCycle
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **billing_cycle_end_date** | **Time** | Effective date of the cycle, will be used to get the license entries of the cycle |  |
+| **account_id** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::EntitlementOverageConfigLookupCycle.new(
+  billing_cycle_end_date: null,
+  account_id: null
+)
+```
+

data/docs/EntitlementOverageEntry.md

@@ -0,0 +1,20 @@
+# TogaiClient::EntitlementOverageEntry
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **feature_id** | **String** |  |  |
+| **quantity** | **Float** |  |  |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::EntitlementOverageEntry.new(
+  feature_id: null,
+  quantity: null
+)
+```
+

data/docs/EntitlementOverageRateCard.md

@@ -0,0 +1,32 @@
+# TogaiClient::EntitlementOverageRateCard
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **feature_id** | **String** | Unique Identifier of the attached Feature |  |
+| **display_name** | **String** | Name to be displayed during invoice | [optional] |
+| **name** | **String** | Unique identifier for the rate card in a price plan. If left null it is auto-generated. | [optional] |
+| **tag** | **String** | A tag string to group rate cards | [optional] |
+| **max_quantity** | **Float** | Maximum quantity allowed for the feature, if not specified, unlimited quantity is allowed | [optional] |
+| **rate_plan** | [**RatePlan**](RatePlan.md) |  |  |
+| **rate_values** | [**Array<RateValue>**](RateValue.md) |  |  |
+| **billing_config** | [**BillingConfig**](BillingConfig.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::EntitlementOverageRateCard.new(
+  feature_id: null,
+  display_name: null,
+  name: null,
+  tag: null,
+  max_quantity: null,
+  rate_plan: null,
+  rate_values: null,
+  billing_config: null
+)
+```
+

data/docs/EntitlementOverageRevenueSummary.md

@@ -0,0 +1,18 @@
+# TogaiClient::EntitlementOverageRevenueSummary
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **revenue** | **Float** |  |  |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::EntitlementOverageRevenueSummary.new(
+  revenue: null
+)
+```
+