launchdarkly_api 2.0.3 → 2.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e5a22af9605471158295cb1d2ac8cc5217bdab29
-  data.tar.gz: e97ffa8b1be31ab648c7362ad911140acacc1609
+SHA256:
+  metadata.gz: 58e814db548b96f9a785ab3fbb27e271dc7a142d6ef0752557f5d3c1c7c34469
+  data.tar.gz: 8f005f60dbf6b3d412a894dcada747aab5b693a1e151d115bc6bb094d9a36a58
 SHA512:
-  metadata.gz: d2b1716648e56ad03a0c0c1a4370cda2341e75fa902f1092196d1518ce9ce0cf2080b7e13ce5b4d7bb864dd948383d4ea7eecb2d16cf4ac90147c442c974b449
-  data.tar.gz: fda9a4ea0b8b98d3a884ddd5770018a27682020ce4e61f54765fc260cff1409ce43aafd350bdef7e8fd451b3ac6b1bd643df2d19299458fb109384b884d97a69
+  metadata.gz: 3c2f5a59e56c92a4d7f4249839aa0dbe1353eb79dfc9ea81637a4d34afa12463369b179ba4b50ff6eefcaa0c5913a94bee2571847078f60368efb5cf2ea166ca
+  data.tar.gz: 2bf44a75f0f1f99b7fb872538dadd878dd31b11352b43118edc271871d7cc9761650770691a777417a5501209427ff4899fed3c8605a6e04def2794795b62f3e

data/README.md

