launchdarkly_api 2.0.33 → 3.3.1

data/lib/launchdarkly_api/models/user_targeting_expiration_resource_id_for_flag.rb

@@ -0,0 +1,219 @@
+=begin
+#LaunchDarkly REST API
+
+#Build custom integrations with the LaunchDarkly REST API
+
+OpenAPI spec version: 3.3.1
+Contact: support@launchdarkly.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.8
+
+=end
+
+require 'date'
+
+module LaunchDarklyApi
+  class UserTargetingExpirationResourceIdForFlag
+    attr_accessor :kind
+
+    attr_accessor :project_key
+
+    attr_accessor :environment_key
+
+    attr_accessor :flag_key
+
+    attr_accessor :key
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'kind' => :'kind',
+        :'project_key' => :'projectKey',
+        :'environment_key' => :'environmentKey',
+        :'flag_key' => :'flagKey',
+        :'key' => :'key'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'kind' => :'String',
+        :'project_key' => :'String',
+        :'environment_key' => :'String',
+        :'flag_key' => :'String',
+        :'key' => :'String'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'kind')
+        self.kind = attributes[:'kind']
+      end
+
+      if attributes.has_key?(:'projectKey')
+        self.project_key = attributes[:'projectKey']
+      end
+
+      if attributes.has_key?(:'environmentKey')
+        self.environment_key = attributes[:'environmentKey']
+      end
+
+      if attributes.has_key?(:'flagKey')
+        self.flag_key = attributes[:'flagKey']
+      end
+
+      if attributes.has_key?(:'key')
+        self.key = attributes[:'key']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          kind == o.kind &&
+          project_key == o.project_key &&
+          environment_key == o.environment_key &&
+          flag_key == o.flag_key &&
+          key == o.key
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [kind, project_key, environment_key, flag_key, key].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = LaunchDarklyApi.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+  end
+end

data/lib/launchdarkly_api/models/users.rb

@@ -3,7 +3,7 @@
 
 #Build custom integrations with the LaunchDarkly REST API
 
-OpenAPI spec version: 2.0.33
+OpenAPI spec version: 3.3.1
 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: 2.0.33
+OpenAPI spec version: 3.3.1
 Contact: support@launchdarkly.com
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.4.8
@@ -14,6 +14,8 @@ require 'date'
 
 module LaunchDarklyApi
   class Variation
+    attr_accessor :_id
+
     attr_accessor :name
 
     attr_accessor :description
@@ -23,6 +25,7 @@ module LaunchDarklyApi
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'_id' => :'_id',
         :'name' => :'name',
         :'description' => :'description',
         :'value' => :'value'
