sib-api-v3-sdk 7.5.0 → 9.0.0

data/lib/sib-api-v3-sdk/api/files_api.rb

@@ -0,0 +1,313 @@
+=begin
+#SendinBlue API
+
+#SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to :   - Manage your campaigns and get the statistics   - Manage your contacts   - Send transactional Emails and SMS   - and much more...  You can download our wrappers at https://github.com/orgs/sendinblue  **Possible responses**   | Code | Message |   | :-------------: | ------------- |   | 200  | OK. Successful Request  |   | 201  | OK. Successful Creation |   | 202  | OK. Request accepted |   | 204  | OK. Successful Update/Deletion  |   | 400  | Error. Bad Request  |   | 401  | Error. Authentication Needed  |   | 402  | Error. Not enough credit, plan upgrade needed  |   | 403  | Error. Permission denied  |   | 404  | Error. Object does not exist |   | 405  | Error. Method not allowed  |   | 406  | Error. Not Acceptable  | 
+
+OpenAPI spec version: 3.0.0
+Contact: contact@sendinblue.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.19
+
+=end
+
+require 'uri'
+
+module SibApiV3Sdk
+  class FilesApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get all files
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :entity Filter by file entity type
+    # @option opts [String] :entity_ids Filter by file entity IDs
+    # @option opts [Integer] :date_from dateFrom to date range filter type (timestamp in milliseconds)
+    # @option opts [Integer] :date_to dateTo to date range filter type (timestamp in milliseconds)
+    # @option opts [Integer] :offset Index of the first document of the page
+    # @option opts [Integer] :limit Number of documents per page (default to 50)
+    # @option opts [String] :sort Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed
+    # @return [FileList]
+    def crm_files_get(opts = {})
+      data, _status_code, _headers = crm_files_get_with_http_info(opts)
+      data
+    end
+
+    # Get all files
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :entity Filter by file entity type
+    # @option opts [String] :entity_ids Filter by file entity IDs
+    # @option opts [Integer] :date_from dateFrom to date range filter type (timestamp in milliseconds)
+    # @option opts [Integer] :date_to dateTo to date range filter type (timestamp in milliseconds)
+    # @option opts [Integer] :offset Index of the first document of the page
+    # @option opts [Integer] :limit Number of documents per page
+    # @option opts [String] :sort Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed
+    # @return [Array<(FileList, Fixnum, Hash)>] FileList data, response status code and response headers
+    def crm_files_get_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: FilesApi.crm_files_get ...'
+      end
+      if @api_client.config.client_side_validation && opts[:'entity'] && !['companies', 'deals', 'contacts'].include?(opts[:'entity'])
+        fail ArgumentError, 'invalid value for "entity", must be one of companies, deals, contacts'
+      end
+      if @api_client.config.client_side_validation && opts[:'sort'] && !['asc', 'desc'].include?(opts[:'sort'])
+        fail ArgumentError, 'invalid value for "sort", must be one of asc, desc'
+      end
+      # resource path
+      local_var_path = '/crm/files'
+
+      # query parameters
+      query_params = {}
+      query_params[:'entity'] = opts[:'entity'] if !opts[:'entity'].nil?
+      query_params[:'entityIds'] = opts[:'entity_ids'] if !opts[:'entity_ids'].nil?
+      query_params[:'dateFrom'] = opts[:'date_from'] if !opts[:'date_from'].nil?
+      query_params[:'dateTo'] = opts[:'date_to'] if !opts[:'date_to'].nil?
+      query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
+
+      # 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 = ['api-key', 'partner-key']
+      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 => 'FileList')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: FilesApi#crm_files_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Get file details
+    # @param id File id to get file data.
+    # @param [Hash] opts the optional parameters
+    # @return [FileData]
+    def crm_files_id_data_get(id, opts = {})
+      data, _status_code, _headers = crm_files_id_data_get_with_http_info(id, opts)
+      data
+    end
+
+    # Get file details
+    # @param id File id to get file data.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(FileData, Fixnum, Hash)>] FileData data, response status code and response headers
+    def crm_files_id_data_get_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: FilesApi.crm_files_id_data_get ...'
+      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 FilesApi.crm_files_id_data_get"
+      end
+      # resource path
+      local_var_path = '/crm/files/{id}/data'.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 = nil
+      auth_names = ['api-key', 'partner-key']
+      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 => 'FileData')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: FilesApi#crm_files_id_data_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Delete a file
+    # @param id File id to delete.
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def crm_files_id_delete(id, opts = {})
+      crm_files_id_delete_with_http_info(id, opts)
+      nil
+    end
+
+    # Delete a file
+    # @param id File id to delete.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def crm_files_id_delete_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: FilesApi.crm_files_id_delete ...'
+      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 FilesApi.crm_files_id_delete"
+      end
+      # resource path
+      local_var_path = '/crm/files/{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 = nil
+      auth_names = ['api-key', 'partner-key']
+      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: FilesApi#crm_files_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Download a file
+    # @param id File id to download.
+    # @param [Hash] opts the optional parameters
+    # @return [FileDownloadableLink]
+    def crm_files_id_get(id, opts = {})
+      data, _status_code, _headers = crm_files_id_get_with_http_info(id, opts)
+      data
+    end
+
+    # Download a file
+    # @param id File id to download.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(FileDownloadableLink, Fixnum, Hash)>] FileDownloadableLink data, response status code and response headers
+    def crm_files_id_get_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: FilesApi.crm_files_id_get ...'
+      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 FilesApi.crm_files_id_get"
+      end
+      # resource path
+      local_var_path = '/crm/files/{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 = nil
+      auth_names = ['api-key', 'partner-key']
+      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 => 'FileDownloadableLink')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: FilesApi#crm_files_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Upload a file
+    # @param file File data to create a file.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :deal_id Deal id linked to a file
+    # @option opts [Integer] :contact_id Contact id linked to a file
+    # @option opts [String] :company_id Company id linked to a file
+    # @return [FileData]
+    def crm_files_post(file, opts = {})
+      data, _status_code, _headers = crm_files_post_with_http_info(file, opts)
+      data
+    end
+
+    # Upload a file
+    # @param file File data to create a file.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :deal_id Deal id linked to a file
+    # @option opts [Integer] :contact_id Contact id linked to a file
+    # @option opts [String] :company_id Company id linked to a file
+    # @return [Array<(FileData, Fixnum, Hash)>] FileData data, response status code and response headers
+    def crm_files_post_with_http_info(file, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: FilesApi.crm_files_post ...'
+      end
+      # verify the required parameter 'file' is set
+      if @api_client.config.client_side_validation && file.nil?
+        fail ArgumentError, "Missing the required parameter 'file' when calling FilesApi.crm_files_post"
+      end
+      # resource path
+      local_var_path = '/crm/files'
+
+      # 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'] = file
+      form_params['dealId'] = opts[:'deal_id'] if !opts[:'deal_id'].nil?
+      form_params['contactId'] = opts[:'contact_id'] if !opts[:'contact_id'].nil?
+      form_params['companyId'] = opts[:'company_id'] if !opts[:'company_id'].nil?
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['api-key', 'partner-key']
+      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 => 'FileData')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: FilesApi#crm_files_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/sib-api-v3-sdk/api/inbound_parsing_api.rb

