subskribe_dev2 1.3.2

data/spec/api/orders_api_spec.rb

@@ -0,0 +1,351 @@
+=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::OrdersApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'OrdersApi' do
+  before do
+    # run before each test
+    @instance = SubskribeDevClient::OrdersApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of OrdersApi' do
+    it 'should create an instance of OrdersApi' do
+      expect(@instance).to be_instance_of(SubskribeDevClient::OrdersApi)
+    end
+  end
+
+  # unit tests for add_document_template
+  # Add new predefined terms
+  # Add a new predefined terms that can be attached to an order as part of PDF document generation.
+  # @param [Hash] opts the optional parameters
+  # @option opts [DocumentTemplateJson] :body 
+  # @return [String]
+  describe 'add_document_template 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_order
+  # Create an order
+  # creates an order with the specified parameters. On success the order id is returned.
+  # @param body json representing the order details
+  # @param [Hash] opts the optional parameters
+  # @option opts [BOOLEAN] :is_dry_run indicates whether this order should be persisted
+  # @option opts [BOOLEAN] :populate_missing_lines indicates whether an amendment should populate missing lines not provided here
+  # @return [OrderJson]
+  describe 'add_order 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_composite_order_document
+  # Generate a composite order PDF
+  # Generates a composite order form PDF. When completed this document can be downloaded via a get to /{id}/pdf.
+  # @param id id of the composite order
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'create_composite_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 create_order_document
+  # Generate an order PDF
+  # Generates an order form PDF. When completed this document can be downloaded via a get to /{id}/pdf.
+  # @param id id of the order
+  # @param [Hash] opts the optional parameters
+  # @option opts [BOOLEAN] :force force regeneration of the PDF document even if there has been no changes. Defaults to false
+  # @return [nil]
+  describe 'create_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 delete_document_template
+  # Delete predefined terms
+  # Deletes the predefined terms specified.
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @return [DocumentTemplateJson]
+  describe 'delete_document_template 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_order
+  # Delete an order
+  # Deletes the specified order
+  # @param id id of the order
+  # @param [Hash] opts the optional parameters
+  # @return [OrderJson]
+  describe 'delete_order 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 execute_order
+  # Mark order as executed
+  # Marks the specified order as executed
+  # @param id id of the order
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :executed_on Order execution time
+  # @return [OrderJson]
+  describe 'execute_order 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 force_execute_order
+  # Mark order as executed
+  # Marks the specified order as executed
+  # @param id id of the order
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :executed_on Order execution time
+  # @option opts [BOOLEAN] :skip_approval_check Skip approval check for imported orders. Defaults to false
+  # @return [OrderJson]
+  describe 'force_execute_order 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_composite_order_document
+  # Fetch composite order form PDF
+  # Downloads the order form PDF for the specified order. This PDF must have been generated via a POST to /{id}/pdf. The response is the PDF document.
+  # @param id id of the order
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'get_composite_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 get_document_template
+  # Get predefined terms detail
+  # Returns a specific predefined terms by Id.
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @return [DocumentTemplateJson]
+  describe 'get_document_template 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_document_templates
+  # Get predefined terms
+  # Returns predefined terms by type. These templates can be attached to orders as part of PDF document generation.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :type 
+  # @return [DocumentTemplateJson]
+  describe 'get_document_templates 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
+  # Return all opportunities
+  # Returns all opportunities associated with the specified account. The results are paginated. To fetch all results, pass the cursor returned from a call to subsequent calls.
+  # @param account_id id of account
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :cursor pass the cursor returned from a call to to subsequent calls until all values are fetched
+  # @option opts [Integer] :limit number of results per page
+  # @option opts [String] :crm_id CRM ID of the opportunity
+  # @return [OpportunityPaginationResponse]
+  describe 'get_opportunities 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_opportunity_by_crm_opportunity_id
+  # Return details of an opportunity
+  # Returns the details of a specified opportunity
+  # @param id id of the opportunity
+  # @param [Hash] opts the optional parameters
+  # @return [OpportunityJson]
+  describe 'get_opportunity_by_crm_opportunity_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_order
+  # Get order details
+  # Get the details of the specified order
+  # @param id order id
+  # @param [Hash] opts the optional parameters
+  # @return [OrderJson]
+  describe 'get_order 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_document1
+  # Fetch order form PDF
+  # Downloads the order form PDF for the specified order. This PDF must have been generated via a POST to /{id}/pdf. The response is the PDF document.
+  # @param id id of the order
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'get_order_document1 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_doc
+  # Download word doc version of order form
+  # Download the order form as a Microsoft Word document. This document must have been generated via a POST to /{id}/pdf. The response is the Word Document.
+  # @param id id of the document
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'get_order_document_doc 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_line_metrics
+  # Get order line metrics
+  # Returns the metrics associated with an order's line items. This includes ARR, TCV, etc.
+  # @param id id of the order
+  # @param [Hash] opts the optional parameters
+  # @return [Hash<String, MetricsJson>]
+  describe 'get_order_line_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_order_metrics
+  # Get order metrics
+  # Returns the metrics associated with an order. This includes ARR, TCV, etc.
+  # @param id id of the order
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :target_date date to generate metrics as of. Defaults to now.
+  # @return [MetricsJson]
+  describe 'get_order_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_orders
+  # Get all Orders
+  # Gets all orders for your tenant. The results are paginated. To fetch all results, take the cursor returned from a call and pass it to subsequent calls.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :cursor cursor returned from previous call
+  # @option opts [Integer] :limit number of results per page
+  # @return [OrderJsonPaginationResponse]
+  describe 'get_orders 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_orders_by_crm_opportunity_id
+  # Return a list of orders associated with a CRM opportunity id
+  # Returns the details of orders
+  # @param id crm id of the opportunity
+  # @param [Hash] opts the optional parameters
+  # @return [Array<Object>]
+  describe 'get_orders_by_crm_opportunity_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 rebase_amendment
+  # Mark order as executed
+  # Rebase the given amendment order onto the latest subscription version
+  # @param order_id id of the order
+  # @param [Hash] opts the optional parameters
+  # @return [OrderJson]
+  describe 'rebase_amendment 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_document_template
+  # Update predefined terms
+  # Updates a predefined terms
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @option opts [DocumentTemplateJson] :body 
+  # @return [nil]
+  describe 'update_document_template 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_document_template_status
+  # Update predefined terms status
+  # Updates the status of a predefined terms
+  # @param id id of the predefined terms
+  # @param status new status to set
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'update_document_template_status 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_order
+  # Update order details
+  # Updates the details of the specified order
+  # @param body json representing the order details
+  # @param [Hash] opts the optional parameters
+  # @option opts [BOOLEAN] :is_dry_run true if the order should not be persisted
+  # @return [nil]
+  describe 'update_order 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_order_status
+  # Update order status
+  # Updates the status of the specified order to the specified value
+  # @param id id of the order
+  # @param status new status
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :status_updated_on Order status update time
+  # @return [nil]
+  describe 'update_order_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/payments_api_spec.rb

