schematichq 1.4.0 → 1.4.2

data/lib/schematic/insights/types/get_plan_growth_response.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Schematic
+  module Insights
+    module Types
+      class GetPlanGrowthResponse < Internal::Types::Model
+        field :data, -> { Schematic::Types::PlanGrowthResponseData }, optional: false, nullable: false
+        field :params, -> { Schematic::Insights::Types::GetPlanGrowthParams }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/schematic/{companies/types/create_plan_trait_response.rb → insights/types/get_summary_response.rb}

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 module Schematic
-  module Companies
+  module Insights
     module Types
-      class CreatePlanTraitResponse < Internal::Types::Model
-        field :data, -> { Schematic::Types::PlanTraitResponseData }, optional: false, nullable: false
+      class GetSummaryResponse < Internal::Types::Model
+        field :data, -> { Schematic::Types::InsightsSummaryResponseData }, optional: false, nullable: false
         field :params, -> { Internal::Types::Hash[String, Object] }, optional: false, nullable: false
       end
     end

data/lib/schematic/insights/types/get_top_features_by_usage_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Schematic
+  module Insights
+    module Types
+      # Input parameters
+      class GetTopFeaturesByUsageParams < Internal::Types::Model
+        field :end_time, -> { String }, optional: true, nullable: false
+        field :limit, -> { Integer }, optional: true, nullable: false
+        field :start_time, -> { String }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/schematic/insights/types/get_top_features_by_usage_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Schematic
+  module Insights
+    module Types
+      class GetTopFeaturesByUsageRequest < Internal::Types::Model
+        field :end_time, -> { String }, optional: false, nullable: false
+        field :limit, -> { Integer }, optional: true, nullable: false
+        field :start_time, -> { String }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/schematic/insights/types/get_top_features_by_usage_response.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Schematic
+  module Insights
+    module Types
+      class GetTopFeaturesByUsageResponse < Internal::Types::Model
+        field :data, -> { Schematic::Types::TopFeaturesByUsageResponseData }, optional: false, nullable: false
+        field :params, -> { Schematic::Insights::Types::GetTopFeaturesByUsageParams }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/schematic/integrationsapi/client.rb

