subskribe_dev 1.0.0 → 1.2.0

data/lib/subskribe_dev.rb

@@ -0,0 +1,229 @@
+=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
+
+# Common files
+require 'subskribe_dev/api_client'
+require 'subskribe_dev/api_error'
+require 'subskribe_dev/version'
+require 'subskribe_dev/configuration'
+
+# Models
+require 'subskribe_dev/models/account_address'
+require 'subskribe_dev/models/account_address_json'
+require 'subskribe_dev/models/account_contact'
+require 'subskribe_dev/models/account_contact_json'
+require 'subskribe_dev/models/account_json'
+require 'subskribe_dev/models/account_payment_method_json'
+require 'subskribe_dev/models/account_receivable_contact_json'
+require 'subskribe_dev/models/accounting_event'
+require 'subskribe_dev/models/accounting_event_paginated_response'
+require 'subskribe_dev/models/accounting_period'
+require 'subskribe_dev/models/accounting_period_calculation'
+require 'subskribe_dev/models/add_and_apply_payment_application_json'
+require 'subskribe_dev/models/anrok_integration_input'
+require 'subskribe_dev/models/approval_matrix_import_data_json'
+require 'subskribe_dev/models/approval_matrix_import_preview'
+require 'subskribe_dev/models/approval_role_json'
+require 'subskribe_dev/models/approval_role_segment_change'
+require 'subskribe_dev/models/approval_segment_json'
+require 'subskribe_dev/models/attachment'
+require 'subskribe_dev/models/attribute_reference'
+require 'subskribe_dev/models/auth_saml_integration_json'
+require 'subskribe_dev/models/automated_invoice_rule'
+require 'subskribe_dev/models/automated_invoice_rule_request_json'
+require 'subskribe_dev/models/avalara_integration'
+require 'subskribe_dev/models/avalara_integration_input'
+require 'subskribe_dev/models/billing_event_entry'
+require 'subskribe_dev/models/billing_event_input'
+require 'subskribe_dev/models/bulk_invoice_run'
+require 'subskribe_dev/models/bulk_invoice_run_exclusions'
+require 'subskribe_dev/models/bulk_invoice_run_input'
+require 'subskribe_dev/models/bulk_invoice_run_item'
+require 'subskribe_dev/models/bulk_invoice_run_selector'
+require 'subskribe_dev/models/bulk_payment_upload_data'
+require 'subskribe_dev/models/bulk_payment_upload_result'
+require 'subskribe_dev/models/byte_buffer'
+require 'subskribe_dev/models/catalog_relationship'
+require 'subskribe_dev/models/charge_json'
+require 'subskribe_dev/models/charge_partial_json'
+require 'subskribe_dev/models/company_contact_json'
+require 'subskribe_dev/models/credit_memo_application_json'
+require 'subskribe_dev/models/credit_memo_balance_json'
+require 'subskribe_dev/models/credit_memo_json'
+require 'subskribe_dev/models/credit_memo_line_item_json'
+require 'subskribe_dev/models/credit_memo_line_item_request_json'
+require 'subskribe_dev/models/credit_memo_pagination_response_json'
+require 'subskribe_dev/models/crm_account_import_response'
+require 'subskribe_dev/models/custom_field_default'
+require 'subskribe_dev/models/custom_field_definition_create_input'
+require 'subskribe_dev/models/custom_field_definition_json'
+require 'subskribe_dev/models/custom_field_definition_update_input'
+require 'subskribe_dev/models/custom_field_entry'
+require 'subskribe_dev/models/custom_field_update_input'
+require 'subskribe_dev/models/custom_field_value'
+require 'subskribe_dev/models/data_import'
+require 'subskribe_dev/models/discount_detail_json'
+require 'subskribe_dev/models/discount_json'
+require 'subskribe_dev/models/docu_sign_integration_request_json'
+require 'subskribe_dev/models/docu_sign_integration_response_json'
+require 'subskribe_dev/models/document_custom_content'
+require 'subskribe_dev/models/document_section'
+require 'subskribe_dev/models/document_template_json'
+require 'subskribe_dev/models/dunning_setting_json'
+require 'subskribe_dev/models/email_notifiers_list'
+require 'subskribe_dev/models/entity'
+require 'subskribe_dev/models/entity_json'
+require 'subskribe_dev/models/entity_ref'
+require 'subskribe_dev/models/entry'
+require 'subskribe_dev/models/external_arr_schedule_json'
+require 'subskribe_dev/models/flatfile_workbook_response'
+require 'subskribe_dev/models/flatfile_workbook_response_data'
+require 'subskribe_dev/models/input_stream'
+require 'subskribe_dev/models/integration'
+require 'subskribe_dev/models/invoice_balance_json'
+require 'subskribe_dev/models/invoice_item_json'
+require 'subskribe_dev/models/invoice_item_preview_json'
+require 'subskribe_dev/models/invoice_json'
+require 'subskribe_dev/models/invoice_json_pagination_response'
+require 'subskribe_dev/models/invoice_number_prefix'
+require 'subskribe_dev/models/invoice_preview_json'
+require 'subskribe_dev/models/ledger_account'
+require 'subskribe_dev/models/ledger_account_mapping'
+require 'subskribe_dev/models/metrics_json'
+require 'subskribe_dev/models/notification_target_and_subscriptions'
+require 'subskribe_dev/models/number_config'
+require 'subskribe_dev/models/opportunity'
+require 'subskribe_dev/models/opportunity_json'
+require 'subskribe_dev/models/opportunity_pagination_response'
+require 'subskribe_dev/models/opportunity_rest_json'
+require 'subskribe_dev/models/order_json'
+require 'subskribe_dev/models/order_json_pagination_response'
+require 'subskribe_dev/models/order_line_item_json'
+require 'subskribe_dev/models/order_line_item_request_json'
+require 'subskribe_dev/models/order_request_json'
+require 'subskribe_dev/models/order_terms'
+require 'subskribe_dev/models/paginated_response'
+require 'subskribe_dev/models/payment_balance_json'
+require 'subskribe_dev/models/payment_configuration'
+require 'subskribe_dev/models/payment_json'
+require 'subskribe_dev/models/payment_json_pagination_response'
+require 'subskribe_dev/models/payment_term_settings_json'
+require 'subskribe_dev/models/plan_json'
+require 'subskribe_dev/models/plan_json_pagination_response'
+require 'subskribe_dev/models/predefined_report_def_chart_json'
+require 'subskribe_dev/models/predefined_report_def_json'
+require 'subskribe_dev/models/predefined_report_defs_json'
+require 'subskribe_dev/models/predefined_report_json'
+require 'subskribe_dev/models/predefined_report_param'
+require 'subskribe_dev/models/predefined_report_param_object'
+require 'subskribe_dev/models/prepaid_stats'
+require 'subskribe_dev/models/price_tier_json'
+require 'subskribe_dev/models/product_category'
+require 'subskribe_dev/models/product_category_pagination_response'
+require 'subskribe_dev/models/product_input_json'
+require 'subskribe_dev/models/product_json'
+require 'subskribe_dev/models/product_json_pagination_response'
+require 'subskribe_dev/models/purchase_order'
+require 'subskribe_dev/models/raw_usage'
+require 'subskribe_dev/models/raw_usages_data'
+require 'subskribe_dev/models/recognition_event_completion'
+require 'subskribe_dev/models/recognition_rule'
+require 'subskribe_dev/models/recurrence_json'
+require 'subskribe_dev/models/refund'
+require 'subskribe_dev/models/refund_detail'
+require 'subskribe_dev/models/refund_request_json'
+require 'subskribe_dev/models/report_duration'
+require 'subskribe_dev/models/report_job_response'
+require 'subskribe_dev/models/salesforce_account'
+require 'subskribe_dev/models/salesforce_account_billing_address'
+require 'subskribe_dev/models/salesforce_client_integration_request_json'
+require 'subskribe_dev/models/settlement_application'
+require 'subskribe_dev/models/standalone_credit_memo_request'
+require 'subskribe_dev/models/subscription_charge_alias'
+require 'subskribe_dev/models/subscription_charge_json'
+require 'subskribe_dev/models/subscription_json'
+require 'subskribe_dev/models/subscription_update_json'
+require 'subskribe_dev/models/tax_jar_integration'
+require 'subskribe_dev/models/tax_jar_integration_input'
+require 'subskribe_dev/models/tax_rate_json'
+require 'subskribe_dev/models/tax_rate_pagination_response_json'
+require 'subskribe_dev/models/tenant_credit_memo_configuration_json'
+require 'subskribe_dev/models/tenant_discount_json'
+require 'subskribe_dev/models/tenant_discount_line_item_json'
+require 'subskribe_dev/models/tenant_invoice_config'
+require 'subskribe_dev/models/tenant_json'
+require 'subskribe_dev/models/tenant_setting_json'
+require 'subskribe_dev/models/time_series_amount_json'
+require 'subskribe_dev/models/time_zone'
+require 'subskribe_dev/models/unit_of_measure_json'
+require 'subskribe_dev/models/unit_of_measure_pagination_response_json'
+require 'subskribe_dev/models/update_invoice_request'
+require 'subskribe_dev/models/usage_aggregate_output'
+require 'subskribe_dev/models/usage_batch_insert_result'
+require 'subskribe_dev/models/user_group_json'
+require 'subskribe_dev/models/user_group_request_json'
+require 'subskribe_dev/models/user_input'
+require 'subskribe_dev/models/user_json'
+require 'subskribe_dev/models/user_pagination_response_json'
+require 'subskribe_dev/models/void_invoice_request'
+require 'subskribe_dev/models/void_payment_json'
+
+# APIs
+require 'subskribe_dev/api/accounting_api'
+require 'subskribe_dev/api/accounts_api'
+require 'subskribe_dev/api/approvals_api'
+require 'subskribe_dev/api/attachments_api'
+require 'subskribe_dev/api/authentication_api'
+require 'subskribe_dev/api/billing_api'
+require 'subskribe_dev/api/credit_memo_api'
+require 'subskribe_dev/api/custom_field_api'
+require 'subskribe_dev/api/customization_api'
+require 'subskribe_dev/api/default_api'
+require 'subskribe_dev/api/discounts_api'
+require 'subskribe_dev/api/erp_api'
+require 'subskribe_dev/api/entities_api'
+require 'subskribe_dev/api/entity_api'
+require 'subskribe_dev/api/import_api'
+require 'subskribe_dev/api/integrations_api'
+require 'subskribe_dev/api/metrics_reporting_api'
+require 'subskribe_dev/api/notifications_api'
+require 'subskribe_dev/api/opportunity_api'
+require 'subskribe_dev/api/orders_api'
+require 'subskribe_dev/api/payments_api'
+require 'subskribe_dev/api/product_catalog_api'
+require 'subskribe_dev/api/rate_card_api'
+require 'subskribe_dev/api/refunds_api'
+require 'subskribe_dev/api/reports_api'
+require 'subskribe_dev/api/revenue_recognition_api'
+require 'subskribe_dev/api/sales_room_api'
+require 'subskribe_dev/api/settings_api'
+require 'subskribe_dev/api/subscriptions_api'
+require 'subskribe_dev/api/usage_api'
+require 'subskribe_dev/api/users_api'
+
+module SubskribeDevClient
+  class << self
+    # Customize default settings for the SDK using block.
+    #   SubskribeDevClient.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end

