zernio-sdk 0.0.558 → 0.0.560

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95b819606f8aa6f719429e45eb155a7f80139d338d97666f789560d210f691b0
-  data.tar.gz: ef93873a14de4cfeaf1ef26cc3ed9003a8278ee130f1a00ac85d931e5b288759
+  metadata.gz: bcaa3f1e5d1d253bd1790b6e44de496391f7bf7b035f046c9382c8b31d650c8e
+  data.tar.gz: 68669d6d6a1d35f7fae39ce311632729e8f68c9682682f661cb61472e18e783d
 SHA512:
-  metadata.gz: 4d39a820634b7047a18a835ce192297eeb7843b00a0f65c2004d396f183a7cecbd89e6162c6303cd7dc077ab69d3d93b688816d0941dd4305fdab42ed54404b1
-  data.tar.gz: 31f9620161b4a8c22797586445fc6c6c765340ac49c5585058b9c43adf8953a854382e0bdaf88c0c53d093c2e856ab2b19cc5afa48e80e2e2dc6d98251ebc5d4
+  metadata.gz: 15bd978afe9fcd59818103203f456d93abcebf1e0e9e3caf7935b73a353e99c72464e841883329457c46ddf422fafa1eb0c5aeaa902d0e428f473e257480a9ac
+  data.tar.gz: f7ffc42d70ae75e14c4ded6a8fc1971975d0f1e0fd70a8152a41b65eae81220fedb9722d2e7128be6ae8037c30ce8ecc3d831cad81fbd16af85dacf5baa38423

data/docs/ProfilesApi.md

@@ -13,11 +13,11 @@ All URIs are relative to *https://zernio.com/api*
 
 ## create_profile
 
-> <ProfileCreateResponse> create_profile(create_profile_request)
+> <ProfileCreateResponse> create_profile(create_profile_request, opts)
 
 Create profile
 
-Creates a new profile with a name, optional description, and color.
+Creates a new profile with a name, optional description, and color. Names are unique per workspace: a duplicate returns a 409 whose details.existingProfileId carries the id of the existing profile. Send an Idempotency-Key header to make retries safe: a retried create with the same key and body replays the original 201 (same _id) instead of conflicting.
 
 ### Examples
 
@@ -32,10 +32,13 @@ end
 
 api_instance = Zernio::ProfilesApi.new
 create_profile_request = Zernio::CreateProfileRequest.new({name: 'name_example'}) # CreateProfileRequest | 
+opts = {
+  idempotency_key: 'idempotency_key_example' # String | Optional client-generated unique key (e.g. a UUID) that makes create retries safe. Same key + same body replays the original response; same key + different body → 422; key still processing → 409.
+}
 
 begin
   # Create profile
-  result = api_instance.create_profile(create_profile_request)
+  result = api_instance.create_profile(create_profile_request, opts)
   p result
 rescue Zernio::ApiError => e
   puts "Error when calling ProfilesApi->create_profile: #{e}"
