subskribe_sandbox 1.0.0

data/spec/api/authentication_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::AuthenticationApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'AuthenticationApi' do
+  before do
+    # run before each test
+    @instance = SubskribeDevClient::AuthenticationApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of AuthenticationApi' do
+    it 'should create an instance of AuthenticationApi' do
+      expect(@instance).to be_instance_of(SubskribeDevClient::AuthenticationApi)
+    end
+  end
+
+  # unit tests for add_saml_integration
+  # Add a saml integration
+  # Adds a saml integration
+  # @param [Hash] opts the optional parameters
+  # @option opts [AuthSamlIntegrationJson] :body saml representing the integration
+  # @return [nil]
+  describe 'add_saml_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 create_api_key
+  # Create a new api key
+  # Create a new api key with the specified parameters. The new key is returned
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :role Role-based permissions to be associated with the key. Specify this OR userId.
+  # @option opts [Integer] :expiry Time of expiry in seconds since Epoch (GMT)
+  # @option opts [String] :user_id User to associate key with. Specify this OR role.
+  # @option opts [String] :entity_id Scope of entities that the key has access to. Either specify a single entity or all entities (i.e. *).
+  # @return [String]
+  describe 'create_api_key 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_all_api_keys
+  # Retrieves all API keys
+  # Retrieves a list of (maximum 500 items) all API keys (including expired and deactivated keys)
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'get_all_api_keys 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_api_key_by_id
+  # Retrieve an API key by id
+  # Retrieve an api key referenced by its id
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'get_api_key_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 revoke_api_key
+  # revoke all keys
+  # Revokes all keys for your tenant
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'revoke_api_key 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 revoke_api_key_by_id
+  # revoke an API key by id
+  # Revoke an api key referenced by its id
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'revoke_api_key_by_id 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/billing_api_spec.rb

