subskribe_dev 1.0.0 → 1.2.0

data/spec/api/revenue_recognition_api_spec.rb

@@ -0,0 +1,144 @@
+=begin
+#Subskribe API
+
+#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+
+OpenAPI spec version: 1.0.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.41
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for SubskribeDevClient::RevenueRecognitionApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'RevenueRecognitionApi' do
+  before do
+    # run before each test
+    @instance = SubskribeDevClient::RevenueRecognitionApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of RevenueRecognitionApi' do
+    it 'should create an instance of RevenueRecognitionApi' do
+      expect(@instance).to be_instance_of(SubskribeDevClient::RevenueRecognitionApi)
+    end
+  end
+
+  # unit tests for add_recognition_rule
+  # Create a revenue recognition rule
+  # Creates a revenue recognition rule.
+  # @param body recognition rule details
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'add_recognition_rule test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for create_recognition_event
+  # Create a revenue recognition event
+  # Creates a revenue recognition event, only if it is different from the previous event for same subscription and charge.
+  # @param body recognition event details
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'create_recognition_event test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for delete_rule
+  # Delete a recognition rule
+  # Deletes a recognition rule. Note you can't delete a recognition rule that's in use.
+  # @param rule_id id of the recognition rule
+  # @param [Hash] opts the optional parameters
+  # @return [RecognitionRule]
+  describe 'delete_rule test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_recognition_events_by_subscription_id_charge_id
+  # Get revenue recognition events
+  # Gets revenue recognition events for the specified subscription and charge.
+  # @param subscription_id id of the subscription
+  # @param charge_id id of the charge
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :accounting_period_id id of the accounting period to limit events to
+  # @return [Array<RecognitionEventCompletion>]
+  describe 'get_recognition_events_by_subscription_id_charge_id test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_recognition_rule_by_id
+  # Get revenue recognition rules
+  # Get revenue recognition rules.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'get_recognition_rule_by_id test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_recognition_rule_by_id1
+  # Get revenue recognition rule
+  # Get a revenue recognition rule using id.
+  # @param id id of the recognition rule
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'get_recognition_rule_by_id1 test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_revenue_waterfall
+  # Download waterfall report
+  # Downloads a revenue waterfall report in csv format.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :start_date report start date as unix timestamp
+  # @option opts [Integer] :end_date report end date as unix timestamp
+  # @return [nil]
+  describe 'get_revenue_waterfall test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_revenue_waterfall_report_v2
+  # Download waterfall report
+  # Downloads a revenue waterfall report in csv format.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'get_revenue_waterfall_report_v2 test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for upload_completion_events
+  # Upload revenue events
+  # Uploads revenue events from a csv file. The format of the file is Subscription.Id,Charge.Id,Alias.Id,RevrecEvent.PercentComplete Percent complete should be a decimal.
+  # @param [Hash] opts the optional parameters
+  # @option opts [File] :file 
+  # @return [nil]
+  describe 'upload_completion_events test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/sales_room_api_spec.rb

@@ -0,0 +1,47 @@
+=begin
+#Subskribe API
+
+#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+
+OpenAPI spec version: 1.0.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.41
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for SubskribeDevClient::SalesRoomApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'SalesRoomApi' do
+  before do
+    # run before each test
+    @instance = SubskribeDevClient::SalesRoomApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of SalesRoomApi' do
+    it 'should create an instance of SalesRoomApi' do
+      expect(@instance).to be_instance_of(SubskribeDevClient::SalesRoomApi)
+    end
+  end
+
+  # unit tests for get_order_document2
+  # Fetch order form PDF for a Sales Room
+  # Downloads the order form PDF for the specified Sales Room.
+  # @param link_id Link id for the sales room
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'get_order_document2 test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/settings_api_spec.rb

@@ -13,13 +13,13 @@ Swagger Codegen version: 2.4.41
 require 'spec_helper'
 require 'json'
 
-# Unit tests for SwaggerClient::SettingsApi
+# Unit tests for SubskribeDevClient::SettingsApi
 # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
 # Please update as you see appropriate
 describe 'SettingsApi' do
   before do
     # run before each test
-    @instance = SwaggerClient::SettingsApi.new
+    @instance = SubskribeDevClient::SettingsApi.new
   end
 
   after do
@@ -28,7 +28,7 @@ describe 'SettingsApi' do
 
   describe 'test an instance of SettingsApi' do
     it 'should create an instance of SettingsApi' do
-      expect(@instance).to be_instance_of(SwaggerClient::SettingsApi)
+      expect(@instance).to be_instance_of(SubskribeDevClient::SettingsApi)
     end
   end
 

data/spec/api/subscriptions_api_spec.rb