@@ -46,12 +49,12 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<ProfileCreateResponse>, Integer, Hash)> create_profile_with_http_info(create_profile_request)
+> <Array(<ProfileCreateResponse>, Integer, Hash)> create_profile_with_http_info(create_profile_request, opts)
 
 ```ruby
 begin
   # Create profile
-  data, status_code, headers = api_instance.create_profile_with_http_info(create_profile_request)
+  data, status_code, headers = api_instance.create_profile_with_http_info(create_profile_request, opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <ProfileCreateResponse>
@@ -65,6 +68,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **create_profile_request** | [**CreateProfileRequest**](CreateProfileRequest.md) |  |  |
+| **idempotency_key** | **String** | Optional client-generated unique key (e.g. a UUID) that makes create retries safe. Same key + same body replays the original response; same key + different body → 422; key still processing → 409. | [optional] |
 
 ### Return type
 
@@ -224,7 +228,7 @@ end
 
 List profiles
 
-Returns profiles sorted by creation date. Use includeOverLimit=true to include profiles that exceed the plan limit.
+Returns profiles sorted default-first, then by creation date. Filter with name (exact match) and paginate with limit/skip; without those params the full list is returned unchanged. Use includeOverLimit=true to include profiles that exceed the plan limit.
 
 ### Examples
 
@@ -239,7 +243,10 @@ end
 
 api_instance = Zernio::ProfilesApi.new
 opts = {
-  include_over_limit: true # Boolean | When true, includes over-limit profiles (marked with isOverLimit: true).
+  include_over_limit: true, # Boolean | When true, includes over-limit profiles (marked with isOverLimit: true).
+  name: 'name_example', # String | Exact-match filter on the profile name. Useful to recover a profile id after an ambiguous create (timeout followed by a 409 on retry).
+  limit: 56, # Integer | Page size. When limit or skip is present, the response includes total and skip (and echoes limit).
+  skip: 56 # Integer | Number of profiles to skip, applied after sorting and filtering.
 }
 
 begin
@@ -274,6 +281,9 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **include_over_limit** | **Boolean** | When true, includes over-limit profiles (marked with isOverLimit: true). | [optional][default to false] |
+| **name** | **String** | Exact-match filter on the profile name. Useful to recover a profile id after an ambiguous create (timeout followed by a 409 on retry). | [optional] |
+| **limit** | **Integer** | Page size. When limit or skip is present, the response includes total and skip (and echoes limit). | [optional] |
+| **skip** | **Integer** | Number of profiles to skip, applied after sorting and filtering. | [optional] |
 
 ### Return type
 

data/docs/ProfilesListResponse.md

@@ -5,6 +5,9 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **profiles** | [**Array<Profile>**](Profile.md) |  | [optional] |
+| **total** | **Integer** | Total matching profiles across all pages. Present only when limit or skip was passed. | [optional] |
+| **skip** | **Integer** | Offset applied. Present only when limit or skip was passed. | [optional] |
+| **limit** | **Integer** | Echo of the limit query param. Present only when it was passed. | [optional] |
 
 ## Example
 
@@ -12,7 +15,10 @@
 require 'zernio-sdk'
 
 instance = Zernio::ProfilesListResponse.new(
-  profiles: null
+  profiles: null,
+  total: null,
+  skip: null,
+  limit: null
 )
 ```
 

data/lib/zernio-sdk/api/profiles_api.rb

@@ -20,9 +20,10 @@ module Zernio
       @api_client = api_client
     end
     # Create profile
-    # Creates a new profile with a name, optional description, and color.
+    # Creates a new profile with a name, optional description, and color. Names are unique per workspace: a duplicate returns a 409 whose details.existingProfileId carries the id of the existing profile. Send an Idempotency-Key header to make retries safe: a retried create with the same key and body replays the original 201 (same _id) instead of conflicting.
     # @param create_profile_request [CreateProfileRequest] 
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key Optional client-generated unique key (e.g. a UUID) that makes create retries safe. Same key + same body replays the original response; same key + different body → 422; key still processing → 409.
     # @return [ProfileCreateResponse]
     def create_profile(create_profile_request, opts = {})
       data, _status_code, _headers = create_profile_with_http_info(create_profile_request, opts)
@@ -30,9 +31,10 @@ module Zernio
     end
 
     # Create profile
-    # Creates a new profile with a name, optional description, and color.
+    # Creates a new profile with a name, optional description, and color. Names are unique per workspace: a duplicate returns a 409 whose details.existingProfileId carries the id of the existing profile. Send an Idempotency-Key header to make retries safe: a retried create with the same key and body replays the original 201 (same _id) instead of conflicting.
     # @param create_profile_request [CreateProfileRequest] 
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key Optional client-generated unique key (e.g. a UUID) that makes create retries safe. Same key + same body replays the original response; same key + different body → 422; key still processing → 409.
     # @return [Array<(ProfileCreateResponse, Integer, Hash)>] ProfileCreateResponse data, response status code and response headers
     def create_profile_with_http_info(create_profile_request, opts = {})
       if @api_client.config.debugging