@@ -0,0 +1,213 @@
+=begin
+#SendinBlue API
+
+#SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to :   - Manage your campaigns and get the statistics   - Manage your contacts   - Send transactional Emails and SMS   - and much more...  You can download our wrappers at https://github.com/orgs/sendinblue  **Possible responses**   | Code | Message |   | :-------------: | ------------- |   | 200  | OK. Successful Request  |   | 201  | OK. Successful Creation |   | 202  | OK. Request accepted |   | 204  | OK. Successful Update/Deletion  |   | 400  | Error. Bad Request  |   | 401  | Error. Authentication Needed  |   | 402  | Error. Not enough credit, plan upgrade needed  |   | 403  | Error. Permission denied  |   | 404  | Error. Object does not exist |   | 405  | Error. Method not allowed  |   | 406  | Error. Not Acceptable  | 
+
+OpenAPI spec version: 3.0.0
+Contact: contact@sendinblue.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.19
+
+=end
+
+require 'uri'
+
+module SibApiV3Sdk
+  class InboundParsingApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+    # Set custom user_agent if explicitly passed in api
+    # default will still remain Swagger-Codegen/#{VERSION}/ruby
+    def setUserAgent(user_agent)
+      @user_agent = user_agent
+      if user_agent.is_a?(String) && user_agent.downcase.start_with?('sendinblue_')
+        @api_client.default_headers['User-Agent'] = @user_agent
+      end
+    end
+    # Retrieve inbound attachment with download token.
+    # This endpoint will retrieve inbound attachment with download token.
+    # @param download_token Token to fetch a particular attachment
+    # @param [Hash] opts the optional parameters
+    # @return [File]
+    def get_inbound_email_attachment(download_token, opts = {})
+      data, _status_code, _headers = get_inbound_email_attachment_with_http_info(download_token, opts)
+      data
+    end
+
+    # Retrieve inbound attachment with download token.
+    # This endpoint will retrieve inbound attachment with download token.
+    # @param download_token Token to fetch a particular attachment
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(File, Fixnum, Hash)>] File data, response status code and response headers
+    def get_inbound_email_attachment_with_http_info(download_token, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InboundParsingApi.get_inbound_email_attachment ...'
+      end
+      # verify the required parameter 'download_token' is set
+      if @api_client.config.client_side_validation && download_token.nil?
+        fail ArgumentError, "Missing the required parameter 'download_token' when calling InboundParsingApi.get_inbound_email_attachment"
+      end
+      # resource path
+      local_var_path = '/inbound/attachments/{downloadToken}'.sub('{' + 'downloadToken' + '}', download_token.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 = ['api-key', 'partner-key']
+      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 => 'File')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: InboundParsingApi#get_inbound_email_attachment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Get the list of all the events for the received emails.
+    # This endpoint will show the list of all the events for the received emails.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :sender Email address of the sender.
+    # @option opts [Date] :start_date Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Maximum time period that can be selected is one month.
+    # @option opts [Date] :end_date Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.
+    # @option opts [Integer] :limit Number of documents returned per page (default to 100)
+    # @option opts [Integer] :offset Index of the first document on the page (default to 0)
+    # @option opts [String] :sort Sort the results in the ascending/descending order of record creation (default to desc)
+    # @return [GetInboundEmailEvents]
+    def get_inbound_email_events(opts = {})
+      data, _status_code, _headers = get_inbound_email_events_with_http_info(opts)
+      data
+    end
+
+    # Get the list of all the events for the received emails.
+    # This endpoint will show the list of all the events for the received emails.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :sender Email address of the sender.
+    # @option opts [Date] :start_date Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Maximum time period that can be selected is one month.
+    # @option opts [Date] :end_date Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.
+    # @option opts [Integer] :limit Number of documents returned per page
+    # @option opts [Integer] :offset Index of the first document on the page
+    # @option opts [String] :sort Sort the results in the ascending/descending order of record creation
+    # @return [Array<(GetInboundEmailEvents, Fixnum, Hash)>] GetInboundEmailEvents data, response status code and response headers
+    def get_inbound_email_events_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InboundParsingApi.get_inbound_email_events ...'
+      end
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 500
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling InboundParsingApi.get_inbound_email_events, must be smaller than or equal to 500.'
+      end
+
+      if @api_client.config.client_side_validation && opts[:'sort'] && !['asc', 'desc'].include?(opts[:'sort'])
+        fail ArgumentError, 'invalid value for "sort", must be one of asc, desc'
+      end
+      # resource path
+      local_var_path = '/inbound/events'
+
+      # query parameters
+      query_params = {}
+      query_params[:'sender'] = opts[:'sender'] if !opts[:'sender'].nil?
+      query_params[:'startDate'] = opts[:'start_date'] if !opts[:'start_date'].nil?
+      query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
+      query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
+
+      # 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 = ['api-key', 'partner-key']
+      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 => 'GetInboundEmailEvents')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: InboundParsingApi#get_inbound_email_events\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Fetch all events history for one particular received email.
+    # This endpoint will show the list of all events history for one particular received email.
+    # @param uuid UUID to fetch events specific to recieved email
+    # @param [Hash] opts the optional parameters
+    # @return [GetInboundEmailEventsByUuid]
+    def get_inbound_email_events_by_uuid(uuid, opts = {})
+      data, _status_code, _headers = get_inbound_email_events_by_uuid_with_http_info(uuid, opts)
+      data
+    end
+
+    # Fetch all events history for one particular received email.
+    # This endpoint will show the list of all events history for one particular received email.
+    # @param uuid UUID to fetch events specific to recieved email
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GetInboundEmailEventsByUuid, Fixnum, Hash)>] GetInboundEmailEventsByUuid data, response status code and response headers
+    def get_inbound_email_events_by_uuid_with_http_info(uuid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InboundParsingApi.get_inbound_email_events_by_uuid ...'
+      end
+      # verify the required parameter 'uuid' is set
+      if @api_client.config.client_side_validation && uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'uuid' when calling InboundParsingApi.get_inbound_email_events_by_uuid"
+      end
+      # resource path
+      local_var_path = '/inbound/events/{uuid}'.sub('{' + 'uuid' + '}', uuid.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 = ['api-key', 'partner-key']
+      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 => 'GetInboundEmailEventsByUuid')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: InboundParsingApi#get_inbound_email_events_by_uuid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end