@@ -32,6 +35,7 @@ module LaunchDarklyApi
     # Attribute type mapping.
     def self.swagger_types
       {
+        :'_id' => :'String',
         :'name' => :'String',
         :'description' => :'String',
         :'value' => :'Object'
@@ -46,6 +50,10 @@ module LaunchDarklyApi
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
 
+      if attributes.has_key?(:'_id')
+        self._id = attributes[:'_id']
+      end
+
       if attributes.has_key?(:'name')
         self.name = attributes[:'name']
       end
@@ -82,6 +90,7 @@ module LaunchDarklyApi
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          _id == o._id &&
           name == o.name &&
           description == o.description &&
           value == o.value
@@ -96,7 +105,7 @@ module LaunchDarklyApi
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [name, description, value].hash
+      [_id, name, description, value].hash
     end
 
     # Builds the object from hash

data/lib/launchdarkly_api/models/webhook.rb

@@ -3,7 +3,7 @@
 
 #Build custom integrations with the LaunchDarkly REST API
 
-OpenAPI spec version: 2.0.33
+OpenAPI spec version: 3.3.1
 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: 2.0.33
+OpenAPI spec version: 3.3.1
 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: 2.0.33
+OpenAPI spec version: 3.3.1
 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: 2.0.33
+OpenAPI spec version: 3.3.1
 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: 2.0.33
+OpenAPI spec version: 3.3.1
 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 = '2.0.33'
+  VERSION = '3.3.1'
 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: 2.0.33
+  version: 3.3.1
 host: app.launchdarkly.com
 basePath: /api/v2
 schemes:
@@ -188,6 +188,10 @@ paths:
         - $ref: '#/parameters/EnvironmentKeyQuery'
         - $ref: '#/parameters/SummaryQuery'
         - $ref: '#/parameters/ArchivedQuery'
+        - $ref: '#/parameters/LimitQuery'
+        - $ref: '#/parameters/OffsetQuery'
+        - $ref: '#/parameters/FilterQuery'
+        - $ref: '#/parameters/SortQuery'
         - $ref: '#/parameters/Tag'
       responses:
         '200':
@@ -353,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/SemanticPatchWithComment'
+      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.
@@ -442,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: >-
@@ -585,6 +671,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/SemanticPatchWithComment'
+      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: >-
@@ -782,6 +910,11 @@ paths:
     get:
       summary: Returns a list of all members in the account.
       operationId: getMembers
+      parameters:
+        - $ref: '#/parameters/LimitQuery'
+        - $ref: '#/parameters/OffsetQuery'
+        - $ref: '#/parameters/FilterQuery'
+        - $ref: '#/parameters/SortQuery'
       responses:
         '200':
           description: Members response.
@@ -809,6 +942,19 @@ paths:
           $ref: '#/responses/Standard409'
       tags:
         - Team members
+  /members/me:
+    get:
+      summary: Get the current team member associated with the token
+      operationId: getMe
+      responses:
+        '200':
+          $ref: '#/responses/Member2xx'
+        '400':
+          $ref: '#/responses/Standard400'
+        '401':
+          $ref: '#/responses/Standard401'
+      tags:
+        - Team members
   '/members/{memberId}':
     get:
       summary: Get a single team member by ID.
@@ -1285,6 +1431,8 @@ definitions:
         type: array
         items:
           $ref: '#/definitions/FeatureFlag'
+      totalCount:
+        type: number
   Member:
     type: object
     properties:
@@ -1303,6 +1451,8 @@ definitions:
       lastName:
         type: string
         example: Turing
+      _verified:
+        type: boolean
       _pendingInvite:
         type: boolean
       isBeta:
@@ -1320,6 +1470,8 @@ definitions:
         type: array
         items:
           $ref: '#/definitions/Member'
+      totalCount:
+        type: number
   FeatureFlagConfig:
     type: object
     properties:
@@ -1417,6 +1569,8 @@ definitions:
   Clause:
     type: object
     properties:
+      _id:
+        type: string
       attribute:
         type: string
         example: groups
@@ -1435,6 +1589,9 @@ definitions:
     required:
       - value
     properties:
+      _id:
+        type: string
+        example: 24b32dd3-0ba6-46ee-86af-230eebf3c7cb
       name:
         type: string
         example: 'True'
@@ -1551,6 +1708,83 @@ 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: number
+        format: int64
+        description: Unix epoch time in milliseconds specifying the expiration date
+        example: 1735689600000
+      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
+  UserTargetingExpirationForSegment:
+    type: object
+    properties:
+      expirationDate:
+        type: number
+        format: int64
+        description: Unix epoch time in milliseconds specifying the expiration date
+        example: 1735689600000
+      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:
+      kind:
+        type: string
+      projectKey:
+        type: string
+      environmentKey:
+        type: string
+      flagKey:
+        type: string
+      key:
+        type: string
   UserSegment:
     type: object
     required:
@@ -2159,6 +2393,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.
@@ -2738,9 +2990,12 @@ parameters:
     description: >-
       By default, each feature will include configurations for each environment.
       You can filter environments with the env query parameter. For example,
-      setting env=production will restrict the returned configurations to just
-      your production environment.
-    type: string
+      setting env=["production"] will restrict the returned configurations to
+      just your production environment.
+    type: array
+    items:
+      type: string
+    collectionFormat: multi
   SummaryQuery:
     name: summary
     in: query
@@ -2759,6 +3014,35 @@ parameters:
       returned.  By default, archived flags are not included in the list of
       flags.
     type: boolean
+  LimitQuery:
+    name: limit
+    in: query
+    required: false
+    description: 'The number of objects to return. Defaults to -1, which returns everything.'
+    type: number
+  OffsetQuery:
+    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: number
+  FilterQuery:
+    name: filter
+    in: query
+    required: false
+    description: 'A comma-separated list of filters. Each filter is of the form field:value.'
+    type: string
+  SortQuery:
+    name: sort
+    in: query
+    required: false
+    description: >-
+      A comma-separated list of fields to sort by. A field prefixed by a - will
+      be sorted in descending order.
+    type: string
   FeatureFlagKey:
     name: featureFlagKey
     in: path
@@ -3001,6 +3285,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