orb-apiamtic-sdk 0.0.1

data/lib/api_reference/apis/subscription_change_api.rb

@@ -0,0 +1,213 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # SubscriptionChangeApi
+  class SubscriptionChangeApi < BaseApi
+    # This endpoint returns a list of pending subscription changes for a
+    # customer. Use the
+    # [Fetch Subscription Change](fetch-subscription-change) endpoint to
+    # retrieve the expected subscription state
+    # after the pending change is applied.
+    # @param [Integer] limit Optional parameter: Example:20
+    # @param [String] cursor Optional parameter: TODO: type description here
+    # @param [String] customer_id Optional parameter: TODO: type description
+    # here
+    # @param [String] external_customer_id Optional parameter: TODO: type
+    # description here
+    # @param [Status12] status Optional parameter: Example:
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def list_subscription_changes(limit: 20,
+                                  cursor: nil,
+                                  customer_id: nil,
+                                  external_customer_id: nil,
+                                  status: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/subscription_changes',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(limit, key: 'limit'))
+                   .query_param(new_parameter(cursor, key: 'cursor'))
+                   .query_param(new_parameter(customer_id, key: 'customer_id'))
+                   .query_param(new_parameter(external_customer_id, key: 'external_customer_id'))
+                   .query_param(new_parameter(status, key: 'status'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('APIKeyAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(SubscriptionChangeListResponses.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request',
+                                 APIException)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 AuthorizationErrorException)
+                    .local_error('404',
+                                 'Not Found',
+                                 APIException)
+                    .local_error('409',
+                                 'Conflict',
+                                 IdempotencyRequestMismatchException)
+                    .local_error('413',
+                                 'Content Too Large',
+                                 APIException)
+                    .local_error('429',
+                                 'Too Many Requests',
+                                 TooManyRequestsException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 ServerErrorException))
+        .execute
+    end
+
+    # This endpoint returns a subscription change given an identifier.
+    # A subscription change is created by including
+    # `Create-Pending-Subscription-Change: True` in the header of
+    # a subscription mutation API call (e.g. [create subscription
+    # endpoint](/api-reference/subscription/create-subscription),
+    # [schedule plan change
+    # endpoint](/api-reference/subscription/schedule-plan-change), ...). The
+    # subscription change
+    # will be referenced by the `pending_subscription_change` field in the
+    # response.
+    # @param [String] subscription_change_id Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def fetch_subscription_change(subscription_change_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/subscription_changes/{subscription_change_id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(subscription_change_id, key: 'subscription_change_id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('APIKeyAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(SubscriptionChangeResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request',
+                                 APIException)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 AuthorizationErrorException)
+                    .local_error('404',
+                                 'Not Found',
+                                 APIException)
+                    .local_error('409',
+                                 'Conflict',
+                                 IdempotencyRequestMismatchException)
+                    .local_error('413',
+                                 'Content Too Large',
+                                 APIException)
+                    .local_error('429',
+                                 'Too Many Requests',
+                                 TooManyRequestsException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 ServerErrorException))
+        .execute
+    end
+
+    # Apply a subscription change to perform the intended action. If a positive
+    # amount is passed with a request to
+    # this endpoint, any eligible invoices that were created will be issued
+    # immediately if they only contain in-advance fees.
+    # @param [String] subscription_change_id Required parameter: TODO: type
+    # description here
+    # @param [ApplyParams] body Optional parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def apply_subscription_change(subscription_change_id,
+                                  body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/subscription_changes/{subscription_change_id}/apply',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(subscription_change_id, key: 'subscription_change_id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('APIKeyAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(SubscriptionChangeResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request',
+                                 APIException)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 AuthorizationErrorException)
+                    .local_error('404',
+                                 'Not Found',
+                                 APIException)
+                    .local_error('409',
+                                 'Conflict',
+                                 IdempotencyRequestMismatchException)
+                    .local_error('413',
+                                 'Content Too Large',
+                                 APIException)
+                    .local_error('429',
+                                 'Too Many Requests',
+                                 TooManyRequestsException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 ServerErrorException))
+        .execute
+    end
+
+    # Cancel a subscription change. The change can no longer be applied. A
+    # subscription can only have one "pending" change at a
+    # time - use this endpoint to cancel an existing change before creating a
+    # new one.
+    # @param [String] subscription_change_id Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def cancel_subscription_change(subscription_change_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/subscription_changes/{subscription_change_id}/cancel',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(subscription_change_id, key: 'subscription_change_id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('APIKeyAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(SubscriptionChangeResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request',
+                                 APIException)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 AuthorizationErrorException)
+                    .local_error('404',
+                                 'Not Found',
+                                 APIException)
+                    .local_error('409',
+                                 'Conflict',
+                                 IdempotencyRequestMismatchException)
+                    .local_error('413',
+                                 'Content Too Large',
+                                 APIException)
+                    .local_error('429',
+                                 'Too Many Requests',
+                                 TooManyRequestsException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 ServerErrorException))
+        .execute
+    end
+  end
+end

