apimatic-bcd-travel-sdk 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0f874c09f0419c38b356dcb8f8014b1973f67f6ce34d168392f3b5ea5aa245bc
+  data.tar.gz: 749e0c6fc19ae4c47e30dac9bb8f1a75de46d0d5be6ea76b01ccaf071b311aa1
+SHA512:
+  metadata.gz: 7a1ec0a906f5508fe8a085310cc63fbc258b1436e89077f8dfc95fa507879efb14d7601256ecc15fa2951e7b795b0f491776c4a8731419badd9684b26d5617f6
+  data.tar.gz: b358719fb59014eefbddbb567958e5ff214682b9a729ed2a724a4656ce1455b68b84cd058cede4382c29a70a0ea0141e78047ce2cec8996bb24c2e66d8121c68

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,180 @@
+
+# Getting Started with BCD Travel API
+
+## Introduction
+
+The Travel Expenses API allows clients and partners to view transaction data (a.k.a. “expense data”) in real-time. This API allows integration with your application to view your corporate travel expenses.
+
+Modify provided Postman environment `Travel Expenses API OAuth 2.0` with your `ClientId`, `ClientSecret`, and environment URLs (`AuthAPI` and `ExpensesAPI`). The `AuthToken` should auto populate by pre-request script associated with the collection or you can use `Generate OAuth 2.0 Token` request.
+
+## Install the Package
+
+Install the gem from the command line:
+
+```bash
+gem install apimatic-bcd-travel-sdk -v 0.0.1
+```
+
+Or add the gem to your Gemfile and run `bundle`:
+
+```ruby
+gem 'apimatic-bcd-travel-sdk', '0.0.1'
+```
+
+For additional gem details, see the [RubyGems page for the apimatic-bcd-travel-sdk gem](https://rubygems.org/gems/apimatic-bcd-travel-sdk/versions/0.0.1).
+
+## 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 'bcd_travel_api'
+include BcdTravelApi
+```
+
+### 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/bcd_travel_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/apimatic-bcd-travel-ruby-sdk/tree/0.0.1/doc/client.md)
+
+The following parameters are configurable for the API Client:
+
+| Parameter | Type | Description |
+|  --- | --- | --- |
+| version | `String` | *Default*: `'DefaultParameterValue'` |
+| environment | [`Environment`](https://www.github.com/sdks-io/apimatic-bcd-travel-ruby-sdk/tree/0.0.1/README.md#environments) | The API environment. <br> **Default: `Environment.PRODUCTION`** |
+| 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: 30** |
+| 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/apimatic-bcd-travel-ruby-sdk/tree/0.0.1/doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
+| logging_configuration | [`LoggingConfiguration`](https://www.github.com/sdks-io/apimatic-bcd-travel-ruby-sdk/tree/0.0.1/doc/logging-configuration.md) | The SDK logging configuration for API calls |
+| bearer_credentials | [`BearerCredentials`](https://www.github.com/sdks-io/apimatic-bcd-travel-ruby-sdk/tree/0.0.1/doc/auth/oauth-2-bearer-token.md) | The credential object for OAuth 2 Bearer token |
+| basic_credentials | [`BasicCredentials`](https://www.github.com/sdks-io/apimatic-bcd-travel-ruby-sdk/tree/0.0.1/doc/auth/basic-authentication.md) | The credential object for Basic Authentication |
+
+The API client can be initialized as follows:
+
+### Code-Based Client Initialization
+
+```ruby
+require 'bcd_travel_api'
+include BcdTravelApi
+
+client = Client.new(
+  bearer_credentials: BearerCredentials.new(
+    access_token: 'AccessToken'
+  ),
+  basic_credentials: BasicCredentials.new(
+    username: 'Username',
+    password: 'Password'
+  ),
+  environment: Environment::PRODUCTION,
+  version: 'DefaultParameterValue',
+  logging_configuration: LoggingConfiguration.new(
+    log_level: Logger::INFO,
+    request_logging_config: RequestLoggingConfiguration.new(
+      log_body: true
+    ),
+    response_logging_config: ResponseLoggingConfiguration.new(
+      log_headers: true
+    )
+  )
+)
+```
+
+### Environment-Based Client Initialization
+
+```ruby
+require 'bcd_travel_api'
+include BcdTravelApi
+
+# Create client from environment
+client = Client.from_env
+```
+
+See the [`Environment-Based Client Initialization`](https://www.github.com/sdks-io/apimatic-bcd-travel-ruby-sdk/tree/0.0.1/doc/environment-based-client-initialization.md) section for details.
+
+## Environments
+
+The SDK can be configured to use a different environment for making API calls. Available environments are:
+
+### Fields
+
+| Name | Description |
+|  --- | --- |
+| PRODUCTION | **Default** |
+| ENVIRONMENT2 | - |
+
+## Authorization
+
+This API uses the following authentication schemes.
+
+* [`bearer (OAuth 2 Bearer token)`](https://www.github.com/sdks-io/apimatic-bcd-travel-ruby-sdk/tree/0.0.1/doc/auth/oauth-2-bearer-token.md)
+* [`basic (Basic Authentication)`](https://www.github.com/sdks-io/apimatic-bcd-travel-ruby-sdk/tree/0.0.1/doc/auth/basic-authentication.md)
+
+## List of APIs
+
+* [Search Expenses](https://www.github.com/sdks-io/apimatic-bcd-travel-ruby-sdk/tree/0.0.1/doc/controllers/search-expenses.md)
+* [Retrieveversions](https://www.github.com/sdks-io/apimatic-bcd-travel-ruby-sdk/tree/0.0.1/doc/controllers/retrieveversions.md)
+* [Hotels](https://www.github.com/sdks-io/apimatic-bcd-travel-ruby-sdk/tree/0.0.1/doc/controllers/hotels.md)
+* [Cars](https://www.github.com/sdks-io/apimatic-bcd-travel-ruby-sdk/tree/0.0.1/doc/controllers/cars.md)
+* [Air-Fare-Search-Simple](https://www.github.com/sdks-io/apimatic-bcd-travel-ruby-sdk/tree/0.0.1/doc/controllers/air-fare-search-simple.md)
+* [Air-Fare-Search-Select-Seat](https://www.github.com/sdks-io/apimatic-bcd-travel-ruby-sdk/tree/0.0.1/doc/controllers/air-fare-search-select-seat.md)
+* [Air-Fare-Search-Optional-Services](https://www.github.com/sdks-io/apimatic-bcd-travel-ruby-sdk/tree/0.0.1/doc/controllers/air-fare-search-optional-services.md)
+* [Air-Availability-Return-Flight](https://www.github.com/sdks-io/apimatic-bcd-travel-ruby-sdk/tree/0.0.1/doc/controllers/air-availability-return-flight.md)
+* [Air](https://www.github.com/sdks-io/apimatic-bcd-travel-ruby-sdk/tree/0.0.1/doc/controllers/air.md)
+* [V2 1](https://www.github.com/sdks-io/apimatic-bcd-travel-ruby-sdk/tree/0.0.1/doc/controllers/v2-1.md)
+* [V2 0](https://www.github.com/sdks-io/apimatic-bcd-travel-ruby-sdk/tree/0.0.1/doc/controllers/v2-0.md)
+
+## SDK Infrastructure
+
+### Configuration
+
+* [ProxySettings](https://www.github.com/sdks-io/apimatic-bcd-travel-ruby-sdk/tree/0.0.1/doc/proxy-settings.md)
+* [Environment-Based Client Initialization](https://www.github.com/sdks-io/apimatic-bcd-travel-ruby-sdk/tree/0.0.1/doc/environment-based-client-initialization.md)
+* [AbstractLogger](https://www.github.com/sdks-io/apimatic-bcd-travel-ruby-sdk/tree/0.0.1/doc/abstract-logger.md)
+* [LoggingConfiguration](https://www.github.com/sdks-io/apimatic-bcd-travel-ruby-sdk/tree/0.0.1/doc/logging-configuration.md)
+* [RequestLoggingConfiguration](https://www.github.com/sdks-io/apimatic-bcd-travel-ruby-sdk/tree/0.0.1/doc/request-logging-configuration.md)
+* [ResponseLoggingConfiguration](https://www.github.com/sdks-io/apimatic-bcd-travel-ruby-sdk/tree/0.0.1/doc/response-logging-configuration.md)
+
+### HTTP
+
+* [HttpResponse](https://www.github.com/sdks-io/apimatic-bcd-travel-ruby-sdk/tree/0.0.1/doc/http-response.md)
+* [HttpRequest](https://www.github.com/sdks-io/apimatic-bcd-travel-ruby-sdk/tree/0.0.1/doc/http-request.md)
+
+### Utilities
+
+* [ApiResponse](https://www.github.com/sdks-io/apimatic-bcd-travel-ruby-sdk/tree/0.0.1/doc/api-response.md)
+* [ApiHelper](https://www.github.com/sdks-io/apimatic-bcd-travel-ruby-sdk/tree/0.0.1/doc/api-helper.md)
+* [DateTimeHelper](https://www.github.com/sdks-io/apimatic-bcd-travel-ruby-sdk/tree/0.0.1/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 'bcd_travel_api'
+
+puts 'BcdTravelApi SDK loaded!'
+puts 'You can now create a client with: client = BcdTravelApi::Client.new'
+puts 'Or use from_env: client = BcdTravelApi::Client.from_env'
+
+# Start an interactive IRB session
+require 'irb'
+IRB.start

data/lib/bcd_travel_api/api_helper.rb

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

data/lib/bcd_travel_api/apis/air_api.rb

@@ -0,0 +1,138 @@
+# bcd_travel_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module BcdTravelApi
+  # AirApi
+  class AirApi < BaseApi
+    # TODO: type endpoint description here
+    # @param [String] api_key Required parameter: TODO: type description here
+    # @param [String] timestamp Required parameter: TODO: type description
+    # here
+    # @param [String] nonce Required parameter: TODO: type description here
+    # @param [String] locale Required parameter: TODO: type description here
+    # @param [String] customer_ip Required parameter: TODO: type description
+    # here
+    # @param [String] session_id Required parameter: TODO: type description
+    # here
+    # @param [String] user_agent Required parameter: TODO: type description
+    # here
+    # @param [String] system Required parameter: TODO: type description here
+    # @param [String] term Required parameter: TODO: type description here
+    # @param [String] authorization Required parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def m_air_destination_lookup_api_key_asb_api_key_timestamp_timestamp_nonce_nonce_locale_en_us_customer_ip_127_0_0_1_session_id_session_id_user_agent_curl_7_64_0_system_aft_configuration_id_4_term_irpin(api_key,
+                                                                                                                                                                                                              timestamp,
+                                                                                                                                                                                                              nonce,
+                                                                                                                                                                                                              locale,
+                                                                                                                                                                                                              customer_ip,
+                                                                                                                                                                                                              session_id,
+                                                                                                                                                                                                              user_agent,
+                                                                                                                                                                                                              system,
+                                                                                                                                                                                                              term,
+                                                                                                                                                                                                              authorization)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/air/destination_lookup',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(api_key, key: 'api_key')
+                                 .is_required(true))
+                   .query_param(new_parameter(timestamp, key: 'timestamp')
+                                 .is_required(true))
+                   .query_param(new_parameter(nonce, key: 'nonce')
+                                 .is_required(true))
+                   .query_param(new_parameter(locale, key: 'locale')
+                                 .is_required(true))
+                   .query_param(new_parameter(customer_ip, key: 'customer_ip')
+                                 .is_required(true))
+                   .query_param(new_parameter(session_id, key: 'session_id')
+                                 .is_required(true))
+                   .query_param(new_parameter(user_agent, key: 'user_agent')
+                                 .is_required(true))
+                   .query_param(new_parameter(system, key: 'system')
+                                 .is_required(true))
+                   .query_param(new_parameter(term, key: 'term')
+                                 .is_required(true))
+                   .header_param(new_parameter(authorization, key: 'Authorization')
+                                  .is_required(true)))
+        .response(new_response_handler
+                    .is_response_void(true)
+                    .is_api_response(true))
+        .execute
+    end
+
+    # TODO: type endpoint description here
+    # @param [String] authorization Required parameter: TODO: type description
+    # here
+    # @param [AirdocumentsIssueRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def m_air_documents_issue(authorization,
+                              body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/air/documents_issue',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(authorization, key: 'Authorization')
+                                  .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end))
+        .response(new_response_handler
+                    .is_response_void(true)
+                    .is_api_response(true))
+        .execute
+    end
+
+    # TODO: type endpoint description here
+    # @param [String] authorization Required parameter: TODO: type description
+    # here
+    # @param [AircompleteVerificationRequest] body Required parameter: TODO:
+    # type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def m_air_complete_verification(authorization,
+                                    body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/air/complete_verification',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(authorization, key: 'Authorization')
+                                  .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end))
+        .response(new_response_handler
+                    .is_response_void(true)
+                    .is_api_response(true))
+        .execute
+    end
+
+    # TODO: type endpoint description here
+    # @param [String] authorization Required parameter: TODO: type description
+    # here
+    # @param [AirretrieveReservationsListRequest] body Required parameter: TODO:
+    # type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def m_air_retrieve_reservations_list(authorization,
+                                         body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/air/retrieve_reservations_list',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(authorization, key: 'Authorization')
+                                  .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end))
+        .response(new_response_handler
+                    .is_response_void(true)
+                    .is_api_response(true))
+        .execute
+    end
+  end
+end

data/lib/bcd_travel_api/apis/air_availability_return_flight_api.rb

@@ -0,0 +1,31 @@
+# bcd_travel_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module BcdTravelApi
+  # AirAvailabilityReturnFlightApi
+  class AirAvailabilityReturnFlightApi < BaseApi
+    # TODO: type endpoint description here
+    # @param [String] authorization Required parameter: TODO: type description
+    # here
+    # @param [String] body Required parameter: TODO: type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def m_air_availability(authorization,
+                           body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/air/availability',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(authorization, key: 'Authorization')
+                                  .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true)))
+        .response(new_response_handler
+                    .is_response_void(true)
+                    .is_api_response(true))
+        .execute
+    end
+  end
+end

data/lib/bcd_travel_api/apis/air_fare_search_optional_services_api.rb

@@ -0,0 +1,31 @@
+# bcd_travel_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module BcdTravelApi
+  # AirFareSearchOptionalServicesApi
+  class AirFareSearchOptionalServicesApi < BaseApi
+    # TODO: type endpoint description here
+    # @param [String] authorization Required parameter: TODO: type description
+    # here
+    # @param [String] body Required parameter: TODO: type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def m_air_get_checkout_data(authorization,
+                                body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/air/get_checkout_data',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(authorization, key: 'Authorization')
+                                  .is_required(true))
+                   .header_param(new_parameter('text/plain', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true)))
+        .response(new_response_handler
+                    .is_response_void(true)
+                    .is_api_response(true))
+        .execute
+    end
+  end
+end

data/lib/bcd_travel_api/apis/air_fare_search_select_seat_api.rb

@@ -0,0 +1,53 @@
+# bcd_travel_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module BcdTravelApi
+  # AirFareSearchSelectSeatApi
+  class AirFareSearchSelectSeatApi < BaseApi
+    # TODO: type endpoint description here
+    # @param [String] authorization Required parameter: TODO: type description
+    # here
+    # @param [String] body Required parameter: TODO: type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def m_air_fare_rules(authorization,
+                         body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/air/fare_rules',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(authorization, key: 'Authorization')
+                                  .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true)))
+        .response(new_response_handler
+                    .is_response_void(true)
+                    .is_api_response(true))
+        .execute
+    end
+
+    # TODO: type endpoint description here
+    # @param [String] authorization Required parameter: TODO: type description
+    # here
+    # @param [String] body Required parameter: TODO: type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def m_air_seat_map(authorization,
+                       body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/air/seat_map',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(authorization, key: 'Authorization')
+                                  .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true)))
+        .response(new_response_handler
+                    .is_response_void(true)
+                    .is_api_response(true))
+        .execute
+    end
+  end
+end