subskribe_sandbox 1.0.0

data/spec/api/product_catalog_api_spec.rb

@@ -0,0 +1,448 @@
+=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::ProductCatalogApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'ProductCatalogApi' do
+  before do
+    # run before each test
+    @instance = SubskribeDevClient::ProductCatalogApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of ProductCatalogApi' do
+    it 'should create an instance of ProductCatalogApi' do
+      expect(@instance).to be_instance_of(SubskribeDevClient::ProductCatalogApi)
+    end
+  end
+
+  # unit tests for activate_plan
+  # Activate a plan
+  # Marks a plan as active
+  # @param plan_id id of the plan
+  # @param [Hash] opts the optional parameters
+  # @return [PlanJson]
+  describe 'activate_plan 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_charge
+  # Add charge to plan
+  # Adds a charge to the specified plan.  On success the id of the new charge is returned
+  # @param plan_id id of the plan
+  # @param body json representing the charge details
+  # @param [Hash] opts the optional parameters
+  # @return [ChargeJson]
+  describe 'add_charge 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_percent_of_plan_relationship
+  # Create percent of relationship
+  # Creates a percent of relationship between a charge and plan. On success the id of the relationship is returned.
+  # @param body json representing the relationship
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'add_percent_of_plan_relationship 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_plan
+  # Create a plan
+  # Creates a plan. On success the id of the new plan is returned.
+  # @param body json of the plan details
+  # @param [Hash] opts the optional parameters
+  # @return [PlanJson]
+  describe 'add_plan 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_product
+  # Create a product
+  # Creates a product for your tenant. On success the id of the product is returned.
+  # @param body product details json
+  # @param [Hash] opts the optional parameters
+  # @return [ProductJson]
+  describe 'add_product 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_product_category
+  # Create a product category
+  # Creates a product category. On success the id of the category is returned.
+  # @param body product category details json
+  # @param [Hash] opts the optional parameters
+  # @return [ProductCategory]
+  describe 'add_product_category 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 deactivate_plan
+  # Revert a plan to draft
+  # Marks a plan as draft
+  # @param plan_id id of the plan
+  # @param [Hash] opts the optional parameters
+  # @return [PlanJson]
+  describe 'deactivate_plan 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_catalog_relationship_by_id
+  # Delete a catalog relationship
+  # Deletes the specified catalog relationship
+  # @param relationship_id id of the relationship
+  # @param [Hash] opts the optional parameters
+  # @return [CatalogRelationship]
+  describe 'delete_catalog_relationship_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 delete_charge
+  # Delete a charge
+  # Removes a charge from a plan.
+  # @param plan_id id of the plan
+  # @param charge_id id of the charge
+  # @param [Hash] opts the optional parameters
+  # @return [ChargeJson]
+  describe 'delete_charge 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_plan
+  # Delete a plan
+  # Deletes a plan. Note you can't delete a plan that's in use.
+  # @param plan_id id of the plan
+  # @param [Hash] opts the optional parameters
+  # @return [PlanJson]
+  describe 'delete_plan 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_product
+  # Delete a product
+  # Delete the specified product.
+  # @param id id of the product
+  # @param [Hash] opts the optional parameters
+  # @return [ProductJson]
+  describe 'delete_product 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_product_category
+  # Delete a product category
+  # Deletes the specified product category. Note that a product category can't be delete once it's in use.
+  # @param id id of the category
+  # @param [Hash] opts the optional parameters
+  # @return [ProductCategory]
+  describe 'delete_product_category 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 deprecate_plan
+  # Deprecate a plan
+  # Marks a plan as deprecated. Once deprecated a plan may not be attached to new orders.
+  # @param plan_id id of the plan
+  # @param [Hash] opts the optional parameters
+  # @return [PlanJson]
+  describe 'deprecate_plan 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 duplicate_plan
+  # Duplicate a plan
+  # Duplicates the specified plan. On success the new plan id is returned.
+  # @param plan_id id of the plan to duplicate
+  # @param [Hash] opts the optional parameters
+  # @return [PlanJson]
+  describe 'duplicate_plan 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 export_product_catalog
+  # Export product catalog
+  # Export the product catalog in CSV format.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'export_product_catalog 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_catalog_relationship_by_id
+  # Get relationship details
+  # Gets the details of the specified catalog relationship.
+  # @param relationship_id id of the relationship
+  # @param [Hash] opts the optional parameters
+  # @return [CatalogRelationship]
+  describe 'get_catalog_relationship_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_charge
+  # Get charge details
+  # Gets the details of the specified charge on the specified plan.
+  # @param plan_id id of the plan
+  # @param charge_id id of the charge
+  # @param [Hash] opts the optional parameters
+  # @return [ChargeJson]
+  describe 'get_charge 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_charge_ledger_accounts
+  # Get ledger accounts
+  # Gets the ledger accounts mapped to the specified charge
+  # @param plan_id id of the plan
+  # @param charge_id id of the charge
+  # @param [Hash] opts the optional parameters
+  # @return [Array<LedgerAccount>]
+  describe 'get_charge_ledger_accounts 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_percent_of_relationships
+  # Get percent of relationships for a plan
+  # Gets the percent of relationships for the specified plan.
+  # @param from_plan_id id of the plan
+  # @param [Hash] opts the optional parameters
+  # @return [Array<CatalogRelationship>]
+  describe 'get_percent_of_relationships 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_plan
+  # Get plan details
+  # Returns the details of the specified plan.
+  # @param plan_id id of the plan
+  # @param [Hash] opts the optional parameters
+  # @return [PlanJson]
+  describe 'get_plan 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_plans
+  # Get plans
+  # Returns all plans for a product. The result is paginated. To retrieve all results pass the cursor returned from a call to the next call until all results are returned.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :product_id id of the product
+  # @option opts [String] :status filter by plan status
+  # @option opts [String] :cursor cursor from the last call
+  # @option opts [Integer] :limit number of results per page
+  # @return [PlanJsonPaginationResponse]
+  describe 'get_plans 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_product
+  # Get product details.
+  # Gets the details of the specified product.
+  # @param id id of the product
+  # @param [Hash] opts the optional parameters
+  # @return [ProductJson]
+  describe 'get_product 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_product_categories
+  # Get product Categories
+  # Gets all product categories for your tenant. The results are paginated. To fetch all results pass the cursor returned from a call to the subsequent calls until all results are returned. Initially the cursor should not be specified.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :cursor cursor from prior call
+  # @option opts [Integer] :limit number of results per page
+  # @return [ProductCategoryPaginationResponse]
+  describe 'get_product_categories 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_product_category
+  # Get product category details
+  # Gets the details of the specified product category
+  # @param id id of the category
+  # @param [Hash] opts the optional parameters
+  # @return [ProductCategory]
+  describe 'get_product_category 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_products
+  # Get products
+  # Returns all products for your tenant. The results on paginated. To fetch them all pass the cursor returned from a call to the subsequent call until all results are fetched. Initially the cursor should not be specified.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :cursor cursor received from prior call
+  # @option opts [Integer] :limit number of results per page
+  # @return [ProductJsonPaginationResponse]
+  describe 'get_products 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_target_plans_for_percent_of_plan_id
+  # Get percent of target plans
+  # Gets the list of percent of charge target plans.
+  # @param plan_id 
+  # @param [Hash] opts the optional parameters
+  # @return [CatalogRelationship]
+  describe 'get_target_plans_for_percent_of_plan_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 map_ledger_accounts_to_charge
+  # Map ledger accounts
+  # Map ledger accounts to the specified charge for the specified plan.
+  # @param plan_id id of the plan
+  # @param charge_id id of the charge
+  # @param body list of the ledger account ids
+  # @param [Hash] opts the optional parameters
+  # @return [Array<LedgerAccount>]
+  describe 'map_ledger_accounts_to_charge 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 patch_charge
+  # Update non-financial charge details
+  # Updates certain details of the specified charge which won&#39;t impact its financial treatment
+  # @param plan_id id of the plan
+  # @param charge_id id of the charge
+  # @param [Hash] opts the optional parameters
+  # @option opts [ChargePartialJson] :body 
+  # @return [ChargeJson]
+  describe 'patch_charge 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 reactivate_plan
+  # Reactivate a plan
+  # Reactivates a deprecated plan.
+  # @param plan_id id of the plan
+  # @param [Hash] opts the optional parameters
+  # @return [PlanJson]
+  describe 'reactivate_plan 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_charge
+  # Update charge details
+  # Updates the details of the specified charge on the specified plan.
+  # @param plan_id id of the plan associated with the charge
+  # @param charge_id id of the charge
+  # @param [Hash] opts the optional parameters
+  # @option opts [ChargeJson] :body 
+  # @return [nil]
+  describe 'update_charge 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_plan
+  # Update plan
+  # Updates the details of the specified plan. Note you can&#39;t update the details of a plan once it&#39;s in use.
+  # @param plan_id id of the plan
+  # @param body json of the plan details
+  # @param [Hash] opts the optional parameters
+  # @return [PlanJson]
+  describe 'update_plan 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_product
+  # Update product details
+  # Updates the details of the specified product
+  # @param id id of the product
+  # @param body product details json
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'update_product 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_product_category
+  # Update product category details
+  # Updates the details of a product category
+  # @param id id of the category
+  # @param body product category details json
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'update_product_category 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/rate_card_api_spec.rb

