togai_client 1.0.1 → 1.0.2

data/docs/InvoicesClass.md

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

data/docs/InvoicesStatus.md

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

data/docs/InvoicesType.md

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

data/docs/JobEntriesPaginatedResponse.md

@@ -0,0 +1,22 @@
+# TogaiClient::JobEntriesPaginatedResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<JobEntriesResponse>**](JobEntriesResponse.md) |  | [optional] |
+| **next_token** | **String** |  | [optional] |
+| **context** | [**PaginationOptions**](PaginationOptions.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::JobEntriesPaginatedResponse.new(
+  data: null,
+  next_token: null,
+  context: null
+)
+```
+

data/docs/JobEntriesResponse.md

@@ -0,0 +1,26 @@
+# TogaiClient::JobEntriesResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **entity_id** | **String** |  |  |
+| **job_id** | **String** |  |  |
+| **status** | **String** |  |  |
+| **created_at** | **Time** |  |  |
+| **metadata** | **Hash<String, String>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::JobEntriesResponse.new(
+  entity_id: null,
+  job_id: null,
+  status: null,
+  created_at: null,
+  metadata: null
+)
+```
+

data/docs/JobsApi.md

@@ -0,0 +1,361 @@
+# TogaiClient::JobsApi
+
+All URIs are relative to *https://api.togai.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**confirm_job**](JobsApi.md#confirm_job) | **POST** /jobs/{job_id}/confirm | Confirm a job |
+| [**get_job_entries**](JobsApi.md#get_job_entries) | **GET** /jobs/{job_id}/entries | List job entries |
+| [**get_job_status**](JobsApi.md#get_job_status) | **GET** /jobs/{job_id} | Get the status of a job |
+| [**get_jobs**](JobsApi.md#get_jobs) | **GET** /jobs | List jobs |
+| [**reject_job**](JobsApi.md#reject_job) | **POST** /jobs/{job_id}/reject | Reject a job |
+
+
+## confirm_job
+
+> <GetJobResponse> confirm_job(job_id)
+
+Confirm a job
+
+Confirm a job
+
+### 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::JobsApi.new
+job_id = 'mig.20aUyEZSuYq.SoGbS' # String | 
+
+begin
+  # Confirm a job
+  result = api_instance.confirm_job(job_id)
+  p result
+rescue TogaiClient::ApiError => e
+  puts "Error when calling JobsApi->confirm_job: #{e}"
+end
+```
+
+#### Using the confirm_job_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetJobResponse>, Integer, Hash)> confirm_job_with_http_info(job_id)
+
+```ruby
+begin
+  # Confirm a job
+  data, status_code, headers = api_instance.confirm_job_with_http_info(job_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetJobResponse>
+rescue TogaiClient::ApiError => e
+  puts "Error when calling JobsApi->confirm_job_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **job_id** | **String** |  |  |
+
+### Return type
+
+[**GetJobResponse**](GetJobResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_job_entries
+
+> <JobEntriesPaginatedResponse> get_job_entries(job_id)
+
+List job entries
+
+List individual job entries and current state of processing
+
+### 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::JobsApi.new
+job_id = 'mig.20aUyEZSuYq.SoGbS' # String | 
+
+begin
+  # List job entries
+  result = api_instance.get_job_entries(job_id)
+  p result
+rescue TogaiClient::ApiError => e
+  puts "Error when calling JobsApi->get_job_entries: #{e}"
+end
+```
+
+#### Using the get_job_entries_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<JobEntriesPaginatedResponse>, Integer, Hash)> get_job_entries_with_http_info(job_id)
+
+```ruby
+begin
+  # List job entries
+  data, status_code, headers = api_instance.get_job_entries_with_http_info(job_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <JobEntriesPaginatedResponse>
+rescue TogaiClient::ApiError => e
+  puts "Error when calling JobsApi->get_job_entries_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **job_id** | **String** |  |  |
+
+### Return type
+
+[**JobEntriesPaginatedResponse**](JobEntriesPaginatedResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_job_status
+
+> <GetJobResponse> get_job_status(job_id)
+
+Get the status of a job
+
+Get the status of a job
+
+### 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::JobsApi.new
+job_id = 'mig.20aUyEZSuYq.SoGbS' # String | 
+
+begin
+  # Get the status of a job
+  result = api_instance.get_job_status(job_id)
+  p result
+rescue TogaiClient::ApiError => e
+  puts "Error when calling JobsApi->get_job_status: #{e}"
+end
+```
+
+#### Using the get_job_status_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetJobResponse>, Integer, Hash)> get_job_status_with_http_info(job_id)
+
+```ruby
+begin
+  # Get the status of a job
+  data, status_code, headers = api_instance.get_job_status_with_http_info(job_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetJobResponse>
+rescue TogaiClient::ApiError => e
+  puts "Error when calling JobsApi->get_job_status_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **job_id** | **String** |  |  |
+
+### Return type
+
+[**GetJobResponse**](GetJobResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_jobs
+
+> <JobsPaginatedResponse> get_jobs(opts)
+
+List jobs
+
+Returns a list of jobs with pagination and sort.
+
+### 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::JobsApi.new
+opts = {
+  next_token: 'eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEwMCwgInNvcnRPcmRlciI6ICJhc2MifQ==', # String | 
+  page_size: 10 # Float | 
+}
+
+begin
+  # List jobs
+  result = api_instance.get_jobs(opts)
+  p result
+rescue TogaiClient::ApiError => e
+  puts "Error when calling JobsApi->get_jobs: #{e}"
+end
+```
+
+#### Using the get_jobs_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<JobsPaginatedResponse>, Integer, Hash)> get_jobs_with_http_info(opts)
+
+```ruby
+begin
+  # List jobs
+  data, status_code, headers = api_instance.get_jobs_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <JobsPaginatedResponse>
+rescue TogaiClient::ApiError => e
+  puts "Error when calling JobsApi->get_jobs_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **next_token** | **String** |  | [optional] |
+| **page_size** | **Float** |  | [optional] |
+
+### Return type
+
+[**JobsPaginatedResponse**](JobsPaginatedResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## reject_job
+
+> <GetJobResponse> reject_job(job_id)
+
+Reject a job
+
+Reject a job
+
+### 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::JobsApi.new
+job_id = 'mig.20aUyEZSuYq.SoGbS' # String | 
+
+begin
+  # Reject a job
+  result = api_instance.reject_job(job_id)
+  p result
+rescue TogaiClient::ApiError => e
+  puts "Error when calling JobsApi->reject_job: #{e}"
+end
+```
+
+#### Using the reject_job_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetJobResponse>, Integer, Hash)> reject_job_with_http_info(job_id)
+
+```ruby
+begin
+  # Reject a job
+  data, status_code, headers = api_instance.reject_job_with_http_info(job_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetJobResponse>
+rescue TogaiClient::ApiError => e
+  puts "Error when calling JobsApi->reject_job_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **job_id** | **String** |  |  |
+
+### Return type
+
+[**GetJobResponse**](GetJobResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/JobsPaginatedResponse.md

@@ -0,0 +1,22 @@
+# TogaiClient::JobsPaginatedResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<JobsWithoutStatusInfoResponse>**](JobsWithoutStatusInfoResponse.md) |  | [optional] |
+| **next_token** | **String** |  | [optional] |
+| **context** | [**PaginationOptions**](PaginationOptions.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::JobsPaginatedResponse.new(
+  data: null,
+  next_token: null,
+  context: null
+)
+```
+

data/docs/JobsWithoutStatusInfoResponse.md

@@ -0,0 +1,24 @@
+# TogaiClient::JobsWithoutStatusInfoResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **type** | **String** |  |  |
+| **status** | **String** |  |  |
+| **updated_at** | **Time** |  |  |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::JobsWithoutStatusInfoResponse.new(
+  id: null,
+  type: null,
+  status: null,
+  updated_at: null
+)
+```
+

data/docs/LicenseEntriesConfig.md

@@ -0,0 +1,24 @@
+# TogaiClient::LicenseEntriesConfig
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **mode** | **String** | Mode to get the license entries for the license rate cards - CUSTOM: Use the license entries provided in the request - LOOKUP_RANGE: Use the license entries of a given account for the specified range - LOOKUP_CYCLE: Use the license entries of a given account for the specified cycle  |  |
+| **custom** | [**Array<LicenseEntry>**](LicenseEntry.md) | List of license entries, this will be considered if mode is CUSTOM | [optional] |
+| **lookup_range** | [**LicenseEntriesConfigLookupRange**](LicenseEntriesConfigLookupRange.md) |  | [optional] |
+| **lookup_cycle** | [**LicenseEntriesConfigLookupCycle**](LicenseEntriesConfigLookupCycle.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::LicenseEntriesConfig.new(
+  mode: null,
+  custom: null,
+  lookup_range: null,
+  lookup_cycle: null
+)
+```
+

data/docs/LicenseEntriesConfigLookupCycle.md

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

data/docs/LicenseEntriesConfigLookupRange.md

@@ -0,0 +1,22 @@
+# TogaiClient::LicenseEntriesConfigLookupRange
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **start** | **Time** |  |  |
+| **_end** | **Time** |  |  |
+| **account_id** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::LicenseEntriesConfigLookupRange.new(
+  start: null,
+  _end: null,
+  account_id: null
+)
+```
+

data/docs/LicenseEntry.md

@@ -0,0 +1,22 @@
+# TogaiClient::LicenseEntry
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **license_id** | **String** |  |  |
+| **quantity** | **Integer** |  |  |
+| **effective_from** | **Time** |  |  |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::LicenseEntry.new(
+  license_id: null,
+  quantity: null,
+  effective_from: null
+)
+```
+

data/docs/LicenseEntryDetailsUpdateRequest.md

@@ -0,0 +1,22 @@
+# TogaiClient::LicenseEntryDetailsUpdateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_id** | **String** | The account id for which the license is being updated |  |
+| **effective_from** | **Time** | The effective from date of the license entry |  |
+| **metadata** | **Hash<String, String>** |  |  |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::LicenseEntryDetailsUpdateRequest.new(
+  account_id: acc.fdjsl.313,
+  effective_from: 2021-03-04T14:25:10Z,
+  metadata: {"key1":"value1","key2":"value2"}
+)
+```
+

data/docs/LicenseRateCard.md

@@ -0,0 +1,40 @@
+# TogaiClient::LicenseRateCard
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique Identifier of the attached AddOn |  |
+| **type** | [**AddOnType**](AddOnType.md) |  | [optional] |
+| **display_name** | **String** | Name of the attached AddOn | [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 licenseRateCards | [optional] |
+| **invoice_timing** | [**InvoiceTiming**](InvoiceTiming.md) |  | [optional] |
+| **usage_cycle** | [**UsageCycleInterval**](UsageCycleInterval.md) |  | [optional] |
+| **enable_proration** | **Boolean** |  |  |
+| **config** | [**LicenseRateCardConfig**](LicenseRateCardConfig.md) |  | [optional] |
+| **rate_plan** | [**RatePlan**](RatePlan.md) |  |  |
+| **rate_values** | [**Array<RateValue>**](RateValue.md) |  |  |
+| **prorated_refund_mode** | [**ProratedRefundMode**](ProratedRefundMode.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::LicenseRateCard.new(
+  id: null,
+  type: null,
+  display_name: null,
+  name: null,
+  tag: null,
+  invoice_timing: null,
+  usage_cycle: null,
+  enable_proration: false,
+  config: null,
+  rate_plan: null,
+  rate_values: null,
+  prorated_refund_mode: null
+)
+```
+

data/docs/LicenseRateCardConfig.md

@@ -0,0 +1,20 @@
+# TogaiClient::LicenseRateCardConfig
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **max_quantity** | **Integer** | Max allowed quantity for a particular license in a price plan | [optional] |
+| **max_quantity_breach_action** | [**MaxQuantityBreachAction**](MaxQuantityBreachAction.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::LicenseRateCardConfig.new(
+  max_quantity: 100,
+  max_quantity_breach_action: null
+)
+```
+