subskribe_dev 1.0.0 → 1.2.0

data/spec/api/custom_field_api_spec.rb

@@ -0,0 +1,126 @@
+=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::CustomFieldApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'CustomFieldApi' do
+  before do
+    # run before each test
+    @instance = SubskribeDevClient::CustomFieldApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of CustomFieldApi' do
+    it 'should create an instance of CustomFieldApi' do
+      expect(@instance).to be_instance_of(SubskribeDevClient::CustomFieldApi)
+    end
+  end
+
+  # unit tests for create_custom_field_definition
+  # Create a custom field definition
+  # Creates a new custom field definition for your tenant. On success the id of the custom field definition is returned.
+  # @param body custom field definition values
+  # @param [Hash] opts the optional parameters
+  # @return [String]
+  describe 'create_custom_field_definition 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_custom_field_definition
+  # Delete a custom field definition
+  # Deletes an existing custom field definition for your tenant. On success the deleted custom field definition object is returned.
+  # @param id object type custom fields are attached to
+  # @param [Hash] opts the optional parameters
+  # @return [CustomFieldDefinitionJson]
+  describe 'delete_custom_field_definition 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_custom_field_definitions
+  # Get custom field definitions
+  # Returns all custom field definitions for a specific parent object type
+  # @param parent_object_type object type custom fields are attached to
+  # @param [Hash] opts the optional parameters
+  # @return [Array<CustomFieldDefinitionJson>]
+  describe 'get_custom_field_definitions 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_custom_fields
+  # Get custom fields by type and parent object id
+  # Returns all custom fields for a specific parent object type and id
+  # @param parent_object_type object type custom fields are attached to
+  # @param parent_object_id Id of the parent object
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'get_custom_fields 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_custom_field
+  # Update an existing set of custom fields
+  # Updates an existing set of custom fields for a given parent object type and id. On success the update custom fields are returned.
+  # @param parent_object_type object type custom fields are attached to
+  # @param parent_object_id Id of the parent object
+  # @param custom_field_name Name of the custom field to be updated
+  # @param body custom field value
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'update_custom_field 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_custom_field_definition
+  # Update an existing custom field definition
+  # Updates an existing custom field definition for your tenant. On success the update custom field definition is returned.
+  # @param id 
+  # @param body custom field definition values
+  # @param [Hash] opts the optional parameters
+  # @return [CustomFieldDefinitionJson]
+  describe 'update_custom_field_definition 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_custom_fields
+  # Update an existing set of custom fields
+  # Updates an existing set of custom fields for a given parent object type and id. On success the update custom fields are returned.
+  # @param parent_object_type object type custom fields are attached to
+  # @param parent_object_id Id of the parent object
+  # @param body custom field values
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'update_custom_fields 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/customization_api_spec.rb

@@ -0,0 +1,89 @@
+=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::CustomizationApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'CustomizationApi' do
+  before do
+    # run before each test
+    @instance = SubskribeDevClient::CustomizationApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of CustomizationApi' do
+    it 'should create an instance of CustomizationApi' do
+      expect(@instance).to be_instance_of(SubskribeDevClient::CustomizationApi)
+    end
+  end
+
+  # unit tests for compile_order_creation_customization_zeppa_script
+  # Compile and Verify a order creation customization for correctness
+  # if this endpoint returns OK it means the plan order customization zeppa script has successfully compiled
+  # @param order_id order id against which the compilation should happen
+  # @param body the zeppa script that needs to be compiled
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :user_id order id against which the compilation should happen
+  # @return [nil]
+  describe 'compile_order_creation_customization_zeppa_script 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 compile_plan_selection_customization_zeppa_script
+  # Compile and Verify a plan selection customization for correctness
+  # if this endpoint returns OK it means the plan selection customization zeppa script has successfully compiled
+  # @param account_id account id against which the compilation should happen
+  # @param body the zeppa script that needs to be compiled
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'compile_plan_selection_customization_zeppa_script 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 test_order_creation_customization_zeppa_script
+  # Test a order creation customization zeppa script
+  # runs the provided zeppa script and returns a list of Rule actions that were applicable after zeppa script ran
+  # @param order_id order id against which the test needs to happen
+  # @param body the zeppa script that needs to be tested
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :user_id the user id against which this test needs to happen, the user should be part of the tenancy
+  # @return [nil]
+  describe 'test_order_creation_customization_zeppa_script 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 test_plan_selection_customization_zeppa_script
+  # Test a plan selection customization zeppa script
+  # runs the provided zeppa script and returns a list of Rule actions that were applicable after zeppa script ran
+  # @param account_id account id against which the test needs to happen
+  # @param body the zeppa script that needs to be tested
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'test_plan_selection_customization_zeppa_script 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/default_api_spec.rb

@@ -0,0 +1,81 @@
+=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::DefaultApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'DefaultApi' do
+  before do
+    # run before each test
+    @instance = SubskribeDevClient::DefaultApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of DefaultApi' do
+    it 'should create an instance of DefaultApi' do
+      expect(@instance).to be_instance_of(SubskribeDevClient::DefaultApi)
+    end
+  end
+
+  # unit tests for add_and_apply_payment
+  # Apply a payment on a specific invoice
+  # Apply a payment per the specified parameters.
+  # @param body add and apply payment parameters in json
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'add_and_apply_payment 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_order_document
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'get_order_document 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 validate_address
+  # Validate an address with Anrok
+  # 
+  # @param [Hash] opts the optional parameters
+  # @option opts [AccountAddress] :body Address input as a JSON
+  # @return [AccountAddress]
+  describe 'validate_address 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 validate_address1
+  # Validate an address with TaxJar
+  # Returns a suggested addresses if found
+  # @param [Hash] opts the optional parameters
+  # @option opts [AccountAddress] :body Address input as a JSON
+  # @return [AccountAddress]
+  describe 'validate_address1 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/discounts_api_spec.rb

@@ -0,0 +1,108 @@
+=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::DiscountsApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'DiscountsApi' do
+  before do
+    # run before each test
+    @instance = SubskribeDevClient::DiscountsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of DiscountsApi' do
+    it 'should create an instance of DiscountsApi' do
+      expect(@instance).to be_instance_of(SubskribeDevClient::DiscountsApi)
+    end
+  end
+
+  # unit tests for add_discount
+  # Create a discount
+  # Creates a discount with the specified details. On success, the ID of the new discount is returned.
+  # @param [Hash] opts the optional parameters
+  # @option opts [DiscountJson] :body details of the discount
+  # @return [String]
+  describe 'add_discount 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_discount
+  # Delete a discount
+  # Deletes a discount. Note that a discount may not be deleted if it is in use.
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_discount 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_discount
+  # Get discount
+  # Returns the details of the specified discount.
+  # @param id id of the discount
+  # @param [Hash] opts the optional parameters
+  # @return [DiscountJson]
+  describe 'get_discount 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_discounts
+  # Get discounts
+  # Returns all discounts that have been defined
+  # @param [Hash] opts the optional parameters
+  # @return [Array<DiscountJson>]
+  describe 'get_discounts 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_discount
+  # Update discount details
+  # Updates the details of the specified discount. Note that a discount cannot be updated once it is in use by an order.
+  # @param id id of the discount
+  # @param [Hash] opts the optional parameters
+  # @option opts [DiscountJson] :body 
+  # @return [nil]
+  describe 'update_discount 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_discount_status
+  # Update discount status
+  # Updates the status of a discount
+  # @param id id of the discount
+  # @param status new status to set
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'update_discount_status 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/entities_api_spec.rb

@@ -0,0 +1,120 @@
+=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::EntitiesApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'EntitiesApi' do
+  before do
+    # run before each test
+    @instance = SubskribeDevClient::EntitiesApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of EntitiesApi' do
+    it 'should create an instance of EntitiesApi' do
+      expect(@instance).to be_instance_of(SubskribeDevClient::EntitiesApi)
+    end
+  end
+
+  # unit tests for create
+  # Create an entity
+  # Create an entity. On success return the created entity.
+  # @param [Hash] opts the optional parameters
+  # @option opts [EntityJson] :body entity
+  # @return [nil]
+  describe 'create 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_entity
+  # Delete entity
+  # Delete the entity if there is no data associated with it.
+  # @param id entity id
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_entity 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_entities
+  # Gets entities
+  # Gets all entities
+  # @param [Hash] opts the optional parameters
+  # @return [Array<EntityJson>]
+  describe 'get_entities 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_entity_by_id
+  # Gets entity details
+  # Gets the entity details of the specified entity id
+  # @param id entity id
+  # @param [Hash] opts the optional parameters
+  # @return [Entity]
+  describe 'get_entity_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_logo
+  # Get entity logo
+  # Get the current logo stored for the given entity
+  # @param entity_id 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'get_logo 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 order_entity_migration
+  # Update order entity
+  # Move order to a target entity
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :target_entity_id 
+  # @option opts [String] :order_id 
+  # @return [nil]
+  describe 'order_entity_migration 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_entity_migration
+  # Move subscription to a target entity
+  # Move subscription and associated transactions to a target entity
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :target_entity_id 
+  # @option opts [String] :subscription_id 
+  # @return [nil]
+  describe 'subscription_entity_migration 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/entity_api_spec.rb

@@ -0,0 +1,48 @@
+=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::EntityApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'EntityApi' do
+  before do
+    # run before each test
+    @instance = SubskribeDevClient::EntityApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of EntityApi' do
+    it 'should create an instance of EntityApi' do
+      expect(@instance).to be_instance_of(SubskribeDevClient::EntityApi)
+    end
+  end
+
+  # unit tests for upload_logo
+  # Update entity logo
+  # Updates the logo used in external facing communication such as order forms and invoices
+  # @param entity_id 
+  # @param [Hash] opts the optional parameters
+  # @option opts [File] :file 
+  # @return [nil]
+  describe 'upload_logo 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/erp_api_spec.rb

@@ -0,0 +1,95 @@
+=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::ERPApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'ERPApi' do
+  before do
+    # run before each test
+    @instance = SubskribeDevClient::ERPApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of ERPApi' do
+    it 'should create an instance of ERPApi' do
+      expect(@instance).to be_instance_of(SubskribeDevClient::ERPApi)
+    end
+  end
+
+  # unit tests for process_delete_tasks
+  # API to trigger ERP journal entry deletion task for accounting period
+  # 
+  # @param accounting_period_id 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'process_delete_tasks 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 process_sync_tasks
+  # API to trigger ERP journal entry sync task for accounting period
+  # 
+  # @param accounting_period_id 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'process_sync_tasks 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 sync_credit_memo_to_erp
+  # API to trigger ERP journal entry deletion task for accounting period
+  # 
+  # @param credit_memo_number 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'sync_credit_memo_to_erp 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 sync_invoice_to_erp
+  # API to trigger ERP journal entry deletion task for accounting period
+  # 
+  # @param invoice_id 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'sync_invoice_to_erp 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 sync_void_invoice_to_erp
+  # API to trigger ERP journal entry deletion task for accounting period
+  # 
+  # @param invoice_number 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'sync_void_invoice_to_erp test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end