norbelys 0.1.0

data/lib/norbelys/api/fields_api.rb

@@ -0,0 +1,290 @@
+=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 FieldsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Delete a field
+    # Soft-delete a custom field so it stops appearing in the UI, the merge-tag catalog, and segment filters. The values already stored under its `code` on each person are kept, so the field can be restored without data loss.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Field]
+    def fields_archive(id, opts = {})
+      data, _status_code, _headers = fields_archive_with_http_info(id, opts)
+      data
+    end
+
+    # Delete a field
+    # Soft-delete a custom field so it stops appearing in the UI, the merge-tag catalog, and segment filters. The values already stored under its `code` on each person are kept, so the field can be restored without data loss.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Field, Integer, Hash)>] Field data, response status code and response headers
+    def fields_archive_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: FieldsApi.fields_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 FieldsApi.fields_archive"
+      end
+      # resource path
+      local_var_path = '/fields/{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] || 'Field'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"FieldsApi.fields_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: FieldsApi#fields_archive\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Create a custom field
+    # Create a custom person-field. Its `code` becomes the `{{ code }}` merge tag used in templates and the key it is filtered by in segments; omit `code` to auto-derive a slug from the label. A `dropdown` field must also supply its `options`.
+    # @param field_create_params [FieldCreateParams] 
+    # @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 [Field]
+    def fields_create(field_create_params, opts = {})
+      data, _status_code, _headers = fields_create_with_http_info(field_create_params, opts)
+      data
+    end
+
+    # Create a custom field
+    # Create a custom person-field. Its &#x60;code&#x60; becomes the &#x60;{{ code }}&#x60; merge tag used in templates and the key it is filtered by in segments; omit &#x60;code&#x60; to auto-derive a slug from the label. A &#x60;dropdown&#x60; field must also supply its &#x60;options&#x60;.
+    # @param field_create_params [FieldCreateParams] 
+    # @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<(Field, Integer, Hash)>] Field data, response status code and response headers
+    def fields_create_with_http_info(field_create_params, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: FieldsApi.fields_create ...'
+      end
+      # verify the required parameter 'field_create_params' is set
+      if @api_client.config.client_side_validation && field_create_params.nil?
+        fail ArgumentError, "Missing the required parameter 'field_create_params' when calling FieldsApi.fields_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 FieldsApi.fields_create, the character length must be smaller than or equal to 255.'
+      end
+
+      # resource path
+      local_var_path = '/fields'
+
+      # 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(field_create_params)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Field'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"FieldsApi.fields_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: FieldsApi#fields_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List custom fields
+    # List all of the org's custom person-fields, in display order. The entire set is returned in one response — there is no pagination, because the set is small. System fields (email, telephone, first/last name) are not included here; only tenant-created custom fields.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :include_archived 
+    # @return [FieldList]
+    def fields_list(opts = {})
+      data, _status_code, _headers = fields_list_with_http_info(opts)
+      data
+    end
+
+    # List custom fields
+    # List all of the org&#39;s custom person-fields, in display order. The entire set is returned in one response — there is no pagination, because the set is small. System fields (email, telephone, first/last name) are not included here; only tenant-created custom fields.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :include_archived 
+    # @return [Array<(FieldList, Integer, Hash)>] FieldList data, response status code and response headers
+    def fields_list_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: FieldsApi.fields_list ...'
+      end
+      # resource path
+      local_var_path = '/fields'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'includeArchived'] = opts[:'include_archived'] if !opts[:'include_archived'].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] || 'FieldList'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"FieldsApi.fields_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: FieldsApi#fields_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update a field
+    # Update a field's label, type, options, or filterability. The `code` is immutable after create — live templates and segments reference it — so it cannot be changed here.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [FieldUpdateParams] :field_update_params 
+    # @return [Field]
+    def fields_update(id, opts = {})
+      data, _status_code, _headers = fields_update_with_http_info(id, opts)
+      data
+    end
+
+    # Update a field
+    # Update a field&#39;s label, type, options, or filterability. The &#x60;code&#x60; is immutable after create — live templates and segments reference it — so it cannot be changed here.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [FieldUpdateParams] :field_update_params 
+    # @return [Array<(Field, Integer, Hash)>] Field data, response status code and response headers
+    def fields_update_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: FieldsApi.fields_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 FieldsApi.fields_update"
+      end
+      # resource path
+      local_var_path = '/fields/{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[:'field_update_params'])
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Field'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"FieldsApi.fields_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: FieldsApi#fields_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/norbelys/api/files_api.rb

@@ -0,0 +1,97 @@
+=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 FilesApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Upload a public file
+    # Upload one image or PDF (Base64, max 8 MB decoded) to the public files bucket. Returns the permanent public URL — embed it in email HTML (signature images, campaign bodies, linked PDFs). The URL contains an unguessable id, is never listed, and is served with no search indexing.
+    # @param file_upload [FileUpload] 
+    # @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 [FileObject]
+    def files_create(file_upload, opts = {})
+      data, _status_code, _headers = files_create_with_http_info(file_upload, opts)
+      data
+    end
+
+    # Upload a public file
+    # Upload one image or PDF (Base64, max 8 MB decoded) to the public files bucket. Returns the permanent public URL — embed it in email HTML (signature images, campaign bodies, linked PDFs). The URL contains an unguessable id, is never listed, and is served with no search indexing.
+    # @param file_upload [FileUpload] 
+    # @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<(FileObject, Integer, Hash)>] FileObject data, response status code and response headers
+    def files_create_with_http_info(file_upload, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: FilesApi.files_create ...'
+      end
+      # verify the required parameter 'file_upload' is set
+      if @api_client.config.client_side_validation && file_upload.nil?
+        fail ArgumentError, "Missing the required parameter 'file_upload' when calling FilesApi.files_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 FilesApi.files_create, the character length must be smaller than or equal to 255.'
+      end
+
+      # resource path
+      local_var_path = '/files'
+
+      # 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(file_upload)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'FileObject'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"FilesApi.files_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: FilesApi#files_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end