google-calendar-apimatic-sdk 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8e73b53b6c689e7f94e75339a5ba965f0723b9331e36b28202b292a62316e44b
+  data.tar.gz: 3f7aa586d6a96a658a1fa97d3b0d9d0fdada70526f8413197274ab24d6ef38be
+SHA512:
+  metadata.gz: 71e0be81dafbefb107819ac9f3b009fd0db5209bed7d2f0957b3618aa849efb3970356ed0a54a6545e59cdcf9cad83e40bba73813353070019a8b212474b37f5
+  data.tar.gz: d828b200fc7e711026761ffc6886a04d606f40fb2f6f5b376a8ee89b4b013c644c262861aea4c4b847a392f978cddc29368a15dce070d73c829b247b42be957c

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,168 @@
+
+# Getting Started with Calendar API
+
+## Introduction
+
+Manipulates events and other calendar data. Provides access to Google Calendar for creating, listing, patching, and deleting events, querying free/busy information, and setting up push notifications for event changes.
+
+## Install the Package
+
+Install the gem from the command line:
+
+```bash
+gem install google-calendar-apimatic-sdk -v 1.0.0
+```
+
+Or add the gem to your Gemfile and run `bundle`:
+
+```ruby
+gem 'google-calendar-apimatic-sdk', '1.0.0'
+```
+
+For additional gem details, see the [RubyGems page for the google-calendar-apimatic-sdk gem](https://rubygems.org/gems/google-calendar-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 'calendar_api'
+include CalendarApi
+```
+
+### 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/calendar_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.](doc/client.md)
+
+The following parameters are configurable for the API Client:
+
+| Parameter | Type | Description |
+|  --- | --- | --- |
+| environment | [`Environment`](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`](doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
+| logging_configuration | [`LoggingConfiguration`](doc/logging-configuration.md) | The SDK logging configuration for API calls |
+| authorization_code_auth_credentials | [`AuthorizationCodeAuthCredentials`](__base_path/auth/oauth-2-authorization-code-grant.md) | The credential object for OAuth 2 Authorization Code Grant |
+
+The API client can be initialized as follows:
+
+### Code-Based Client Initialization
+
+```ruby
+require 'calendar_api'
+include CalendarApi
+
+client = Client.new(
+  authorization_code_auth_credentials: AuthorizationCodeAuthCredentials.new(
+    oauth_client_id: 'OAuthClientId',
+    oauth_client_secret: 'OAuthClientSecret',
+    oauth_redirect_uri: 'OAuthRedirectUri',
+    oauth_scopes: [
+      OauthScope::HTTPS_WWW_GOOGLEAPIS_COM_AUTH_CALENDAR_READONLY,
+      OauthScope::HTTPS_WWW_GOOGLEAPIS_COM_AUTH_CALENDAR_EVENTS
+    ]
+  ),
+  environment: Environment::PRODUCTION,
+  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 'calendar_api'
+include CalendarApi
+
+# Create client from environment
+client = Client.from_env
+```
+
+See the [`Environment-Based Client Initialization`](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** Google Calendar API v3 |
+
+## Authorization
+
+This API uses the following authentication schemes.
+
+* [`oauth2 (OAuth 2 Authorization Code Grant)`](__base_path/auth/oauth-2-authorization-code-grant.md)
+
+## List of APIs
+
+* [Calendar List](doc/controllers/calendar-list.md)
+* [Events](doc/controllers/events.md)
+* [Free Busy](doc/controllers/free-busy.md)
+* [Channels](doc/controllers/channels.md)
+
+## SDK Infrastructure
+
+### Configuration
+
+* [ProxySettings](doc/proxy-settings.md)
+* [Environment-Based Client Initialization](doc/environment-based-client-initialization.md)
+* [AbstractLogger](doc/abstract-logger.md)
+* [LoggingConfiguration](doc/logging-configuration.md)
+* [RequestLoggingConfiguration](doc/request-logging-configuration.md)
+* [ResponseLoggingConfiguration](doc/response-logging-configuration.md)
+
+### HTTP
+
+* [HttpResponse](doc/http-response.md)
+* [HttpRequest](doc/http-request.md)
+
+### Utilities
+
+* [ApiResponse](doc/api-response.md)
+* [ApiHelper](doc/api-helper.md)
+* [DateTimeHelper](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 'calendar_api'
+
+puts 'CalendarApi SDK loaded!'
+puts 'You can now create a client with: client = CalendarApi::Client.new'
+puts 'Or use from_env: client = CalendarApi::Client.from_env'
+
+# Start an interactive IRB session
+require 'irb'
+IRB.start

data/lib/calendar_api/api_helper.rb

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

data/lib/calendar_api/apis/base_api.rb

@@ -0,0 +1,67 @@
+# calendar_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CalendarApi
+  # BaseApi.
+  class BaseApi
+    include CoreLibrary
+    attr_accessor :config, :http_call_back
+
+    def self.user_agent
+      'Ruby-SDK/1.0.0 (OS: {os-info}, Engine: {engine}/{engine-version})'
+    end
+
+    def self.user_agent_parameters
+      {
+        '{engine}' => { 'value' => RUBY_ENGINE, 'encode' => false },
+        '{engine-version}' => { 'value' => RUBY_ENGINE_VERSION, 'encode' => false },
+        '{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

data/lib/calendar_api/apis/calendar_list_api.rb

@@ -0,0 +1,63 @@
+# calendar_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CalendarApi
+  # CalendarListApi
+  class CalendarListApi < BaseApi
+    # Returns the calendars on the user's calendar list. Use the returned
+    # calendar IDs as the calendarId path parameter for event operations.
+    # @param [Integer] max_results Optional parameter: Maximum number of entries
+    # returned on one result page. Default is 100, maximum allowed is 250.
+    # @param [CalendarAccessRole] min_access_role Optional parameter: The
+    # minimum access role for the user in the returned entries.
+    # @param [String] page_token Optional parameter: Token specifying which
+    # result page to return.
+    # @param [TrueClass | FalseClass] show_deleted Optional parameter: Whether
+    # to include deleted calendar list entries in the result. Default is
+    # false.
+    # @param [TrueClass | FalseClass] show_hidden Optional parameter: Whether to
+    # show hidden entries. Default is false.
+    # @param [String] sync_token Optional parameter: Token obtained from the
+    # nextSyncToken field returned on the last page of a previous list request.
+    # Makes the result contain only entries that have changed since then.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def list_calendar_list(max_results: 100,
+                           min_access_role: nil,
+                           page_token: nil,
+                           show_deleted: false,
+                           show_hidden: false,
+                           sync_token: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/users/me/calendarList',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(max_results, key: 'maxResults'))
+                   .query_param(new_parameter(min_access_role, key: 'minAccessRole'))
+                   .query_param(new_parameter(page_token, key: 'pageToken'))
+                   .query_param(new_parameter(show_deleted, key: 'showDeleted'))
+                   .query_param(new_parameter(show_hidden, key: 'showHidden'))
+                   .query_param(new_parameter(sync_token, key: 'syncToken'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('oauth2')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(CalendarListResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad request — invalid parameters or request body.',
+                                 ErrorResponseError1Exception)
+                    .local_error('401',
+                                 'Authentication required or credentials are invalid.',
+                                 ErrorResponseError1Exception)
+                    .local_error('403',
+                                 'Insufficient permissions for the requested resource.',
+                                 ErrorResponseError1Exception)
+                    .local_error('404',
+                                 'The requested resource was not found.',
+                                 ErrorResponseError1Exception))
+        .execute
+    end
+  end
+end

data/lib/calendar_api/apis/channels_api.rb

@@ -0,0 +1,42 @@
+# calendar_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CalendarApi
+  # ChannelsApi
+  class ChannelsApi < BaseApi
+    # Stops receiving push notifications for the specified channel. This is
+    # required to clean up channels created by the watchEvents operation.
+    # @param [StopChannelRequest] body Required parameter: Request body for stop
+    # a notification channel.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def stop_channel(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/channels/stop',
+                                     Server::DEFAULT)
+                   .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)
+                   .auth(Single.new('oauth2')))
+        .response(new_response_handler
+                    .is_response_void(true)
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad request — invalid parameters or request body.',
+                                 ErrorResponseError1Exception)
+                    .local_error('401',
+                                 'Authentication required or credentials are invalid.',
+                                 ErrorResponseError1Exception)
+                    .local_error('403',
+                                 'Insufficient permissions for the requested resource.',
+                                 ErrorResponseError1Exception)
+                    .local_error('404',
+                                 'The requested resource was not found.',
+                                 ErrorResponseError1Exception))
+        .execute
+    end
+  end
+end