subskribe_sandbox 1.0.0 → 1.0.1

data/lib/swagger_client/api/import_api.rb

@@ -0,0 +1,568 @@
+=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 'uri'
+
+module SwaggerClient
+  class ImportApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # 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]
+    def create_flatfile_workbook(domain, opts = {})
+      data, _status_code, _headers = create_flatfile_workbook_with_http_info(domain, opts)
+      data
+    end
+
+    # 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 [Array<(FlatfileWorkbookResponse, Fixnum, Hash)>] FlatfileWorkbookResponse data, response status code and response headers
+    def create_flatfile_workbook_with_http_info(domain, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ImportApi.create_flatfile_workbook ...'
+      end
+      # verify the required parameter 'domain' is set
+      if @api_client.config.client_side_validation && domain.nil?
+        fail ArgumentError, "Missing the required parameter 'domain' when calling ImportApi.create_flatfile_workbook"
+      end
+      # verify enum value
+      if @api_client.config.client_side_validation && !['ORDER'].include?(domain)
+        fail ArgumentError, "invalid value for 'domain', must be one of ORDER"
+      end
+      # resource path
+      local_var_path = '/import/flatfile/{domain}'.sub('{' + 'domain' + '}', domain.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['ApiKeyAuth']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'FlatfileWorkbookResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ImportApi#create_flatfile_workbook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # 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]
+    def get_account_contacts_in_import_format(opts = {})
+      get_account_contacts_in_import_format_with_http_info(opts)
+      nil
+    end
+
+    # 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 [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def get_account_contacts_in_import_format_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ImportApi.get_account_contacts_in_import_format ...'
+      end
+      # resource path
+      local_var_path = '/import/export/accountContact'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream', 'application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['ApiKeyAuth']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ImportApi#get_account_contacts_in_import_format\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # 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]
+    def get_amendment_order_export_in_import_format(opts = {})
+      get_amendment_order_export_in_import_format_with_http_info(opts)
+      nil
+    end
+
+    # 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 [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def get_amendment_order_export_in_import_format_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ImportApi.get_amendment_order_export_in_import_format ...'
+      end
+      # resource path
+      local_var_path = '/import/export/amendmentOrders'
+
+      # query parameters
+      query_params = {}
+      query_params[:'generation'] = opts[:'generation'] if !opts[:'generation'].nil?
+      query_params[:'useRealIds'] = opts[:'use_real_ids'] if !opts[:'use_real_ids'].nil?
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream', 'application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['ApiKeyAuth']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ImportApi#get_amendment_order_export_in_import_format\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Return available schemas
+    # Returns the set of schemas available for import
+    # @param [Hash] opts the optional parameters
+    # @return [Hash<String, Array<Object>>]
+    def get_available_schemas(opts = {})
+      data, _status_code, _headers = get_available_schemas_with_http_info(opts)
+      data
+    end
+
+    # Return available schemas
+    # Returns the set of schemas available for import
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Hash<String, Array<Object>>, Fixnum, Hash)>] Hash<String, Array<Object>> data, response status code and response headers
+    def get_available_schemas_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ImportApi.get_available_schemas ...'
+      end
+      # resource path
+      local_var_path = '/import/schemas'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['ApiKeyAuth']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Hash<String, Array<Object>>')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ImportApi#get_available_schemas\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # 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]
+    def get_catalog_data_in_import_format(opts = {})
+      get_catalog_data_in_import_format_with_http_info(opts)
+      nil
+    end
+
+    # 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 [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def get_catalog_data_in_import_format_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ImportApi.get_catalog_data_in_import_format ...'
+      end
+      # resource path
+      local_var_path = '/import/export/catalog'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream', 'application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['ApiKeyAuth']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ImportApi#get_catalog_data_in_import_format\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # 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]
+    def get_data_import_by_id(import_id, opts = {})
+      data, _status_code, _headers = get_data_import_by_id_with_http_info(import_id, opts)
+      data
+    end
+
+    # 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 [Array<(DataImport, Fixnum, Hash)>] DataImport data, response status code and response headers
+    def get_data_import_by_id_with_http_info(import_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ImportApi.get_data_import_by_id ...'
+      end
+      # verify the required parameter 'import_id' is set
+      if @api_client.config.client_side_validation && import_id.nil?
+        fail ArgumentError, "Missing the required parameter 'import_id' when calling ImportApi.get_data_import_by_id"
+      end
+      # resource path
+      local_var_path = '/import/{importId}'.sub('{' + 'importId' + '}', import_id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['ApiKeyAuth']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'DataImport')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ImportApi#get_data_import_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Gets all import items
+    # Gets all items that was imported
+    # @param [Hash] opts the optional parameters
+    # @return [DataImport]
+    def get_data_imports(opts = {})
+      data, _status_code, _headers = get_data_imports_with_http_info(opts)
+      data
+    end
+
+    # Gets all import items
+    # Gets all items that was imported
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(DataImport, Fixnum, Hash)>] DataImport data, response status code and response headers
+    def get_data_imports_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ImportApi.get_data_imports ...'
+      end
+      # resource path
+      local_var_path = '/import'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['ApiKeyAuth']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'DataImport')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ImportApi#get_data_imports\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Get import details
+    # Returns the details of an import by its ID
+    # @param import_id 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def get_import_result1(import_id, opts = {})
+      get_import_result1_with_http_info(import_id, opts)
+      nil
+    end
+
+    # Get import details
+    # Returns the details of an import by its ID
+    # @param import_id 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def get_import_result1_with_http_info(import_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ImportApi.get_import_result1 ...'
+      end
+      # verify the required parameter 'import_id' is set
+      if @api_client.config.client_side_validation && import_id.nil?
+        fail ArgumentError, "Missing the required parameter 'import_id' when calling ImportApi.get_import_result1"
+      end
+      # resource path
+      local_var_path = '/import/{importId}/result'.sub('{' + 'importId' + '}', import_id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream', 'application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['ApiKeyAuth']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ImportApi#get_import_result1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # 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]
+    def get_new_order_export_in_import_format(opts = {})
+      get_new_order_export_in_import_format_with_http_info(opts)
+      nil
+    end
+
+    # 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 [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def get_new_order_export_in_import_format_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ImportApi.get_new_order_export_in_import_format ...'
+      end
+      # resource path
+      local_var_path = '/import/export/newOrders'
+
+      # query parameters
+      query_params = {}
+      query_params[:'useRealIds'] = opts[:'use_real_ids'] if !opts[:'use_real_ids'].nil?
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream', 'application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['ApiKeyAuth']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ImportApi#get_new_order_export_in_import_format\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Process an import by ID
+    # Processes the import specified.
+    # @param import_id 
+    # @param [Hash] opts the optional parameters
+    # @return [DataImport]
+    def process_import(import_id, opts = {})
+      data, _status_code, _headers = process_import_with_http_info(import_id, opts)
+      data
+    end
+
+    # Process an import by ID
+    # Processes the import specified.
+    # @param import_id 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(DataImport, Fixnum, Hash)>] DataImport data, response status code and response headers
+    def process_import_with_http_info(import_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ImportApi.process_import ...'
+      end
+      # verify the required parameter 'import_id' is set
+      if @api_client.config.client_side_validation && import_id.nil?
+        fail ArgumentError, "Missing the required parameter 'import_id' when calling ImportApi.process_import"
+      end
+      # resource path
+      local_var_path = '/import/{importId}/process'.sub('{' + 'importId' + '}', import_id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['ApiKeyAuth']
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'DataImport')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ImportApi#process_import\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # 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]
+    def validate_multi_part_file_import(opts = {})
+      data, _status_code, _headers = validate_multi_part_file_import_with_http_info(opts)
+      data
+    end
+
+    # 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 [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
+    def validate_multi_part_file_import_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ImportApi.validate_multi_part_file_import ...'
+      end
+      # resource path
+      local_var_path = '/import'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
+
+      # form parameters
+      form_params = {}
+      form_params['file'] = opts[:'file'] if !opts[:'file'].nil?
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['ApiKeyAuth']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'String')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ImportApi#validate_multi_part_file_import\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end