data/spec/api/accounting_api_spec.rb

@@ -0,0 +1,74 @@
+=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::AccountingApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'AccountingApi' do
+  before do
+    # run before each test
+    @instance = SubskribeDevClient::AccountingApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of AccountingApi' do
+    it 'should create an instance of AccountingApi' do
+      expect(@instance).to be_instance_of(SubskribeDevClient::AccountingApi)
+    end
+  end
+
+  # unit tests for get_accounting_events
+  # Get accounting events for the specified dates
+  # Returns all accounting related events between the from and to dates. Since there can be a large number of these, the results are paginated. To retrieve subsequent pages of events, pass in the pageToken returned from the prior call.
+  # @param from start date in seconds since Epoch(GMT)
+  # @param to end date in seconds since Epoch(GMT)
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :limit number of items per page
+  # @option opts [String] :page_token pass this to subsequent calls
+  # @return [AccountingEventPaginatedResponse]
+  describe 'get_accounting_events 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_journal_entries
+  # Return Journal Entries for period
+  # Returns all Journal Entries for the specified accounting period as text/csv
+  # @param accounting_period_id Id of the period
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'get_journal_entries 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 specify_current_accounting_period
+  # Specify the current accounting period
+  # Specify the start date of and open an accounting period, making it current
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :start_date Start date of new period in seconds since Epoch (GMT)
+  # @return [AccountingPeriod]
+  describe 'specify_current_accounting_period 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/accounts_api_spec.rb

