orb-apiamtic-sdk 0.0.1

data/lib/api_reference/apis/alert_api.rb

@@ -0,0 +1,497 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # AlertApi
+  class AlertApi < BaseApi
+    # This endpoint returns a list of alerts within Orb.
+    # The request must specify one of `customer_id`, `external_customer_id`, or
+    # `subscription_id`.
+    # If querying by subscription_id, the endpoint will return the subscription
+    # level alerts as well as the plan level alerts
+    # associated with the subscription.
+    # The list of alerts is ordered starting from the most recently created
+    # alert.
+    # This endpoint follows Orb's [standardized pagination
+    # format](/api-reference/pagination).
+    # @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 [String] subscription_id Optional parameter: TODO: type description
+    # here
+    # @param [DateTime] created_at_gte Optional parameter: TODO: type
+    # description here
+    # @param [DateTime] created_at_gt Optional parameter: TODO: type description
+    # here
+    # @param [DateTime] created_at_lt Optional parameter: TODO: type description
+    # here
+    # @param [DateTime] created_at_lte Optional parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def list_alerts(limit: 20,
+                    cursor: nil,
+                    customer_id: nil,
+                    external_customer_id: nil,
+                    subscription_id: nil,
+                    created_at_gte: nil,
+                    created_at_gt: nil,
+                    created_at_lt: nil,
+                    created_at_lte: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/alerts',
+                                     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(subscription_id, key: 'subscription_id'))
+                   .query_param(new_parameter(created_at_gte, key: 'created_at[gte]'))
+                   .query_param(new_parameter(created_at_gt, key: 'created_at[gt]'))
+                   .query_param(new_parameter(created_at_lt, key: 'created_at[lt]'))
+                   .query_param(new_parameter(created_at_lte, key: 'created_at[lte]'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('APIKeyAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(Alerts.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 creates a new alert to monitor a customer's credit balance.
+    # There are three types of alerts that can be scoped to
+    #  customers: `credit_balance_depleted`, `credit_balance_dropped`, and
+    # `credit_balance_recovered`. Customers can have a maximum
+    #  of one of each type of alert per [credit balance
+    # currency](/product-catalog/prepurchase).
+    # `credit_balance_dropped` alerts require a list of thresholds to be
+    # provided while `credit_balance_depleted`
+    #  and `credit_balance_recovered` alerts do not require thresholds.
+    # @param [String] customer_id Required parameter: TODO: type description
+    # here
+    # @param [CreateCustomerAlertRequestParams] body Required parameter: TODO:
+    # type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def create_customer_alert(customer_id: nil,
+                              body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/alerts/customer_id/{customer_id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(customer_id, key: 'customer_id')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .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(Alert.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 creates a new alert to monitor a customer's credit balance.
+    # There are three types of alerts that can be scoped to
+    #  customers: `credit_balance_depleted`, `credit_balance_dropped`, and
+    # `credit_balance_recovered`. Customers can have a maximum
+    #  of one of each type of alert per [credit balance
+    # currency](/product-catalog/prepurchase).
+    # `credit_balance_dropped` alerts require a list of thresholds to be
+    # provided while `credit_balance_depleted`
+    #  and `credit_balance_recovered` alerts do not require thresholds.
+    # @param [String] external_customer_id Required parameter: TODO: type
+    # description here
+    # @param [CreateCustomerAlertRequestParams] body Required parameter: TODO:
+    # type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def create_customer_alert_external_customer_id(external_customer_id: nil,
+                                                   body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/alerts/external_customer_id/{external_customer_id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(external_customer_id, key: 'external_customer_id')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .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(Alert.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 is used to create alerts at the subscription level.
+    # Subscription level alerts can be one of two types: `usage_exceeded` or
+    # `cost_exceeded`. A `usage_exceeded` alert is
+    # scoped to a particular metric and is triggered when the usage of that
+    # metric exceeds predefined thresholds during the
+    # current billing cycle. A `cost_exceeded` alert is triggered when the total
+    # amount due during the current billing cycle surpasses
+    # predefined thresholds. `cost_exceeded` alerts do not include burndown of
+    # pre-purchase credits. Each subscription can have one
+    # `cost_exceeded` alert and one `usage_exceeded` alert per metric that is a
+    # part of the subscription. Alerts are triggered based
+    # on usage or cost conditions met during the current billing cycle.
+    # @param [String] subscription_id Required parameter: TODO: type description
+    # here
+    # @param [CreateSubscriptionAlertRequestParams] body Required parameter:
+    # TODO: type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def create_subscription_alert(subscription_id,
+                                  body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/alerts/subscription_id/{subscription_id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(subscription_id, key: 'subscription_id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .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(Alert.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 updates the thresholds of an alert.
+    # @param [String] alert_configuration_id Required parameter: TODO: type
+    # description here
+    # @param [UpdateAlertRequestParams] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def update_alert(alert_configuration_id,
+                     body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/alerts/{alert_configuration_id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(alert_configuration_id, key: 'alert_configuration_id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .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(Alert.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 trashes a subscription- or customer-scoped alert. The alert
+    # is
+    # soft-deleted: it stops firing immediately and no longer appears in fetch
+    # or list
+    # responses, while the underlying record is retained internally for audit.
+    # Plan-level alerts cannot be trashed via the API — disable them instead
+    # (`POST /v1/alerts/{alert_configuration_id}/disable`). Their removal would
+    # need to be
+    # unwound from every subscription the alert was propagated to, which isn't
+    # supported yet.
+    # @param [String] alert_configuration_id Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def trash_alert(alert_configuration_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/alerts/{alert_configuration_id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(alert_configuration_id, key: 'alert_configuration_id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .auth(Single.new('APIKeyAuth')))
+        .response(new_response_handler
+                    .is_response_void(true)
+                    .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 allows you to disable an alert. To disable a plan-level
+    # alert for a specific subscription, you must include
+    # the `subscription_id`. The `subscription_id` is not required for customer
+    # or subscription level alerts.
+    # @param [String] alert_configuration_id Required parameter: TODO: type
+    # description here
+    # @param [String] subscription_id Optional parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def disable_alert(alert_configuration_id,
+                      subscription_id: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/alerts/{alert_configuration_id}/disable',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(alert_configuration_id, key: 'alert_configuration_id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .query_param(new_parameter(subscription_id, key: 'subscription_id'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('APIKeyAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(Alert.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 allows you to enable an alert. To enable a plan-level alert
+    # for a specific subscription, you must include
+    # the `subscription_id`. The `subscription_id` is not required for customer
+    # or subscription level alerts.
+    # @param [String] alert_configuration_id Required parameter: TODO: type
+    # description here
+    # @param [String] subscription_id Optional parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def enable_alert(alert_configuration_id,
+                     subscription_id: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/alerts/{alert_configuration_id}/enable',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(alert_configuration_id, key: 'alert_configuration_id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .query_param(new_parameter(subscription_id, key: 'subscription_id'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('APIKeyAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(Alert.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 retrieves an alert by its ID.
+    # @param [String] alert_id Required parameter: TODO: type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def fetch_alert(alert_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/alerts/{alert_id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(alert_id, key: 'alert_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(Alert.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/apis/availability_api.rb

@@ -0,0 +1,51 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # AvailabilityApi
+  class AvailabilityApi < BaseApi
+    # This endpoint allows you to test your connection to the Orb API and check
+    # the validity of your API key, passed in
+    # the Authorization header. This is particularly useful for checking that
+    # your environment is set up properly, and is
+    # a great choice for connectors and integrations.
+    # This API does not have any side-effects or return any Orb resources.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def ping
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/ping',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('APIKeyAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(PingResponse.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/apis/base_api.rb

@@ -0,0 +1,65 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # BaseApi.
+  class BaseApi
+    include CoreLibrary
+    attr_accessor :config, :http_call_back
+
+    def self.user_agent
+      'Ruby SDK, Version: 0.0.1, on OS {os-info}'
+    end
+
+    def self.user_agent_parameters
+      {
+        '{os-info}' => { 'value' => RUBY_PLATFORM, 'encode' => false }
+      }
+    end
+
+    GLOBAL_ERRORS = {
+      'default' => ErrorCase.new
+                            .error_message('HTTP response not OK.')
+                            .exception_type(APIException)
+    }.freeze
+
+    # Initialization constructor.
+    # @param [GlobalConfiguration] global_configuration The instance of GlobalConfiguration.
+    def initialize(global_configuration)
+      @global_configuration = global_configuration
+      @config = @global_configuration.client_configuration
+      @http_call_back = @config.http_callback
+      @api_call = ApiCall.new(@global_configuration)
+    end
+
+    # Creates a new instance of the request builder.
+    # @param [String] http_method The HTTP method to use in the request.
+    # @param [String] path The endpoint path to use in the request.
+    # @param [String] server The server to extract the base uri for the request.
+    # @return [RequestBuilder] The instance of RequestBuilder.
+    def new_request_builder(http_method, path, server)
+      RequestBuilder.new
+                    .http_method(http_method)
+                    .path(path)
+                    .server(server)
+    end
+
+    # Creates a new instance of the response handler.
+    # @return [ResponseHandler] The instance of ResponseHandler.
+    def new_response_handler
+      ResponseHandler.new
+    end
+
+    # Creates a new instance of the parameter.
+    # @param [String|optional] key The key of the parameter.
+    # @param [Object] value The value of the parameter.
+    # @return [Parameter] The instance of Parameter.
+    def new_parameter(value, key: nil)
+      Parameter.new
+               .key(key)
+               .value(value)
+    end
+  end
+end