launchdarkly_api 3.0.0 → 3.1.0

data/lib/launchdarkly_api/models/webhooks.rb

@@ -3,7 +3,7 @@
 
 #Build custom integrations with the LaunchDarkly REST API
 
-OpenAPI spec version: 3.0.0
+OpenAPI spec version: 3.1.0
 Contact: support@launchdarkly.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.8

data/lib/launchdarkly_api/models/weighted_variation.rb

@@ -3,7 +3,7 @@
 
 #Build custom integrations with the LaunchDarkly REST API
 
-OpenAPI spec version: 3.0.0
+OpenAPI spec version: 3.1.0
 Contact: support@launchdarkly.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.8

data/lib/launchdarkly_api/version.rb

@@ -3,7 +3,7 @@
 
 #Build custom integrations with the LaunchDarkly REST API
 
-OpenAPI spec version: 3.0.0
+OpenAPI spec version: 3.1.0
 Contact: support@launchdarkly.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.8
@@ -11,5 +11,5 @@ Swagger Codegen version: 2.4.8
 =end
 
 module LaunchDarklyApi
-  VERSION = '3.0.0'
+  VERSION = '3.1.0'
 end

data/openapi.yml

@@ -10,7 +10,7 @@ info:
   license:
     name: Apache 2.0
     url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
-  version: 3.0.0
+  version: 3.1.0
 host: app.launchdarkly.com
 basePath: /api/v2
 schemes:
@@ -357,6 +357,46 @@ paths:
           $ref: '#/responses/BetaApi403'
       tags:
         - Feature flags
+  '/flags/{projectKey}/{featureFlagKey}/expiring-user-targets/{environmentKey}':
+    get:
+      summary: Get expiring user targets for feature flag
+      operationId: getExpiringUserTargets
+      parameters:
+        - $ref: '#/parameters/ProjectKey'
+        - $ref: '#/parameters/EnvironmentKey'
+        - $ref: '#/parameters/FeatureFlagKey'
+      responses:
+        '200':
+          description: User targets of the requested feature flag.
+          schema:
+            $ref: '#/definitions/UserTargetingExpirationForFlags'
+        '401':
+          $ref: '#/responses/Standard401'
+      tags:
+        - Feature flags
+    patch:
+      summary: 'Update, add, or delete expiring user targets on feature flag'
+      operationId: patchExpiringUserTargets
+      parameters:
+        - $ref: '#/parameters/ProjectKey'
+        - $ref: '#/parameters/EnvironmentKey'
+        - $ref: '#/parameters/FeatureFlagKey'
+        - $ref: '#/parameters/PatchWithComment'
+      responses:
+        '200':
+          description: User targeting expirations on feature flag response.
+          schema:
+            $ref: '#/definitions/UserTargetingExpirationForFlags'
+        '400':
+          $ref: '#/responses/Standard400'
+        '401':
+          $ref: '#/responses/Standard401'
+        '404':
+          $ref: '#/responses/Standard404'
+        '409':
+          $ref: '#/responses/Standard409'
+      tags:
+        - Feature flags
   '/segments/{projectKey}/{environmentKey}':
     get:
       summary: Get a list of all user segments in the given project.
@@ -589,6 +629,48 @@ paths:
           $ref: '#/responses/Standard404'
       tags:
         - User settings
+  '/users/{projectKey}/{userKey}/expiring-user-targets/{environmentKey}':
+    get:
+      summary: Get expiring dates on flags for user
+      operationId: getExpiringUserTargetsForUser
+      parameters:
+        - $ref: '#/parameters/ProjectKey'
+        - $ref: '#/parameters/EnvironmentKey'
+        - $ref: '#/parameters/UserKey'
+      responses:
+        '200':
+          description: User targets of the requested feature flag.
+          schema:
+            $ref: '#/definitions/UserTargetingExpirationOnFlagsForUser'
+        '401':
+          $ref: '#/responses/Standard401'
+      tags:
+        - User settings
+    patch:
+      summary: >-
+        Update, add, or delete expiring user targets for a single user on all
+        flags
+      operationId: patchExpiringUserTargetsForFlags
+      parameters:
+        - $ref: '#/parameters/ProjectKey'
+        - $ref: '#/parameters/EnvironmentKey'
+        - $ref: '#/parameters/UserKey'
+        - $ref: '#/parameters/PatchWithComment'
+      responses:
+        '200':
+          description: User Targeting expiration for single user on all flags response.
+          schema:
+            $ref: '#/definitions/UserTargetingExpirationOnFlagsForUser'
+        '400':
+          $ref: '#/responses/Standard400'
+        '401':
+          $ref: '#/responses/Standard401'
+        '404':
+          $ref: '#/responses/Standard404'
+        '409':
+          $ref: '#/responses/Standard409'
+      tags:
+        - User settings
   /auditlog:
     get:
       summary: >-
