docusign_rooms 1.0.0.beta

data/lib/docusign_rooms/api/form_libraries_api.rb

@@ -0,0 +1,158 @@
+=begin
+#DocuSign Rooms API - v2
+
+#An API for an integrator to access the features of DocuSign Rooms
+
+OpenAPI spec version: v2
+Contact: devcenter@docusign.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+=end
+
+require "uri"
+
+module DocuSign_Rooms
+
+  class GetFormLibrariesOptions
+    # Default value is 100 and max value is 100
+    attr_accessor :count
+
+    # Default value is 0
+    attr_accessor :start_position
+
+    def self.default
+      @@default ||= GetFormLibrariesOptions.new
+    end
+  end
+
+  class GetFormLibraryFormsOptions
+    # Default value is 100 and max value is 100
+    attr_accessor :count
+
+    # Default value is 0
+    attr_accessor :start_position
+
+    def self.default
+      @@default ||= GetFormLibraryFormsOptions.new
+    end
+  end
+
+
+  class FormLibrariesApi
+    attr_accessor :api_client
+
+    def initialize(api_client = FormLibrariesApi.default)
+      @api_client = api_client
+    end
+
+    # Gets a paged list of forms libraries.
+    # 
+    # @param account_id 
+    # @param DocuSign_Rooms::GetFormLibrariesOptions Options for modifying the behavior of the function.
+    # @return [FormLibrarySummaryList]
+    def get_form_libraries(account_id, options = DocuSign_Rooms::GetFormLibrariesOptions.default)
+      data, _status_code, _headers = get_form_libraries_with_http_info(account_id, options)
+      return data
+    end
+
+    # Gets a paged list of forms libraries.
+    # 
+    # @param account_id 
+    # @param DocuSign_Rooms::GetFormLibrariesOptions Options for modifying the behavior of the function.
+    # @return [Array<(FormLibrarySummaryList, Fixnum, Hash)>] FormLibrarySummaryList data, response status code and response headers
+    def get_form_libraries_with_http_info(account_id, options = DocuSign_Rooms::GetFormLibrariesOptions.default)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: FormLibrariesApi.get_form_libraries ..."
+      end
+      # verify the required parameter 'account_id' is set
+      fail ArgumentError, "Missing the required parameter 'account_id' when calling FormLibrariesApi.get_form_libraries" if account_id.nil?
+      # resource path
+      local_var_path = "/v2/accounts/{accountId}/form_libraries".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'count'] = options.count if !options.count.nil?
+      query_params[:'startPosition'] = options.start_position if !options.start_position.nil?
+
+      # 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 = []
+      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 => 'FormLibrarySummaryList')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: FormLibrariesApi#get_form_libraries\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Gets a paged list of forms in a forms library.
+    # 
+    # @param form_library_id Library Id
+    # @param account_id 
+    # @param DocuSign_Rooms::GetFormLibraryFormsOptions Options for modifying the behavior of the function.
+    # @return [FormSummaryList]
+    def get_form_library_forms(form_library_id, account_id, options = DocuSign_Rooms::GetFormLibraryFormsOptions.default)
+      data, _status_code, _headers = get_form_library_forms_with_http_info(form_library_id, account_id, options)
+      return data
+    end
+
+    # Gets a paged list of forms in a forms library.
+    # 
+    # @param form_library_id Library Id
+    # @param account_id 
+    # @param DocuSign_Rooms::GetFormLibraryFormsOptions Options for modifying the behavior of the function.
+    # @return [Array<(FormSummaryList, Fixnum, Hash)>] FormSummaryList data, response status code and response headers
+    def get_form_library_forms_with_http_info(form_library_id, account_id, options = DocuSign_Rooms::GetFormLibraryFormsOptions.default)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: FormLibrariesApi.get_form_library_forms ..."
+      end
+      # verify the required parameter 'form_library_id' is set
+      fail ArgumentError, "Missing the required parameter 'form_library_id' when calling FormLibrariesApi.get_form_library_forms" if form_library_id.nil?
+      # verify the required parameter 'account_id' is set
+      fail ArgumentError, "Missing the required parameter 'account_id' when calling FormLibrariesApi.get_form_library_forms" if account_id.nil?
+      # resource path
+      local_var_path = "/v2/accounts/{accountId}/form_libraries/{formLibraryId}/forms".sub('{format}','json').sub('{' + 'formLibraryId' + '}', form_library_id.to_s).sub('{' + 'accountId' + '}', account_id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'count'] = options.count if !options.count.nil?
+      query_params[:'startPosition'] = options.start_position if !options.start_position.nil?
+
+      # 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 = []
+      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 => 'FormSummaryList')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: FormLibrariesApi#get_form_library_forms\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/docusign_rooms/api/offices_api.rb