@@ -0,0 +1,223 @@
+# frozen_string_literal: true
+
+module Schematic
+  module Integrationsapi
+    class Client
+      # @param client [Schematic::Internal::Http::RawClient]
+      #
+      # @return [void]
+      def initialize(client:)
+        @client = client
+      end
+
+      # @param request_options [Hash]
+      # @param params [Hash]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      # @option params [String] :integration_id
+      #
+      # @return [Schematic::Integrationsapi::Types::RunIntegrationResponse]
+      def run_integration(request_options: {}, **params)
+        params = Schematic::Internal::Types::Utils.normalize_keys(params)
+        request = Schematic::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "GET",
+          path: "integration/start/#{URI.encode_uri_component(params[:integration_id].to_s)}",
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Schematic::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          Schematic::Integrationsapi::Types::RunIntegrationResponse.load(response.body)
+        else
+          error_class = Schematic::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # @param request_options [Hash]
+      # @param params [Hash]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      # @option params [Boolean, nil] :billing_only
+      # @option params [String, nil] :exclude_ids
+      # @option params [String, nil] :id
+      # @option params [Schematic::Types::IntegrationState, nil] :state
+      # @option params [Schematic::Types::IntegrationType, nil] :type
+      # @option params [Integer, nil] :limit
+      # @option params [Integer, nil] :offset
+      #
+      # @return [Schematic::Integrationsapi::Types::ListIntegrationsResponse]
+      def list_integrations(request_options: {}, **params)
+        params = Schematic::Internal::Types::Utils.normalize_keys(params)
+        query_param_names = %i[billing_only exclude_ids id state type limit offset]
+        query_params = {}
+        query_params["billing_only"] = params[:billing_only] if params.key?(:billing_only)
+        query_params["exclude_ids"] = params[:exclude_ids] if params.key?(:exclude_ids)
+        query_params["id"] = params[:id] if params.key?(:id)
+        query_params["state"] = params[:state] if params.key?(:state)
+        query_params["type"] = params[:type] if params.key?(:type)
+        query_params["limit"] = params[:limit] if params.key?(:limit)
+        query_params["offset"] = params[:offset] if params.key?(:offset)
+        params.except(*query_param_names)
+
+        request = Schematic::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "GET",
+          path: "integrations",
+          query: query_params,
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Schematic::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          Schematic::Integrationsapi::Types::ListIntegrationsResponse.load(response.body)
+        else
+          error_class = Schematic::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # @param request_options [Hash]
+      # @param params [Hash]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      # @option params [String] :type
+      #
+      # @return [Schematic::Integrationsapi::Types::GetIntegrationWebhookUrlResponse]
+      def get_integration_webhook_url(request_options: {}, **params)
+        params = Schematic::Internal::Types::Utils.normalize_keys(params)
+        request = Schematic::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "GET",
+          path: "integrations/#{URI.encode_uri_component(params[:type].to_s)}/webhook-url",
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Schematic::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          Schematic::Integrationsapi::Types::GetIntegrationWebhookUrlResponse.load(response.body)
+        else
+          error_class = Schematic::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # @param request_options [Hash]
+      # @param params [Schematic::Integrationsapi::Types::StartDataImportRequestBody]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      #
+      # @return [Schematic::Integrationsapi::Types::StartDataImportResponse]
+      def start_data_import(request_options: {}, **params)
+        params = Schematic::Internal::Types::Utils.normalize_keys(params)
+        request = Schematic::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "POST",
+          path: "integrations/start-data-import",
+          body: Schematic::Integrationsapi::Types::StartDataImportRequestBody.new(params).to_h,
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Schematic::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          Schematic::Integrationsapi::Types::StartDataImportResponse.load(response.body)
+        else
+          error_class = Schematic::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # @param request_options [Hash]
+      # @param params [Hash]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      #
+      # @return [Schematic::Integrationsapi::Types::LoadSampleDataSetV2Response]
+      def load_sample_data_set_v_2(request_options: {}, **params)
+        Schematic::Internal::Types::Utils.normalize_keys(params)
+        request = Schematic::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "GET",
+          path: "integrations/stripe/dataset-sample-v2",
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Schematic::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          Schematic::Integrationsapi::Types::LoadSampleDataSetV2Response.load(response.body)
+        else
+          error_class = Schematic::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # @param request_options [Hash]
+      # @param params [Hash]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      # @option params [String] :integration_id
+      #
+      # @return [Schematic::Integrationsapi::Types::UninstallIntegrationResponse]
+      def uninstall_integration(request_options: {}, **params)
+        params = Schematic::Internal::Types::Utils.normalize_keys(params)
+        request = Schematic::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "DELETE",
+          path: "integrations/uninstall/#{URI.encode_uri_component(params[:integration_id].to_s)}",
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Schematic::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          Schematic::Integrationsapi::Types::UninstallIntegrationResponse.load(response.body)
+        else
+          error_class = Schematic::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+    end
+  end
+end

