mb-apimatic-sdk 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 91e64bed3cb39044653ae5a5b94bc1c9946c449cec33d47813c2b93dce302213
+  data.tar.gz: 4e99fbc474b725aade4dd2b80a0983254483e89f2fa83851e82ccbce6e5d3857
+SHA512:
+  metadata.gz: 52e1012e4b84e3ec316e9bea72172aaa3540eadb7b9df8c1a1a8b418b28052dca54e11e779e650fef312110c36ed78490fade2820239f08083704cf17ed85cd1
+  data.tar.gz: b291d7c9d504f616637905f8cd3755d39d4c74e45d12c704380dab441184518f4ac8621838627e4f49381dd0296ffcf58445cffbd3ede61e54e2eec4bc6da30f

data/LICENSE

@@ -0,0 +1,28 @@
+License: 
+========
+The MIT License (MIT)
+http://opensource.org/licenses/MIT
+
+Copyright (c) 2014 - 2026 APIMATIC Limited
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+Trade Mark:
+==========
+APIMATIC is a trade mark for APIMATIC Limited

data/README.md

@@ -0,0 +1,139 @@
+
+# Getting Started with MINDBODY Public API
+
+## Install the Package
+
+Install the gem from the command line:
+
+```bash
+gem install mb-apimatic-sdk -v 1.0.0
+```
+
+Or add the gem to your Gemfile and run `bundle`:
+
+```ruby
+gem 'mb-apimatic-sdk', '1.0.0'
+```
+
+For additional gem details, see the [RubyGems page for the mb-apimatic-sdk gem](https://rubygems.org/gems/mb-apimatic-sdk/versions/1.0.0).
+
+## IRB Console Usage
+
+You can explore the SDK interactively using IRB in two ways
+
+### 1. Use IRB with Installed Gem
+
+Open your system terminal (Command Prompt, Git Bash or macOS Terminal) and type the following command to start the irb console.
+
+```bash
+irb
+```
+
+Now you can load the SDK in the IRB
+
+```ruby
+require 'mindbody_public_api'
+include MindbodyPublicApi
+```
+
+### 2. Use IRB within SDK
+
+Open your system terminal (Command Prompt, Git Bash or macOS Terminal) and navigate to the root folder of SDK.
+
+```
+cd path/to/mindbody_public_api
+```
+
+Now you can start the preconfigured irb console by running the following command
+
+```bash
+ruby bin/console
+```
+
+**_Note:_** This automatically loads the SDK from lib/
+
+## Initialize the API Client
+
+**_Note:_** Documentation for the client can be found [here.](https://www.github.com/sdks-io/mb-apimatic-ruby-sdk/tree/1.0.0/doc/client.md)
+
+The following parameters are configurable for the API Client:
+
+| Parameter | Type | Description |
+|  --- | --- | --- |
+| connection | `Faraday::Connection` | The Faraday connection object passed by the SDK user for making requests |
+| adapter | `Faraday::Adapter` | The Faraday adapter object passed by the SDK user for performing http requests |
+| timeout | `Float` | The value to use for connection timeout. <br> **Default: 60** |
+| max_retries | `Integer` | The number of times to retry an endpoint call if it fails. <br> **Default: 0** |
+| retry_interval | `Float` | Pause in seconds between retries. <br> **Default: 1** |
+| backoff_factor | `Float` | The amount to multiply each successive retry's interval amount by in order to provide backoff. <br> **Default: 2** |
+| retry_statuses | `Array` | A list of HTTP statuses to retry. <br> **Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]** |
+| retry_methods | `Array` | A list of HTTP methods to retry. <br> **Default: %i[get put]** |
+| http_callback | `HttpCallBack` | The Http CallBack allows defining callables for pre and post API calls. |
+| proxy_settings | [`ProxySettings`](https://www.github.com/sdks-io/mb-apimatic-ruby-sdk/tree/1.0.0/doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
+| custom_header_authentication_credentials | [`CustomHeaderAuthenticationCredentials`](https://www.github.com/sdks-io/mb-apimatic-ruby-sdk/tree/1.0.0/doc/auth/custom-header-signature.md) | The credential object for Custom Header Signature |
+
+The API client can be initialized as follows:
+
+### Code-Based Client Initialization
+
+```ruby
+require 'mindbody_public_api'
+include MindbodyPublicApi
+
+client = Client.new(
+  custom_header_authentication_credentials: CustomHeaderAuthenticationCredentials.new(
+    api_key: 'API-Key'
+  )
+)
+```
+
+### Environment-Based Client Initialization
+
+```ruby
+require 'mindbody_public_api'
+include MindbodyPublicApi
+
+# Create client from environment
+client = Client.from_env
+```
+
+See the [`Environment-Based Client Initialization`](https://www.github.com/sdks-io/mb-apimatic-ruby-sdk/tree/1.0.0/doc/environment-based-client-initialization.md) section for details.
+
+## Authorization
+
+This API uses the following authentication schemes.
+
+* [`API-Key (Custom Header Signature)`](https://www.github.com/sdks-io/mb-apimatic-ruby-sdk/tree/1.0.0/doc/auth/custom-header-signature.md)
+
+## List of APIs
+
+* [Appointment](https://www.github.com/sdks-io/mb-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/appointment.md)
+* [Class](https://www.github.com/sdks-io/mb-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/class.md)
+* [Client](https://www.github.com/sdks-io/mb-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/client.md)
+* [Cross Site](https://www.github.com/sdks-io/mb-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/cross-site.md)
+* [Enrollment](https://www.github.com/sdks-io/mb-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/enrollment.md)
+* [Payroll](https://www.github.com/sdks-io/mb-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/payroll.md)
+* [Pick a Spot](https://www.github.com/sdks-io/mb-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/pick-a-spot.md)
+* [Pricing Option](https://www.github.com/sdks-io/mb-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/pricing-option.md)
+* [Sale](https://www.github.com/sdks-io/mb-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/sale.md)
+* [Site](https://www.github.com/sdks-io/mb-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/site.md)
+* [Staff](https://www.github.com/sdks-io/mb-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/staff.md)
+* [User Token](https://www.github.com/sdks-io/mb-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/user-token.md)
+
+## SDK Infrastructure
+
+### Configuration
+
+* [ProxySettings](https://www.github.com/sdks-io/mb-apimatic-ruby-sdk/tree/1.0.0/doc/proxy-settings.md)
+* [Environment-Based Client Initialization](https://www.github.com/sdks-io/mb-apimatic-ruby-sdk/tree/1.0.0/doc/environment-based-client-initialization.md)
+
+### HTTP
+
+* [HttpResponse](https://www.github.com/sdks-io/mb-apimatic-ruby-sdk/tree/1.0.0/doc/http-response.md)
+* [HttpRequest](https://www.github.com/sdks-io/mb-apimatic-ruby-sdk/tree/1.0.0/doc/http-request.md)
+
+### Utilities
+
+* [ApiHelper](https://www.github.com/sdks-io/mb-apimatic-ruby-sdk/tree/1.0.0/doc/api-helper.md)
+* [DateTimeHelper](https://www.github.com/sdks-io/mb-apimatic-ruby-sdk/tree/1.0.0/doc/date-time-helper.md)
+

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+# Load the lib folder into Ruby's load path
+$LOAD_PATH.unshift(File.expand_path('../lib', __dir__))
+
+# Require the gem
+require 'mindbody_public_api'
+
+puts 'MindbodyPublicApi SDK loaded!'
+puts 'You can now create a client with: client = MindbodyPublicApi::Client.new'
+puts 'Or use from_env: client = MindbodyPublicApi::Client.from_env'
+
+# Start an interactive IRB session
+require 'irb'
+IRB.start

data/lib/mindbody_public_api/api_helper.rb

@@ -0,0 +1,10 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module MindbodyPublicApi
+  # API utility class
+  class APIHelper < CoreLibrary::ApiHelper
+  end
+end

data/lib/mindbody_public_api/client.rb

@@ -0,0 +1,138 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module MindbodyPublicApi
+  #  mindbody_public_api client class.
+  class Client
+    include CoreLibrary
+    attr_reader :config, :auth_managers
+
+    def user_agent_detail
+      config.user_agent_detail
+    end
+
+    # Access to appointment controller.
+    # @return [AppointmentController] Returns the controller instance.
+    def appointment
+      @appointment ||= AppointmentController.new @global_configuration
+    end
+
+    # Access to mclass controller.
+    # @return [ClassController] Returns the controller instance.
+    def mclass
+      @mclass ||= ClassController.new @global_configuration
+    end
+
+    # Access to client controller.
+    # @return [ClientController] Returns the controller instance.
+    def client
+      @client ||= ClientController.new @global_configuration
+    end
+
+    # Access to cross_site controller.
+    # @return [CrossSiteController] Returns the controller instance.
+    def cross_site
+      @cross_site ||= CrossSiteController.new @global_configuration
+    end
+
+    # Access to enrollment controller.
+    # @return [EnrollmentController] Returns the controller instance.
+    def enrollment
+      @enrollment ||= EnrollmentController.new @global_configuration
+    end
+
+    # Access to payroll controller.
+    # @return [PayrollController] Returns the controller instance.
+    def payroll
+      @payroll ||= PayrollController.new @global_configuration
+    end
+
+    # Access to pick_a_spot controller.
+    # @return [PickASpotController] Returns the controller instance.
+    def pick_a_spot
+      @pick_a_spot ||= PickASpotController.new @global_configuration
+    end
+
+    # Access to pricing_option controller.
+    # @return [PricingOptionController] Returns the controller instance.
+    def pricing_option
+      @pricing_option ||= PricingOptionController.new @global_configuration
+    end
+
+    # Access to sale controller.
+    # @return [SaleController] Returns the controller instance.
+    def sale
+      @sale ||= SaleController.new @global_configuration
+    end
+
+    # Access to site controller.
+    # @return [SiteController] Returns the controller instance.
+    def site
+      @site ||= SiteController.new @global_configuration
+    end
+
+    # Access to staff controller.
+    # @return [StaffController] Returns the controller instance.
+    def staff
+      @staff ||= StaffController.new @global_configuration
+    end
+
+    # Access to user_token controller.
+    # @return [UserTokenController] Returns the controller instance.
+    def user_token
+      @user_token ||= UserTokenController.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,
+      environment: Environment::PRODUCTION, api_key: nil,
+      custom_header_authentication_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, environment: environment,
+                    api_key: api_key,
+                    custom_header_authentication_credentials: custom_header_authentication_credentials
+                  )
+                else
+                  config
+                end
+
+      @global_configuration = GlobalConfiguration.new(client_configuration: @config)
+                                                 .base_uri_executor(@config.method(:get_base_uri))
+                                                 .global_errors(BaseController::GLOBAL_ERRORS)
+                                                 .user_agent(BaseController.user_agent)
+
+      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[API-Key].each { |auth| @auth_managers[auth] = nil }
+      @auth_managers['API-Key'] = CustomHeaderAuthentication.new(
+        http_client_config.custom_header_authentication_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/mindbody_public_api/configuration.rb

@@ -0,0 +1,181 @@
+# mindbody_public_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module MindbodyPublicApi
+  # An enum for SDK environments.
+  class Environment
+    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
+    def api_key
+      @custom_header_authentication_credentials.api_key
+    end
+
+    # The attribute readers for properties.
+    attr_reader :environment, :custom_header_authentication_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,
+      environment: Environment::PRODUCTION, api_key: nil,
+      custom_header_authentication_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
+
+      # Current API environment
+      @environment = String(environment)
+
+      # API Key Authentication
+      @api_key = api_key
+
+      # Initializing Custom Header Signature credentials with the provided auth parameters
+      @custom_header_authentication_credentials = create_auth_credentials_object(
+        api_key, custom_header_authentication_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, environment: nil, api_key: nil,
+                   custom_header_authentication_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
+      environment ||= self.environment
+      custom_header_authentication_credentials = create_auth_credentials_object(
+        api_key,
+        custom_header_authentication_credentials || self.custom_header_authentication_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, environment: environment,
+        custom_header_authentication_credentials: custom_header_authentication_credentials
+      )
+    end
+
+    def create_auth_credentials_object(api_key,
+                                       custom_header_authentication_credentials)
+      return custom_header_authentication_credentials if api_key.nil?
+
+      warn('The \'api_key\' params are deprecated. Use \'custom_header_authent'\
+           'ication_credentials\' param instead.')
+
+      unless custom_header_authentication_credentials.nil?
+        return custom_header_authentication_credentials.clone_with(
+          api_key: api_key
+        )
+      end
+
+      CustomHeaderAuthenticationCredentials.new(api_key: api_key)
+    end
+
+    # All the environments the SDK can run in.
+    ENVIRONMENTS = {
+      Environment::PRODUCTION => {
+        Server::DEFAULT => 'https://api.mindbodyonline.com'
+      }
+    }.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 ===
+      custom_header_authentication_credentials = CustomHeaderAuthenticationCredentials.from_env
+
+      # === Proxy settings ===
+      proxy_settings = ProxySettings.from_env
+
+      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,
+        custom_header_authentication_credentials: custom_header_authentication_credentials,
+        proxy_settings: proxy_settings
+      )
+    end
+  end
+end