@@ -42,6 +44,10 @@ module Zernio
       if @api_client.config.client_side_validation && create_profile_request.nil?
         fail ArgumentError, "Missing the required parameter 'create_profile_request' when calling ProfilesApi.create_profile"
       end
+      if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length > 255
+        fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling ProfilesApi.create_profile, the character length must be smaller than or equal to 255.'
+      end
+
       # resource path
       local_var_path = '/v1/profiles'
 
@@ -57,6 +63,7 @@ module Zernio
       if !content_type.nil?
           header_params['Content-Type'] = content_type
       end
+      header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
 
       # form parameters
       form_params = opts[:form_params] || {}
@@ -214,9 +221,12 @@ module Zernio
     end
 
     # List profiles
-    # Returns profiles sorted by creation date. Use includeOverLimit=true to include profiles that exceed the plan limit.
+    # Returns profiles sorted default-first, then by creation date. Filter with name (exact match) and paginate with limit/skip; without those params the full list is returned unchanged. Use includeOverLimit=true to include profiles that exceed the plan limit.
     # @param [Hash] opts the optional parameters
     # @option opts [Boolean] :include_over_limit When true, includes over-limit profiles (marked with isOverLimit: true). (default to false)
+    # @option opts [String] :name Exact-match filter on the profile name. Useful to recover a profile id after an ambiguous create (timeout followed by a 409 on retry).
+    # @option opts [Integer] :limit Page size. When limit or skip is present, the response includes total and skip (and echoes limit).
+    # @option opts [Integer] :skip Number of profiles to skip, applied after sorting and filtering.
     # @return [ProfilesListResponse]
     def list_profiles(opts = {})
       data, _status_code, _headers = list_profiles_with_http_info(opts)
@@ -224,20 +234,38 @@ module Zernio
     end
 
     # List profiles
-    # Returns profiles sorted by creation date. Use includeOverLimit&#x3D;true to include profiles that exceed the plan limit.
+    # Returns profiles sorted default-first, then by creation date. Filter with name (exact match) and paginate with limit/skip; without those params the full list is returned unchanged. Use includeOverLimit&#x3D;true to include profiles that exceed the plan limit.
     # @param [Hash] opts the optional parameters
     # @option opts [Boolean] :include_over_limit When true, includes over-limit profiles (marked with isOverLimit: true). (default to false)
+    # @option opts [String] :name Exact-match filter on the profile name. Useful to recover a profile id after an ambiguous create (timeout followed by a 409 on retry).
+    # @option opts [Integer] :limit Page size. When limit or skip is present, the response includes total and skip (and echoes limit).
+    # @option opts [Integer] :skip Number of profiles to skip, applied after sorting and filtering.
     # @return [Array<(ProfilesListResponse, Integer, Hash)>] ProfilesListResponse data, response status code and response headers
     def list_profiles_with_http_info(opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ProfilesApi.list_profiles ...'
       end
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 1000
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ProfilesApi.list_profiles, must be smaller than or equal to 1000.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ProfilesApi.list_profiles, must be greater than or equal to 1.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'skip'].nil? && opts[:'skip'] < 0
+        fail ArgumentError, 'invalid value for "opts[:"skip"]" when calling ProfilesApi.list_profiles, must be greater than or equal to 0.'
+      end
+
       # resource path
       local_var_path = '/v1/profiles'
 
       # query parameters
       query_params = opts[:query_params] || {}
       query_params[:'includeOverLimit'] = opts[:'include_over_limit'] if !opts[:'include_over_limit'].nil?
+      query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}

data/lib/zernio-sdk/models/profiles_list_response.rb

@@ -17,10 +17,22 @@ module Zernio
   class ProfilesListResponse < ApiModelBase
     attr_accessor :profiles
 