data/lib/schematic/integrationsapi/types/get_integration_webhook_url_response.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Schematic
+  module Integrationsapi
+    module Types
+      class GetIntegrationWebhookUrlResponse < Internal::Types::Model
+        field :data, -> { Schematic::Types::IntegrationWebhookUrlResponseData }, optional: false, nullable: false
+        field :params, -> { Internal::Types::Hash[String, Object] }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/schematic/integrationsapi/types/list_integrations_params.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Schematic
+  module Integrationsapi
+    module Types
+      # Input parameters
+      class ListIntegrationsParams < Internal::Types::Model
+        field :billing_only, -> { Internal::Types::Boolean }, optional: true, nullable: false
+        field :exclude_ids, -> { Internal::Types::Array[String] }, optional: true, nullable: false
+        field :id, -> { String }, optional: true, nullable: false
+        field :limit, -> { Integer }, optional: true, nullable: false
+        field :offset, -> { Integer }, optional: true, nullable: false
+        field :state, -> { Schematic::Types::IntegrationState }, optional: true, nullable: false
+        field :type, -> { Schematic::Types::IntegrationType }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/schematic/integrationsapi/types/list_integrations_request.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Schematic
+  module Integrationsapi
+    module Types
+      class ListIntegrationsRequest < Internal::Types::Model
+        field :billing_only, -> { Internal::Types::Boolean }, optional: true, nullable: false
+        field :exclude_ids, -> { String }, optional: true, nullable: false
+        field :id, -> { String }, optional: true, nullable: false
+        field :state, -> { Schematic::Types::IntegrationState }, optional: true, nullable: false
+        field :type, -> { Schematic::Types::IntegrationType }, optional: true, nullable: false
+        field :limit, -> { Integer }, optional: true, nullable: false
+        field :offset, -> { Integer }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/schematic/integrationsapi/types/list_integrations_response.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Schematic
+  module Integrationsapi
+    module Types
+      class ListIntegrationsResponse < Internal::Types::Model
+        field :data, -> { Internal::Types::Array[Schematic::Types::IntegrationsListResponseData] }, optional: false, nullable: false
+        field :params, -> { Schematic::Integrationsapi::Types::ListIntegrationsParams }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/schematic/integrationsapi/types/load_sample_data_set_v_2_response.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Schematic
+  module Integrationsapi
+    module Types
+      class LoadSampleDataSetV2Response < Internal::Types::Model
+        field :data, -> { Schematic::Types::IntegrationsDataSetResponseData }, optional: false, nullable: false
+        field :params, -> { Internal::Types::Hash[String, Object] }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/schematic/integrationsapi/types/run_integration_response.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Schematic
+  module Integrationsapi
+    module Types
+      class RunIntegrationResponse < Internal::Types::Model
+        field :data, -> { Schematic::Types::IntegrationsResponseData }, optional: false, nullable: false
+        field :params, -> { Internal::Types::Hash[String, Object] }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/schematic/integrationsapi/types/start_data_import_request_body.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Schematic
+  module Integrationsapi
+    module Types
+      class StartDataImportRequestBody < Internal::Types::Model
+        field :company_matching_criteria, -> { Schematic::Types::CompanyMatchingCriteria }, optional: true, nullable: false
+        field :company_matching_field, -> { String }, optional: true, nullable: false
+        field :integration_id, -> { String }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/schematic/integrationsapi/types/start_data_import_response.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Schematic
+  module Integrationsapi
+    module Types
+      class StartDataImportResponse < Internal::Types::Model
+        field :data, -> { Schematic::Types::IntegrationsResponseData }, optional: false, nullable: false
+        field :params, -> { Internal::Types::Hash[String, Object] }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/schematic/{companies/types/delete_plan_trait_response.rb → integrationsapi/types/uninstall_integration_response.rb}

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 module Schematic
-  module Companies
+  module Integrationsapi
     module Types
-      class DeletePlanTraitResponse < Internal::Types::Model
+      class UninstallIntegrationResponse < Internal::Types::Model
         field :data, -> { Schematic::Types::DeleteResponse }, optional: false, nullable: false
         field :params, -> { Internal::Types::Hash[String, Object] }, optional: false, nullable: false
       end

data/lib/schematic/planbundle/client.rb

@@ -10,6 +10,38 @@ module Schematic
         @client = client
       end
 
+      # @param request_options [Hash]
+      # @param params [Schematic::Planbundle::Types::CreateCustomPlanBundleRequestBody]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      #
+      # @return [Schematic::Planbundle::Types::CreateCustomPlanBundleResponse]
+      def create_custom_plan_bundle(request_options: {}, **params)
+        params = Schematic::Internal::Types::Utils.normalize_keys(params)
+        request = Schematic::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "POST",
+          path: "custom-plan-bundles",
+          body: Schematic::Planbundle::Types::CreateCustomPlanBundleRequestBody.new(params).to_h,
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Schematic::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          Schematic::Planbundle::Types::CreateCustomPlanBundleResponse.load(response.body)
+        else
+          error_class = Schematic::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
       # @param request_options [Hash]
       # @param params [Schematic::Planbundle::Types::CreatePlanBundleRequestBody]
       # @option request_options [String] :base_url

data/lib/schematic/planbundle/types/create_custom_plan_bundle_request_body.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Schematic
+  module Planbundle
+    module Types
+      class CreateCustomPlanBundleRequestBody < Internal::Types::Model
+        field :billing_product, -> { Schematic::Types::UpsertBillingProductRequestBody }, optional: true, nullable: false
+        field :entitlements, -> { Internal::Types::Array[Schematic::Types::PlanBundleEntitlementRequestBody] }, optional: false, nullable: false
+        field :plan, -> { Schematic::Types::CreateCustomPlanBundlePlanRequestBody }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/schematic/planbundle/types/create_custom_plan_bundle_response.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Schematic
+  module Planbundle
+    module Types
+      class CreateCustomPlanBundleResponse < Internal::Types::Model
+        field :data, -> { Schematic::Types::PlanBundleResponseData }, optional: false, nullable: false
+        field :params, -> { Internal::Types::Hash[String, Object] }, optional: false, nullable: false
+      end
+    end
+  end
+end