launchdarkly_api 5.0.3 → 6.0.0

data/docs/AuditLogApi.md

@@ -1,123 +1,161 @@
 # LaunchDarklyApi::AuditLogApi
 
-All URIs are relative to *https://app.launchdarkly.com/api/v2*
+All URIs are relative to *https://app.launchdarkly.com*
 
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**get_audit_log_entries**](AuditLogApi.md#get_audit_log_entries) | **GET** /auditlog | Get a list of all audit log entries. The query parameters allow you to restrict the returned results by date ranges, resource specifiers, or a full-text search query.
-[**get_audit_log_entry**](AuditLogApi.md#get_audit_log_entry) | **GET** /auditlog/{resourceId} | Use this endpoint to fetch a single audit log entry by its resouce ID.
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_audit_log_entries**](AuditLogApi.md#get_audit_log_entries) | **GET** /api/v2/auditlog | List audit log feature flag entries |
+| [**get_audit_log_entry**](AuditLogApi.md#get_audit_log_entry) | **GET** /api/v2/auditlog/{id} | Get audit log entry |
 
 
-# **get_audit_log_entries**
-> AuditLogEntries get_audit_log_entries(opts)
+## get_audit_log_entries
 
-Get a list of all audit log entries. The query parameters allow you to restrict the returned results by date ranges, resource specifiers, or a full-text search query.
+> <AuditLogEntryListingRepCollection> get_audit_log_entries(opts)
+
+List audit log feature flag entries
+
+Get a list of all audit log entries. The query parameters let you restrict the results that return by date ranges, resource specifiers, or a full-text search query.
+
+### Examples
 
-### Example
 ```ruby
-# load the gem
+require 'time'
 require 'launchdarkly_api'
 # setup authorization
 LaunchDarklyApi.configure do |config|
-  # Configure API key authorization: Token
-  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Configure API key authorization: ApiKey
+  config.api_key['ApiKey'] = 'YOUR API KEY'
   # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['Authorization'] = 'Bearer'
+  # config.api_key_prefix['ApiKey'] = 'Bearer'
 end
 
 api_instance = LaunchDarklyApi::AuditLogApi.new
-
-opts = { 
-  before: 789, # Integer | A timestamp filter, expressed as a Unix epoch time in milliseconds. All entries returned will have before this timestamp.
-  after: 789, # Integer | A timestamp filter, expressed as a Unix epoch time in milliseconds. All entries returned will have occurred after this timestamp.
-  q: 'q_example', # String | Text to search for. You can search for the full or partial name of the resource involved or full or partial email address of the member who made the change.
-  limit: 8.14, # Float | A limit on the number of audit log entries to be returned, between 1 and 20.
-  spec: 'spec_example' # String | A resource specifier, allowing you to filter audit log listings by resource.
+opts = {
+  before: 789, # Integer | A timestamp filter, expressed as a Unix epoch time in milliseconds.  All entries this returns occurred before the timestamp.
+  after: 789, # Integer | A timestamp filter, expressed as a Unix epoch time in milliseconds. All entries this returns occurred after the timestamp.
+  q: 'q_example', # String | Text to search for. You can search for the full or partial name of the resource, or full or partial email address of the member who made a change.
+  limit: 789, # Integer | A limit on the number of audit log entries that return. Set between 1 and 20.
+  spec: 'spec_example' # String | A resource specifier that lets you filter audit log listings by resource
 }
 
 begin
-  #Get a list of all audit log entries. The query parameters allow you to restrict the returned results by date ranges, resource specifiers, or a full-text search query.
+  # List audit log feature flag entries
   result = api_instance.get_audit_log_entries(opts)
   p result
 rescue LaunchDarklyApi::ApiError => e
-  puts "Exception when calling AuditLogApi->get_audit_log_entries: #{e}"
+  puts "Error when calling AuditLogApi->get_audit_log_entries: #{e}"
+end
+```
+
+#### Using the get_audit_log_entries_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AuditLogEntryListingRepCollection>, Integer, Hash)> get_audit_log_entries_with_http_info(opts)
+
+```ruby
+begin
+  # List audit log feature flag entries
+  data, status_code, headers = api_instance.get_audit_log_entries_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AuditLogEntryListingRepCollection>
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling AuditLogApi->get_audit_log_entries_with_http_info: #{e}"
 end
 ```
 
 ### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **before** | **Integer**| A timestamp filter, expressed as a Unix epoch time in milliseconds. All entries returned will have before this timestamp. | [optional] 
- **after** | **Integer**| A timestamp filter, expressed as a Unix epoch time in milliseconds. All entries returned will have occurred after this timestamp. | [optional] 
- **q** | **String**| Text to search for. You can search for the full or partial name of the resource involved or full or partial email address of the member who made the change. | [optional] 
- **limit** | **Float**| A limit on the number of audit log entries to be returned, between 1 and 20. | [optional] 
- **spec** | **String**| A resource specifier, allowing you to filter audit log listings by resource. | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **before** | **Integer** | A timestamp filter, expressed as a Unix epoch time in milliseconds.  All entries this returns occurred before the timestamp. | [optional] |
+| **after** | **Integer** | A timestamp filter, expressed as a Unix epoch time in milliseconds. All entries this returns occurred after the timestamp. | [optional] |
+| **q** | **String** | Text to search for. You can search for the full or partial name of the resource, or full or partial email address of the member who made a change. | [optional] |
+| **limit** | **Integer** | A limit on the number of audit log entries that return. Set between 1 and 20. | [optional] |
+| **spec** | **String** | A resource specifier that lets you filter audit log listings by resource | [optional] |
 
 ### Return type
 
-[**AuditLogEntries**](AuditLogEntries.md)
+[**AuditLogEntryListingRepCollection**](AuditLogEntryListingRepCollection.md)
 
 ### Authorization
 
-[Token](../README.md#Token)
+[ApiKey](../README.md#ApiKey)
 
 ### HTTP request headers
 
- - **Content-Type**: application/json
- - **Accept**: application/json
+- **Content-Type**: Not defined
+- **Accept**: application/json
 
 
+## get_audit_log_entry
 
-# **get_audit_log_entry**
-> AuditLogEntry get_audit_log_entry(resource_id, )
+> <AuditLogEntryRep> get_audit_log_entry(id)
 
-Use this endpoint to fetch a single audit log entry by its resouce ID.
+Get audit log entry
+
+Fetch a detailed audit log entry representation. The detailed representation includes several fields that are not present in the summary representation:  - `delta`: the JSON patch body that was used in the request to update the entity - `previousVersion`: a JSON representation of the previous version of the entity - `currentVersion`: a JSON representation of the current version of the entity 
+
+### Examples
 
-### Example
 ```ruby
-# load the gem
+require 'time'
 require 'launchdarkly_api'
 # setup authorization
 LaunchDarklyApi.configure do |config|
-  # Configure API key authorization: Token
-  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Configure API key authorization: ApiKey
+  config.api_key['ApiKey'] = 'YOUR API KEY'
   # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['Authorization'] = 'Bearer'
+  # config.api_key_prefix['ApiKey'] = 'Bearer'
 end
 
 api_instance = LaunchDarklyApi::AuditLogApi.new
+id = 'id_example' # String | The ID of the audit log entry
 
-resource_id = 'resource_id_example' # String | The resource ID.
+begin
+  # Get audit log entry
+  result = api_instance.get_audit_log_entry(id)
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Error when calling AuditLogApi->get_audit_log_entry: #{e}"
+end
+```
 
+#### Using the get_audit_log_entry_with_http_info variant
 
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AuditLogEntryRep>, Integer, Hash)> get_audit_log_entry_with_http_info(id)
+
+```ruby
 begin
-  #Use this endpoint to fetch a single audit log entry by its resouce ID.
-  result = api_instance.get_audit_log_entry(resource_id, )
-  p result
+  # Get audit log entry
+  data, status_code, headers = api_instance.get_audit_log_entry_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AuditLogEntryRep>
 rescue LaunchDarklyApi::ApiError => e
-  puts "Exception when calling AuditLogApi->get_audit_log_entry: #{e}"
+  puts "Error when calling AuditLogApi->get_audit_log_entry_with_http_info: #{e}"
 end
 ```
 
 ### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **resource_id** | **String**| The resource ID. | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The ID of the audit log entry |  |
 
 ### Return type
 
-[**AuditLogEntry**](AuditLogEntry.md)
+[**AuditLogEntryRep**](AuditLogEntryRep.md)
 
 ### Authorization
 
-[Token](../README.md#Token)
+[ApiKey](../README.md#ApiKey)
 
 ### HTTP request headers
 
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
+- **Content-Type**: Not defined
+- **Accept**: application/json
 

data/docs/AuditLogEntryListingRep.md

@@ -0,0 +1,52 @@
+# LaunchDarklyApi::AuditLogEntryListingRep
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_links** | [**Hash<String, Link>**](Link.md) |  |  |
+| **_id** | **String** |  |  |
+| **_account_id** | **String** |  |  |
+| **date** | **Integer** |  |  |
+| **accesses** | [**Array<ResourceAccess>**](ResourceAccess.md) |  |  |
+| **kind** | **String** |  |  |
+| **name** | **String** |  |  |
+| **description** | **String** |  |  |
+| **short_description** | **String** |  |  |
+| **comment** | **String** |  | [optional] |
+| **subject** | [**SubjectDataRep**](SubjectDataRep.md) |  | [optional] |
+| **member** | [**MemberDataRep**](MemberDataRep.md) |  | [optional] |
+| **token** | [**TokenDataRep**](TokenDataRep.md) |  | [optional] |
+| **app** | [**AuthorizedAppDataRep**](AuthorizedAppDataRep.md) |  | [optional] |
+| **title_verb** | **String** |  | [optional] |
+| **title** | **String** |  | [optional] |
+| **target** | [**TargetResourceRep**](TargetResourceRep.md) |  | [optional] |
+| **parent** | [**ParentResourceRep**](ParentResourceRep.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::AuditLogEntryListingRep.new(
+  _links: null,
+  _id: null,
+  _account_id: null,
+  date: null,
+  accesses: null,
+  kind: null,
+  name: null,
+  description: null,
+  short_description: null,
+  comment: null,
+  subject: null,
+  member: null,
+  token: null,
+  app: null,
+  title_verb: null,
+  title: null,
+  target: null,
+  parent: null
+)
+```
+

data/docs/AuditLogEntryListingRepCollection.md

@@ -0,0 +1,20 @@
+# LaunchDarklyApi::AuditLogEntryListingRepCollection
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **items** | [**Array<AuditLogEntryListingRep>**](AuditLogEntryListingRep.md) |  |  |
+| **_links** | [**Hash<String, Link>**](Link.md) |  |  |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::AuditLogEntryListingRepCollection.new(
+  items: null,
+  _links: null
+)
+```
+

data/docs/AuditLogEntryRep.md

@@ -0,0 +1,64 @@
+# LaunchDarklyApi::AuditLogEntryRep
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_links** | [**Hash<String, Link>**](Link.md) |  |  |
+| **_id** | **String** |  |  |
+| **_account_id** | **String** |  |  |
+| **date** | **Integer** |  |  |
+| **accesses** | [**Array<ResourceAccess>**](ResourceAccess.md) |  |  |
+| **kind** | **String** |  |  |
+| **name** | **String** |  |  |
+| **description** | **String** |  |  |
+| **short_description** | **String** |  |  |
+| **comment** | **String** |  | [optional] |
+| **subject** | [**SubjectDataRep**](SubjectDataRep.md) |  | [optional] |
+| **member** | [**MemberDataRep**](MemberDataRep.md) |  | [optional] |
+| **token** | [**TokenDataRep**](TokenDataRep.md) |  | [optional] |
+| **app** | [**AuthorizedAppDataRep**](AuthorizedAppDataRep.md) |  | [optional] |
+| **title_verb** | **String** |  | [optional] |
+| **title** | **String** |  | [optional] |
+| **target** | [**TargetResourceRep**](TargetResourceRep.md) |  | [optional] |
+| **parent** | [**ParentResourceRep**](ParentResourceRep.md) |  | [optional] |
+| **delta** | **Object** |  | [optional] |
+| **trigger_body** | **Object** |  | [optional] |
+| **merge** | **Object** |  | [optional] |
+| **previous_version** | **Object** |  | [optional] |
+| **current_version** | **Object** |  | [optional] |
+| **subentries** | [**Array<AuditLogEntryListingRep>**](AuditLogEntryListingRep.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::AuditLogEntryRep.new(
+  _links: null,
+  _id: null,
+  _account_id: null,
+  date: null,
+  accesses: null,
+  kind: null,
+  name: null,
+  description: null,
+  short_description: null,
+  comment: null,
+  subject: null,
+  member: null,
+  token: null,
+  app: null,
+  title_verb: null,
+  title: null,
+  target: null,
+  parent: null,
+  delta: null,
+  trigger_body: null,
+  merge: null,
+  previous_version: null,
+  current_version: null,
+  subentries: null
+)
+```
+

data/docs/AuthorizedAppDataRep.md

@@ -0,0 +1,26 @@
+# LaunchDarklyApi::AuthorizedAppDataRep
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_links** | [**Hash<String, Link>**](Link.md) |  | [optional] |
+| **_id** | **String** |  | [optional] |
+| **is_scim** | **Boolean** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **maintainer_name** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::AuthorizedAppDataRep.new(
+  _links: null,
+  _id: null,
+  is_scim: null,
+  name: null,
+  maintainer_name: null
+)
+```
+

data/docs/BigSegmentTarget.md

@@ -0,0 +1,22 @@
+# LaunchDarklyApi::BigSegmentTarget
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_key** | **String** | The user key |  |
+| **included** | **Boolean** | Indicates whether the user is included.<br />Included users are always segment members, regardless of segment rules. |  |
+| **excluded** | **Boolean** | Indicates whether the user is excluded.<br />Segment rules bypass excluded users, so they will never be included based on rules. Excluded users may still be included explicitly. |  |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::BigSegmentTarget.new(
+  user_key: null,
+  included: null,
+  excluded: null
+)
+```
+

data/docs/BranchCollectionRep.md

@@ -0,0 +1,20 @@
+# LaunchDarklyApi::BranchCollectionRep
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_links** | [**Hash<String, Link>**](Link.md) |  |  |
+| **items** | [**Array<BranchRep>**](BranchRep.md) |  |  |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::BranchCollectionRep.new(
+  _links: null,
+  items: null
+)
+```
+

data/docs/BranchRep.md

@@ -0,0 +1,28 @@
+# LaunchDarklyApi::BranchRep
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [optional] |
+| **head** | **String** |  | [optional] |
+| **update_sequence_id** | **Integer** |  | [optional] |
+| **sync_time** | **Integer** |  | [optional] |
+| **references** | [**Array<ReferenceRep>**](ReferenceRep.md) |  | [optional] |
+| **_links** | **Hash<String, Object>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'launchdarkly_api'
+
+instance = LaunchDarklyApi::BranchRep.new(
+  name: null,
+  head: null,
+  update_sequence_id: null,
+  sync_time: null,
+  references: null,
+  _links: null
+)
+```
+