data/lib/api_reference/client.rb

@@ -0,0 +1,175 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  #  api_reference client class.
+  class Client
+    include CoreLibrary
+    attr_reader :config, :auth_managers
+
+    def user_agent_detail
+      config.user_agent_detail
+    end
+
+    # Access to alert controller.
+    # @return [AlertApi] Returns the controller instance.
+    def alert
+      @alert ||= AlertApi.new @global_configuration
+    end
+
+    # Access to availability controller.
+    # @return [AvailabilityApi] Returns the controller instance.
+    def availability
+      @availability ||= AvailabilityApi.new @global_configuration
+    end
+
+    # Access to coupon controller.
+    # @return [CouponApi] Returns the controller instance.
+    def coupon
+      @coupon ||= CouponApi.new @global_configuration
+    end
+
+    # Access to credit controller.
+    # @return [CreditApi] Returns the controller instance.
+    def credit
+      @credit ||= CreditApi.new @global_configuration
+    end
+
+    # Access to credit_note controller.
+    # @return [CreditNoteApi] Returns the controller instance.
+    def credit_note
+      @credit_note ||= CreditNoteApi.new @global_configuration
+    end
+
+    # Access to customer controller.
+    # @return [CustomerApi] Returns the controller instance.
+    def customer
+      @customer ||= CustomerApi.new @global_configuration
+    end
+
+    # Access to dimensional_price_group controller.
+    # @return [DimensionalPriceGroupApi] Returns the controller instance.
+    def dimensional_price_group
+      @dimensional_price_group ||= DimensionalPriceGroupApi.new @global_configuration
+    end
+
+    # Access to event controller.
+    # @return [EventApi] Returns the controller instance.
+    def event
+      @event ||= EventApi.new @global_configuration
+    end
+
+    # Access to invoice controller.
+    # @return [InvoiceApi] Returns the controller instance.
+    def invoice
+      @invoice ||= InvoiceApi.new @global_configuration
+    end
+
+    # Access to item controller.
+    # @return [ItemApi] Returns the controller instance.
+    def item
+      @item ||= ItemApi.new @global_configuration
+    end
+
+    # Access to license controller.
+    # @return [LicenseApi] Returns the controller instance.
+    def license
+      @license ||= LicenseApi.new @global_configuration
+    end
+
+    # Access to license_type controller.
+    # @return [LicenseTypeApi] Returns the controller instance.
+    def license_type
+      @license_type ||= LicenseTypeApi.new @global_configuration
+    end
+
+    # Access to metric controller.
+    # @return [MetricApi] Returns the controller instance.
+    def metric
+      @metric ||= MetricApi.new @global_configuration
+    end
+
+    # Access to plan controller.
+    # @return [PlanApi] Returns the controller instance.
+    def plan
+      @plan ||= PlanApi.new @global_configuration
+    end
+
+    # Access to price controller.
+    # @return [PriceApi] Returns the controller instance.
+    def price
+      @price ||= PriceApi.new @global_configuration
+    end
+
+    # Access to price_interval controller.
+    # @return [PriceIntervalApi] Returns the controller instance.
+    def price_interval
+      @price_interval ||= PriceIntervalApi.new @global_configuration
+    end
+
+    # Access to subscription controller.
+    # @return [SubscriptionApi] Returns the controller instance.
+    def subscription
+      @subscription ||= SubscriptionApi.new @global_configuration
+    end
+
+    # Access to subscription_change controller.
+    # @return [SubscriptionChangeApi] Returns the controller instance.
+    def subscription_change
+      @subscription_change ||= SubscriptionChangeApi.new @global_configuration
+    end
+
+    def initialize(
+      connection: nil, adapter: :net_http_persistent, timeout: 60,
+      max_retries: 0, retry_interval: 1, backoff_factor: 2,
+      retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
+      retry_methods: %i[get put], http_callback: nil, proxy_settings: nil,
+      logging_configuration: nil, environment: Environment::PRODUCTION,
+      bearer_auth_credentials: nil, config: nil
+    )
+      @config = if config.nil?
+                  Configuration.new(
+                    connection: connection, adapter: adapter, timeout: timeout,
+                    max_retries: max_retries, retry_interval: retry_interval,
+                    backoff_factor: backoff_factor,
+                    retry_statuses: retry_statuses,
+                    retry_methods: retry_methods, http_callback: http_callback,
+                    proxy_settings: proxy_settings,
+                    logging_configuration: logging_configuration,
+                    environment: environment,
+                    bearer_auth_credentials: bearer_auth_credentials
+                  )
+                else
+                  config
+                end
+      user_agent_params = BaseApi.user_agent_parameters
+
+      @global_configuration = GlobalConfiguration.new(client_configuration: @config)
+                                                 .base_uri_executor(@config.method(:get_base_uri))
+                                                 .global_errors(BaseApi::GLOBAL_ERRORS)
+                                                 .user_agent(BaseApi.user_agent,
+                                                             agent_parameters: user_agent_params)
+
+      initialize_auth_managers(@global_configuration)
+      @global_configuration = @global_configuration.auth_managers(@auth_managers)
+    end
+
+    # Initializes the auth managers hash used for authenticating API calls.
+    # @param [GlobalConfiguration] global_config The global configuration of the SDK)
+    def initialize_auth_managers(global_config)
+      @auth_managers = {}
+      http_client_config = global_config.client_configuration
+      %w[APIKeyAuth].each { |auth| @auth_managers[auth] = nil }
+      @auth_managers['APIKeyAuth'] = Oauth2.new(http_client_config.bearer_auth_credentials)
+    end
+
+    # Creates a client directly from environment variables.
+    def self.from_env(**overrides)
+      default_config = Configuration.build_default_config_from_env
+      new_config = default_config.clone_with(**overrides)
+      new(config: new_config)
+    end
+  end
+end