+    # Total matching profiles across all pages. Present only when limit or skip was passed.
+    attr_accessor :total
+
+    # Offset applied. Present only when limit or skip was passed.
+    attr_accessor :skip
+
+    # Echo of the limit query param. Present only when it was passed.
+    attr_accessor :limit
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'profiles' => :'profiles'
+        :'profiles' => :'profiles',
+        :'total' => :'total',
+        :'skip' => :'skip',
+        :'limit' => :'limit'
       }
     end
 
@@ -37,7 +49,10 @@ module Zernio
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'profiles' => :'Array<Profile>'
+        :'profiles' => :'Array<Profile>',
+        :'total' => :'Integer',
+        :'skip' => :'Integer',
+        :'limit' => :'Integer'
       }
     end
 
@@ -68,6 +83,18 @@ module Zernio
           self.profiles = value
         end
       end
+
+      if attributes.key?(:'total')
+        self.total = attributes[:'total']
+      end
+
+      if attributes.key?(:'skip')
+        self.skip = attributes[:'skip']
+      end
+
+      if attributes.key?(:'limit')
+        self.limit = attributes[:'limit']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -90,7 +117,10 @@ module Zernio
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          profiles == o.profiles
+          profiles == o.profiles &&
+          total == o.total &&
+          skip == o.skip &&
+          limit == o.limit
     end
 
     # @see the `==` method
@@ -102,7 +132,7 @@ module Zernio
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [profiles].hash
+      [profiles, total, skip, limit].hash
     end
 
     # Builds the object from hash

data/lib/zernio-sdk/version.rb

@@ -11,5 +11,5 @@ Generator version: 7.19.0
 =end
 
 module Zernio
-  VERSION = '0.0.558'
+  VERSION = '0.0.560'
 end

data/openapi.yaml

@@ -6112,6 +6112,15 @@ components:
           type: array
           items:
             $ref: '#/components/schemas/Profile'
+        total:
+          type: integer
+          description: 'Total matching profiles across all pages. Present only when limit or skip was passed.'
+        skip:
+          type: integer
+          description: 'Offset applied. Present only when limit or skip was passed.'
+        limit:
+          type: integer
+          description: Echo of the limit query param. Present only when it was passed.
     ProfileCreateResponse:
       type: object
       properties:
@@ -13287,7 +13296,11 @@ paths:
       operationId: listProfiles
       tags: [Profiles]
       summary: List profiles
-      description: Returns profiles sorted by creation date. Use includeOverLimit=true to include profiles that exceed the plan limit.
+      description: >-
+        Returns profiles sorted default-first, then by creation date. Filter
+        with name (exact match) and paginate with limit/skip; without those
+        params the full list is returned unchanged. Use includeOverLimit=true
+        to include profiles that exceed the plan limit.
       parameters:
         - name: includeOverLimit
           in: query
@@ -13296,6 +13309,21 @@ paths:
             type: boolean
             default: false
           description: "When true, includes over-limit profiles (marked with isOverLimit: true)."
+        - name: name
+          in: query
+          required: false
+          schema: { type: string }
+          description: 'Exact-match filter on the profile name. Useful to recover a profile id after an ambiguous create (timeout followed by a 409 on retry).'
+        - name: limit
+          in: query
+          required: false
+          schema: { type: integer, minimum: 1, maximum: 1000 }
+          description: 'Page size. When limit or skip is present, the response includes total and skip (and echoes limit).'
+        - name: skip
+          in: query
+          required: false
+          schema: { type: integer, minimum: 0 }
+          description: 'Number of profiles to skip, applied after sorting and filtering.'
       responses:
         '200':
           description: Profiles
@@ -13311,12 +13339,29 @@ paths:
                         name: "Personal Brand"
                         color: "#ffeda0"
                         isDefault: true
+        '400': { $ref: '#/components/responses/BadRequest' }
         '401': { $ref: '#/components/responses/Unauthorized' }
     post:
       operationId: createProfile
       tags: [Profiles]
       summary: Create profile
