norbelys 0.1.0

data/lib/norbelys/api/people_api.rb

@@ -0,0 +1,689 @@
+=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 PeopleApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Archive a person
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Person]
+    def people_archive(id, opts = {})
+      data, _status_code, _headers = people_archive_with_http_info(id, opts)
+      data
+    end
+
+    # Archive a person
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Person, Integer, Hash)>] Person data, response status code and response headers
+    def people_archive_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PeopleApi.people_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 PeopleApi.people_archive"
+      end
+      # resource path
+      local_var_path = '/people/{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] || 'Person'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"PeopleApi.people_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: PeopleApi#people_archive\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get audience summary
+    # Summarize the whole workspace, one group, or one segment: exact people total, lifecycle mix, recent engagement, average score, and a 12-week audience-arrival series.
+    # @param scope [AnyOf] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :group_id 
+    # @option opts [String] :segment_id 
+    # @return [AudienceSummary]
+    def people_audience_summary(scope, opts = {})
+      data, _status_code, _headers = people_audience_summary_with_http_info(scope, opts)
+      data
+    end
+
+    # Get audience summary
+    # Summarize the whole workspace, one group, or one segment: exact people total, lifecycle mix, recent engagement, average score, and a 12-week audience-arrival series.
+    # @param scope [AnyOf] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :group_id 
+    # @option opts [String] :segment_id 
+    # @return [Array<(AudienceSummary, Integer, Hash)>] AudienceSummary data, response status code and response headers
+    def people_audience_summary_with_http_info(scope, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PeopleApi.people_audience_summary ...'
+      end
+      # resource path
+      local_var_path = '/people/audience-summary'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'scope'] = scope
+      query_params[:'groupId'] = opts[:'group_id'] if !opts[:'group_id'].nil?
+      query_params[:'segmentId'] = opts[:'segment_id'] if !opts[:'segment_id'].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] || 'AudienceSummary'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"PeopleApi.people_audience_summary",
+        :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: PeopleApi#people_audience_summary\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Bulk create people (verifies + suppresses in the background; optional group / campaign)
+    # @param people_bulk_create_params [PeopleBulkCreateParams] 
+    # @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 [PeopleBulkCreateResult]
+    def people_bulk_create(people_bulk_create_params, opts = {})
+      data, _status_code, _headers = people_bulk_create_with_http_info(people_bulk_create_params, opts)
+      data
+    end
+
+    # Bulk create people (verifies + suppresses in the background; optional group / campaign)
+    # @param people_bulk_create_params [PeopleBulkCreateParams] 
+    # @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<(PeopleBulkCreateResult, Integer, Hash)>] PeopleBulkCreateResult data, response status code and response headers
+    def people_bulk_create_with_http_info(people_bulk_create_params, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PeopleApi.people_bulk_create ...'
+      end
+      # verify the required parameter 'people_bulk_create_params' is set
+      if @api_client.config.client_side_validation && people_bulk_create_params.nil?
+        fail ArgumentError, "Missing the required parameter 'people_bulk_create_params' when calling PeopleApi.people_bulk_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 PeopleApi.people_bulk_create, the character length must be smaller than or equal to 255.'
+      end
+
+      # resource path
+      local_var_path = '/people/bulk'
+
+      # 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(people_bulk_create_params)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'PeopleBulkCreateResult'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"PeopleApi.people_bulk_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: PeopleApi#people_bulk_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Create a person
+    # Add one person (a lead) to the CRM. `email` is required; anything beyond the system fields rides in `customFields` keyed by code. To insert many at once, use bulkCreate instead.
+    # @param person_create_params [PersonCreateParams] 
+    # @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 [Person]
+    def people_create(person_create_params, opts = {})
+      data, _status_code, _headers = people_create_with_http_info(person_create_params, opts)
+      data
+    end
+
+    # Create a person
+    # Add one person (a lead) to the CRM. &#x60;email&#x60; is required; anything beyond the system fields rides in &#x60;customFields&#x60; keyed by code. To insert many at once, use bulkCreate instead.
+    # @param person_create_params [PersonCreateParams] 
+    # @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<(Person, Integer, Hash)>] Person data, response status code and response headers
+    def people_create_with_http_info(person_create_params, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PeopleApi.people_create ...'
+      end
+      # verify the required parameter 'person_create_params' is set
+      if @api_client.config.client_side_validation && person_create_params.nil?
+        fail ArgumentError, "Missing the required parameter 'person_create_params' when calling PeopleApi.people_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 PeopleApi.people_create, the character length must be smaller than or equal to 255.'
+      end
+
+      # resource path
+      local_var_path = '/people'
+
+      # 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(person_create_params)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Person'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"PeopleApi.people_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: PeopleApi#people_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Erase a person (GDPR)
+    # Permanently scrub this person's PII and redact their inbound messages — the ONE true hard delete (distinct from archive/DELETE, which only soft-archives and keeps the data). Irreversible; use for a GDPR erasure request.
+    # @param id [String] 
+    # @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 [PersonErased]
+    def people_erase(id, opts = {})
+      data, _status_code, _headers = people_erase_with_http_info(id, opts)
+      data
+    end
+
+    # Erase a person (GDPR)
+    # Permanently scrub this person&#39;s PII and redact their inbound messages — the ONE true hard delete (distinct from archive/DELETE, which only soft-archives and keeps the data). Irreversible; use for a GDPR erasure request.
+    # @param id [String] 
+    # @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<(PersonErased, Integer, Hash)>] PersonErased data, response status code and response headers
+    def people_erase_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PeopleApi.people_erase ...'
+      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 PeopleApi.people_erase"
+      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 PeopleApi.people_erase, the character length must be smaller than or equal to 255.'
+      end
+
+      # resource path
+      local_var_path = '/people/{id}/erase'.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']
+      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]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'PersonErased'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"PeopleApi.people_erase",
+        :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: PeopleApi#people_erase\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get a person
+    # Read one person. Pass `expand[]=timeline` for their merged sent/received messages, `expand[]=enrollments` for campaign memberships, `expand[]=groups` for their static lists, and/or `expand[]=segments` for dynamic audiences they currently match.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :expand 
+    # @return [PersonDetail]
+    def people_find(id, opts = {})
+      data, _status_code, _headers = people_find_with_http_info(id, opts)
+      data
+    end
+
+    # Get a person
+    # Read one person. Pass &#x60;expand[]&#x3D;timeline&#x60; for their merged sent/received messages, &#x60;expand[]&#x3D;enrollments&#x60; for campaign memberships, &#x60;expand[]&#x3D;groups&#x60; for their static lists, and/or &#x60;expand[]&#x3D;segments&#x60; for dynamic audiences they currently match.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :expand 
+    # @return [Array<(PersonDetail, Integer, Hash)>] PersonDetail data, response status code and response headers
+    def people_find_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PeopleApi.people_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 PeopleApi.people_find"
+      end
+      allowable_values = ["timeline", "enrollments", "groups", "segments"]
+      if @api_client.config.client_side_validation && opts[:'expand'] && !opts[:'expand'].all? { |item| allowable_values.include?(item) }
+        fail ArgumentError, "invalid value for \"expand\", must include one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/people/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :csv) if !opts[:'expand'].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] || 'PersonDetail'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"PeopleApi.people_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: PeopleApi#people_find\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get a bulk import's verify stats (sendable / suppressed / pending)
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [PersonImportStats]
+    def people_get_bulk(id, opts = {})
+      data, _status_code, _headers = people_get_bulk_with_http_info(id, opts)
+      data
+    end
+
+    # Get a bulk import&#39;s verify stats (sendable / suppressed / pending)
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(PersonImportStats, Integer, Hash)>] PersonImportStats data, response status code and response headers
+    def people_get_bulk_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PeopleApi.people_get_bulk ...'
+      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 PeopleApi.people_get_bulk"
+      end
+      # resource path
+      local_var_path = '/people/bulk/{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] || 'PersonImportStats'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"PeopleApi.people_get_bulk",
+        :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: PeopleApi#people_get_bulk\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List people
+    # List the org's people (its CRM leads); `total` is the full match count. Filter by status, source, group, or segment, or pass a live `filter` rule tree to preview a draft segment. Cursor callers remain newest-first; page-based callers can sort by creation, name, email, last activity, or engagement score.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :cursor 
+    # @option opts [Boolean] :include_archived 
+    # @option opts [String] :dir 
+    # @option opts [AudienceFilter] :filter 
+    # @option opts [String] :group_id 
+    # @option opts [Integer] :limit 
+    # @option opts [Integer] :page 
+    # @option opts [String] :search 
+    # @option opts [String] :segment_id 
+    # @option opts [String] :sort 
+    # @option opts [Array<String>] :source 
+    # @option opts [Array<String>] :status 
+    # @return [PersonList]
+    def people_list(opts = {})
+      data, _status_code, _headers = people_list_with_http_info(opts)
+      data
+    end
+
+    # List people
+    # List the org&#39;s people (its CRM leads); &#x60;total&#x60; is the full match count. Filter by status, source, group, or segment, or pass a live &#x60;filter&#x60; rule tree to preview a draft segment. Cursor callers remain newest-first; page-based callers can sort by creation, name, email, last activity, or engagement score.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :cursor 
+    # @option opts [Boolean] :include_archived 
+    # @option opts [String] :dir 
+    # @option opts [AudienceFilter] :filter 
+    # @option opts [String] :group_id 
+    # @option opts [Integer] :limit 
+    # @option opts [Integer] :page 
+    # @option opts [String] :search 
+    # @option opts [String] :segment_id 
+    # @option opts [String] :sort 
+    # @option opts [Array<String>] :source 
+    # @option opts [Array<String>] :status 
+    # @return [Array<(PersonList, Integer, Hash)>] PersonList data, response status code and response headers
+    def people_list_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PeopleApi.people_list ...'
+      end
+      allowable_values = ["asc", "desc"]
+      if @api_client.config.client_side_validation && opts[:'dir'] && !allowable_values.include?(opts[:'dir'])
+        fail ArgumentError, "invalid value for \"dir\", must be one of #{allowable_values}"
+      end
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 500
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling PeopleApi.people_list, must be smaller than or equal to 500.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling PeopleApi.people_list, must be greater than or equal to 1.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"page"]" when calling PeopleApi.people_list, must be greater than or equal to 1.'
+      end
+
+      allowable_values = ["created_at", "email", "last_activity_at", "name", "score"]
+      if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
+        fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
+      end
+      allowable_values = ["csv_import", "manual", "api", "form", "inbound", "integration"]
+      if @api_client.config.client_side_validation && opts[:'source'] && !opts[:'source'].all? { |item| allowable_values.include?(item) }
+        fail ArgumentError, "invalid value for \"source\", must include one of #{allowable_values}"
+      end
+      allowable_values = ["active", "replied", "bounced", "unsubscribed", "finished"]
+      if @api_client.config.client_side_validation && opts[:'status'] && !opts[:'status'].all? { |item| allowable_values.include?(item) }
+        fail ArgumentError, "invalid value for \"status\", must include one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/people'
+
+      # 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[:'dir'] = opts[:'dir'] if !opts[:'dir'].nil?
+      query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
+      query_params[:'groupId'] = opts[:'group_id'] if !opts[:'group_id'].nil?
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
+      query_params[:'segmentId'] = opts[:'segment_id'] if !opts[:'segment_id'].nil?
+      query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
+      query_params[:'source'] = @api_client.build_collection_param(opts[:'source'], :csv) if !opts[:'source'].nil?
+      query_params[:'status'] = @api_client.build_collection_param(opts[:'status'], :csv) if !opts[:'status'].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] || 'PersonList'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"PeopleApi.people_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: PeopleApi#people_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update a person
+    # Patch a person's editable fields; only the fields you send change. Note that `customFields` replaces the entire custom-field bag — send the full set, not a partial delta.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [PersonUpdateParams] :person_update_params 
+    # @return [PersonDetail]
+    def people_update(id, opts = {})
+      data, _status_code, _headers = people_update_with_http_info(id, opts)
+      data
+    end
+
+    # Update a person
+    # Patch a person&#39;s editable fields; only the fields you send change. Note that &#x60;customFields&#x60; replaces the entire custom-field bag — send the full set, not a partial delta.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [PersonUpdateParams] :person_update_params 
+    # @return [Array<(PersonDetail, Integer, Hash)>] PersonDetail data, response status code and response headers
+    def people_update_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PeopleApi.people_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 PeopleApi.people_update"
+      end
+      # resource path
+      local_var_path = '/people/{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[:'person_update_params'])
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'PersonDetail'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"PeopleApi.people_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: PeopleApi#people_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end