launchdarkly_api 3.1.0 → 3.2.0

data/lib/launchdarkly_api/models/user_targeting_expiration_on_flags_for_user.rb

@@ -3,7 +3,7 @@
 
 #Build custom integrations with the LaunchDarkly REST API
 
-OpenAPI spec version: 3.1.0
+OpenAPI spec version: 3.2.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/user_targeting_expiration_resource_id_for_flag.rb

@@ -3,7 +3,7 @@
 
 #Build custom integrations with the LaunchDarkly REST API
 
-OpenAPI spec version: 3.1.0
+OpenAPI spec version: 3.2.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/users.rb

@@ -3,7 +3,7 @@
 
 #Build custom integrations with the LaunchDarkly REST API
 
-OpenAPI spec version: 3.1.0
+OpenAPI spec version: 3.2.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/variation.rb

@@ -3,7 +3,7 @@
 
 #Build custom integrations with the LaunchDarkly REST API
 
-OpenAPI spec version: 3.1.0
+OpenAPI spec version: 3.2.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/webhook.rb

@@ -3,7 +3,7 @@
 
 #Build custom integrations with the LaunchDarkly REST API
 
-OpenAPI spec version: 3.1.0
+OpenAPI spec version: 3.2.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/webhook_body.rb

@@ -3,7 +3,7 @@
 
 #Build custom integrations with the LaunchDarkly REST API
 
-OpenAPI spec version: 3.1.0
+OpenAPI spec version: 3.2.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/webhooks.rb

@@ -3,7 +3,7 @@
 
 #Build custom integrations with the LaunchDarkly REST API
 
-OpenAPI spec version: 3.1.0
+OpenAPI spec version: 3.2.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.1.0
+OpenAPI spec version: 3.2.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.1.0
+OpenAPI spec version: 3.2.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.1.0'
+  VERSION = '3.2.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.1.0
+  version: 3.2.0
 host: app.launchdarkly.com
 basePath: /api/v2
 schemes:
@@ -381,7 +381,7 @@ paths:
         - $ref: '#/parameters/ProjectKey'
         - $ref: '#/parameters/EnvironmentKey'
         - $ref: '#/parameters/FeatureFlagKey'
-        - $ref: '#/parameters/PatchWithComment'
+        - $ref: '#/parameters/SemanticPatchWithComment'
       responses:
         '200':
           description: User targeting expirations on feature flag response.
@@ -486,6 +486,48 @@ paths:
           $ref: '#/responses/Standard404'
       tags:
         - User segments
+  '/segments/{projectKey}/{userSegmentKey}/expiring-user-targets/{environmentKey}':
+    get:
+      summary: Get expiring user targets for user segment
+      operationId: getExpiringUserTargetsOnSegment
+      parameters:
+        - $ref: '#/parameters/ProjectKey'
+        - $ref: '#/parameters/EnvironmentKey'
+        - $ref: '#/parameters/UserSegmentKey'
+      responses:
+        '200':
+          description: User targeting expirations on user segment response.
+          schema:
+            $ref: '#/definitions/UserTargetingExpirationForSegment'
+        '401':
+          $ref: '#/responses/Standard401'
+        '404':
+          $ref: '#/responses/Standard404'
+      tags:
+        - User segments
+    patch:
+      summary: 'Update, add, or delete expiring user targets on user segment'
+      operationId: patchExpiringUserTargetsOnSegment
+      parameters:
+        - $ref: '#/parameters/ProjectKey'
+        - $ref: '#/parameters/EnvironmentKey'
+        - $ref: '#/parameters/UserSegmentKey'
+        - $ref: '#/parameters/SemanticPatchWithComment'
+      responses:
+        '200':
+          description: User targeting expirations on user segment response.
+          schema:
+            $ref: '#/definitions/UserTargetingExpirationForSegment'
+        '400':
+          $ref: '#/responses/Standard400'
+        '401':
+          $ref: '#/responses/Standard401'
+        '404':
+          $ref: '#/responses/Standard404'
+        '409':
+          $ref: '#/responses/Standard409'
+      tags:
+        - User segments
   '/users/{projectKey}/{environmentKey}':
     get:
       summary: >-
