reference_service 0.0.1

data/docs/SubscriptionPaymentCard.md

@@ -0,0 +1,21 @@
+# OpenapiClient::SubscriptionPaymentCard
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**card_number** | **Integer** | Credit/Debit card number used for paying for the subscription | 
+**expiry** | **String** | Credit/Debit expiry date used for paying for the subscription | 
+**cvc** | **Integer** | Credit/Debit cvc number used for paying for the subscription | 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::SubscriptionPaymentCard.new(card_number: 5506900140100305,
+                                 expiry: 01/01,
+                                 cvc: 123)
+```
+
+

data/docs/SubscriptionResponse.md

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

data/docs/TopLocationsReport.md

@@ -0,0 +1,17 @@
+# OpenapiClient::TopLocationsReport
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**locations** | [**Array<SpendingReport>**](SpendingReport.md) | Array of spending reports for the top locations | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::TopLocationsReport.new(locations: null)
+```
+
+

data/docs/UnsubscribedResponse.md

@@ -0,0 +1,19 @@
+# OpenapiClient::UnsubscribedResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**subscription_id** | **String** | Unique identifier of the subscription (Version 4 UUID) | [optional] 
+**message** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::UnsubscribedResponse.new(subscription_id: cb9fa3cc-8a06-39af-b605-934799914275,
+                                 message: Subscription Cancelled)
+```
+
+

data/git_push.sh

@@ -0,0 +1,55 @@
+#!/bin/sh
+#
+# Generated by: https://openapi-generator.tech
+#
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 openapi-pestore-perl "minor update"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="GIT_USER_ID"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="GIT_REPO_ID"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=`git remote`
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://github.com/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:${GIT_TOKEN}@github.com/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://github.com/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'
+

data/lib/openapi_client.rb

@@ -0,0 +1,55 @@
+=begin
+#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/)** --- 
+
+The version of the OpenAPI document: 1.1.0
+Contact: developers@mastercard.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.0.1-SNAPSHOT
+
+=end
+
+# Common files
+require 'openapi_client/api_client'
+require 'openapi_client/api_error'
+require 'openapi_client/version'
+require 'openapi_client/configuration'
+
+# Models
+require 'openapi_client/models/active_subscription'
+require 'openapi_client/models/error'
+require 'openapi_client/models/error_errors'
+require 'openapi_client/models/error_errors_error'
+require 'openapi_client/models/sector'
+require 'openapi_client/models/sector_spending'
+require 'openapi_client/models/spending_report'
+require 'openapi_client/models/subscription'
+require 'openapi_client/models/subscription_object'
+require 'openapi_client/models/subscription_payment_card'
+require 'openapi_client/models/subscription_response'
+require 'openapi_client/models/top_locations_report'
+require 'openapi_client/models/unsubscribed_response'
+
+# APIs
+require 'openapi_client/api/reports_api'
+require 'openapi_client/api/sector_api'
+require 'openapi_client/api/subscribe_api'
+
+module OpenapiClient
+  class << self
+    # Customize default settings for the SDK using block.
+    #   OpenapiClient.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end

data/lib/openapi_client/api/reports_api.rb

@@ -0,0 +1,252 @@
+=begin
+#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/)** --- 
+
+The version of the OpenAPI document: 1.1.0
+Contact: developers@mastercard.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.0.1-SNAPSHOT
+
+=end
+
+require 'uri'
+
+module OpenapiClient
+  class ReportsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Retrieves e-commerce spending for a particular location, sector and date range or single date
+    # @param date [Date] The date for the requested data
+    # @param location [String] The location for which you wish to receive the top-sectors report.
+    # @param spending_type [String] Used to distinguish between gross spending (GS) &amp; average transaction value (ATV)
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :sector The sector for which you wish to receive reports. Sector ids can be retrieved from sectors call
+    # @return [SpendingReport]
+    def get_spending(date, location, spending_type, opts = {})
+      data, _status_code, _headers = get_spending_with_http_info(date, location, spending_type, opts)
+      data
+    end
+
+    # Retrieves e-commerce spending for a particular location, sector and date range or single date
+    # @param date [Date] The date for the requested data
+    # @param location [String] The location for which you wish to receive the top-sectors report.
+    # @param spending_type [String] Used to distinguish between gross spending (GS) &amp; average transaction value (ATV)
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :sector The sector for which you wish to receive reports. Sector ids can be retrieved from sectors call
+    # @return [Array<(SpendingReport, Integer, Hash)>] SpendingReport data, response status code and response headers
+    def get_spending_with_http_info(date, location, spending_type, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ReportsApi.get_spending ...'
+      end
+      # verify the required parameter 'date' is set
+      if @api_client.config.client_side_validation && date.nil?
+        fail ArgumentError, "Missing the required parameter 'date' when calling ReportsApi.get_spending"
+      end
+      # verify the required parameter 'location' is set
+      if @api_client.config.client_side_validation && location.nil?
+        fail ArgumentError, "Missing the required parameter 'location' when calling ReportsApi.get_spending"
+      end
+      # verify the required parameter 'spending_type' is set
+      if @api_client.config.client_side_validation && spending_type.nil?
+        fail ArgumentError, "Missing the required parameter 'spending_type' when calling ReportsApi.get_spending"
+      end
+      # resource path
+      local_var_path = '/spending-reports'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'date'] = date
+      query_params[:'location'] = location
+      query_params[:'spending_type'] = spending_type
+      query_params[:'sector'] = opts[:'sector'] if !opts[:'sector'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'SpendingReport' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || []
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ReportsApi#get_spending\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Retrieves the top grossing locations for the specified date/sector/spending type
+    # @param date [Date] The date for the requested data
+    # @param spending_type [String] Used to distinguish between gross spending (GS) &amp; average transaction value (ATV)
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :sector The sector for which you wish to receive reports. Sector ids can be retrieved from sectors call
+    # @option opts [Integer] :limit Can be used to limit the amount of results returned from a query (Pagination)
+    # @option opts [Integer] :offset The number of items to offset the start of the list from (Pagination)
+    # @return [TopLocationsReport]
+    def get_top_locations(date, spending_type, opts = {})
+      data, _status_code, _headers = get_top_locations_with_http_info(date, spending_type, opts)
+      data
+    end
+
+    # Retrieves the top grossing locations for the specified date/sector/spending type
+    # @param date [Date] The date for the requested data
+    # @param spending_type [String] Used to distinguish between gross spending (GS) &amp; average transaction value (ATV)
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :sector The sector for which you wish to receive reports. Sector ids can be retrieved from sectors call
+    # @option opts [Integer] :limit Can be used to limit the amount of results returned from a query (Pagination)
+    # @option opts [Integer] :offset The number of items to offset the start of the list from (Pagination)
+    # @return [Array<(TopLocationsReport, Integer, Hash)>] TopLocationsReport data, response status code and response headers
+    def get_top_locations_with_http_info(date, spending_type, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ReportsApi.get_top_locations ...'
+      end
+      # verify the required parameter 'date' is set
+      if @api_client.config.client_side_validation && date.nil?
+        fail ArgumentError, "Missing the required parameter 'date' when calling ReportsApi.get_top_locations"
+      end
+      # verify the required parameter 'spending_type' is set
+      if @api_client.config.client_side_validation && spending_type.nil?
+        fail ArgumentError, "Missing the required parameter 'spending_type' when calling ReportsApi.get_top_locations"
+      end
+      # resource path
+      local_var_path = '/top-locations'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'date'] = date
+      query_params[:'spending_type'] = spending_type
+      query_params[:'sector'] = opts[:'sector'] if !opts[:'sector'].nil?
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'TopLocationsReport' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || []
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ReportsApi#get_top_locations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Retrieves the top grossing sectors for the specified date & location
+    # @param date [Date] The date for the requested data
+    # @param location [String] The location for which you wish to receive the top-sectors report.
+    # @param spending_type [String] Used to distinguish between gross spending (GS) &amp; average transaction value (ATV)
+    # @param [Hash] opts the optional parameters
+    # @return [Array<Array>]
+    def get_top_sectors(date, location, spending_type, opts = {})
+      data, _status_code, _headers = get_top_sectors_with_http_info(date, location, spending_type, opts)
+      data
+    end
+
+    # Retrieves the top grossing sectors for the specified date &amp; location
+    # @param date [Date] The date for the requested data
+    # @param location [String] The location for which you wish to receive the top-sectors report.
+    # @param spending_type [String] Used to distinguish between gross spending (GS) &amp; average transaction value (ATV)
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<Array>, Integer, Hash)>] Array<Array> data, response status code and response headers
+    def get_top_sectors_with_http_info(date, location, spending_type, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ReportsApi.get_top_sectors ...'
+      end
+      # verify the required parameter 'date' is set
+      if @api_client.config.client_side_validation && date.nil?
+        fail ArgumentError, "Missing the required parameter 'date' when calling ReportsApi.get_top_sectors"
+      end
+      # verify the required parameter 'location' is set
+      if @api_client.config.client_side_validation && location.nil?
+        fail ArgumentError, "Missing the required parameter 'location' when calling ReportsApi.get_top_sectors"
+      end
+      # verify the required parameter 'spending_type' is set
+      if @api_client.config.client_side_validation && spending_type.nil?
+        fail ArgumentError, "Missing the required parameter 'spending_type' when calling ReportsApi.get_top_sectors"
+      end
+      # resource path
+      local_var_path = '/top-sectors'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'date'] = date
+      query_params[:'location'] = location
+      query_params[:'spending_type'] = spending_type
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'Array<Array>' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || []
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ReportsApi#get_top_sectors\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/openapi_client/api/sector_api.rb

@@ -0,0 +1,151 @@
+=begin
+#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/)** --- 
+
+The version of the OpenAPI document: 1.1.0
+Contact: developers@mastercard.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.0.1-SNAPSHOT
+
+=end
+
+require 'uri'
+
+module OpenapiClient
+  class SectorApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Returns the valid sectors which can be passed to various other endpoints in the sector field
+    # @param [Hash] opts the optional parameters
+    # @return [Array<Sector>]
+    def get_sectors(opts = {})
+      data, _status_code, _headers = get_sectors_with_http_info(opts)
+      data
+    end
+
+    # Returns the valid sectors which can be passed to various other endpoints in the sector field
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<Sector>, Integer, Hash)>] Array<Sector> data, response status code and response headers
+    def get_sectors_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SectorApi.get_sectors ...'
+      end
+      # resource path
+      local_var_path = '/sectors'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'Array<Sector>' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || []
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SectorApi#get_sectors\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Retrieves the top grossing sectors for the specified date & location
+    # @param date [Date] The date for the requested data
+    # @param location [String] The location for which you wish to receive the top-sectors report.
+    # @param spending_type [String] Used to distinguish between gross spending (GS) &amp; average transaction value (ATV)
+    # @param [Hash] opts the optional parameters
+    # @return [Array<Array>]
+    def get_top_sectors(date, location, spending_type, opts = {})
+      data, _status_code, _headers = get_top_sectors_with_http_info(date, location, spending_type, opts)
+      data
+    end
+
+    # Retrieves the top grossing sectors for the specified date &amp; location
+    # @param date [Date] The date for the requested data
+    # @param location [String] The location for which you wish to receive the top-sectors report.
+    # @param spending_type [String] Used to distinguish between gross spending (GS) &amp; average transaction value (ATV)
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<Array>, Integer, Hash)>] Array<Array> data, response status code and response headers
+    def get_top_sectors_with_http_info(date, location, spending_type, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SectorApi.get_top_sectors ...'
+      end
+      # verify the required parameter 'date' is set
+      if @api_client.config.client_side_validation && date.nil?
+        fail ArgumentError, "Missing the required parameter 'date' when calling SectorApi.get_top_sectors"
+      end
+      # verify the required parameter 'location' is set
+      if @api_client.config.client_side_validation && location.nil?
+        fail ArgumentError, "Missing the required parameter 'location' when calling SectorApi.get_top_sectors"
+      end
+      # verify the required parameter 'spending_type' is set
+      if @api_client.config.client_side_validation && spending_type.nil?
+        fail ArgumentError, "Missing the required parameter 'spending_type' when calling SectorApi.get_top_sectors"
+      end
+      # resource path
+      local_var_path = '/top-sectors'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'date'] = date
+      query_params[:'location'] = location
+      query_params[:'spending_type'] = spending_type
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'Array<Array>' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || []
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SectorApi#get_top_sectors\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end