subskribe_dev 1.0.0 → 1.2.0

data/spec/api/import_api_spec.rb

@@ -0,0 +1,164 @@
+=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::ImportApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'ImportApi' do
+  before do
+    # run before each test
+    @instance = SubskribeDevClient::ImportApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of ImportApi' do
+    it 'should create an instance of ImportApi' do
+      expect(@instance).to be_instance_of(SubskribeDevClient::ImportApi)
+    end
+  end
+
+  # unit tests for create_flatfile_workbook
+  # Create a Flatfile workbook
+  # Creates a Flatfile workbook and adds it to a space
+  # @param domain the domain to import
+  # @param [Hash] opts the optional parameters
+  # @return [FlatfileWorkbookResponse]
+  describe 'create_flatfile_workbook 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_account_contacts_in_import_format
+  # Get account contacts for export
+  # Gets account contacts in a format appropriate for re-import. On success, the output is a csv containing the account and contacts.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'get_account_contacts_in_import_format 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_amendment_order_export_in_import_format
+  # Get amendment orders in import CSV format
+  # Gets amendment orders in a format appropriate for re-import for the given generation. On success, the output is a csv containing the orders.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :generation the generation of amendments to include in the export, generations are defined as 1 based index of number of amendments applied to subscription
+  # @option opts [BOOLEAN] :use_real_ids use the subskribe ID instead of external ID for exported objects
+  # @return [nil]
+  describe 'get_amendment_order_export_in_import_format 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_available_schemas
+  # Return available schemas
+  # Returns the set of schemas available for import
+  # @param [Hash] opts the optional parameters
+  # @return [Hash<String, Array<Object>>]
+  describe 'get_available_schemas 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_data_in_import_format
+  # Get catalog data for export
+  # Gets catalog data in a format appropriate for re-import. On success, the output is a csv containing the catalog data containing Product, Plan and Charge data.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'get_catalog_data_in_import_format 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_data_import_by_id
+  # Gets an import item
+  # Gets an item that was imported by its ID
+  # @param import_id id of the item
+  # @param [Hash] opts the optional parameters
+  # @return [DataImport]
+  describe 'get_data_import_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_data_imports
+  # Gets all import items
+  # Gets all items that was imported
+  # @param [Hash] opts the optional parameters
+  # @return [DataImport]
+  describe 'get_data_imports 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_import_result1
+  # Get import details
+  # Returns the details of an import by its ID
+  # @param import_id 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'get_import_result1 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_new_order_export_in_import_format
+  # Get new orders in import CSV format
+  # Gets new orders in a format appropriate for re-import. On success, the output is a csv containing the orders.
+  # @param [Hash] opts the optional parameters
+  # @option opts [BOOLEAN] :use_real_ids use the subskribe ID instead of external ID for exported objects
+  # @return [nil]
+  describe 'get_new_order_export_in_import_format 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_import
+  # Process an import by ID
+  # Processes the import specified.
+  # @param import_id 
+  # @param [Hash] opts the optional parameters
+  # @return [DataImport]
+  describe 'process_import 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_multi_part_file_import
+  # Validate import file
+  # Validates a multi-part import file. Returns an import ID on success.
+  # @param [Hash] opts the optional parameters
+  # @option opts [File] :file 
+  # @return [String]
+  describe 'validate_multi_part_file_import 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/integrations_api_spec.rb