-      description: Creates a new profile with a name, optional description, and color.
+      description: >-
+        Creates a new profile with a name, optional description, and color.
+        Names are unique per workspace: a duplicate returns a 409 whose
+        details.existingProfileId carries the id of the existing profile.
+        Send an Idempotency-Key header to make retries safe: a retried create
+        with the same key and body replays the original 201 (same _id)
+        instead of conflicting.
+      parameters:
+        - name: Idempotency-Key
+          in: header
+          required: false
+          schema: { type: string, maxLength: 255 }
+          description: >-
+            Optional client-generated unique key (e.g. a UUID) that makes
+            create retries safe. Same key + same body replays the original
+            response; same key + different body → 422; key still processing →
+            409.
       requestBody:
         required: true
         content:
@@ -13353,7 +13398,8 @@ paths:
         '401': { $ref: '#/components/responses/Unauthorized' }
         '402': { $ref: '#/components/responses/PaymentRequired' }
         '403': { description: Profile limit exceeded }
-        '409': { description: "A profile with this name already exists (code: profile_name_conflict)." }
+        '409': { description: 'A profile with this name already exists (code: profile_name_conflict); details.existingProfileId carries the id of the existing profile. Also returned while a request with the same Idempotency-Key is still processing.' }
+        '422': { description: Idempotency-Key reused with a different body }
   /v1/profiles/{profileId}:
     get:
       operationId: getProfile
@@ -33536,6 +33582,7 @@ paths:
                     type: array
                     items: { $ref: '#/components/schemas/AdCampaign' }
                   pagination: { $ref: '#/components/schemas/Pagination' }
+        '400': { $ref: '#/components/responses/BadRequest' }
         '401': { $ref: '#/components/responses/Unauthorized' }
         '403':
           description: Ads access required. Legacy plans need the Ads add-on; included by default on usage-based plans.

data/spec/api/profiles_api_spec.rb

@@ -34,9 +34,10 @@ describe 'ProfilesApi' do
 
   # unit tests for create_profile
   # Create profile
-  # Creates a new profile with a name, optional description, and color.
+  # Creates a new profile with a name, optional description, and color. Names are unique per workspace: a duplicate returns a 409 whose details.existingProfileId carries the id of the existing profile. Send an Idempotency-Key header to make retries safe: a retried create with the same key and body replays the original 201 (same _id) instead of conflicting.
   # @param create_profile_request 
   # @param [Hash] opts the optional parameters
+  # @option opts [String] :idempotency_key Optional client-generated unique key (e.g. a UUID) that makes create retries safe. Same key + same body replays the original response; same key + different body → 422; key still processing → 409.
   # @return [ProfileCreateResponse]
   describe 'create_profile test' do
     it 'should work' do
@@ -70,9 +71,12 @@ describe 'ProfilesApi' do
 
   # unit tests for list_profiles
   # List profiles
-  # Returns profiles sorted by creation date. Use includeOverLimit=true to include profiles that exceed the plan limit.
+  # Returns profiles sorted default-first, then by creation date. Filter with name (exact match) and paginate with limit/skip; without those params the full list is returned unchanged. Use includeOverLimit=true to include profiles that exceed the plan limit.
   # @param [Hash] opts the optional parameters
   # @option opts [Boolean] :include_over_limit When true, includes over-limit profiles (marked with isOverLimit: true).
+  # @option opts [String] :name Exact-match filter on the profile name. Useful to recover a profile id after an ambiguous create (timeout followed by a 409 on retry).
+  # @option opts [Integer] :limit Page size. When limit or skip is present, the response includes total and skip (and echoes limit).
+  # @option opts [Integer] :skip Number of profiles to skip, applied after sorting and filtering.
   # @return [ProfilesListResponse]
   describe 'list_profiles test' do
     it 'should work' do

data/spec/models/profiles_list_response_spec.rb

@@ -33,4 +33,22 @@ describe Zernio::ProfilesListResponse do
     end
   end
 
+  describe 'test attribute "total"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "skip"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "limit"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
 end