ssoready 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: eae7d3a91ffaa2a24a93694e881ad865dd00f9cb4567f657d37335975029ab0a
+  data.tar.gz: 405f5ab9bb277715d81ab9810491133c1cdebada999d72b44a4c3e8b4caf2c8c
+SHA512:
+  metadata.gz: f5ab8e8cade77237383875ecc23607ed64e7998cbcfd38f5b92ef7919ac3a0efabd63fea14661f8df3a37a852baf6e705df1455da6067518aa566f6ac5f15da2
+  data.tar.gz: 8edde9a2038c2af2f12cdbd63e75bb47098c5bd99c7ad9cfbeb45d1dba24b345e15593357abfd464e7e0b90c11f3b4dbf2f2dd87b40ac5990a924968ba12f7a4

data/lib/environment.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module SSOReady
+  class Environment
+    DEFAULT = "https://api.ssoready.com"
+  end
+end

data/lib/gemconfig.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module SSOReady
+  module Gemconfig
+    VERSION = ""
+    AUTHORS = [""].freeze
+    EMAIL = ""
+    SUMMARY = ""
+    DESCRIPTION = ""
+    HOMEPAGE = "https://github.com/ssoready/ssoready-ruby"
+    SOURCE_CODE_URI = "https://github.com/ssoready/ssoready-ruby"
+    CHANGELOG_URI = "https://github.com/ssoready/ssoready-ruby/blob/master/CHANGELOG.md"
+  end
+end

data/lib/requests.rb