@@ -1445,6 +1527,8 @@ definitions:
   Clause:
     type: object
     properties:
+      _id:
+        type: string
       attribute:
         type: string
         example: groups
@@ -1579,6 +1663,57 @@ definitions:
         type: object
         additionalProperties:
           $ref: '#/definitions/FeatureFlagStatusForQueriedEnvironment'
+  UserTargetingExpirationForFlags:
+    type: object
+    properties:
+      _links:
+        $ref: '#/definitions/Links'
+      items:
+        type: array
+        items:
+          $ref: '#/definitions/UserTargetingExpirationForFlag'
+  UserTargetingExpirationOnFlagsForUser:
+    type: object
+    properties:
+      _links:
+        $ref: '#/definitions/Links'
+      items:
+        type: array
+        items:
+          $ref: '#/definitions/UserTargetingExpirationForFlag'
+  UserTargetingExpirationForFlag:
+    type: object
+    properties:
+      expirationDate:
+        type: integer
+        description: Date scheduled for expiration
+      variationId:
+        type: string
+        description: the ID of the variation that the user is targeted on a flag
+      userKey:
+        type: string
+        description: Unique identifier for the user
+      _id:
+        type: string
+      _resourceId:
+        $ref: '#/definitions/UserTargetingExpirationResourceIdForFlag'
+      _links:
+        $ref: '#/definitions/Links'
+      _version:
+        type: integer
+  UserTargetingExpirationResourceIdForFlag:
+    type: object
+    properties:
+      kind:
+        type: string
+      projectKey:
+        type: string
+      environmentKey:
+        type: string
+      flagKey:
+        type: string
+      key:
+        type: string
   UserSegment:
     type: object
     required:

data/spec/api/audit_log_api_spec.rb

@@ -3,7 +3,7 @@
 
 #Build custom integrations with the LaunchDarkly REST API
 
-OpenAPI spec version: 3.0.0
+OpenAPI spec version: 3.1.0
 Contact: support@launchdarkly.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.8

data/spec/api/custom_roles_api_spec.rb

@@ -3,7 +3,7 @@
 
 #Build custom integrations with the LaunchDarkly REST API
 
-OpenAPI spec version: 3.0.0
+OpenAPI spec version: 3.1.0
 Contact: support@launchdarkly.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.8

data/spec/api/customer_metrics_api_spec.rb

@@ -3,7 +3,7 @@
 
 #Build custom integrations with the LaunchDarkly REST API
 
-OpenAPI spec version: 3.0.0
+OpenAPI spec version: 3.1.0
 Contact: support@launchdarkly.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.8

data/spec/api/data_export_destinations_api_spec.rb

@@ -3,7 +3,7 @@
 
 #Build custom integrations with the LaunchDarkly REST API
 
-OpenAPI spec version: 3.0.0
+OpenAPI spec version: 3.1.0
 Contact: support@launchdarkly.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.8

data/spec/api/environments_api_spec.rb

@@ -3,7 +3,7 @@
 
 #Build custom integrations with the LaunchDarkly REST API
 
-OpenAPI spec version: 3.0.0
+OpenAPI spec version: 3.1.0
 Contact: support@launchdarkly.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.8

data/spec/api/feature_flags_api_spec.rb

@@ -3,7 +3,7 @@
 
 #Build custom integrations with the LaunchDarkly REST API
 
-OpenAPI spec version: 3.0.0
+OpenAPI spec version: 3.1.0
 Contact: support@launchdarkly.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.8
@@ -57,6 +57,19 @@ describe 'FeatureFlagsApi' do
     end
   end
 
+  # unit tests for get_expiring_user_targets
+  # Get expiring user targets for feature flag
+  # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
+  # @param environment_key The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
+  # @param feature_flag_key The feature flag's key. The key identifies the flag in your code.
+  # @param [Hash] opts the optional parameters
+  # @return [UserTargetingExpirationForFlags]
+  describe 'get_expiring_user_targets test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for get_feature_flag
   # Get a single feature flag by key.
   # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
@@ -126,6 +139,20 @@ describe 'FeatureFlagsApi' do
     end
   end
 
+  # unit tests for patch_expiring_user_targets
+  # Update, add, or delete expiring user targets on feature flag
+  # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
+  # @param environment_key The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
+  # @param feature_flag_key The feature flag's key. The key identifies the flag in your code.
+  # @param patch_comment Requires a JSON Patch representation of the desired changes to the project, and an optional comment. 'http://jsonpatch.com/' Feature flag patches also support JSON Merge Patch format. 'https://tools.ietf.org/html/rfc7386' The addition of comments is also supported.
+  # @param [Hash] opts the optional parameters
+  # @return [UserTargetingExpirationForFlags]
+  describe 'patch_expiring_user_targets test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for patch_feature_flag
   # Perform a partial update to a feature.
   # @param project_key The project key, used to tie the flags together under one project so they can be managed together.

