norbelys 0.1.0

data/lib/norbelys/api/segments_api.rb

@@ -0,0 +1,370 @@
+=begin
+#Norbelys API
+
+#The **Norbelys API** is a single, predictable REST surface for cold email and outreach — people, senders, programs, and sending all live behind the five patterns below. Developer-first and AI-first: every name is either already invented (Schema.org) or obvious.  ## Authentication  Every request authenticates with an **org-scoped API key**. Create one in **Settings → API keys** and send it as a bearer token:  ```http GET https://api.norbelys.com/v1/people Authorization: Bearer ak_live_… ```  Interactive agents may instead use OAuth 2.1 (see `/auth.md` and the `/.well-known/oauth-protected-resource` metadata).  ## Conventions  - **Base URL** — `https://api.norbelys.com/v1`. - **JSON in, JSON out.** Timestamps are ISO-8601 in UTC. - **Cursor pagination.** List endpoints take `limit` + `cursor` and return   `{ data, hasMore, nextCursor }` (offset-paged tables add `page` + `total`). - **Expansions.** Detail GETs take an `expand[]` query param to inline related   data (e.g. `GET /people/{id}?expand[]=timeline`) instead of extra calls. - **Soft deletes.** Anything that has been used is archived, never hard-deleted —   `DELETE` archives the resource and returns it.  ## Errors  Failures return the same envelope on every 4xx/5xx, with the matching HTTP status:  ```json { \"error\": { \"type\": \"invalid_request\", \"code\": \"invalid_param\",             \"message\": \"…\", \"hint\": \"…\", \"doc_url\": \"…\" } } ```  `type` is a broad, machine-routable category derived from the status; `code` is the stable machine contract you branch on (never the human `message`). See the `ApiError` schema.  ## Idempotency  Every `POST` accepts an optional **`Idempotency-Key`** header. Reuse the same key to replay the original result for 24h instead of re-executing — so a retried create can never double-charge or duplicate a record.  ## Rate limits & versioning  Abuse control is enforced at the edge; responses advertise the policy via the `RateLimit-Policy` header, and a `429` carries `Retry-After`. The API is versioned in the URL path (`/v1`). Breaking changes ship under a new version; a retiring surface is announced with `Deprecation` + `Sunset` response headers at least 90 days ahead.
+
+The version of the OpenAPI document: 0.0.1
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.10.0
+
+=end
+
+require 'cgi'
+
+module Norbelys
+  class SegmentsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Delete a segment
+    # Permanently delete the segment and detach it from any program that used it as an audience source. The people it matched are unaffected.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Segment]
+    def segments_archive(id, opts = {})
+      data, _status_code, _headers = segments_archive_with_http_info(id, opts)
+      data
+    end
+
+    # Delete a segment
+    # Permanently delete the segment and detach it from any program that used it as an audience source. The people it matched are unaffected.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Segment, Integer, Hash)>] Segment data, response status code and response headers
+    def segments_archive_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SegmentsApi.segments_archive ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling SegmentsApi.segments_archive"
+      end
+      # resource path
+      local_var_path = '/segments/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Segment'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"SegmentsApi.segments_archive",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SegmentsApi#segments_archive\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Create a segment
+    # Create a segment: a named, saved audience filter (the rule tree in `definition`). Membership is computed live, so it auto-refreshes as people change. Preview the people it matches at GET /v1/people?segmentId={id}.
+    # @param segment_create_params [SegmentCreateParams] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key Opt-in idempotency for a safely retried write: reuse the same key to replay the original result for 24h instead of re-executing. Recommended on every POST.
+    # @return [Segment]
+    def segments_create(segment_create_params, opts = {})
+      data, _status_code, _headers = segments_create_with_http_info(segment_create_params, opts)
+      data
+    end
+
+    # Create a segment
+    # Create a segment: a named, saved audience filter (the rule tree in &#x60;definition&#x60;). Membership is computed live, so it auto-refreshes as people change. Preview the people it matches at GET /v1/people?segmentId&#x3D;{id}.
+    # @param segment_create_params [SegmentCreateParams] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key Opt-in idempotency for a safely retried write: reuse the same key to replay the original result for 24h instead of re-executing. Recommended on every POST.
+    # @return [Array<(Segment, Integer, Hash)>] Segment data, response status code and response headers
+    def segments_create_with_http_info(segment_create_params, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SegmentsApi.segments_create ...'
+      end
+      # verify the required parameter 'segment_create_params' is set
+      if @api_client.config.client_side_validation && segment_create_params.nil?
+        fail ArgumentError, "Missing the required parameter 'segment_create_params' when calling SegmentsApi.segments_create"
+      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 SegmentsApi.segments_create, the character length must be smaller than or equal to 255.'
+      end
+
+      # resource path
+      local_var_path = '/segments'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      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] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(segment_create_params)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Segment'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"SegmentsApi.segments_create",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SegmentsApi#segments_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get a segment
+    # Read one segment, including its saved filter definition. List the people it currently matches at GET /v1/people?segmentId={id}.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Segment]
+    def segments_find(id, opts = {})
+      data, _status_code, _headers = segments_find_with_http_info(id, opts)
+      data
+    end
+
+    # Get a segment
+    # Read one segment, including its saved filter definition. List the people it currently matches at GET /v1/people?segmentId&#x3D;{id}.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Segment, Integer, Hash)>] Segment data, response status code and response headers
+    def segments_find_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SegmentsApi.segments_find ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling SegmentsApi.segments_find"
+      end
+      # resource path
+      local_var_path = '/segments/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Segment'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"SegmentsApi.segments_find",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SegmentsApi#segments_find\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List segments
+    # List the org's segments — dynamic saved filters over people — newest first.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :cursor 
+    # @option opts [Boolean] :include_archived 
+    # @option opts [Integer] :limit 
+    # @option opts [String] :q 
+    # @return [SegmentList]
+    def segments_list(opts = {})
+      data, _status_code, _headers = segments_list_with_http_info(opts)
+      data
+    end
+
+    # List segments
+    # List the org&#39;s segments — dynamic saved filters over people — newest first.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :cursor 
+    # @option opts [Boolean] :include_archived 
+    # @option opts [Integer] :limit 
+    # @option opts [String] :q 
+    # @return [Array<(SegmentList, Integer, Hash)>] SegmentList data, response status code and response headers
+    def segments_list_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SegmentsApi.segments_list ...'
+      end
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling SegmentsApi.segments_list, must be smaller than or equal to 100.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling SegmentsApi.segments_list, must be greater than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/segments'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
+      query_params[:'includeArchived'] = opts[:'include_archived'] if !opts[:'include_archived'].nil?
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SegmentList'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"SegmentsApi.segments_list",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SegmentsApi#segments_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update a segment
+    # Rename a segment or replace its filter definition. Because membership is computed live, changing the definition immediately changes who the segment matches.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [SegmentUpdateParams] :segment_update_params 
+    # @return [Segment]
+    def segments_update(id, opts = {})
+      data, _status_code, _headers = segments_update_with_http_info(id, opts)
+      data
+    end
+
+    # Update a segment
+    # Rename a segment or replace its filter definition. Because membership is computed live, changing the definition immediately changes who the segment matches.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [SegmentUpdateParams] :segment_update_params 
+    # @return [Array<(Segment, Integer, Hash)>] Segment data, response status code and response headers
+    def segments_update_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SegmentsApi.segments_update ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling SegmentsApi.segments_update"
+      end
+      # resource path
+      local_var_path = '/segments/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'segment_update_params'])
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Segment'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"SegmentsApi.segments_update",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SegmentsApi#segments_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end