norbelys 0.1.0

data/lib/norbelys/api/organization_api.rb

@@ -0,0 +1,329 @@
+=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 OrganizationApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get the organization's feature flags
+    # Returns the workspace's resolved feature flags (per-org, evaluated at the edge). Use it to conditionally render gated features in a client; server endpoints enforce their own gate independently.
+    # @param [Hash] opts the optional parameters
+    # @return [Features]
+    def organization_features(opts = {})
+      data, _status_code, _headers = organization_features_with_http_info(opts)
+      data
+    end
+
+    # Get the organization's feature flags
+    # Returns the workspace's resolved feature flags (per-org, evaluated at the edge). Use it to conditionally render gated features in a client; server endpoints enforce their own gate independently.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Features, Integer, Hash)>] Features data, response status code and response headers
+    def organization_features_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: OrganizationApi.organization_features ...'
+      end
+      # resource path
+      local_var_path = '/organization/features'
+
+      # 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] || 'Features'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"OrganizationApi.organization_features",
+        :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: OrganizationApi#organization_features\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get the organization
+    # The workspace this credential acts on: org id, display name, company profile, onboarding and notification state. Read-only — THE first call to confirm \"who am I / which tenant is this?\".
+    # @param [Hash] opts the optional parameters
+    # @return [Organization]
+    def organization_find(opts = {})
+      data, _status_code, _headers = organization_find_with_http_info(opts)
+      data
+    end
+
+    # Get the organization
+    # The workspace this credential acts on: org id, display name, company profile, onboarding and notification state. Read-only — THE first call to confirm \&quot;who am I / which tenant is this?\&quot;.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Organization, Integer, Hash)>] Organization data, response status code and response headers
+    def organization_find_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: OrganizationApi.organization_find ...'
+      end
+      # resource path
+      local_var_path = '/organization'
+
+      # 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] || 'Organization'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"OrganizationApi.organization_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: OrganizationApi#organization_find\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get the workspace pulse
+    # One-call workspace briefing: every campaign with its lead count, completion, and engagement funnel over the window (default 7 days), the mailbox fleet rolled up by state and reputation, and the account deliverability headline. THE first read for any \"how is everything going?\" / status question — prefer it over separately listing programs, senders, and analytics.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :days 
+    # @return [OrganizationPulse]
+    def organization_pulse(opts = {})
+      data, _status_code, _headers = organization_pulse_with_http_info(opts)
+      data
+    end
+
+    # Get the workspace pulse
+    # One-call workspace briefing: every campaign with its lead count, completion, and engagement funnel over the window (default 7 days), the mailbox fleet rolled up by state and reputation, and the account deliverability headline. THE first read for any \&quot;how is everything going?\&quot; / status question — prefer it over separately listing programs, senders, and analytics.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :days 
+    # @return [Array<(OrganizationPulse, Integer, Hash)>] OrganizationPulse data, response status code and response headers
+    def organization_pulse_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: OrganizationApi.organization_pulse ...'
+      end
+      if @api_client.config.client_side_validation && !opts[:'days'].nil? && opts[:'days'] > 90
+        fail ArgumentError, 'invalid value for "opts[:"days"]" when calling OrganizationApi.organization_pulse, must be smaller than or equal to 90.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'days'].nil? && opts[:'days'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"days"]" when calling OrganizationApi.organization_pulse, must be greater than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/organization/pulse'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'days'] = opts[:'days'] if !opts[:'days'].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] || 'OrganizationPulse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"OrganizationApi.organization_pulse",
+        :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: OrganizationApi#organization_pulse\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update the organization
+    # Update the workspace's editable profile and settings: company profile, onboarding state, deliverability alerts, and bounce-handling policy. Idempotent — every field is optional, and calling it with an empty body just reconciles the tenant (it provisions the org's registry row when the user moves faster than the provisioning webhook). Returns the full resolved organization state. Members and invites are managed through Clerk, not this endpoint.
+    # @param organization_update_params [OrganizationUpdateParams] 
+    # @param [Hash] opts the optional parameters
+    # @return [Organization]
+    def organization_update(organization_update_params, opts = {})
+      data, _status_code, _headers = organization_update_with_http_info(organization_update_params, opts)
+      data
+    end
+
+    # Update the organization
+    # Update the workspace&#39;s editable profile and settings: company profile, onboarding state, deliverability alerts, and bounce-handling policy. Idempotent — every field is optional, and calling it with an empty body just reconciles the tenant (it provisions the org&#39;s registry row when the user moves faster than the provisioning webhook). Returns the full resolved organization state. Members and invites are managed through Clerk, not this endpoint.
+    # @param organization_update_params [OrganizationUpdateParams] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Organization, Integer, Hash)>] Organization data, response status code and response headers
+    def organization_update_with_http_info(organization_update_params, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: OrganizationApi.organization_update ...'
+      end
+      # verify the required parameter 'organization_update_params' is set
+      if @api_client.config.client_side_validation && organization_update_params.nil?
+        fail ArgumentError, "Missing the required parameter 'organization_update_params' when calling OrganizationApi.organization_update"
+      end
+      # resource path
+      local_var_path = '/organization'
+
+      # 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(organization_update_params)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Organization'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"OrganizationApi.organization_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: OrganizationApi#organization_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get the organization's plan usage
+    # The workspace's usage against its plan limits: live campaigns, active contacts, and emails sent this UTC month, each with the cap and an `ok`/`near`/`reached` level, plus the plan itself. Use it to answer \"how close am I to my limits?\" — the caps are enforced server-side regardless.
+    # @param [Hash] opts the optional parameters
+    # @return [OrganizationUsage]
+    def organization_usage(opts = {})
+      data, _status_code, _headers = organization_usage_with_http_info(opts)
+      data
+    end
+
+    # Get the organization&#39;s plan usage
+    # The workspace&#39;s usage against its plan limits: live campaigns, active contacts, and emails sent this UTC month, each with the cap and an &#x60;ok&#x60;/&#x60;near&#x60;/&#x60;reached&#x60; level, plus the plan itself. Use it to answer \&quot;how close am I to my limits?\&quot; — the caps are enforced server-side regardless.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(OrganizationUsage, Integer, Hash)>] OrganizationUsage data, response status code and response headers
+    def organization_usage_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: OrganizationApi.organization_usage ...'
+      end
+      # resource path
+      local_var_path = '/organization/usage'
+
+      # 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] || 'OrganizationUsage'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"OrganizationApi.organization_usage",
+        :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: OrganizationApi#organization_usage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end