@@ -0,0 +1,162 @@
+=begin
+#Subskribe API
+
+#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+
+OpenAPI spec version: 1.0.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.41
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for SubskribeDevClient::SubscriptionsApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'SubscriptionsApi' do
+  before do
+    # run before each test
+    @instance = SubskribeDevClient::SubscriptionsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of SubscriptionsApi' do
+    it 'should create an instance of SubscriptionsApi' do
+      expect(@instance).to be_instance_of(SubskribeDevClient::SubscriptionsApi)
+    end
+  end
+
+  # unit tests for delete_subscription
+  # Delete subscription
+  # Deletes the subscription for given subscription Id if invoices have not been generated and revenue has not been recognized
+  # @param id subscription id
+  # @param version subscription version
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_subscription test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_subscription_billing_periods
+  # Get billing periods
+  # Gets the billing periods for the specified subscription.
+  # @param id subscription id
+  # @param [Hash] opts the optional parameters
+  # @return [Array<Integer>]
+  describe 'get_subscription_billing_periods test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_subscription_by_id
+  # Get subscription details
+  # Gets the details of the specified subscription.
+  # @param id subscription id
+  # @param [Hash] opts the optional parameters
+  # @return [SubscriptionJson]
+  describe 'get_subscription_by_id test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_subscription_metrics
+  # Get subscription metrics
+  # Returns the metrics associated with the specified subscription. Metrics include ACV, ARR, etc.
+  # @param id id of the subscription
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :target_date As of date for the metrics. If omitted defaults to now.
+  # @return [MetricsJson]
+  describe 'get_subscription_metrics test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_subscriptions
+  # Get paginated subscriptions
+  # returns all Subscriptions in the system in a paginated fashion
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :limit number of items per page
+  # @option opts [String] :page_token pass this to subsequent calls
+  # @option opts [String] :account_id optionally pass in account Id, only subscriptions for this account will will returned
+  # @return [PaginatedResponse]
+  describe 'get_subscriptions test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for revert_subscription
+  # Revert subscription
+  # Reverts the subscription for given subscription Id and version to it&#39;s previous version. Operation is allowed only if invoices have not been generated and revenue has not been recognized
+  # @param id subscription id
+  # @param version subscription version
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'revert_subscription test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for subscription_modifiable
+  # Subscription can be modified
+  # Returns true if subscription can be deleted.
+  # @param id subscription id
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'subscription_modifiable test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for subscription_reversible
+  # Subscription can be reverted
+  # Returns true if subscription can be reverted to a prior version.
+  # @param id subscription id
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'subscription_reversible test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for update_renewal_opportunity
+  # Link renewal opportunity to subscription
+  # Update renewal opportunity CRM id on subscription
+  # @param id subscription id
+  # @param renewal_opportunity_crm_id renewal opportunity CRM id
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'update_renewal_opportunity test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for update_subscription
+  # Update subscription details
+  # Updates the details of the specified subscription.
+  # @param id subscription id
+  # @param body subscription details in json
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'update_subscription test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/usage_api_spec.rb

@@ -0,0 +1,169 @@
+=begin
+#Subskribe API
+
+#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+
+OpenAPI spec version: 1.0.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.41
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for SubskribeDevClient::UsageApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'UsageApi' do
+  before do
+    # run before each test
+    @instance = SubskribeDevClient::UsageApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of UsageApi' do
+    it 'should create an instance of UsageApi' do
+      expect(@instance).to be_instance_of(SubskribeDevClient::UsageApi)
+    end
+  end
+
+  # unit tests for add_and_apply_bulk_payments_csv
+  # Add and apply bulk payments to invoices CSV
+  # Bulk upload payments to invoices in CSV file
+  # @param [Hash] opts the optional parameters
+  # @option opts [File] :file 
+  # @return [BulkPaymentUploadResult]
+  describe 'add_and_apply_bulk_payments_csv test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for add_usage
+  # Add usage record
+  # Load usage records into the system
+  # @param [Hash] opts the optional parameters
+  # @option opts [RawUsagesData] :body 
+  # @return [UsageBatchInsertResult]
+  describe 'add_usage test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_usage_aggregates_for_subscription
+  # Get aggregated usage
+  # Retrieve the current aggregated usage data for a subscription between 2 instants
+  # @param subscription_id 
+  # @param from 
+  # @param to 
+  # @param [Hash] opts the optional parameters
+  # @return [Array<UsageAggregateOutput>]
+  describe 'get_usage_aggregates_for_subscription test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_usage_arrival_time_checkpoint
+  # Get usage arrival checkpoint
+  # Retrieve the latest usage record upload to the system as epoch seconds
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'get_usage_arrival_time_checkpoint test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_usage_stats_for_all_subscriptions
+  # Get all prepaid drawdown usage stats
+  # Retrieve the current prepaid drawdown statistics for all subscriptions for a time range
+  # @param from 
+  # @param to 
+  # @param [Hash] opts the optional parameters
+  # @return [Array<PrepaidStats>]
+  describe 'get_usage_stats_for_all_subscriptions test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_usage_stats_for_all_subscriptions_csv
+  # Get all prepaid drawdown usage stats CSV
+  # Retrieve the current prepaid drawdown statistics for all subscriptions for a time range in CSV format
+  # @param from 
+  # @param to 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'get_usage_stats_for_all_subscriptions_csv test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_usage_stats_for_subscription
+  # Get prepaid drawdown usage stats for subscription
+  # Retrieve the current prepaid drawdown statistics for a subscription
+  # @param subscription_id ID of subscription to retrieve usages stats for
+  # @param [Hash] opts the optional parameters
+  # @return [Array<PrepaidStats>]
+  describe 'get_usage_stats_for_subscription test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_usage_stats_for_subscription_csv
+  # Get prepaid drawdown usage stats CSV
+  # Retrieve the current prepaid drawdown statistics for a subscription in CSV format
+  # @param subscription_id 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'get_usage_stats_for_subscription_csv test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_usage_stats_for_subscription_pdf
+  # Get prepaid drawdown usage stats PDF
+  # Retrieve the current prepaid drawdown statistics for a subscription in PDF format
+  # @param subscription_id 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'get_usage_stats_for_subscription_pdf test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for perform_on_demand_usage_aggregation
+  # Aggregate raw usage
+  # Trigger the process to aggregate any remaining raw usage records
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'perform_on_demand_usage_aggregation test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for upload_subscription_usage_csv
+  # Upload usage record CSV
+  # Upload usage records in CSV file. Each row of the file represents a single usage record
+  # @param [Hash] opts the optional parameters
+  # @option opts [File] :file 
+  # @return [UsageBatchInsertResult]
+  describe 'upload_subscription_usage_csv test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end