@@ -0,0 +1,159 @@
+# frozen_string_literal: true
+
+require_relative "environment"
+require "faraday"
+require "faraday/retry"
+require "async/http/faraday"
+
+module SSOReady
+  class RequestClient
+    # @return [Hash{String => String}]
+    attr_reader :headers
+    # @return [Faraday]
+    attr_reader :conn
+    # @return [String]
+    attr_reader :base_url
+    # @return [String]
+    attr_reader :default_environment
+
+    # @param environment [SSOReady::Environment]
+    # @param base_url [String]
+    # @param max_retries [Long] The number of times to retry a failed request, defaults to 2.
+    # @param timeout_in_seconds [Long]
+    # @param api_key [String]
+    # @return [SSOReady::RequestClient]
+    def initialize(environment: SSOReady::Environment::DEFAULT, base_url: nil, max_retries: nil,
+                   timeout_in_seconds: nil, api_key: nil)
+      @default_environment = environment
+      @base_url = environment || base_url
+      @headers = {
+        "X-Fern-Language": "Ruby",
+        "X-Fern-SDK-Name": "ssoready",
+        "X-Fern-SDK-Version": "0.1.0",
+        "Authorization": %(Bearer #{api_key || ENV["SSOREADY_API_KEY"]})
+      }
+      @conn = Faraday.new(headers: @headers) do |faraday|
+        faraday.request :json
+        faraday.response :raise_error, include_request: true
+        faraday.request :retry, { max: max_retries } unless max_retries.nil?
+        faraday.options.timeout = timeout_in_seconds unless timeout_in_seconds.nil?
+      end
+    end
+
+    # @param request_options [SSOReady::RequestOptions]
+    # @return [String]
+    def get_url(request_options: nil)
+      request_options&.base_url || @default_environment || @base_url
+    end
+  end
+
+  class AsyncRequestClient
+    # @return [Hash{String => String}]
+    attr_reader :headers
+    # @return [Faraday]
+    attr_reader :conn
+    # @return [String]
+    attr_reader :base_url
+    # @return [String]
+    attr_reader :default_environment
+
+    # @param environment [SSOReady::Environment]
+    # @param base_url [String]
+    # @param max_retries [Long] The number of times to retry a failed request, defaults to 2.
+    # @param timeout_in_seconds [Long]
+    # @param api_key [String]
+    # @return [SSOReady::AsyncRequestClient]
+    def initialize(environment: SSOReady::Environment::DEFAULT, base_url: nil, max_retries: nil,
+                   timeout_in_seconds: nil, api_key: nil)
+      @default_environment = environment
+      @base_url = environment || base_url
+      @headers = {
+        "X-Fern-Language": "Ruby",
+        "X-Fern-SDK-Name": "ssoready",
+        "X-Fern-SDK-Version": "0.1.0",
+        "Authorization": %(Bearer #{api_key || ENV["SSOREADY_API_KEY"]})
+      }
+      @conn = Faraday.new(headers: @headers) do |faraday|
+        faraday.request :json
+        faraday.response :raise_error, include_request: true
+        faraday.adapter :async_http
+        faraday.request :retry, { max: max_retries } unless max_retries.nil?
+        faraday.options.timeout = timeout_in_seconds unless timeout_in_seconds.nil?
+      end
+    end
+
+    # @param request_options [SSOReady::RequestOptions]
+    # @return [String]
+    def get_url(request_options: nil)
+      request_options&.base_url || @default_environment || @base_url
+    end
+  end
+
+  # Additional options for request-specific configuration when calling APIs via the
+  #  SDK.
+  class RequestOptions
+    # @return [String]
+    attr_reader :base_url
+    # @return [String]
+    attr_reader :api_key
+    # @return [Hash{String => Object}]
+    attr_reader :additional_headers
+    # @return [Hash{String => Object}]
+    attr_reader :additional_query_parameters
+    # @return [Hash{String => Object}]
+    attr_reader :additional_body_parameters
+    # @return [Long]
+    attr_reader :timeout_in_seconds
+
+    # @param base_url [String]
+    # @param api_key [String]
+    # @param additional_headers [Hash{String => Object}]
+    # @param additional_query_parameters [Hash{String => Object}]
+    # @param additional_body_parameters [Hash{String => Object}]
+    # @param timeout_in_seconds [Long]
+    # @return [SSOReady::RequestOptions]
+    def initialize(base_url: nil, api_key: nil, additional_headers: nil, additional_query_parameters: nil,
+                   additional_body_parameters: nil, timeout_in_seconds: nil)
+      @base_url = base_url
+      @api_key = api_key
+      @additional_headers = additional_headers
+      @additional_query_parameters = additional_query_parameters
+      @additional_body_parameters = additional_body_parameters
+      @timeout_in_seconds = timeout_in_seconds
+    end
+  end
+
+  # Additional options for request-specific configuration when calling APIs via the
+  #  SDK.
+  class IdempotencyRequestOptions
+    # @return [String]
+    attr_reader :base_url
+    # @return [String]
+    attr_reader :api_key
+    # @return [Hash{String => Object}]
+    attr_reader :additional_headers
+    # @return [Hash{String => Object}]
+    attr_reader :additional_query_parameters
+    # @return [Hash{String => Object}]
+    attr_reader :additional_body_parameters
+    # @return [Long]
+    attr_reader :timeout_in_seconds
+
+    # @param base_url [String]
+    # @param api_key [String]
+    # @param additional_headers [Hash{String => Object}]
+    # @param additional_query_parameters [Hash{String => Object}]
+    # @param additional_body_parameters [Hash{String => Object}]
+    # @param timeout_in_seconds [Long]
+    # @return [SSOReady::IdempotencyRequestOptions]
+    def initialize(base_url: nil, api_key: nil, additional_headers: nil, additional_query_parameters: nil,
+                   additional_body_parameters: nil, timeout_in_seconds: nil)
+      @base_url = base_url
+      @api_key = api_key
+      @additional_headers = additional_headers
+      @additional_query_parameters = additional_query_parameters
+      @additional_body_parameters = additional_body_parameters
+      @timeout_in_seconds = timeout_in_seconds
+    end
+  end
+end

data/lib/ssoready/management/client.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require_relative "../../requests"
+require_relative "organizations/client"
+require_relative "saml_connections/client"
+require_relative "scim_directories/client"
+require_relative "setup_urls/client"
+
+module SSOReady
+  module Management
+    class Client
+      # @return [SSOReady::Management::OrganizationsClient]
+      attr_reader :organizations
+      # @return [SSOReady::Management::SAMLConnectionsClient]
+      attr_reader :saml_connections
+      # @return [SSOReady::Management::SCIMDirectoriesClient]
+      attr_reader :scim_directories
+      # @return [SSOReady::Management::SetupURLsClient]
+      attr_reader :setup_urls
+
+      # @param request_client [SSOReady::RequestClient]
+      # @return [SSOReady::Management::Client]
+      def initialize(request_client:)
+        @organizations = SSOReady::Management::OrganizationsClient.new(request_client: request_client)
+        @saml_connections = SSOReady::Management::SAMLConnectionsClient.new(request_client: request_client)
+        @scim_directories = SSOReady::Management::SCIMDirectoriesClient.new(request_client: request_client)
+        @setup_urls = SSOReady::Management::SetupURLsClient.new(request_client: request_client)
+      end
+    end
+
+    class AsyncClient
+      # @return [SSOReady::Management::AsyncOrganizationsClient]
+      attr_reader :organizations
+      # @return [SSOReady::Management::AsyncSAMLConnectionsClient]
+      attr_reader :saml_connections
+      # @return [SSOReady::Management::AsyncSCIMDirectoriesClient]
+      attr_reader :scim_directories
+      # @return [SSOReady::Management::AsyncSetupURLsClient]
+      attr_reader :setup_urls
+
+      # @param request_client [SSOReady::AsyncRequestClient]
+      # @return [SSOReady::Management::AsyncClient]
+      def initialize(request_client:)
+        @organizations = SSOReady::Management::AsyncOrganizationsClient.new(request_client: request_client)
+        @saml_connections = SSOReady::Management::AsyncSAMLConnectionsClient.new(request_client: request_client)
+        @scim_directories = SSOReady::Management::AsyncSCIMDirectoriesClient.new(request_client: request_client)
+        @setup_urls = SSOReady::Management::AsyncSetupURLsClient.new(request_client: request_client)
+      end
+    end
+  end
+end

data/lib/ssoready/management/organizations/client.rb

@@ -0,0 +1,247 @@
+# frozen_string_literal: true
+
+require_relative "../../../requests"
+require_relative "../../types/list_organizations_response"
+require_relative "../../types/organization"
+require_relative "../../types/create_organization_response"
+require_relative "../../types/get_organization_response"
+require_relative "../../types/update_organization_response"
+require "async"
+
+module SSOReady
+  module Management
+    class OrganizationsClient
+      # @return [SSOReady::RequestClient]
+      attr_reader :request_client
+
+      # @param request_client [SSOReady::RequestClient]
+      # @return [SSOReady::Management::OrganizationsClient]
+      def initialize(request_client:)
+        @request_client = request_client
+      end
+
+      # Gets a list of organizations.
+      #
+      # @param page_token [String] Pagination token. Leave empty to get the first page of results.
+      # @param request_options [SSOReady::RequestOptions]
+      # @return [SSOReady::ListOrganizationsResponse]
+      # @example
+      #  api = SSOReady::Client.new(
+      #    environment: SSOReady::Environment::DEFAULT,
+      #    base_url: "https://api.example.com",
+      #    api_key: "YOUR_AUTH_TOKEN"
+      #  )
+      #  api.management.organizations.list_organizations
+      def list_organizations(page_token: nil, request_options: nil)
+        response = @request_client.conn.get do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
+          req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+          req.params = { **(request_options&.additional_query_parameters || {}), "pageToken": page_token }.compact
+          req.url "#{@request_client.get_url(request_options: request_options)}/v1/organizations"
+        end
+        SSOReady::ListOrganizationsResponse.from_json(json_object: response.body)
+      end
+
+      # Creates an organization.
+      #
+      # @param request [Hash] Request of type SSOReady::Organization, as a Hash
+      #   * :id (String)
+      #   * :environment_id (String)
+      #   * :display_name (String)
+      #   * :external_id (String)
+      #   * :domains (Array<String>)
+      # @param request_options [SSOReady::RequestOptions]
+      # @return [SSOReady::CreateOrganizationResponse]
+      # @example
+      #  api = SSOReady::Client.new(
+      #    environment: SSOReady::Environment::DEFAULT,
+      #    base_url: "https://api.example.com",
+      #    api_key: "YOUR_AUTH_TOKEN"
+      #  )
+      #  api.management.organizations.create_organization(request: {  })
+      def create_organization(request:, request_options: nil)
+        response = @request_client.conn.post do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
+          req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+          req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
+          req.url "#{@request_client.get_url(request_options: request_options)}/v1/organizations"
+        end
+        SSOReady::CreateOrganizationResponse.from_json(json_object: response.body)
+      end
+
+      # Gets an organization.
+      #
+      # @param id [String] ID of the organization to get.
+      # @param request_options [SSOReady::RequestOptions]
+      # @return [SSOReady::GetOrganizationResponse]
+      # @example
+      #  api = SSOReady::Client.new(
+      #    environment: SSOReady::Environment::DEFAULT,
+      #    base_url: "https://api.example.com",
+      #    api_key: "YOUR_AUTH_TOKEN"
+      #  )
+      #  api.management.organizations.get_organization(id: "id")
+      def get_organization(id:, request_options: nil)
+        response = @request_client.conn.get do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
+          req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+          req.url "#{@request_client.get_url(request_options: request_options)}/v1/organizations/#{id}"
+        end
+        SSOReady::GetOrganizationResponse.from_json(json_object: response.body)
+      end
+
+      # Updates an organization.
+      #
+      # @param id [String] ID of the organization to update.
+      # @param request [Hash] Request of type SSOReady::Organization, as a Hash
+      #   * :id (String)
+      #   * :environment_id (String)
+      #   * :display_name (String)
+      #   * :external_id (String)
+      #   * :domains (Array<String>)
+      # @param request_options [SSOReady::RequestOptions]
+      # @return [SSOReady::UpdateOrganizationResponse]
+      # @example
+      #  api = SSOReady::Client.new(
+      #    environment: SSOReady::Environment::DEFAULT,
+      #    base_url: "https://api.example.com",
+      #    api_key: "YOUR_AUTH_TOKEN"
+      #  )
+      #  api.management.organizations.update_organization(id: "id", request: {  })
+      def update_organization(id:, request:, request_options: nil)
+        response = @request_client.conn.patch do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
+          req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+          req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
+          req.url "#{@request_client.get_url(request_options: request_options)}/v1/organizations/#{id}"
+        end
+        SSOReady::UpdateOrganizationResponse.from_json(json_object: response.body)
+      end
+    end
+
+    class AsyncOrganizationsClient
+      # @return [SSOReady::AsyncRequestClient]
+      attr_reader :request_client
+
+      # @param request_client [SSOReady::AsyncRequestClient]
+      # @return [SSOReady::Management::AsyncOrganizationsClient]
+      def initialize(request_client:)
+        @request_client = request_client
+      end
+
+      # Gets a list of organizations.
+      #
+      # @param page_token [String] Pagination token. Leave empty to get the first page of results.
+      # @param request_options [SSOReady::RequestOptions]
+      # @return [SSOReady::ListOrganizationsResponse]
+      # @example
+      #  api = SSOReady::Client.new(
+      #    environment: SSOReady::Environment::DEFAULT,
+      #    base_url: "https://api.example.com",
+      #    api_key: "YOUR_AUTH_TOKEN"
+      #  )
+      #  api.management.organizations.list_organizations
+      def list_organizations(page_token: nil, request_options: nil)
+        Async do
+          response = @request_client.conn.get do |req|
+            req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+            req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
+            req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+            req.params = { **(request_options&.additional_query_parameters || {}), "pageToken": page_token }.compact
+            req.url "#{@request_client.get_url(request_options: request_options)}/v1/organizations"
+          end
+          SSOReady::ListOrganizationsResponse.from_json(json_object: response.body)
+        end
+      end
+
+      # Creates an organization.
+      #
+      # @param request [Hash] Request of type SSOReady::Organization, as a Hash
+      #   * :id (String)
+      #   * :environment_id (String)
+      #   * :display_name (String)
+      #   * :external_id (String)
+      #   * :domains (Array<String>)
+      # @param request_options [SSOReady::RequestOptions]
+      # @return [SSOReady::CreateOrganizationResponse]
+      # @example
+      #  api = SSOReady::Client.new(
+      #    environment: SSOReady::Environment::DEFAULT,
+      #    base_url: "https://api.example.com",
+      #    api_key: "YOUR_AUTH_TOKEN"
+      #  )
+      #  api.management.organizations.create_organization(request: {  })
+      def create_organization(request:, request_options: nil)
+        Async do
+          response = @request_client.conn.post do |req|
+            req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+            req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
+            req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+            req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
+            req.url "#{@request_client.get_url(request_options: request_options)}/v1/organizations"
+          end
+          SSOReady::CreateOrganizationResponse.from_json(json_object: response.body)
+        end
+      end
+
+      # Gets an organization.
+      #
+      # @param id [String] ID of the organization to get.
+      # @param request_options [SSOReady::RequestOptions]
+      # @return [SSOReady::GetOrganizationResponse]
+      # @example
+      #  api = SSOReady::Client.new(
+      #    environment: SSOReady::Environment::DEFAULT,
+      #    base_url: "https://api.example.com",
+      #    api_key: "YOUR_AUTH_TOKEN"
+      #  )
+      #  api.management.organizations.get_organization(id: "id")
+      def get_organization(id:, request_options: nil)
+        Async do
+          response = @request_client.conn.get do |req|
+            req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+            req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
+            req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+            req.url "#{@request_client.get_url(request_options: request_options)}/v1/organizations/#{id}"
+          end
+          SSOReady::GetOrganizationResponse.from_json(json_object: response.body)
+        end
+      end
+
+      # Updates an organization.
+      #
+      # @param id [String] ID of the organization to update.
+      # @param request [Hash] Request of type SSOReady::Organization, as a Hash
+      #   * :id (String)
+      #   * :environment_id (String)
+      #   * :display_name (String)
+      #   * :external_id (String)
+      #   * :domains (Array<String>)
+      # @param request_options [SSOReady::RequestOptions]
+      # @return [SSOReady::UpdateOrganizationResponse]
+      # @example
+      #  api = SSOReady::Client.new(
+      #    environment: SSOReady::Environment::DEFAULT,
+      #    base_url: "https://api.example.com",
+      #    api_key: "YOUR_AUTH_TOKEN"
+      #  )
+      #  api.management.organizations.update_organization(id: "id", request: {  })
+      def update_organization(id:, request:, request_options: nil)
+        Async do
+          response = @request_client.conn.patch do |req|
+            req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+            req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
+            req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+            req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
+            req.url "#{@request_client.get_url(request_options: request_options)}/v1/organizations/#{id}"
+          end
+          SSOReady::UpdateOrganizationResponse.from_json(json_object: response.body)
+        end
+      end
+    end
+  end
+end