data/spec/api/projects_api_spec.rb

@@ -3,7 +3,7 @@
 
 #Build custom integrations with the LaunchDarkly REST API
 
-OpenAPI spec version: 3.0.0
+OpenAPI spec version: 3.1.0
 Contact: support@launchdarkly.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.8

data/spec/api/root_api_spec.rb

@@ -3,7 +3,7 @@
 
 #Build custom integrations with the LaunchDarkly REST API
 
-OpenAPI spec version: 3.0.0
+OpenAPI spec version: 3.1.0
 Contact: support@launchdarkly.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.8

data/spec/api/team_members_api_spec.rb

@@ -3,7 +3,7 @@
 
 #Build custom integrations with the LaunchDarkly REST API
 
-OpenAPI spec version: 3.0.0
+OpenAPI spec version: 3.1.0
 Contact: support@launchdarkly.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.8

data/spec/api/user_segments_api_spec.rb

@@ -3,7 +3,7 @@
 
 #Build custom integrations with the LaunchDarkly REST API
 
-OpenAPI spec version: 3.0.0
+OpenAPI spec version: 3.1.0
 Contact: support@launchdarkly.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.8

data/spec/api/user_settings_api_spec.rb

@@ -3,7 +3,7 @@
 
 #Build custom integrations with the LaunchDarkly REST API
 
-OpenAPI spec version: 3.0.0
+OpenAPI spec version: 3.1.0
 Contact: support@launchdarkly.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.8
@@ -32,6 +32,19 @@ describe 'UserSettingsApi' do
     end
   end
 
+  # unit tests for get_expiring_user_targets_for_user
+  # Get expiring dates on flags for user
+  # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
+  # @param environment_key The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
+  # @param user_key The user's key.
+  # @param [Hash] opts the optional parameters
+  # @return [UserTargetingExpirationOnFlagsForUser]
+  describe 'get_expiring_user_targets_for_user test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for get_user_flag_setting
   # Fetch a single flag setting for a user by key.
   # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
@@ -59,6 +72,20 @@ describe 'UserSettingsApi' do
     end
   end
 
+  # unit tests for patch_expiring_user_targets_for_flags
+  # Update, add, or delete expiring user targets for a single user on all flags
+  # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
+  # @param environment_key The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
+  # @param user_key The user's key.
+  # @param patch_comment Requires a JSON Patch representation of the desired changes to the project, and an optional comment. 'http://jsonpatch.com/' Feature flag patches also support JSON Merge Patch format. 'https://tools.ietf.org/html/rfc7386' The addition of comments is also supported.
+  # @param [Hash] opts the optional parameters
+  # @return [UserTargetingExpirationOnFlagsForUser]
+  describe 'patch_expiring_user_targets_for_flags test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for put_flag_setting
   # Specifically enable or disable a feature flag for a user based on their key.
   # @param project_key The project key, used to tie the flags together under one project so they can be managed together.

data/spec/api/users_api_spec.rb

@@ -3,7 +3,7 @@
 
 #Build custom integrations with the LaunchDarkly REST API
 
-OpenAPI spec version: 3.0.0
+OpenAPI spec version: 3.1.0
 Contact: support@launchdarkly.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.8

data/spec/api/webhooks_api_spec.rb

@@ -3,7 +3,7 @@
 
 #Build custom integrations with the LaunchDarkly REST API
 
-OpenAPI spec version: 3.0.0
+OpenAPI spec version: 3.1.0
 Contact: support@launchdarkly.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.8

data/spec/api_client_spec.rb

@@ -3,7 +3,7 @@
 
 #Build custom integrations with the LaunchDarkly REST API
 
-OpenAPI spec version: 3.0.0
+OpenAPI spec version: 3.1.0
 Contact: support@launchdarkly.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.8

data/spec/configuration_spec.rb

@@ -3,7 +3,7 @@
 
 #Build custom integrations with the LaunchDarkly REST API
 
-OpenAPI spec version: 3.0.0
+OpenAPI spec version: 3.1.0
 Contact: support@launchdarkly.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.8

data/spec/models/audit_log_entries_spec.rb

@@ -3,7 +3,7 @@
 
 #Build custom integrations with the LaunchDarkly REST API
 
-OpenAPI spec version: 3.0.0
+OpenAPI spec version: 3.1.0
 Contact: support@launchdarkly.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.8