@@ -0,0 +1,132 @@
+=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::PaymentsApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'PaymentsApi' do
+  before do
+    # run before each test
+    @instance = SubskribeDevClient::PaymentsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of PaymentsApi' do
+    it 'should create an instance of PaymentsApi' do
+      expect(@instance).to be_instance_of(SubskribeDevClient::PaymentsApi)
+    end
+  end
+
+  # unit tests for get_account_payment
+  # Get payments
+  # Returns the payments for the specified account
+  # @param id id of the account
+  # @param [Hash] opts the optional parameters
+  # @return [Array<PaymentJson>]
+  describe 'get_account_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_account_payment_management_link
+  # Get account payment management link
+  # Returns a payment management link for an account
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @return [String]
+  describe 'get_account_payment_management_link 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_payment
+  # Get payment details
+  # Gets the details of the specified payment
+  # @param id id of the payment
+  # @param [Hash] opts the optional parameters
+  # @return [PaymentJson]
+  describe 'get_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_payment_balance
+  # Get payment balance
+  # Gets the balance of a payment
+  # @param id id of the payment
+  # @param [Hash] opts the optional parameters
+  # @return [PaymentBalanceJson]
+  describe 'get_payment_balance 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_payment_configuration
+  # Get payment configuration
+  # Returns the payment configuration for your tenant
+  # @param [Hash] opts the optional parameters
+  # @return [PaymentConfiguration]
+  describe 'get_payment_configuration 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_payments
+  # Get all payments
+  # Returns all payments for you tenant. The results are paginated. To fetch all take the cursor returned from a call and pass it to a subsequent call.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :cursor cursor returned from previous call
+  # @option opts [Integer] :limit number of results per page
+  # @return [PaymentJsonPaginationResponse]
+  describe 'get_payments 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_payment_configuration
+  # Update payment configuration
+  # Updates the payment configuration for your tenant.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Array<String>] :body Payment types to set. Options can be one or more of the allowable values
+  # @return [PaymentConfiguration]
+  describe 'update_payment_configuration 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 void_payment
+  # Voids a payment
+  # Voids the specified payment per the specified parameters
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @option opts [VoidPaymentJson] :body 
+  # @return [PaymentJson]
+  describe 'void_payment test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end