@@ -0,0 +1,232 @@
+=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::AccountsApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'AccountsApi' do
+  before do
+    # run before each test
+    @instance = SubskribeDevClient::AccountsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of AccountsApi' do
+    it 'should create an instance of AccountsApi' do
+      expect(@instance).to be_instance_of(SubskribeDevClient::AccountsApi)
+    end
+  end
+
+  # unit tests for add_account
+  # Add a new account
+  # Create an account with the specified parameters. On success, the id of the newly created account is returned
+  # @param [Hash] opts the optional parameters
+  # @option opts [AccountJson] :body 
+  # @return [AccountJson]
+  describe 'add_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 add_account_contact
+  # Add a contact for an account
+  # Creates and adds a new contact for the specified account and returns the new contact ID
+  # @param account_id 
+  # @param [Hash] opts the optional parameters
+  # @option opts [AccountContactJson] :body 
+  # @option opts [BOOLEAN] :skip_address_validation value = perform basic address validation
+  # @option opts [BOOLEAN] :strict_validation value = require the address to match a canonical address, if it exists
+  # @return [AccountContactJson]
+  describe 'add_account_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 add_account_payment_method
+  # Add a payment method to an account
+  # Add a payment method to the specified account and return its ID
+  # @param account_id 
+  # @param [Hash] opts the optional parameters
+  # @option opts [AccountPaymentMethodJson] :body 
+  # @return [AccountPaymentMethodJson]
+  describe 'add_account_payment_method 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_account
+  # Delete an account
+  # Deletes the account associated with the passed ID
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_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 delete_account_contact
+  # Delete a contact
+  # Deletes the contact specified by the account id and contact id
+  # @param contact_id 
+  # @param account_id 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_account_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_account
+  # Get an account by id
+  # Returns the details of the account specified by the passed id
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :id_type 
+  # @return [AccountJson]
+  describe 'get_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 get_account_contact
+  # Gets contact details
+  # Returns the details of the specified contact
+  # @param account_id 
+  # @param contact_id 
+  # @param [Hash] opts the optional parameters
+  # @return [AccountContactJson]
+  describe 'get_account_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_account_contacts
+  # Get contacts for an account
+  # Returns a list of contacts associated with the specified account id
+  # @param account_id 
+  # @param [Hash] opts the optional parameters
+  # @option opts [BOOLEAN] :expand 
+  # @return [Array<AccountContactJson>]
+  describe 'get_account_contacts 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_metrics
+  # Returns metrics for the specified account
+  # Fetches metrics such as ARR, TCV, etc for the specified account as of the specified target date
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :target_date 
+  # @return [MetricsJson]
+  describe 'get_account_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_account_payment_methods
+  # Get the payment methods for an account
+  # Returns a list of payment methods for the specified account id
+  # @param account_id 
+  # @param [Hash] opts the optional parameters
+  # @return [Array<AccountPaymentMethodJson>]
+  describe 'get_account_payment_methods 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
+  # Get all accounts
+  # Returns a paginated list of accounts
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :cursor 
+  # @option opts [Integer] :limit 
+  # @option opts [String] :type 
+  # @return [Array<AccountJson>]
+  describe 'get_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_payment_method
+  # Get the details of a payment method
+  # Returns the details of the payment method for the specified account id and payment method id
+  # @param account_id 
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @return [AccountPaymentMethodJson]
+  describe 'get_payment_method 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_crm_account
+  # Import an account from a CRM
+  # Ensures an account exists which matches the passed details.If an account exists that has a matching CRM Id, it will be updated, if not, it will be created
+  # @param [Hash] opts the optional parameters
+  # @option opts [AccountJson] :body 
+  # @return [CrmAccountImportResponse]
+  describe 'import_crm_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 update_account
+  # Update an account
+  # Updates an existing account with the specified parameters
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @option opts [AccountJson] :body 
+  # @return [nil]
+  describe 'update_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 update_account_contact
+  # Update a contact
+  # Updates the contact specified by the account id and contact id with the passed information
+  # @param account_id 
+  # @param contact_id 
+  # @param [Hash] opts the optional parameters
+  # @option opts [AccountContactJson] :body 
+  # @option opts [BOOLEAN] :skip_address_validation 
+  # @option opts [BOOLEAN] :strict_validation 
+  # @return [nil]
+  describe 'update_account_contact test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end