@@ -1,142 +1,89 @@
 This repository contains a client library for LaunchDarkly's REST API. This client was automatically
 generated from our [OpenAPI specification](https://github.com/launchdarkly/ld-openapi).
 
-This REST API is for custom integrations, data export, or automating your feature flag workflows. *DO NOT* use this client library to add feature flags to your web or mobile application. To integrate feature flags with your application, please see the [SDK documentation](https://docs.launchdarkly.com/v2.0/docs)
+This REST API is for custom integrations, data export, or automating your feature flag workflows. *DO NOT* use this client library to include feature flags in your web or mobile application. To integrate feature flags with your application, please see the [SDK documentation](https://docs.launchdarkly.com/v2.0/docs)
 
 # launchdarkly_api
 
-`launchdarkly_api` - the Ruby gem for the LaunchDarkly REST API
+LaunchDarklyApi - the Ruby gem for the LaunchDarkly REST API
 
 Build custom integrations with the LaunchDarkly REST API
 
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
-- API version: 2.0.3
-- Package version: 1.0.0
+- API version: 2.0.10
+- Package version: 2.0.10
 - Build package: io.swagger.codegen.languages.RubyClientCodegen
 For more information, please visit [https://support.launchdarkly.com](https://support.launchdarkly.com)
 
 ## Installation
 
-In the steps shown below, substitute the current API version where you see `VERSION`.
+### Build a gem
 
-### To use the latest release from RubyGems
-
-Add this to your Gemfile:
-
-    gem 'launchdarkly_api', '~> VERSION'
-
-### To use source code from Git
-
-Use this method if you want to use an alternate branch or a fork from Git. Add the following in the Gemfile:
-
-    gem 'launchdarkly_api', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
-
-### To build the gem locally
-
-Check out the source code, then build it:
+To build the Ruby code into a gem:
 
 ```shell
 gem build launchdarkly_api.gemspec
 ```
 
-Then install the gem locally:
+Then either install the gem locally:
 
 ```shell
-gem install ./launchdarkly-api-VERSION.gem
-# To include development dependencies, use gem install --dev
+gem install ./launchdarkly_api-2.0.10.gem
 ```
+(for development, run `gem install --dev ./launchdarkly_api-2.0.10.gem` to install the development dependencies)
 
-Finally add this to the Gemfile:
-
-    gem 'launchdarkly_api', '~> VERSION'
-
-## Usage examples
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
-### Getting the name and description of a feature flag
-
-```ruby
-require 'launchdarkly_api'
-
-api_key = 'put a valid API key for your account here'
-project_key = 'put the key of your project here'
-flag_key = 'put the key of a feature flag here'
-
-LaunchDarklyApi.configure do |config|
-  config.api_key['Authorization'] = api_key
-end
-
-flag_api = LaunchDarklyApi::FeatureFlagsApi.new
-
-begin
-  flag = flag_api.get_feature_flag(project_key, flag_key)
-  puts "Flag key: #{flag_key}, name: #{flag.name}, description: #{flag.description}"
-rescue LaunchDarklyApi::ApiError => e
-  puts "API returned error: #{e.message} #{e.response_body}"
-end
-```
+Finally add this to the Gemfile:
 
-### Modifying a feature flag
+    gem 'launchdarkly_api', '~> 2.0.10'
 
-```ruby
-require 'launchdarkly_api'
+### Install from Git
 
-api_key = 'put a valid API key for your account here'
-project_key = 'put the key of your project here'
-environment_key = 'the key of the environment where you want to change the flag'
-flag_key = 'put the key of a feature flag here'
+If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
 
-LaunchDarklyApi.configure do |config|
-  config.api_key['Authorization'] = api_key
-end
+    gem 'launchdarkly_api', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
 
-flag_api = LaunchDarklyApi::FeatureFlagsApi.new
+### Include the Ruby code directly
 
-# This example turns on targeting for the specified flag.
-# Properties are modified with JSON Patch syntax - http://jsonpatch.com/
-# Note that all environment-specific properties have a path prefix that includes the environment key.
-property_path = "/environments/#{environment_key}/on"
-new_value = true
-patches = [ LaunchDarklyApi::PatchOperation.new(op: 'replace', path: property_path, value: new_value) ]
-patch_and_comment = LaunchDarklyApi::PatchComment.new(patch: patches, comment: 'turning flag on')
+Include the Ruby code directly using `-I` as follows:
 
-begin
-  flag_api.patch_feature_flag(project_key, flag_key, patch_and_comment)
-rescue LaunchDarklyApi::ApiError => e
-  puts "API returned error: #{e.message} #{e.response_body}"
-end
+```shell
+ruby -Ilib script.rb
 ```
 
-### Querying the audit log
+## Getting Started
 
+Please follow the [installation](#installation) procedure and then run the following code:
 ```ruby
 # Load the gem
 require 'launchdarkly_api'
 
-api_key = 'put a valid API key for your account here'
-
+# Setup authorization
 LaunchDarklyApi.configure do |config|
-  config.api_key['Authorization'] = api_key
+  # Configure API key authorization: Token
+  config.api_key['Authorization'] = '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'
 end
 
-audit_log_api = LaunchDarklyApi::AuditLogApi.new
-
-current_time_millis = (Time.now.to_f * 1000).to_i
-one_hour_ago = current_time_millis - (60 * 60 * 1000)
+api_instance = LaunchDarklyApi::AuditLogApi.new
 
-opts = {
-  after: one_hour_ago,
-  limit: 10
-} # see API documentation for other options you can use here
+opts = { 
+  before: 8.14, # Float | A timestamp filter, expressed as a Unix epoch time in milliseconds. All entries returned will have before this timestamp.
+  after: 8.14, # Float | A timestamp filter, expressed as a Unix epoch time in milliseconds. All entries returned will have occured 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 fullpartial 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.
+}
 
 begin
-  result = audit_log_api.get_audit_log_entries(opts)
-  puts "Audit log entries from the last hour:"
-  result.items.each { |item|
-    puts item.title
-  }
+  #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.
+  result = api_instance.get_audit_log_entries(opts)
+  p result
 rescue LaunchDarklyApi::ApiError => e
-  puts "API returned error: #{e.message} #{e.response_body}"
+  puts "Exception when calling AuditLogApi->get_audit_log_entries: #{e}"
 end
 
 ```
@@ -203,12 +150,15 @@ Class | Method | HTTP request | Description
  - [LaunchDarklyApi::AuditLogEntry](docs/AuditLogEntry.md)
  - [LaunchDarklyApi::AuditLogEntryTarget](docs/AuditLogEntryTarget.md)
  - [LaunchDarklyApi::Clause](docs/Clause.md)
+ - [LaunchDarklyApi::CustomProperties](docs/CustomProperties.md)
+ - [LaunchDarklyApi::CustomProperty](docs/CustomProperty.md)
+ - [LaunchDarklyApi::CustomPropertyValues](docs/CustomPropertyValues.md)
  - [LaunchDarklyApi::CustomRole](docs/CustomRole.md)
  - [LaunchDarklyApi::CustomRoleBody](docs/CustomRoleBody.md)
  - [LaunchDarklyApi::CustomRoleKeyOrId](docs/CustomRoleKeyOrId.md)
  - [LaunchDarklyApi::CustomRoles](docs/CustomRoles.md)
  - [LaunchDarklyApi::Environment](docs/Environment.md)
- - [LaunchDarklyApi::EnvironmentBody](docs/EnvironmentBody.md)
+ - [LaunchDarklyApi::EnvironmentPost](docs/EnvironmentPost.md)
  - [LaunchDarklyApi::Fallthrough](docs/Fallthrough.md)
  - [LaunchDarklyApi::FeatureFlag](docs/FeatureFlag.md)
  - [LaunchDarklyApi::FeatureFlagBody](docs/FeatureFlagBody.md)
@@ -262,3 +212,44 @@ Class | Method | HTTP request | Description
 - **Type**: API key
 - **API key parameter name**: Authorization
 - **Location**: HTTP header
+
+## Sample Code
+
+```
+# Load the gem
+require 'launchdarkly_api'
+
+# Setup authorization
+LaunchDarklyApi.configure do |config|
+  config.api_key['Authorization'] = ENV['LD_API_KEY']
+end
+
+api_instance = LaunchDarklyApi::FeatureFlagsApi.new
+
+project_key = "openapi"
+flag_key = "test-ruby"
+
+# Create a flag with a json variations
+body = LaunchDarklyApi::FeatureFlagBody.new(
+  name: "test-ruby",
+  key: flag_key,
+  variations: [
+    LaunchDarklyApi::Variation.new(value=[1,2]),
+    LaunchDarklyApi::Variation.new(value=[3,4]),
+    LaunchDarklyApi::Variation.new(value=[5]),
+  ])
+
+begin
+  result = api_instance.post_feature_flag(project_key, body)
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Exception creating feature flag: #{e}"
+end
+
+# Clean up new flag
+begin
+  result = api_instance.delete_feature_flag(project_key, flag_key)
+  p result
+rescue LaunchDarklyApi::ApiError => e
+  puts "Exception deleting feature flag: #{e}"
+end```

data/docs/CustomProperties.md

@@ -0,0 +1,7 @@
+# LaunchDarklyApi::CustomProperties
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/CustomProperty.md

@@ -0,0 +1,9 @@
+# LaunchDarklyApi::CustomProperty
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The name of the property. | 
+**value** | [**CustomPropertyValues**](CustomPropertyValues.md) |  | [optional] 
+
+

data/docs/CustomPropertyValues.md

@@ -0,0 +1,7 @@
+# LaunchDarklyApi::CustomPropertyValues
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/Environment.md

@@ -13,5 +13,6 @@ Name | Type | Description | Notes
 **default_ttl** | **Float** | The default TTL. | [optional] 
 **secure_mode** | **BOOLEAN** | Determines if this environment is in safe mode. | [optional] 
 **default_track_events** | **BOOLEAN** | Set to true to send detailed event information for new flags. | [optional] 
+**tags** | **Array<String>** | An array of tags for this environment. | [optional] 
 
 

data/docs/{EnvironmentBody.md → EnvironmentPost.md}

@@ -1,4 +1,4 @@
-# LaunchDarklyApi::EnvironmentBody
+# LaunchDarklyApi::EnvironmentPost
 
 ## Properties
 Name | Type | Description | Notes

data/docs/EnvironmentsApi.md

@@ -198,7 +198,7 @@ api_instance = LaunchDarklyApi::EnvironmentsApi.new
 
 project_key = "project_key_example" # String | The project key, used to tie the flags together under one project so they can be managed together.
 
-environment_body = LaunchDarklyApi::EnvironmentBody.new # EnvironmentBody | New environment.
+environment_body = LaunchDarklyApi::EnvironmentPost.new # EnvironmentPost | New environment.
 
 
 begin
@@ -214,7 +214,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. | 
- **environment_body** | [**EnvironmentBody**](EnvironmentBody.md)| New environment. | 
+ **environment_body** | [**EnvironmentPost**](EnvironmentPost.md)| New environment. | 
 
 ### Return type
 

data/docs/FeatureFlag.md

@@ -13,6 +13,8 @@ Name | Type | Description | Notes
 **maintainer_id** | **String** | The ID of the member that should maintain this flag. | [optional] 
 **tags** | **Array<String>** | An array of tags for this feature flag. | [optional] 
 **variations** | [**Array<Variation>**](Variation.md) | The variations for this feature flag. | [optional] 
+**_version** | **Integer** |  | [optional] 
+**custom_properties** | [**CustomProperties**](CustomProperties.md) |  | [optional] 
 **_links** | [**Links**](Links.md) |  | [optional] 
 **_maintainer** | [**Member**](Member.md) |  | [optional] 
 **environments** | [**Hash<String, FeatureFlagConfig>**](FeatureFlagConfig.md) |  | [optional] 

data/docs/FeatureFlagBody.md

@@ -5,6 +5,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **String** | A human-friendly name for the feature flag. Remember to note if this flag is intended to be temporary or permanent. | 
 **key** | **String** | A unique key that will be used to reference the flag in your code. | 
+**description** | **String** | A description of the feature flag. | [optional] 
 **variations** | [**Array<Variation>**](Variation.md) | An array of possible variations for the flag. | 
 **temporary** | **BOOLEAN** | Whether or not the flag is a temporary flag. | [optional] 
 **tags** | **Array<String>** | Tags for the feature flag. | [optional] 

data/docs/FeatureFlagConfig.md

@@ -10,6 +10,7 @@ Name | Type | Description | Notes
 **last_modified** | **Integer** |  | [optional] 
 **version** | **Integer** |  | [optional] 
 **targets** | [**Array<Target>**](Target.md) |  | [optional] 
+**goal_ids** | **Array<String>** |  | [optional] 
 **rules** | [**Array<Rule>**](Rule.md) |  | [optional] 
 **fallthrough** | [**Fallthrough**](Fallthrough.md) |  | [optional] 
 **off_variation** | **Integer** |  | [optional] 

data/docs/FeatureFlagStatus.md

@@ -6,6 +6,6 @@ Name | Type | Description | Notes
 **_links** | [**Links**](Links.md) |  | [optional] 
 **name** | **String** | | Name     | Description | | --------:| ----------- | | new      | the feature flag was created within the last 7 days, and has not been requested yet | | active   | the feature flag was requested by your servers or clients within the last 7 days | | inactive | the feature flag was created more than 7 days ago, and hasn't been requested by your servers or clients within the past 7 days | | launched | one variation of the feature flag has been rolled out to all your users for at least 7 days |  | [optional] 
 **last_requested** | **String** |  | [optional] 
-**default** | **BOOLEAN** |  | [optional] 
+**default** | **Object** |  | [optional] 
 
 

data/docs/FeatureFlagsApi.md

@@ -356,7 +356,7 @@ Name | Type | Description  | Notes
 
 
 # **post_feature_flag**
-> post_feature_flag(project_key, feature_flag_body)
+> FeatureFlag post_feature_flag(project_key, feature_flag_body, opts)
 
 Creates a new feature flag.
 
@@ -378,10 +378,14 @@ project_key = "project_key_example" # String | The project key, used to tie the
 
 feature_flag_body = LaunchDarklyApi::FeatureFlagBody.new # FeatureFlagBody | Create a new feature flag.
 
+opts = { 
+  clone: "clone_example" # String | The key of the feature flag to be cloned. The key identifies the flag in your code.  For example, setting clone=flagKey will copy the full targeting configuration for all environments (including on/off state) from the original flag to the new flag.
+}
 
 begin
   #Creates a new feature flag.
-  api_instance.post_feature_flag(project_key, feature_flag_body)
+  result = api_instance.post_feature_flag(project_key, feature_flag_body, opts)
+  p result
 rescue LaunchDarklyApi::ApiError => e
   puts "Exception when calling FeatureFlagsApi->post_feature_flag: #{e}"
 end
@@ -393,10 +397,11 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. | 
  **feature_flag_body** | [**FeatureFlagBody**](FeatureFlagBody.md)| Create a new feature flag. | 
+ **clone** | **String**| The key of the feature flag to be cloned. The key identifies the flag in your code.  For example, setting clone=flagKey will copy the full targeting configuration for all environments (including on/off state) from the original flag to the new flag. | [optional] 
 
 ### Return type
 
-nil (empty response body)
+[**FeatureFlag**](FeatureFlag.md)
 
 ### Authorization
 

data/docs/Project.md

@@ -8,5 +8,6 @@ Name | Type | Description | Notes
 **key** | **String** |  | [optional] 
 **name** | **String** |  | [optional] 
 **environments** | [**Array<Environment>**](Environment.md) |  | [optional] 
+**tags** | **Array<String>** | An array of tags for this project. | [optional] 
 
 

data/docs/ProjectBody.md

@@ -5,5 +5,6 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **String** |  | 
 **key** | **String** |  | 
+**environments** | [**Array<EnvironmentPost>**](EnvironmentPost.md) |  | [optional] 
 
 

data/docs/Rule.md

@@ -3,6 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**_id** | **String** |  | [optional] 
 **variation** | **Integer** |  | [optional] 
 **rollout** | [**Rollout**](Rollout.md) |  | [optional] 
 **clauses** | [**Array<Clause>**](Clause.md) |  | [optional] 

data/docs/UserFlagSettings.md

@@ -4,6 +4,6 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **_links** | [**Links**](Links.md) |  | [optional] 
-**items** | **Object** |  | [optional] 
+**items** | [**Hash<String, UserFlagSetting>**](UserFlagSetting.md) |  | [optional] 
 
 

data/launchdarkly_api.gemspec

@@ -5,7 +5,7 @@
 
 #Build custom integrations with the LaunchDarkly REST API
 
-OpenAPI spec version: 2.0.3
+OpenAPI spec version: 2.0.10
 Contact: support@launchdarkly.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.3.1
@@ -19,7 +19,7 @@ Gem::Specification.new do |s|
   s.name        = "launchdarkly_api"
   s.version     = LaunchDarklyApi::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Swagger-Codegen"]
+  s.authors     = ["LaunchDarkly"]
   s.email       = ["support@launchdarkly.com"]
   s.homepage    = "https://github.com/launchdarkly/api-client-ruby"
   s.summary     = "LaunchDarkly REST API Ruby Gem"