@@ -0,0 +1,516 @@
+=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::BillingApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'BillingApi' do
+  before do
+    # run before each test
+    @instance = SubskribeDevClient::BillingApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of BillingApi' do
+    it 'should create an instance of BillingApi' do
+      expect(@instance).to be_instance_of(SubskribeDevClient::BillingApi)
+    end
+  end
+
+  # unit tests for add_automated_invoice_rule
+  # Create an automated invoice rule
+  # Creates an automated invoice rule with the specified parameters
+  # @param body automated invoice rule
+  # @param [Hash] opts the optional parameters
+  # @return [AutomatedInvoiceRule]
+  describe 'add_automated_invoice_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 add_billing_schedule
+  # Add a new billing schedule for subscription line item
+  # Creates a new billing schedule entry for an event based charge
+  # @param body new billing event
+  # @param [Hash] opts the optional parameters
+  # @return [String]
+  describe 'add_billing_schedule 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_subscription_charge_alias
+  # Create an alias for a subscription id/charge id pair
+  # This allows you to specify a string alias for a subscription id and a charge id. This can be useful when, for example, you want to upload usage statistics and would rather specify your own id (or another external id), rather than referring to Subskribe's internal ids.
+  # @param alias_id alias to map to create the mapping for
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :subscription_id the subscription id
+  # @option opts [String] :charge_id the charge id
+  # @return [nil]
+  describe 'add_subscription_charge_alias 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 apply_credit_memo
+  # Apply a credit memo
+  # Applies a credit memo per the specified parameters
+  # @param body application details in json
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'apply_credit_memo 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_bulk_invoice_run
+  # Create a bulk invoice run
+  # Creates a bulk invoice run as specified by the input parameters. On success the id of the run is returned.
+  # @param body json representing the run parameters
+  # @param [Hash] opts the optional parameters
+  # @return [String]
+  describe 'create_bulk_invoice_run 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_invoice_document
+  # Generate invoice PDF
+  # Generates a PDF version of the specified invoice. Once generated, PDF can be later fetched via a call to /{invoiceNumber}/pdf.
+  # @param invoice_number 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'create_invoice_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_billing_schedule
+  # Delete an existing billing schedule
+  # Billing schedules must be deleted in reverse chronological order.
+  # @param id billing schedule entry id
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_billing_schedule 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_invoice
+  # Delete invoice
+  # Deletes the specified invoice
+  # @param number number of the invoice
+  # @param [Hash] opts the optional parameters
+  # @return [InvoiceJson]
+  describe 'delete_invoice 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_subscription_charge_alias
+  # Delete the specified alias
+  # Deletes the specified alias mapping
+  # @param alias_id 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_subscription_charge_alias 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 generate_invoice
+  # Generate subscription invoices
+  # Generates the invoices for the given subscription
+  # @param subscription_id id of the subscription
+  # @param target_date Time in seconds since Epoch (GMT) to generate invoice from
+  # @param invoice_charge_inclusion_option types of charges to include
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :invoice_date Time in seconds since Epoch (GMT) to set invoice date to
+  # @return [Array<InvoiceJson>]
+  describe 'generate_invoice 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_receivable_contact
+  # Get the contact for accounts receivable
+  # Returns the details of the account receivable contact for your tenant
+  # @param [Hash] opts the optional parameters
+  # @return [AccountReceivableContactJson]
+  describe 'get_account_receivable_contact 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_automated_invoice_rule
+  # Get automated invoice rule details
+  # Returns the details of the specified automated invoice rule
+  # @param id id of the automated invoice rule
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'get_automated_invoice_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_automated_invoice_rules
+  # Get automated invoice rules for a tenant
+  # Returns all the configured automated invoice rules for the tenant
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'get_automated_invoice_rules 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_billing_schedules
+  # Get billing schedules for a subscription line item
+  # Retrieve all billing schedules for a subscription line item
+  # @param subscription_id 
+  # @param subscription_charge_id 
+  # @param [Hash] opts the optional parameters
+  # @return [Array<BillingEventEntry>]
+  describe 'get_billing_schedules 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_bulk_invoice_run
+  # Get bulk invoice run details
+  # Returns the details of the specified bulk invoice run
+  # @param bulk_invoice_run_id id of the run
+  # @param [Hash] opts the optional parameters
+  # @return [BulkInvoiceRun]
+  describe 'get_bulk_invoice_run 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_bulk_invoice_run_items
+  # Get items for bulk invoice run
+  # Returns the items associated with the specified bulk invoice run
+  # @param bulk_invoice_run_id id of the run
+  # @param [Hash] opts the optional parameters
+  # @return [Array<BulkInvoiceRunItem>]
+  describe 'get_bulk_invoice_run_items 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_dunning_setting
+  # Get dunning settings
+  # Returns the dunning settings for your tenant
+  # @param [Hash] opts the optional parameters
+  # @return [DunningSettingJson]
+  describe 'get_dunning_setting 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_invoice
+  # Get invoice details
+  # Returns the details of the specified invoice number
+  # @param number number of the invoice
+  # @param [Hash] opts the optional parameters
+  # @return [InvoiceJson]
+  describe 'get_invoice 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_invoice_balance
+  # Get invoice balance
+  # Returns the balance of the specified invoice number
+  # @param number number of the invoice
+  # @param [Hash] opts the optional parameters
+  # @return [InvoiceBalanceJson]
+  describe 'get_invoice_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_invoice_document_pdf
+  # Download invoice PDF
+  # Downloads the PDF for an invoice after it has been generated via a POST to /{invoiceNumber}/pdf. The data return will be the PDF document contents.
+  # @param invoice_number number of the invoice
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'get_invoice_document_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 get_invoices
+  # Get all invoices for a subscription
+  # Returns all invoices for a subscription. The result is paginated. Use the cursor returned from a request in subsequent calls to retrieve all results.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :subscription_id 
+  # @option opts [String] :status status filter for invoices
+  # @option opts [String] :cursor used to iterate through all results
+  # @option opts [Integer] :limit number of items per page
+  # @return [InvoiceJsonPaginationResponse]
+  describe 'get_invoices 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_raw_invoice_document_json
+  # Get the invoice document JSON that is used to render invoice PDF
+  # Invoice document JSON that contains all details required to render full Invoice document
+  # @param invoice_number number of the invoice
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'get_raw_invoice_document_json 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_settlement_application
+  # Get settlement application details
+  # Gets the details of specified settlement application.
+  # @param id id of the settlement application
+  # @param [Hash] opts the optional parameters
+  # @return [SettlementApplication]
+  describe 'get_settlement_application 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_settlement_applications
+  # Get settlement applications
+  # Returns the settlement applications for the specified invoice number.
+  # @param invoice_number number of the invoice
+  # @param [Hash] opts the optional parameters
+  # @return [Array<SettlementApplication>]
+  describe 'get_settlement_applications 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_charge_alias
+  # Get the details of an alias
+  # Returns the details of the specified alias id including the subscription id and the charge id it is mapped to.
+  # @param alias_id 
+  # @param [Hash] opts the optional parameters
+  # @return [SubscriptionChargeAlias]
+  describe 'get_subscription_charge_alias 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_for_subscription_charge
+  # Get usage
+  # Returns the usage invoice items 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
+  # @return [Array<InvoiceItemJson>]
+  describe 'get_usage_for_subscription_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 list_aliases_for_subscription
+  # Get aliases for a subscription
+  # Returns all aliases for the specified subscription id.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :subscription_id id of the subscription
+  # @return [Array<SubscriptionChargeAlias>]
+  describe 'list_aliases_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 post_invoice
+  # Mark invoice as posted
+  # Marks the specified invoice as posted
+  # @param number number of the invoice
+  # @param [Hash] opts the optional parameters
+  # @return [InvoiceJson]
+  describe 'post_invoice 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 post_invoices_for_bulk_invoice_run
+  # Posts invoices for a bulk run
+  # Marks all invoices associated with the specified bulk run as posted
+  # @param bulk_invoice_run_id id of the run
+  # @param [Hash] opts the optional parameters
+  # @option opts [Array<String>] :body 
+  # @return [BulkInvoiceRun]
+  describe 'post_invoices_for_bulk_invoice_run 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 preview_invoice_by_order_period
+  # Get unbilled usage
+  # Returns the unbilled usage invoice items for the specified subscription
+  # @param subscription_id id of the subscription
+  # @param [Hash] opts the optional parameters
+  # @return [Array<InvoiceItemJson>]
+  describe 'preview_invoice_by_order_period 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 preview_invoice_by_order_period1
+  # Preview invoices
+  # Returns a preview of invoice for the specified order id OR subscription id
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :order_id id of order
+  # @option opts [String] :subscription_id id of subscription
+  # @return [Array<InvoicePreviewJson>]
+  describe 'preview_invoice_by_order_period1 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 put_account_receivable_contact
+  # Set the contact for accounts receivable
+  # Sets the details of the account receivable contact for your tenant
+  # @param [Hash] opts the optional parameters
+  # @option opts [AccountReceivableContactJson] :account_receivable_contact_json contact details
+  # @return [nil]
+  describe 'put_account_receivable_contact 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 send_invoice_reminder
+  # Send an Invoice Reminder
+  # Sends a reminder email for the specified invoice
+  # @param invoice_number number of the invoice
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'send_invoice_reminder 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 send_test_dunning_email
+  # Send a test email
+  # Sends a test email for dunning to the use associated with this API call. Note A user bound api key is required for this operation.
+  # @param reminder_type type of the reminder
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'send_test_dunning_email 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_automated_invoice_rule
+  # Update automated invoice rule details
+  # Updates the details of the specified automated invoice rule
+  # @param id id of the automated invoice rule
+  # @param body automated invoice rule
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'update_automated_invoice_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 update_dunning_setting
+  # Update dunning settings
+  # Updates the dunning settings for your tenant
+  # @param [Hash] opts the optional parameters
+  # @option opts [DunningSettingJson] :body json representing the dunning settings
+  # @return [nil]
+  describe 'update_dunning_setting 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_invoice
+  # Update invoice details
+  # Updates the details of the specified invoice.
+  # @param number number of the invoice
+  # @param body json representing invoice details
+  # @param [Hash] opts the optional parameters
+  # @return [InvoiceJson]
+  describe 'update_invoice 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_invoice_sequence
+  # Update invoice sequence
+  # Updates the invoice sequence by invoice config id.
+  # @param invoice_config_id invoice config id
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :next_invoice_number long integer value
+  # @return [TenantInvoiceConfig]
+  describe 'update_invoice_sequence 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_invoice
+  # Mark invoice as voided
+  # Marks the specified invoice as voided
+  # @param number number of the invoice
+  # @param body json representing invoice details
+  # @param [Hash] opts the optional parameters
+  # @return [InvoiceJson]
+  describe 'void_invoice test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end