@@ -0,0 +1,420 @@
+=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::IntegrationsApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'IntegrationsApi' do
+  before do
+    # run before each test
+    @instance = SubskribeDevClient::IntegrationsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of IntegrationsApi' do
+    it 'should create an instance of IntegrationsApi' do
+      expect(@instance).to be_instance_of(SubskribeDevClient::IntegrationsApi)
+    end
+  end
+
+  # unit tests for add_integration
+  # Add a Anrok integration
+  # Returns the integration ID if successful
+  # @param [Hash] opts the optional parameters
+  # @option opts [AnrokIntegrationInput] :body Integration input as a JSON
+  # @return [nil]
+  describe 'add_integration 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_integration1
+  # Add a TaxJar integration
+  # Returns the integration ID if successful
+  # @param [Hash] opts the optional parameters
+  # @option opts [TaxJarIntegrationInput] :body Integration input as a JSON
+  # @return [nil]
+  describe 'add_integration1 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 authorization_code_callback
+  # Handle HubSpot authorization code
+  # Endpoint to handle and process a HubSpot authorization code
+  # @param code authorization code
+  # @param state HubSpot integration id
+  # @param redirect_uri uri to redirect to HubSpot
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'authorization_code_callback 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 authorization_code_callback1
+  # Callback for the authorization code
+  # Handles the authorization code callback from Salesforce
+  # @param code authorization code
+  # @param state id of the integration
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :redirect_uri uri to redirect to
+  # @return [nil]
+  describe 'authorization_code_callback1 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 complete_integration
+  # Complete Docusign integration
+  # Complete the docusign integration. This should be called after the integration has been created and an authorization code has been received from Docusign.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :code authorization code received from Docusign
+  # @option opts [String] :state id of the integration
+  # @return [DocuSignIntegrationResponseJson]
+  describe 'complete_integration 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_integration
+  # Delete Docusign integration
+  # Removes integration with Docusign from your tenant
+  # @param [Hash] opts the optional parameters
+  # @return [DocuSignIntegrationResponseJson]
+  describe 'delete_integration 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_integration1
+  # Delete HubSpot Integration
+  # Deletes your integration with HubSpot.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_integration1 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_integration2
+  # Delete Salesforce integration
+  # Removes the Salesforce integration for the tenant.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_integration2 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_account_by_id
+  # Get Salesforce account
+  # Gets a Salesforce account by its id.
+  # @param id id of the account
+  # @param [Hash] opts the optional parameters
+  # @return [SalesforceAccount]
+  describe 'get_account_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_accounts_by_name
+  # Get Salesforce accounts
+  # Returns Salesforce accounts matching the specified name.
+  # @param name account name
+  # @param [Hash] opts the optional parameters
+  # @return [Array<SalesforceAccount>]
+  describe 'get_accounts_by_name 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_integration
+  # Get integration details
+  # Gets the integration details of the specified integration id
+  # @param integration_id integration id
+  # @param [Hash] opts the optional parameters
+  # @return [Integration]
+  describe 'get_integration 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_integration1
+  # Gets Avalara integration details
+  # Gets the integration details of the specified integration id
+  # @param integration_id integration id
+  # @param [Hash] opts the optional parameters
+  # @return [AvalaraIntegration]
+  describe 'get_integration1 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_integration2
+  # Get integration details
+  # Gets the integration details of the specified integration id
+  # @param integration_id integration id
+  # @param [Hash] opts the optional parameters
+  # @return [TaxJarIntegration]
+  describe 'get_integration2 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_integration_by_tenant
+  # Gets Avalara integration details
+  # Returns the details of the Avalara integration for your tenant
+  # @param [Hash] opts the optional parameters
+  # @return [AvalaraIntegration]
+  describe 'get_integration_by_tenant 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_opportunities_by_account_id
+  # Get Salesforce opportunities
+  # Returns the Salesforce opportunities associated withe the specified account.
+  # @param account_id id of the account
+  # @param [Hash] opts the optional parameters
+  # @return [Array<Opportunity>]
+  describe 'get_opportunities_by_account_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 import_account
+  # Import account from Salesforce
+  # Imports an account from Salesforce. On success a redirect uri is returned.
+  # @param body json representation of the account
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'import_account 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 initiate_integration
+  # Create Docusign integration
+  # Creates an integration with Docusign. On success a redirect URL is returned.
+  # @param [Hash] opts the optional parameters
+  # @option opts [DocuSignIntegrationRequestJson] :body details of the integration
+  # @return [nil]
+  describe 'initiate_integration 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 initiate_integration1
+  # Initiate a HubSpot integration
+  # Initiates an integration with HubSpot. On success redirect URL is returned.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :email admin email
+  # @return [String]
+  describe 'initiate_integration1 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 initiate_integration2
+  # Initiate integration with Salesforce
+  # Initiate a Salesforce integration. On success a redirect url is returned.
+  # @param [Hash] opts the optional parameters
+  # @option opts [SalesforceClientIntegrationRequestJson] :body 
+  # @return [nil]
+  describe 'initiate_integration2 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 integrate
+  # Create an Avalara integration
+  # Creates an integration with Avalara according to the specified details. On success the id of the integration is returned
+  # @param [Hash] opts the optional parameters
+  # @option opts [AvalaraIntegrationInput] :body json representing the integration
+  # @return [nil]
+  describe 'integrate 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 ping
+  # Pings Avalara
+  # Once an integration is set up Avalara can be pinged to ensure it is working correctly. On success \&quot;PONG\&quot; is returned.
+  # @param [Hash] opts the optional parameters
+  # @option opts [AvalaraIntegrationInput] :body 
+  # @return [nil]
+  describe 'ping 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 setup_hub_spot
+  # Add custom properties to HubSpot
+  # Add custom properties to HubSpot
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'setup_hub_spot 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_account_to_salesforce
+  # Sync an account to Salesforce
+  # Syncs the account ARR and its orders to Salesforce.
+  # @param id account id to sync
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'sync_account_to_salesforce 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_deleted_orders_to_salesforce
+  # Sync orders to Salesforce
+  # Syncs the specified order to Salesforce.
+  # @param ids opportunityIds
+  # @param [Hash] opts the optional parameters
+  # @return [OrderJson]
+  describe 'sync_deleted_orders_to_salesforce 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_esign_details_for_order_to_hub_spot
+  # Sync esign details for order id
+  # 
+  # @param order_id 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'sync_esign_details_for_order_to_hub_spot 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_order_to_salesforce
+  # Sync order to Salesforce
+  # Syncs the specified order to Salesforce.
+  # @param id order id
+  # @param [Hash] opts the optional parameters
+  # @return [OrderJson]
+  describe 'sync_order_to_salesforce 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_orders_to_salesforce
+  # Sync orders to Salesforce
+  # Syncs the specified order to Salesforce.
+  # @param ids order ids
+  # @param [Hash] opts the optional parameters
+  # @return [OrderJson]
+  describe 'sync_orders_to_salesforce 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_tenant_to_salesforce
+  # Sync whole tenant to Salesforce in a paginated fashion
+  # Syncs the specified tenant to Salesforce. Returns paginated JSON of accounts which were synced
+  # @param tenant_id 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :cursor 
+  # @option opts [Integer] :limit 
+  # @return [nil]
+  describe 'sync_tenant_to_salesforce 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_integration
+  # Test an integration is valid
+  # 
+  # @param [Hash] opts the optional parameters
+  # @option opts [AnrokIntegrationInput] :body Integration input as a JSON
+  # @return [String]
+  describe 'test_integration 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_integration1
+  # Test an integration is valid
+  # 
+  # @param [Hash] opts the optional parameters
+  # @option opts [TaxJarIntegrationInput] :body Integration input as a JSON
+  # @return [String]
+  describe 'test_integration1 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_primary_order_id_for_opportunity
+  # Make an order primary
+  # Marks an order as the primary order for its opportunity.
+  # @param id order id
+  # @param [Hash] opts the optional parameters
+  # @return [OrderJson]
+  describe 'update_primary_order_id_for_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 verify_setup
+  # Verify HubSpot setup
+  # Verify custom objects and properties
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'verify_setup 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/metrics_reporting_api_spec.rb

