Class: PhoneComClient::SchedulesApi
- Inherits:
-
Object
- Object
- PhoneComClient::SchedulesApi
- Defined in:
- lib/phone_com_client/api/schedules_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#get_account_schedule(account_id, schedule_id, opts = {}) ⇒ ScheduleFull
Show details of an individual schedule Show details of an individual schedule.
-
#get_account_schedule_with_http_info(account_id, schedule_id, opts = {}) ⇒ Array<(ScheduleFull, Fixnum, Hash)>
Show details of an individual schedule Show details of an individual schedule.
-
#initialize(api_client = ApiClient.default) ⇒ SchedulesApi
constructor
A new instance of SchedulesApi.
-
#list_account_schedules(account_id, opts = {}) ⇒ ListSchedules
Get a list of schedules for an account Get a list of schedules for an account.
-
#list_account_schedules_with_http_info(account_id, opts = {}) ⇒ Array<(ListSchedules, Fixnum, Hash)>
Get a list of schedules for an account Get a list of schedules for an account.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ SchedulesApi
Returns a new instance of SchedulesApi.
19 20 21 |
# File 'lib/phone_com_client/api/schedules_api.rb', line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end |
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
17 18 19 |
# File 'lib/phone_com_client/api/schedules_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#get_account_schedule(account_id, schedule_id, opts = {}) ⇒ ScheduleFull
Show details of an individual schedule Show details of an individual schedule
28 29 30 31 |
# File 'lib/phone_com_client/api/schedules_api.rb', line 28 def get_account_schedule(account_id, schedule_id, opts = {}) data, _status_code, _headers = get_account_schedule_with_http_info(account_id, schedule_id, opts) data end |
#get_account_schedule_with_http_info(account_id, schedule_id, opts = {}) ⇒ Array<(ScheduleFull, Fixnum, Hash)>
Show details of an individual schedule Show details of an individual schedule
39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 |
# File 'lib/phone_com_client/api/schedules_api.rb', line 39 def get_account_schedule_with_http_info(account_id, schedule_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: SchedulesApi.get_account_schedule ...' end # verify the required parameter 'account_id' is set if @api_client.config.client_side_validation && account_id.nil? fail ArgumentError, "Missing the required parameter 'account_id' when calling SchedulesApi.get_account_schedule" end # verify the required parameter 'schedule_id' is set if @api_client.config.client_side_validation && schedule_id.nil? fail ArgumentError, "Missing the required parameter 'schedule_id' when calling SchedulesApi.get_account_schedule" end # resource path local_var_path = '/accounts/{account_id}/schedules/{schedule_id}'.sub('{' + 'account_id' + '}', account_id.to_s).sub('{' + 'schedule_id' + '}', schedule_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 = ['apiKey'] 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 => 'ScheduleFull') if @api_client.config.debugging @api_client.config.logger.debug "API called: SchedulesApi#get_account_schedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_account_schedules(account_id, opts = {}) ⇒ ListSchedules
Get a list of schedules for an account Get a list of schedules for an account
94 95 96 97 |
# File 'lib/phone_com_client/api/schedules_api.rb', line 94 def list_account_schedules(account_id, opts = {}) data, _status_code, _headers = list_account_schedules_with_http_info(account_id, opts) data end |
#list_account_schedules_with_http_info(account_id, opts = {}) ⇒ Array<(ListSchedules, Fixnum, Hash)>
Get a list of schedules for an account Get a list of schedules for an account
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 |
# File 'lib/phone_com_client/api/schedules_api.rb', line 111 def list_account_schedules_with_http_info(account_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: SchedulesApi.list_account_schedules ...' end # verify the required parameter 'account_id' is set if @api_client.config.client_side_validation && account_id.nil? fail ArgumentError, "Missing the required parameter 'account_id' when calling SchedulesApi.list_account_schedules" end if @api_client.config.client_side_validation && !opts[:'sort_id'].nil? && opts[:'sort_id'] !~ Regexp.new(/asc|desc/) fail ArgumentError, "invalid value for 'opts[:\"sort_id\"]' when calling SchedulesApi.list_account_schedules, must conform to the pattern /asc|desc/." end if @api_client.config.client_side_validation && !opts[:'sort_name'].nil? && opts[:'sort_name'] !~ Regexp.new(/asc|desc/) fail ArgumentError, "invalid value for 'opts[:\"sort_name\"]' when calling SchedulesApi.list_account_schedules, must conform to the pattern /asc|desc/." end # resource path local_var_path = '/accounts/{account_id}/schedules'.sub('{' + 'account_id' + '}', account_id.to_s) # query parameters query_params = {} query_params[:'filters[id]'] = @api_client.build_collection_param(opts[:'filters_id'], :multi) if !opts[:'filters_id'].nil? query_params[:'filters[name]'] = @api_client.build_collection_param(opts[:'filters_name'], :multi) if !opts[:'filters_name'].nil? query_params[:'sort[id]'] = opts[:'sort_id'] if !opts[:'sort_id'].nil? query_params[:'sort[name]'] = opts[:'sort_name'] if !opts[:'sort_name'].nil? query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil? query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].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 = ['apiKey'] 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 => 'ListSchedules') if @api_client.config.debugging @api_client.config.logger.debug "API called: SchedulesApi#list_account_schedules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |