reference_service 0.0.1

data/docs/Sector.md

@@ -0,0 +1,19 @@
+# OpenapiClient::Sector
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sector_id** | **Integer** |  | 
+**sector_name** | **String** |  | 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::Sector.new(sector_id: 0,
+                                 sector_name: CLOTHING)
+```
+
+

data/docs/SectorApi.md

@@ -0,0 +1,100 @@
+# OpenapiClient::SectorApi
+
+All URIs are relative to *https://stage.api.mastercard.com/golden-service*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_sectors**](SectorApi.md#get_sectors) | **GET** /sectors | Returns the valid sectors which can be passed to various other endpoints in the sector field
+[**get_top_sectors**](SectorApi.md#get_top_sectors) | **GET** /top-sectors | Retrieves the top grossing sectors for the specified date & location
+
+
+
+## get_sectors
+
+> Array<Sector> get_sectors
+
+Returns the valid sectors which can be passed to various other endpoints in the sector field
+
+### Example
+
+```ruby
+# load the gem
+require 'openapi_client'
+
+api_instance = OpenapiClient::SectorApi.new
+
+begin
+  #Returns the valid sectors which can be passed to various other endpoints in the sector field
+  result = api_instance.get_sectors
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Exception when calling SectorApi->get_sectors: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array<Sector>**](Sector.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::SectorApi.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 SectorApi->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
+

data/docs/SectorSpending.md

@@ -0,0 +1,23 @@
+# OpenapiClient::SectorSpending
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sector_id** | **Integer** |  | 
+**sector_name** | **String** |  | 
+**amount_spent** | **Float** |  | 
+**average_per_transaction** | **Float** |  | 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::SectorSpending.new(sector_id: 0,
+                                 sector_name: Clothing,
+                                 amount_spent: 1000000.12,
+                                 average_per_transaction: 120.0)
+```
+
+

data/docs/SpendingReport.md

@@ -0,0 +1,23 @@
+# OpenapiClient::SpendingReport
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**location** | **String** | The location being reported on | 
+**spending_type** | **String** | The spending type being reported | [optional] 
+**amount** | **Float** | The amount spent for the given location | [optional] 
+**sectors** | [**Array<SectorSpending>**](SectorSpending.md) | Array of sector spending objects | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::SpendingReport.new(location: New York,
+                                 spending_type: ATV,
+                                 amount: 10432.13123,
+                                 sectors: null)
+```
+
+

data/docs/SubscribeApi.md

@@ -0,0 +1,244 @@
+# OpenapiClient::SubscribeApi
+
+All URIs are relative to *https://stage.api.mastercard.com/golden-service*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_subscription**](SubscribeApi.md#get_subscription) | **GET** /subscriptions/{subscription_id} | Gets a specific subscription using a subscription Id passed as in the path
+[**list_subscriptions**](SubscribeApi.md#list_subscriptions) | **GET** /subscriptions | gets all active subscriptions for a particular user. Returned list size can be limited using the limit parameter
+[**subscribe**](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
+[**unsubscribe**](SubscribeApi.md#unsubscribe) | **DELETE** /subscriptions | Un-subscribes from a specified subcription
+[**update_subscription**](SubscribeApi.md#update_subscription) | **PUT** /subscriptions | Updates an active subscription
+
+
+
+## get_subscription
+
+> SubscriptionResponse get_subscription(subscription_id)
+
+Gets a specific subscription using a subscription Id passed as in the path
+
+### Example
+
+```ruby
+# load the gem
+require 'openapi_client'
+
+api_instance = OpenapiClient::SubscribeApi.new
+subscription_id = 'cb9fa3cc-8a06-39af-b605-934799914275' # String | Unique identifier of a particular subscription (UUID Version 4)
+
+begin
+  #Gets a specific subscription using a subscription Id passed as in the path
+  result = api_instance.get_subscription(subscription_id)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Exception when calling SubscribeApi->get_subscription: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **subscription_id** | [**String**](.md)| Unique identifier of a particular subscription (UUID Version 4) | 
+
+### Return type
+
+[**SubscriptionResponse**](SubscriptionResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_subscriptions
+
+> Array<ActiveSubscription> list_subscriptions(opts)
+
+gets all active subscriptions for a particular user. Returned list size can be limited using the limit parameter
+
+### Example
+
+```ruby
+# load the gem
+require 'openapi_client'
+
+api_instance = OpenapiClient::SubscribeApi.new
+opts = {
+  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
+  #gets all active subscriptions for a particular user. Returned list size can be limited using the limit parameter
+  result = api_instance.list_subscriptions(opts)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Exception when calling SubscribeApi->list_subscriptions: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **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
+
+[**Array<ActiveSubscription>**](ActiveSubscription.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## subscribe
+
+> Array<SubscriptionResponse> subscribe(request_body)
+
+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
+
+### Example
+
+```ruby
+# load the gem
+require 'openapi_client'
+
+api_instance = OpenapiClient::SubscribeApi.new
+request_body = {'key' => OpenapiClient::SubscriptionObject.new} # Hash<String, SubscriptionObject> | Request body required to create a particular subscription
+
+begin
+  #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
+  result = api_instance.subscribe(request_body)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Exception when calling SubscribeApi->subscribe: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **request_body** | [**Hash&lt;String, SubscriptionObject&gt;**](SubscriptionObject.md)| Request body required to create a particular subscription | 
+
+### Return type
+
+[**Array&lt;SubscriptionResponse&gt;**](SubscriptionResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## unsubscribe
+
+> UnsubscribedResponse unsubscribe(subscription_id)
+
+Un-subscribes from a specified subcription
+
+### Example
+
+```ruby
+# load the gem
+require 'openapi_client'
+
+api_instance = OpenapiClient::SubscribeApi.new
+subscription_id = 'cb9fa3cc-8a06-39af-b605-934799914275' # String | Unique identifier of a particular subscription (Version 4 UUID)
+
+begin
+  #Un-subscribes from a specified subcription
+  result = api_instance.unsubscribe(subscription_id)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Exception when calling SubscribeApi->unsubscribe: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **subscription_id** | [**String**](.md)| Unique identifier of a particular subscription (Version 4 UUID) | 
+
+### Return type
+
+[**UnsubscribedResponse**](UnsubscribedResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_subscription
+
+> SubscriptionResponse update_subscription(subscription_id, subscription_object)
+
+Updates an active subscription
+
+### Example
+
+```ruby
+# load the gem
+require 'openapi_client'
+
+api_instance = OpenapiClient::SubscribeApi.new
+subscription_id = 'cb9fa3cc-8a06-39af-b605-934799914275' # String | Unique identifier of a particular subscription (UUID Version 4)
+subscription_object = OpenapiClient::SubscriptionObject.new # SubscriptionObject | Request body required to update a particular subscription
+
+begin
+  #Updates an active subscription
+  result = api_instance.update_subscription(subscription_id, subscription_object)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Exception when calling SubscribeApi->update_subscription: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **subscription_id** | [**String**](.md)| Unique identifier of a particular subscription (UUID Version 4) | 
+ **subscription_object** | [**SubscriptionObject**](SubscriptionObject.md)| Request body required to update a particular subscription | 
+
+### Return type
+
+[**SubscriptionResponse**](SubscriptionResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/Subscription.md

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

data/docs/SubscriptionObject.md

@@ -0,0 +1,27 @@
+# OpenapiClient::SubscriptionObject
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email_address** | **String** | The email address to which the reports will be sent to | [optional] 
+**location** | **String** | The location you wish to create a subscription for | [optional] 
+**sector** | **Integer** | The sector for which you wish to receive reports. Sector ids can be retrieved from sectors call | [optional] 
+**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] 
+**subscription_payment_card** | [**SubscriptionPaymentCard**](SubscriptionPaymentCard.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::SubscriptionObject.new(email_address: example@mastercard.com,
+                                 location: New York,
+                                 sector: 0,
+                                 frequency: b,
+                                 subscription_image: null,
+                                 subscription_payment_card: null)
+```
+
+