@@ -0,0 +1,84 @@
+=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::MetricsReportingApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'MetricsReportingApi' do
+  before do
+    # run before each test
+    @instance = SubskribeDevClient::MetricsReportingApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of MetricsReportingApi' do
+    it 'should create an instance of MetricsReportingApi' do
+      expect(@instance).to be_instance_of(SubskribeDevClient::MetricsReportingApi)
+    end
+  end
+
+  # unit tests for add_external_arr_metrics
+  # submit request to generate external arr metrics
+  # returns the request with its captured id. Arr metrics will be generated as a backend job
+  # @param [Hash] opts the optional parameters
+  # @option opts [ExternalArrScheduleJson] :body 
+  # @return [nil]
+  describe 'add_external_arr_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_external_arr_metrics
+  # gets external arr metrics request for the provided id
+  # returns the external arr metrics request for the provided id
+  # @param id id of the externalArrMetrics request
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'get_external_arr_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_external_arr_metrics1
+  # gets external arr metrics requests submitted
+  # returns the paginated list of external arr metrics requests
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :cursor 
+  # @option opts [Integer] :limit 
+  # @return [nil]
+  describe 'get_external_arr_metrics1 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 populate_arr_metrics_for_subscription
+  # submit request to generate/regenerate arr metrics for a subscription
+  # returns 200 if the result is successfully submitted to a background task
+  # @param subscription_id id of the subscription
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'populate_arr_metrics_for_subscription test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end