@@ -655,7 +697,7 @@ paths:
         - $ref: '#/parameters/ProjectKey'
         - $ref: '#/parameters/EnvironmentKey'
         - $ref: '#/parameters/UserKey'
-        - $ref: '#/parameters/PatchWithComment'
+        - $ref: '#/parameters/SemanticPatchWithComment'
       responses:
         '200':
           description: User Targeting expiration for single user on all flags response.
@@ -1701,6 +1743,28 @@ definitions:
         $ref: '#/definitions/Links'
       _version:
         type: integer
+  UserTargetingExpirationForSegment:
+    type: object
+    properties:
+      expirationDate:
+        type: integer
+        description: Date scheduled for expiration
+      targetType:
+        type: string
+        description: >-
+          either the included or excluded variation that the user is targeted on
+          a segment
+      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:
@@ -2322,6 +2386,24 @@ definitions:
       - op
       - path
       - value
+  SemanticPatchOperation:
+    type: object
+    properties:
+      comment:
+        type: string
+        example: This is a comment string
+      instructions:
+        type: array
+        items:
+          properties:
+            kind:
+              type: string
+              example: removeUserTargets
+              description: >-
+                The name of the modification you would like to perform on a
+                resource.
+    required:
+      - instructions
   CustomProperty:
     type: object
     description: A name and value describing a custom property.
@@ -2932,14 +3014,14 @@ parameters:
     description: 'The number of objects to return. Defaults to -1, which returns everything.'
     type: number
   OffsetQuery:
-    name: number
+    name: offset
     in: query
     required: false
     description: >-
       Where to start in the list. This is for use with pagination. For example,
       an offset of 10 would skip the first 10 items and then return the next
       limit items.
-    type: boolean
+    type: number
   FilterQuery:
     name: filter
     in: query
@@ -3196,6 +3278,19 @@ parameters:
       type: array
       items:
         $ref: '#/definitions/PatchOperation'
+  SemanticPatchWithComment:
+    name: SemanticPatchWithComment
+    in: body
+    required: true
+    description: >-
+      Requires a Semantic Patch representation of the desired changes to the
+      resource.
+      'https://apidocs.launchdarkly.com/reference#updates-via-semantic-patches'.
+      The addition of comments is also supported.
+    schema:
+      type: object
+      items:
+        $ref: '#/definitions/SemanticPatchOperation'
   StreamSource:
     name: source
     in: path

data/spec/api/audit_log_api_spec.rb

@@ -3,7 +3,7 @@
 
 #Build custom integrations with the LaunchDarkly REST API
 
-OpenAPI spec version: 3.1.0
+OpenAPI spec version: 3.2.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.1.0
+OpenAPI spec version: 3.2.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.1.0
+OpenAPI spec version: 3.2.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.1.0
+OpenAPI spec version: 3.2.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.1.0
+OpenAPI spec version: 3.2.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.1.0
+OpenAPI spec version: 3.2.0
 Contact: support@launchdarkly.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.8
@@ -128,7 +128,7 @@ describe 'FeatureFlagsApi' do
   # @option opts [BOOLEAN] :summary By default in api version >= 1, flags will _not_ include their list of prerequisites, targets or rules.  Set summary=0 to include these fields for each flag returned.
   # @option opts [BOOLEAN] :archived When set to 1, archived flags will be included in the list of flags returned.  By default, archived flags are not included in the list of flags.
   # @option opts [Float] :limit The number of objects to return. Defaults to -1, which returns everything.
-  # @option opts [BOOLEAN] :number Where to start in the list. This is for use with pagination. For example, an offset of 10 would skip the first 10 items and then return the next limit items.
+  # @option opts [Float] :offset Where to start in the list. This is for use with pagination. For example, an offset of 10 would skip the first 10 items and then return the next limit items.
   # @option opts [String] :filter A comma-separated list of filters. Each filter is of the form field:value.
   # @option opts [String] :sort A comma-separated list of fields to sort by. A field prefixed by a - will be sorted in descending order.
   # @option opts [String] :tag Filter by tag. A tag can be used to group flags across projects.