@@ -0,0 +1,46 @@
+=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::RateCardApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'RateCardApi' do
+  before do
+    # run before each test
+    @instance = SubskribeDevClient::RateCardApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of RateCardApi' do
+    it 'should create an instance of RateCardApi' do
+      expect(@instance).to be_instance_of(SubskribeDevClient::RateCardApi)
+    end
+  end
+
+  # unit tests for get_price_attributes_csv
+  # Fetch the price attributes defined in the system in CSV format
+  # Get all the price attributes in the system in CSV format one per row
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'get_price_attributes_csv 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/refunds_api_spec.rb

@@ -0,0 +1,73 @@
+=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::RefundsApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'RefundsApi' do
+  before do
+    # run before each test
+    @instance = SubskribeDevClient::RefundsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of RefundsApi' do
+    it 'should create an instance of RefundsApi' do
+      expect(@instance).to be_instance_of(SubskribeDevClient::RefundsApi)
+    end
+  end
+
+  # unit tests for create_and_apply_refund
+  # Create and apply refund
+  # Creates and applies a refund per the specified parameters. On success the id of the refund is returned.
+  # @param body refund request details json
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'create_and_apply_refund 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_refund_by_id
+  # Get refund details
+  # Get the details of the specified refund.
+  # @param account_id id of the account
+  # @param id id of the refund
+  # @param [Hash] opts the optional parameters
+  # @return [Refund]
+  describe 'get_refund_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_refunds
+  # Get refunds
+  # Get all refunds for the specified account, OR if a credit memo number is specified in addition to the account id, get the details of only that.
+  # @param account_id id of the account
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :credit_memo_number id of a credit memo
+  # @return [Array<RefundDetail>]
+  describe 'get_refunds 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/reports_api_spec.rb

@@ -0,0 +1,82 @@
+=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::ReportsApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'ReportsApi' do
+  before do
+    # run before each test
+    @instance = SubskribeDevClient::ReportsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of ReportsApi' do
+    it 'should create an instance of ReportsApi' do
+      expect(@instance).to be_instance_of(SubskribeDevClient::ReportsApi)
+    end
+  end
+
+  # unit tests for generate
+  # Generate a report
+  # Generates a report with the specified parameters. This report can later be downloaded via /reports/{reportRunId}/result
+  # @param body json definition of the report
+  # @param [Hash] opts the optional parameters
+  # @return [ReportJobResponse]
+  describe 'generate 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_predefined_report_defs
+  # Get report definitions
+  # Returns the definitions of the reports defined for your tenant.
+  # @param [Hash] opts the optional parameters
+  # @return [PredefinedReportDefsJson]
+  describe 'get_predefined_report_defs 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_report_output
+  # Run a generated report
+  # Runs a report generated with /generate. On success a csv of the report is returned.
+  # @param report_run_id id of the report
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'get_report_output 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 run
+  # Run a report
+  # Runs the specified report and returns the result as a csv.
+  # @param body definition of the report in json
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'run test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end