data/lib/api_reference/configuration.rb

@@ -0,0 +1,166 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # An enum for SDK environments.
+  class Environment
+    # PRODUCTION: Production server
+    ENVIRONMENT = [
+      PRODUCTION = 'production'.freeze
+    ].freeze
+
+    # Converts a string or symbol into a valid Environment constant.
+    def self.from_value(value, default_value = PRODUCTION)
+      return default_value if value.nil?
+
+      default_value
+    end
+  end
+
+  # An enum for API servers.
+  class Server
+    SERVER = [
+      DEFAULT = 'default'.freeze
+    ].freeze
+
+    # Converts a string or symbol into a valid Server constant.
+    def self.from_value(value, default_value = DEFAULT)
+      return default_value if value.nil?
+
+      default_value
+    end
+  end
+
+  # All configuration including auth info and base URI for the API access
+  # are configured in this class.
+  class Configuration < CoreLibrary::HttpClientConfiguration
+    # The attribute readers for properties.
+    attr_reader :environment, :bearer_auth_credentials
+
+    class << self
+      attr_reader :environments
+    end
+
+    def initialize(
+      connection: nil, adapter: :net_http_persistent, timeout: 60,
+      max_retries: 0, retry_interval: 1, backoff_factor: 2,
+      retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
+      retry_methods: %i[get put], http_callback: nil, proxy_settings: nil,
+      logging_configuration: nil, environment: Environment::PRODUCTION,
+      bearer_auth_credentials: nil
+    )
+      super connection: connection, adapter: adapter, timeout: timeout,
+            max_retries: max_retries, retry_interval: retry_interval,
+            backoff_factor: backoff_factor, retry_statuses: retry_statuses,
+            retry_methods: retry_methods, http_callback: http_callback,
+            proxy_settings: proxy_settings,
+            logging_configuration: logging_configuration
+
+      # Current API environment
+      @environment = String(environment)
+
+      # The object holding OAuth 2 Bearer token credentials
+      @bearer_auth_credentials = bearer_auth_credentials
+
+      # Initializing OAuth 2 Bearer token credentials with the provided auth parameters
+      @bearer_auth_credentials = bearer_auth_credentials
+
+      # The Http Client to use for making requests.
+      set_http_client CoreLibrary::FaradayClient.new(self)
+    end
+
+    def clone_with(connection: nil, adapter: nil, timeout: nil,
+                   max_retries: nil, retry_interval: nil, backoff_factor: nil,
+                   retry_statuses: nil, retry_methods: nil, http_callback: nil,
+                   proxy_settings: nil, logging_configuration: nil,
+                   environment: nil, bearer_auth_credentials: nil)
+      connection ||= self.connection
+      adapter ||= self.adapter
+      timeout ||= self.timeout
+      max_retries ||= self.max_retries
+      retry_interval ||= self.retry_interval
+      backoff_factor ||= self.backoff_factor
+      retry_statuses ||= self.retry_statuses
+      retry_methods ||= self.retry_methods
+      http_callback ||= self.http_callback
+      proxy_settings ||= self.proxy_settings
+      logging_configuration ||= self.logging_configuration
+      environment ||= self.environment
+      bearer_auth_credentials ||= self.bearer_auth_credentials
+
+      Configuration.new(connection: connection, adapter: adapter,
+                        timeout: timeout, max_retries: max_retries,
+                        retry_interval: retry_interval,
+                        backoff_factor: backoff_factor,
+                        retry_statuses: retry_statuses,
+                        retry_methods: retry_methods,
+                        http_callback: http_callback,
+                        proxy_settings: proxy_settings,
+                        logging_configuration: logging_configuration,
+                        environment: environment,
+                        bearer_auth_credentials: bearer_auth_credentials)
+    end
+
+
+    # All the environments the SDK can run in.
+    ENVIRONMENTS = {
+      Environment::PRODUCTION => {
+        Server::DEFAULT => 'https://api.withorb.com/v1'
+      }
+    }.freeze
+
+    # Generates the appropriate base URI for the environment and the server.
+    # @param [Configuration::Server] server The server enum for which the base URI is
+    # required.
+    # @return [String] The base URI.
+    def get_base_uri(server = Server::DEFAULT)
+      ENVIRONMENTS[environment][server].clone
+    end
+
+    # Builds a Configuration instance using environment variables.
+    def self.build_default_config_from_env
+      # === Core environment ===
+      environment = Environment.from_value(ENV.fetch('ENVIRONMENT', 'production'))
+      timeout = (ENV['TIMEOUT'] || 60).to_f
+      max_retries = (ENV['MAX_RETRIES'] || 0).to_i
+      retry_interval = (ENV['RETRY_INTERVAL'] || 1).to_f
+      backoff_factor = (ENV['BACKOFF_FACTOR'] || 2).to_f
+      retry_statuses = ENV.fetch('RETRY_STATUSES',
+                                 '[408, 413, 429, 500, 502, 503, 504, 521, 522, 524]').gsub(/[\[\]]/, '')
+                                          .split(',')
+                                          .map(&:strip)
+                                          .map do |item|
+                                            item.match?(/\A\d+\z/) ? item.to_i : item.downcase
+                                          end
+      retry_methods = ENV.fetch('RETRY_METHODS', '%i[get put]').gsub(/[\[\]]/, '')
+                                          .split(',')
+                                          .map(&:strip)
+                                          .map do |item|
+                                            item.match?(/\A\d+\z/) ? item.to_i : item.downcase
+                                          end
+
+      # === Authentication credentials ===
+      bearer_auth_credentials = BearerAuthCredentials.from_env
+
+      # === Proxy settings ===
+      proxy_settings = ProxySettings.from_env
+      # === Logging Configuration ===
+      logging_configuration = LoggingConfiguration.from_env if LoggingConfiguration.any_logging_configured?
+
+      Configuration.new(
+        environment: environment,
+        timeout: timeout,
+        max_retries: max_retries,
+        retry_interval: retry_interval,
+        backoff_factor: backoff_factor,
+        retry_statuses: retry_statuses,
+        retry_methods: retry_methods,
+        bearer_auth_credentials: bearer_auth_credentials,
+        proxy_settings: proxy_settings,
+        logging_configuration: logging_configuration
+      )
+    end
+  end
+end

data/lib/api_reference/exceptions/api_exception.rb

@@ -0,0 +1,21 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # Class for exceptions when there is a network error, status code error, etc.
+  class APIException < CoreLibrary::ApiException
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} status_code: #{@response_code}, reason: #{@reason}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} status_code: #{@response_code.inspect}, reason: #{@reason.inspect}>"
+    end
+  end
+end

data/lib/api_reference/exceptions/authorization_error_exception.rb

@@ -0,0 +1,60 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # AuthorizationError class.
+  class AuthorizationErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_reader :type
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_reader :status
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :detail
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :title
+
+    # The constructor.
+    # @param [String] reason The reason for raising an exception.
+    # @param [HttpResponse] response The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] hash The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      return nil unless hash
+
+      @detail = hash.key?('detail') ? hash['detail'] : SKIP
+      @title = hash.key?('title') ? hash['title'] : SKIP
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} type: #{@type}, status: #{@status}, detail: #{@detail}, title: #{@title}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} type: #{@type.inspect}, status: #{@status.inspect}, detail:"\
+      " #{@detail.inspect}, title: #{@title.inspect}>"
+    end
+  end
+end