subskribe_sandbox 1.0.0 → 1.0.1

data/lib/swagger_client/api/custom_field_api.rb

@@ -0,0 +1,434 @@
+=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 CustomFieldApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Create a custom field definition
+    # Creates a new custom field definition for your tenant. On success the id of the custom field definition is returned.
+    # @param body custom field definition values
+    # @param [Hash] opts the optional parameters
+    # @return [String]
+    def create_custom_field_definition(body, opts = {})
+      data, _status_code, _headers = create_custom_field_definition_with_http_info(body, opts)
+      data
+    end
+
+    # Create a custom field definition
+    # Creates a new custom field definition for your tenant. On success the id of the custom field definition is returned.
+    # @param body custom field definition values
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
+    def create_custom_field_definition_with_http_info(body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CustomFieldApi.create_custom_field_definition ...'
+      end
+      # verify the required parameter 'body' is set
+      if @api_client.config.client_side_validation && body.nil?
+        fail ArgumentError, "Missing the required parameter 'body' when calling CustomFieldApi.create_custom_field_definition"
+      end
+      # resource path
+      local_var_path = '/customFieldDefinition'
+
+      # 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(body)
+      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: CustomFieldApi#create_custom_field_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Delete a custom field definition
+    # Deletes an existing custom field definition for your tenant. On success the deleted custom field definition object is returned.
+    # @param id object type custom fields are attached to
+    # @param [Hash] opts the optional parameters
+    # @return [CustomFieldDefinitionJson]
+    def delete_custom_field_definition(id, opts = {})
+      data, _status_code, _headers = delete_custom_field_definition_with_http_info(id, opts)
+      data
+    end
+
+    # Delete a custom field definition
+    # Deletes an existing custom field definition for your tenant. On success the deleted custom field definition object is returned.
+    # @param id object type custom fields are attached to
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CustomFieldDefinitionJson, Fixnum, Hash)>] CustomFieldDefinitionJson data, response status code and response headers
+    def delete_custom_field_definition_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CustomFieldApi.delete_custom_field_definition ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling CustomFieldApi.delete_custom_field_definition"
+      end
+      # resource path
+      local_var_path = '/customFieldDefinition/{id}'.sub('{' + 'id' + '}', 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(:DELETE, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'CustomFieldDefinitionJson')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CustomFieldApi#delete_custom_field_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Get custom field definitions
+    # Returns all custom field definitions for a specific parent object type
+    # @param parent_object_type object type custom fields are attached to
+    # @param [Hash] opts the optional parameters
+    # @return [Array<CustomFieldDefinitionJson>]
+    def get_custom_field_definitions(parent_object_type, opts = {})
+      data, _status_code, _headers = get_custom_field_definitions_with_http_info(parent_object_type, opts)
+      data
+    end
+
+    # Get custom field definitions
+    # Returns all custom field definitions for a specific parent object type
+    # @param parent_object_type object type custom fields are attached to
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<CustomFieldDefinitionJson>, Fixnum, Hash)>] Array<CustomFieldDefinitionJson> data, response status code and response headers
+    def get_custom_field_definitions_with_http_info(parent_object_type, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CustomFieldApi.get_custom_field_definitions ...'
+      end
+      # verify the required parameter 'parent_object_type' is set
+      if @api_client.config.client_side_validation && parent_object_type.nil?
+        fail ArgumentError, "Missing the required parameter 'parent_object_type' when calling CustomFieldApi.get_custom_field_definitions"
+      end
+      # resource path
+      local_var_path = '/customFieldDefinition/{parentObjectType}'.sub('{' + 'parentObjectType' + '}', parent_object_type.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 => 'Array<CustomFieldDefinitionJson>')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CustomFieldApi#get_custom_field_definitions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Get custom fields by type and parent object id
+    # Returns all custom fields for a specific parent object type and id
+    # @param parent_object_type object type custom fields are attached to
+    # @param parent_object_id Id of the parent object
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def get_custom_fields(parent_object_type, parent_object_id, opts = {})
+      get_custom_fields_with_http_info(parent_object_type, parent_object_id, opts)
+      nil
+    end
+
+    # Get custom fields by type and parent object id
+    # Returns all custom fields for a specific parent object type and id
+    # @param parent_object_type object type custom fields are attached to
+    # @param parent_object_id Id of the parent object
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def get_custom_fields_with_http_info(parent_object_type, parent_object_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CustomFieldApi.get_custom_fields ...'
+      end
+      # verify the required parameter 'parent_object_type' is set
+      if @api_client.config.client_side_validation && parent_object_type.nil?
+        fail ArgumentError, "Missing the required parameter 'parent_object_type' when calling CustomFieldApi.get_custom_fields"
+      end
+      # verify the required parameter 'parent_object_id' is set
+      if @api_client.config.client_side_validation && parent_object_id.nil?
+        fail ArgumentError, "Missing the required parameter 'parent_object_id' when calling CustomFieldApi.get_custom_fields"
+      end
+      # resource path
+      local_var_path = '/customField/{parentObjectType}/{parentObjectId}'.sub('{' + 'parentObjectType' + '}', parent_object_type.to_s).sub('{' + 'parentObjectId' + '}', parent_object_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)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CustomFieldApi#get_custom_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Update an existing set of custom fields
+    # Updates an existing set of custom fields for a given parent object type and id. On success the update custom fields are returned.
+    # @param parent_object_type object type custom fields are attached to
+    # @param parent_object_id Id of the parent object
+    # @param custom_field_name Name of the custom field to be updated
+    # @param body custom field value
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def update_custom_field(parent_object_type, parent_object_id, custom_field_name, body, opts = {})
+      update_custom_field_with_http_info(parent_object_type, parent_object_id, custom_field_name, body, opts)
+      nil
+    end
+
+    # Update an existing set of custom fields
+    # Updates an existing set of custom fields for a given parent object type and id. On success the update custom fields are returned.
+    # @param parent_object_type object type custom fields are attached to
+    # @param parent_object_id Id of the parent object
+    # @param custom_field_name Name of the custom field to be updated
+    # @param body custom field value
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def update_custom_field_with_http_info(parent_object_type, parent_object_id, custom_field_name, body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CustomFieldApi.update_custom_field ...'
+      end
+      # verify the required parameter 'parent_object_type' is set
+      if @api_client.config.client_side_validation && parent_object_type.nil?
+        fail ArgumentError, "Missing the required parameter 'parent_object_type' when calling CustomFieldApi.update_custom_field"
+      end
+      # verify the required parameter 'parent_object_id' is set
+      if @api_client.config.client_side_validation && parent_object_id.nil?
+        fail ArgumentError, "Missing the required parameter 'parent_object_id' when calling CustomFieldApi.update_custom_field"
+      end
+      # verify the required parameter 'custom_field_name' is set
+      if @api_client.config.client_side_validation && custom_field_name.nil?
+        fail ArgumentError, "Missing the required parameter 'custom_field_name' when calling CustomFieldApi.update_custom_field"
+      end
+      # verify the required parameter 'body' is set
+      if @api_client.config.client_side_validation && body.nil?
+        fail ArgumentError, "Missing the required parameter 'body' when calling CustomFieldApi.update_custom_field"
+      end
+      # resource path
+      local_var_path = '/customField/{parentObjectType}/{parentObjectId}/{customFieldName}'.sub('{' + 'parentObjectType' + '}', parent_object_type.to_s).sub('{' + 'parentObjectId' + '}', parent_object_id.to_s).sub('{' + 'customFieldName' + '}', custom_field_name.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(body)
+      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)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CustomFieldApi#update_custom_field\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Update an existing custom field definition
+    # Updates an existing custom field definition for your tenant. On success the update custom field definition is returned.
+    # @param id 
+    # @param body custom field definition values
+    # @param [Hash] opts the optional parameters
+    # @return [CustomFieldDefinitionJson]
+    def update_custom_field_definition(id, body, opts = {})
+      data, _status_code, _headers = update_custom_field_definition_with_http_info(id, body, opts)
+      data
+    end
+
+    # Update an existing custom field definition
+    # Updates an existing custom field definition for your tenant. On success the update custom field definition is returned.
+    # @param id 
+    # @param body custom field definition values
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CustomFieldDefinitionJson, Fixnum, Hash)>] CustomFieldDefinitionJson data, response status code and response headers
+    def update_custom_field_definition_with_http_info(id, body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CustomFieldApi.update_custom_field_definition ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling CustomFieldApi.update_custom_field_definition"
+      end
+      # verify the required parameter 'body' is set
+      if @api_client.config.client_side_validation && body.nil?
+        fail ArgumentError, "Missing the required parameter 'body' when calling CustomFieldApi.update_custom_field_definition"
+      end
+      # resource path
+      local_var_path = '/customFieldDefinition/{id}'.sub('{' + 'id' + '}', 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(body)
+      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 => 'CustomFieldDefinitionJson')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CustomFieldApi#update_custom_field_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Update an existing set of custom fields
+    # Updates an existing set of custom fields for a given parent object type and id. On success the update custom fields are returned.
+    # @param parent_object_type object type custom fields are attached to
+    # @param parent_object_id Id of the parent object
+    # @param body custom field values
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def update_custom_fields(parent_object_type, parent_object_id, body, opts = {})
+      update_custom_fields_with_http_info(parent_object_type, parent_object_id, body, opts)
+      nil
+    end
+
+    # Update an existing set of custom fields
+    # Updates an existing set of custom fields for a given parent object type and id. On success the update custom fields are returned.
+    # @param parent_object_type object type custom fields are attached to
+    # @param parent_object_id Id of the parent object
+    # @param body custom field values
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def update_custom_fields_with_http_info(parent_object_type, parent_object_id, body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CustomFieldApi.update_custom_fields ...'
+      end
+      # verify the required parameter 'parent_object_type' is set
+      if @api_client.config.client_side_validation && parent_object_type.nil?
+        fail ArgumentError, "Missing the required parameter 'parent_object_type' when calling CustomFieldApi.update_custom_fields"
+      end
+      # verify the required parameter 'parent_object_id' is set
+      if @api_client.config.client_side_validation && parent_object_id.nil?
+        fail ArgumentError, "Missing the required parameter 'parent_object_id' when calling CustomFieldApi.update_custom_fields"
+      end
+      # verify the required parameter 'body' is set
+      if @api_client.config.client_side_validation && body.nil?
+        fail ArgumentError, "Missing the required parameter 'body' when calling CustomFieldApi.update_custom_fields"
+      end
+      # resource path
+      local_var_path = '/customField/{parentObjectType}/{parentObjectId}'.sub('{' + 'parentObjectType' + '}', parent_object_type.to_s).sub('{' + 'parentObjectId' + '}', parent_object_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(body)
+      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)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CustomFieldApi#update_custom_fields\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end