@@ -0,0 +1,310 @@
+=begin
+#DocuSign Rooms API - v2
+
+#An API for an integrator to access the features of DocuSign Rooms
+
+OpenAPI spec version: v2
+Contact: devcenter@docusign.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+=end
+
+require "uri"
+
+module DocuSign_Rooms
+
+  class GetOfficesOptions
+    # Number of offices to include in the response, (Default 100)
+    attr_accessor :count
+
+    # Position in the overall list of offices to begin results.
+    attr_accessor :start_position
+
+    # When true, the response only includes offices accessible to the calling user.
+    attr_accessor :only_accessible
+
+    # When specified, the response only includes offices whose names includes the specified search string.
+    attr_accessor :search
+
+    def self.default
+      @@default ||= GetOfficesOptions.new
+    end
+  end
+
+
+  class OfficesApi
+    attr_accessor :api_client
+
+    def initialize(api_client = OfficesApi.default)
+      @api_client = api_client
+    end
+
+    # Create an office.
+    # 
+    # @param account_id 
+    # @param office  
+    # @return [Office]
+    def create_office(account_id, office)
+      data, _status_code, _headers = create_office_with_http_info(account_id,  office)
+      return data
+    end
+
+    # Create an office.
+    # 
+    # @param account_id 
+    # @param office  
+    # @return [Array<(Office, Fixnum, Hash)>] Office data, response status code and response headers
+    def create_office_with_http_info(account_id, office)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: OfficesApi.create_office ..."
+      end
+      # verify the required parameter 'office' is set
+      fail ArgumentError, "Missing the required parameter 'office' when calling OfficesApi.create_office" if office.nil?
+      # verify the required parameter 'account_id' is set
+      fail ArgumentError, "Missing the required parameter 'account_id' when calling OfficesApi.create_office" if account_id.nil?
+      # resource path
+      local_var_path = "/v2/accounts/{accountId}/offices".sub('{format}','json').sub('{' + 'accountId' + '}', account_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'])
+      # 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 = @api_client.object_to_http_body(office)
+      auth_names = []
+      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 => 'Office')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: OfficesApi#create_office\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Delete an office.
+    # 
+    # @param office_id 
+    # @param account_id 
+    # @return [nil]
+    def delete_office(office_id, account_id)
+      delete_office_with_http_info(office_id, account_id)
+      return nil
+    end
+
+    # Delete an office.
+    # 
+    # @param office_id 
+    # @param account_id 
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def delete_office_with_http_info(office_id, account_id)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: OfficesApi.delete_office ..."
+      end
+      # verify the required parameter 'office_id' is set
+      fail ArgumentError, "Missing the required parameter 'office_id' when calling OfficesApi.delete_office" if office_id.nil?
+      # verify the required parameter 'account_id' is set
+      fail ArgumentError, "Missing the required parameter 'account_id' when calling OfficesApi.delete_office" if account_id.nil?
+      # resource path
+      local_var_path = "/v2/accounts/{accountId}/offices/{officeId}".sub('{format}','json').sub('{' + 'officeId' + '}', office_id.to_s).sub('{' + 'accountId' + '}', account_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 = []
+      data, status_code, headers = @api_client.call_api(:DELETE, 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: OfficesApi#delete_office\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get information about the office with the given officeId.
+    # 
+    # @param office_id 
+    # @param account_id 
+    # @return [Office]
+    def get_office(office_id, account_id)
+      data, _status_code, _headers = get_office_with_http_info(office_id, account_id)
+      return data
+    end
+
+    # Get information about the office with the given officeId.
+    # 
+    # @param office_id 
+    # @param account_id 
+    # @return [Array<(Office, Fixnum, Hash)>] Office data, response status code and response headers
+    def get_office_with_http_info(office_id, account_id)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: OfficesApi.get_office ..."
+      end
+      # verify the required parameter 'office_id' is set
+      fail ArgumentError, "Missing the required parameter 'office_id' when calling OfficesApi.get_office" if office_id.nil?
+      # verify the required parameter 'account_id' is set
+      fail ArgumentError, "Missing the required parameter 'account_id' when calling OfficesApi.get_office" if account_id.nil?
+      # resource path
+      local_var_path = "/v2/accounts/{accountId}/offices/{officeId}".sub('{format}','json').sub('{' + 'officeId' + '}', office_id.to_s).sub('{' + 'accountId' + '}', account_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 = []
+      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 => 'Office')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: OfficesApi#get_office\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get all offices.
+    # 
+    # @param account_id 
+    # @param DocuSign_Rooms::GetOfficesOptions Options for modifying the behavior of the function.
+    # @return [OfficeSummaryList]
+    def get_offices(account_id, options = DocuSign_Rooms::GetOfficesOptions.default)
+      data, _status_code, _headers = get_offices_with_http_info(account_id, options)
+      return data
+    end
+
+    # Get all offices.
+    # 
+    # @param account_id 
+    # @param DocuSign_Rooms::GetOfficesOptions Options for modifying the behavior of the function.
+    # @return [Array<(OfficeSummaryList, Fixnum, Hash)>] OfficeSummaryList data, response status code and response headers
+    def get_offices_with_http_info(account_id, options = DocuSign_Rooms::GetOfficesOptions.default)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: OfficesApi.get_offices ..."
+      end
+      # verify the required parameter 'account_id' is set
+      fail ArgumentError, "Missing the required parameter 'account_id' when calling OfficesApi.get_offices" if account_id.nil?
+      # resource path
+      local_var_path = "/v2/accounts/{accountId}/offices".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'count'] = options.count if !options.count.nil?
+      query_params[:'startPosition'] = options.start_position if !options.start_position.nil?
+      query_params[:'onlyAccessible'] = options.only_accessible if !options.only_accessible.nil?
+      query_params[:'search'] = options.search if !options.search.nil?
+
+      # 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 = []
+      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 => 'OfficeSummaryList')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: OfficesApi#get_offices\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Lists the number of objects of each type that reference the office.
+    # 
+    # @param office_id 
+    # @param account_id 
+    # @return [OfficeReferenceCountList]
+    def get_reference_counts(office_id, account_id)
+      data, _status_code, _headers = get_reference_counts_with_http_info(office_id, account_id)
+      return data
+    end
+
+    # Lists the number of objects of each type that reference the office.
+    # 
+    # @param office_id 
+    # @param account_id 
+    # @return [Array<(OfficeReferenceCountList, Fixnum, Hash)>] OfficeReferenceCountList data, response status code and response headers
+    def get_reference_counts_with_http_info(office_id, account_id)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: OfficesApi.get_reference_counts ..."
+      end
+      # verify the required parameter 'office_id' is set
+      fail ArgumentError, "Missing the required parameter 'office_id' when calling OfficesApi.get_reference_counts" if office_id.nil?
+      # verify the required parameter 'account_id' is set
+      fail ArgumentError, "Missing the required parameter 'account_id' when calling OfficesApi.get_reference_counts" if account_id.nil?
+      # resource path
+      local_var_path = "/v2/accounts/{accountId}/offices/{officeId}/reference_counts".sub('{format}','json').sub('{' + 'officeId' + '}', office_id.to_s).sub('{' + 'accountId' + '}', account_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 = []
+      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 => 'OfficeReferenceCountList')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: OfficesApi#get_reference_counts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end