@@ -144,7 +144,7 @@ describe 'FeatureFlagsApi' do
   # @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 semantic_patch_with_comment Requires a Semantic Patch representation of the desired changes to the resource. 'https://apidocs.launchdarkly.com/reference#updates-via-semantic-patches'. The addition of comments is also supported.
   # @param [Hash] opts the optional parameters
   # @return [UserTargetingExpirationForFlags]
   describe 'patch_expiring_user_targets test' do

data/spec/api/projects_api_spec.rb

@@ -3,7 +3,7 @@
 
 #Build custom integrations with the LaunchDarkly REST API
 
-OpenAPI spec version: 3.1.0
+OpenAPI spec version: 3.2.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.1.0
+OpenAPI spec version: 3.2.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.1.0
+OpenAPI spec version: 3.2.0
 Contact: support@launchdarkly.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.8
@@ -68,7 +68,7 @@ describe 'TeamMembersApi' do
   # Returns a list of all members in the account.
   # @param [Hash] opts the optional parameters
   # @option opts [Float] :limit The number of objects to return. Defaults to -1, which returns everything.
-  # @option opts [BOOLEAN] :number Where to start in the list. This is for use with pagination. For example, an offset of 10 would skip the first 10 items and then return the next limit items.
+  # @option opts [Float] :offset Where to start in the list. This is for use with pagination. For example, an offset of 10 would skip the first 10 items and then return the next limit items.
   # @option opts [String] :filter A comma-separated list of filters. Each filter is of the form field:value.
   # @option opts [String] :sort A comma-separated list of fields to sort by. A field prefixed by a - will be sorted in descending order.
   # @return [Members]

data/spec/api/user_segments_api_spec.rb

@@ -3,7 +3,7 @@
 
 #Build custom integrations with the LaunchDarkly REST API
 
-OpenAPI spec version: 3.1.0
+OpenAPI spec version: 3.2.0
 Contact: support@launchdarkly.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.8
@@ -45,6 +45,19 @@ describe 'UserSegmentsApi' do
     end
   end
 
+  # unit tests for get_expiring_user_targets_on_segment
+  # Get expiring user targets for user segment
+  # @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_segment_key The user segment's key. The key identifies the user segment in your code.
+  # @param [Hash] opts the optional parameters
+  # @return [UserTargetingExpirationForSegment]
+  describe 'get_expiring_user_targets_on_segment 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_segment
   # Get a single user segment by key.
   # @param project_key The project key, used to tie the flags together under one project so they can be managed together.
@@ -71,6 +84,20 @@ describe 'UserSegmentsApi' do
     end
   end
 
+  # unit tests for patch_expiring_user_targets_on_segment
+  # Update, add, or delete expiring user targets on user segment
+  # @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_segment_key The user segment's key. The key identifies the user segment in your code.
+  # @param semantic_patch_with_comment Requires a Semantic Patch representation of the desired changes to the resource. 'https://apidocs.launchdarkly.com/reference#updates-via-semantic-patches'. The addition of comments is also supported.
+  # @param [Hash] opts the optional parameters
+  # @return [UserTargetingExpirationForSegment]
+  describe 'patch_expiring_user_targets_on_segment 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_user_segment
   # Perform a partial update to a user segment.
   # @param project_key The project key, used to tie the flags together under one project so they can be managed together.

data/spec/api/user_settings_api_spec.rb

@@ -3,7 +3,7 @@
 
 #Build custom integrations with the LaunchDarkly REST API
 
-OpenAPI spec version: 3.1.0
+OpenAPI spec version: 3.2.0
 Contact: support@launchdarkly.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.8
@@ -77,7 +77,7 @@ describe 'UserSettingsApi' do
   # @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 semantic_patch_with_comment Requires a Semantic Patch representation of the desired changes to the resource. 'https://apidocs.launchdarkly.com/reference#updates-via-semantic-patches'. The addition of comments is also supported.
   # @param [Hash] opts the optional parameters
   # @return [UserTargetingExpirationOnFlagsForUser]
   describe 'patch_expiring_user_targets_for_flags test' do