reference_service 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1b67add4f6e4d5be9618a7a39a369b10b471a97084c20f08f6c7171c82fad7bd
+  data.tar.gz: 5b127d834f258d70fab6f43dace0fa67bf4a882a8eb31cedd5038f72eea2dc8a
+SHA512:
+  metadata.gz: c4a650dfa54435162ad16abeb34f6343e98fade5059e7e6b719c56d9209a395fd1d0edb1befb7503e50ae9cde2ebf3c950fe13d261f807e5d0aea112a2213dc0
+  data.tar.gz: 72ecc9262d72dade474534ced8f181682febedae22660902484d5ae5aaa07d638ce6017488d785a86d9dff008835992ec47a5288fa243de73ddeb2e1264fb1e7

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 12.0.0'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/Gemfile.lock

@@ -0,0 +1,79 @@
+PATH
+  remote: .
+  specs:
+    openapi_client (1.0.0)
+      json (~> 2.1, >= 2.1.0)
+      typhoeus (~> 1.0, >= 1.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ZenTest (4.11.2)
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    autotest (4.4.6)
+      ZenTest (>= 4.4.1)
+    autotest-fsevent (0.2.14)
+      sys-uname
+    autotest-growl (0.2.16)
+    autotest-rails-pure (4.1.2)
+    byebug (10.0.2)
+    coderay (1.1.2)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    ethon (0.11.0)
+      ffi (>= 1.3.0)
+    ffi (1.9.25)
+    hashdiff (0.3.7)
+    json (2.1.0)
+    method_source (0.9.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.6.0)
+      byebug (~> 10.0)
+      pry (~> 0.10)
+    public_suffix (3.0.3)
+    rake (12.0.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    safe_yaml (1.0.4)
+    sys-uname (1.0.3)
+      ffi (>= 1.0.0)
+    typhoeus (1.3.0)
+      ethon (>= 0.9.0)
+    vcr (3.0.3)
+    webmock (1.24.6)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  autotest (~> 4.4, >= 4.4.6)
+  autotest-fsevent (~> 0.2, >= 0.2.12)
+  autotest-growl (~> 0.2, >= 0.2.16)
+  autotest-rails-pure (~> 4.1, >= 4.1.2)
+  openapi_client!
+  pry-byebug
+  rake (~> 12.0.0)
+  rspec (~> 3.6, >= 3.6.0)
+  vcr (~> 3.0, >= 3.0.1)
+  webmock (~> 1.24, >= 1.24.3)
+
+BUNDLED WITH
+   1.16.1

data/README.md

@@ -0,0 +1,126 @@
+# openapi_client
+
+OpenapiClient - the Ruby gem for the Golden Service API
+
+An API that conforms to the standards and best practices that should be adhered to
+in all Mastercard owned APIs. Can be used to create subscriptions to reports that are
+generated twice daily (6am & 6pm) that deliver e-commerce spending across multiple sectors and locations.
+<br/>
+---
+* **All requests must be signed using oauth 1.0a. Please refer to: https://developer.mastercard.com/platform/documentation/using-oauth-1a-to-access-mastercard-apis/**
+---
+* **The user must provide their card details when creating a subscription. These details must be
+encrypted before entering transit. Please refer to [Mastercard security](https://stage.developer.mastercard.com/platform/documentation/securing-sensitive-data-using-payload-encryption/)**
+---
+
+
+This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 1.1.0
+- Package version: 1.0.0
+- Build package: org.openapitools.codegen.languages.RubyClientCodegen
+For more information, please visit [https://developer.mastercard.com/](https://developer.mastercard.com/)
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build openapi_client.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./openapi_client-1.0.0.gem
+```
+
+(for development, run `gem install --dev ./openapi_client-1.0.0.gem` to install the development dependencies)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+    gem 'openapi_client', '~> 1.0.0'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
+
+    gem 'openapi_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+
+```ruby
+# Load the gem
+require 'openapi_client'
+
+api_instance = OpenapiClient::ReportsApi.new
+date = Date.parse('29/02/2019') # Date | The date for the requested data
+location = 'New York' # String | The location for which you wish to receive the top-sectors report.
+spending_type = 'ATV' # String | Used to distinguish between gross spending (GS) & average transaction value (ATV)
+opts = {
+  sector: 0 # Integer | The sector for which you wish to receive reports. Sector ids can be retrieved from sectors call
+}
+
+begin
+  #Retrieves e-commerce spending for a particular location, sector and date range or single date
+  result = api_instance.get_spending(date, location, spending_type, opts)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Exception when calling ReportsApi->get_spending: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://stage.api.mastercard.com/golden-service*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*OpenapiClient::ReportsApi* | [**get_spending**](docs/ReportsApi.md#get_spending) | **GET** /spending-reports | Retrieves e-commerce spending for a particular location, sector and date range or single date
+*OpenapiClient::ReportsApi* | [**get_top_locations**](docs/ReportsApi.md#get_top_locations) | **GET** /top-locations | Retrieves the top grossing locations for the specified date/sector/spending type
+*OpenapiClient::ReportsApi* | [**get_top_sectors**](docs/ReportsApi.md#get_top_sectors) | **GET** /top-sectors | Retrieves the top grossing sectors for the specified date & location
+*OpenapiClient::SectorApi* | [**get_sectors**](docs/SectorApi.md#get_sectors) | **GET** /sectors | Returns the valid sectors which can be passed to various other endpoints in the sector field
+*OpenapiClient::SectorApi* | [**get_top_sectors**](docs/SectorApi.md#get_top_sectors) | **GET** /top-sectors | Retrieves the top grossing sectors for the specified date & location
+*OpenapiClient::SubscribeApi* | [**get_subscription**](docs/SubscribeApi.md#get_subscription) | **GET** /subscriptions/{subscription_id} | Gets a specific subscription using a subscription Id passed as in the path
+*OpenapiClient::SubscribeApi* | [**list_subscriptions**](docs/SubscribeApi.md#list_subscriptions) | **GET** /subscriptions | gets all active subscriptions for a particular user. Returned list size can be limited using the limit parameter
+*OpenapiClient::SubscribeApi* | [**subscribe**](docs/SubscribeApi.md#subscribe) | **POST** /subscriptions | Allows the user to subscribe to a particular location and receive updates on e-commerce spending in their chosen area. The user can pay for the subscription on a daily basis. The user is charged for every report they receive until their subscription is cancelled
+*OpenapiClient::SubscribeApi* | [**unsubscribe**](docs/SubscribeApi.md#unsubscribe) | **DELETE** /subscriptions | Un-subscribes from a specified subcription
+*OpenapiClient::SubscribeApi* | [**update_subscription**](docs/SubscribeApi.md#update_subscription) | **PUT** /subscriptions | Updates an active subscription
+
+
+## Documentation for Models
+
+ - [OpenapiClient::ActiveSubscription](docs/ActiveSubscription.md)
+ - [OpenapiClient::Error](docs/Error.md)
+ - [OpenapiClient::ErrorErrors](docs/ErrorErrors.md)
+ - [OpenapiClient::ErrorErrorsError](docs/ErrorErrorsError.md)
+ - [OpenapiClient::Sector](docs/Sector.md)
+ - [OpenapiClient::SectorSpending](docs/SectorSpending.md)
+ - [OpenapiClient::SpendingReport](docs/SpendingReport.md)
+ - [OpenapiClient::Subscription](docs/Subscription.md)
+ - [OpenapiClient::SubscriptionObject](docs/SubscriptionObject.md)
+ - [OpenapiClient::SubscriptionPaymentCard](docs/SubscriptionPaymentCard.md)
+ - [OpenapiClient::SubscriptionResponse](docs/SubscriptionResponse.md)
+ - [OpenapiClient::TopLocationsReport](docs/TopLocationsReport.md)
+ - [OpenapiClient::UnsubscribedResponse](docs/UnsubscribedResponse.md)
+
+
+## Documentation for Authorization
+
+ All endpoints do not require authorization.
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/docs/ActiveSubscription.md

@@ -0,0 +1,27 @@
+# OpenapiClient::ActiveSubscription
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email_address** | **String** | The email address of the active subscription | [optional] 
+**subscription_id** | **String** | The unique identifier of the subscription (Version 4 UUID) | 
+**location** | **String** | The location that reports are generated for as part of the subscription | 
+**sector** | [**Sector**](Sector.md) |  | 
+**frequency** | **String** | b - Bi-Daily, d - Daily, w - Weekly | [optional] 
+**subscription_image** | **String** | An image that can be included as part of the subscription. MUST be sent in base64 format. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::ActiveSubscription.new(email_address: testmail@mastercard.com,
+                                 subscription_id: cb9fa3cc-8a06-39af-b605-934799914275,
+                                 location: New York,
+                                 sector: null,
+                                 frequency: b,
+                                 subscription_image: null)
+```
+
+

data/docs/Error.md

@@ -0,0 +1,17 @@
+# OpenapiClient::Error
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**errors** | [**ErrorErrors**](ErrorErrors.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::Error.new(errors: null)
+```
+
+

data/docs/ErrorErrors.md

@@ -0,0 +1,17 @@
+# OpenapiClient::ErrorErrors
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**error** | [**Array<ErrorErrorsError>**](ErrorErrorsError.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::ErrorErrors.new(error: null)
+```
+
+

data/docs/ErrorErrorsError.md

@@ -0,0 +1,25 @@
+# OpenapiClient::ErrorErrorsError
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**source** | **String** |  | [optional] 
+**reason_code** | **String** |  | [optional] 
+**description** | **String** |  | [optional] 
+**recoverable** | **Boolean** |  | [optional] 
+**details** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::ErrorErrorsError.new(source: Golden_Service,
+                                 reason_code: 400,
+                                 description: Bad Request,
+                                 recoverable: false,
+                                 details: Invalid email address)
+```
+
+

data/docs/ReportsApi.md

@@ -0,0 +1,168 @@
+# OpenapiClient::ReportsApi
+
+All URIs are relative to *https://stage.api.mastercard.com/golden-service*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_spending**](ReportsApi.md#get_spending) | **GET** /spending-reports | Retrieves e-commerce spending for a particular location, sector and date range or single date
+[**get_top_locations**](ReportsApi.md#get_top_locations) | **GET** /top-locations | Retrieves the top grossing locations for the specified date/sector/spending type
+[**get_top_sectors**](ReportsApi.md#get_top_sectors) | **GET** /top-sectors | Retrieves the top grossing sectors for the specified date & location
+
+
+
+## get_spending
+
+> SpendingReport get_spending(date, location, spending_type, opts)
+
+Retrieves e-commerce spending for a particular location, sector and date range or single date
+
+### Example
+
+```ruby
+# load the gem
+require 'openapi_client'
+
+api_instance = OpenapiClient::ReportsApi.new
+date = Date.parse('29/02/2019') # Date | The date for the requested data
+location = 'New York' # String | The location for which you wish to receive the top-sectors report.
+spending_type = 'ATV' # String | Used to distinguish between gross spending (GS) & average transaction value (ATV)
+opts = {
+  sector: 0 # Integer | The sector for which you wish to receive reports. Sector ids can be retrieved from sectors call
+}
+
+begin
+  #Retrieves e-commerce spending for a particular location, sector and date range or single date
+  result = api_instance.get_spending(date, location, spending_type, opts)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Exception when calling ReportsApi->get_spending: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **date** | **Date**| The date for the requested data | 
+ **location** | **String**| The location for which you wish to receive the top-sectors report. | 
+ **spending_type** | **String**| Used to distinguish between gross spending (GS) & average transaction value (ATV) | 
+ **sector** | **Integer**| The sector for which you wish to receive reports. Sector ids can be retrieved from sectors call | [optional] 
+
+### Return type
+
+[**SpendingReport**](SpendingReport.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_top_locations
+
+> TopLocationsReport get_top_locations(date, spending_type, opts)
+
+Retrieves the top grossing locations for the specified date/sector/spending type
+
+### Example
+
+```ruby
+# load the gem
+require 'openapi_client'
+
+api_instance = OpenapiClient::ReportsApi.new
+date = Date.parse('29/02/2019') # Date | The date for the requested data
+spending_type = 'ATV' # String | Used to distinguish between gross spending (GS) & average transaction value (ATV)
+opts = {
+  sector: 0, # Integer | The sector for which you wish to receive reports. Sector ids can be retrieved from sectors call
+  limit: 5, # Integer | Can be used to limit the amount of results returned from a query (Pagination)
+  offset: 5 # Integer | The number of items to offset the start of the list from (Pagination)
+}
+
+begin
+  #Retrieves the top grossing locations for the specified date/sector/spending type
+  result = api_instance.get_top_locations(date, spending_type, opts)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Exception when calling ReportsApi->get_top_locations: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **date** | **Date**| The date for the requested data | 
+ **spending_type** | **String**| Used to distinguish between gross spending (GS) & average transaction value (ATV) | 
+ **sector** | **Integer**| The sector for which you wish to receive reports. Sector ids can be retrieved from sectors call | [optional] 
+ **limit** | **Integer**| Can be used to limit the amount of results returned from a query (Pagination) | [optional] 
+ **offset** | **Integer**| The number of items to offset the start of the list from (Pagination) | [optional] 
+
+### Return type
+
+[**TopLocationsReport**](TopLocationsReport.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_top_sectors
+
+> Array<Array> get_top_sectors(date, location, spending_type)
+
+Retrieves the top grossing sectors for the specified date & location
+
+### Example
+
+```ruby
+# load the gem
+require 'openapi_client'
+
+api_instance = OpenapiClient::ReportsApi.new
+date = Date.parse('29/02/2019') # Date | The date for the requested data
+location = 'New York' # String | The location for which you wish to receive the top-sectors report.
+spending_type = 'ATV' # String | Used to distinguish between gross spending (GS) & average transaction value (ATV)
+
+begin
+  #Retrieves the top grossing sectors for the specified date & location
+  result = api_instance.get_top_sectors(date, location, spending_type)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Exception when calling ReportsApi->get_top_sectors: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **date** | **Date**| The date for the requested data | 
+ **location** | **String**| The location for which you wish to receive the top-sectors report. | 
+ **spending_type** | **String**| Used to distinguish between gross spending (GS) & average transaction value (ATV) | 
+
+### Return type
+
+**Array<Array>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+