Class: SunshineConversationsClient::ClientsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/sunshine-conversations-client/api/clients_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ClientsApi

Returns a new instance of ClientsApi.



16
17
18
 
# File 'lib/sunshine-conversations-client/api/clients_api.rb', line 16

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



14
15
16
 
# File 'lib/sunshine-conversations-client/api/clients_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#create_client(app_id, user_id_or_external_id, client_create, opts = {}) ⇒ ClientResponse

Create Client Create a client and link it to a channel specified by the ‘matchCriteria.type`. Note that the client is initially created with a `pending` status. The status of the linking request can be tracked by listening to the `client:add`, `client:update` and `client:removed` webhooks. For more information, see [channel transfer](developer.zendesk.com/documentation/conversations/messaging-platform/programmable-conversations/channel-transfer/).

Parameters:

  • app_id (String) —

    Identifies the app.

  • user_id_or_external_id (String) —

    The user's id or externalId.

  • client_create (ClientCreate)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



26
27
28
29
 
# File 'lib/sunshine-conversations-client/api/clients_api.rb', line 26

def create_client(app_id, user_id_or_external_id, client_create, opts = {})
  data, _status_code, _headers = create_client_with_http_info(app_id, user_id_or_external_id, client_create, opts)
  data
end

#create_client_with_http_info(app_id, user_id_or_external_id, client_create, opts = {}) ⇒ Array<(ClientResponse, Integer, Hash)>

Create Client Create a client and link it to a channel specified by the &#x60;matchCriteria.type&#x60;. Note that the client is initially created with a &#x60;pending&#x60; status. The status of the linking request can be tracked by listening to the &#x60;client:add&#x60;, &#x60;client:update&#x60; and &#x60;client:removed&#x60; webhooks. For more information, see [channel transfer](developer.zendesk.com/documentation/conversations/messaging-platform/programmable-conversations/channel-transfer/).

Parameters:

  • app_id (String) —

    Identifies the app.

  • user_id_or_external_id (String) —

    The user&#39;s id or externalId.

  • client_create (ClientCreate)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ClientResponse, Integer, Hash)>) —

    ClientResponse data, response status code and response headers



38
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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/sunshine-conversations-client/api/clients_api.rb', line 38

def create_client_with_http_info(app_id, user_id_or_external_id, client_create, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ClientsApi.create_client ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling ClientsApi.create_client"
  end
  # verify the required parameter 'user_id_or_external_id' is set
  if @api_client.config.client_side_validation && user_id_or_external_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id_or_external_id' when calling ClientsApi.create_client"
  end
  # verify the required parameter 'client_create' is set
  if @api_client.config.client_side_validation && client_create.nil?
    fail ArgumentError, "Missing the required parameter 'client_create' when calling ClientsApi.create_client"
  end
  # resource path
  local_var_path = '/v2/apps/{appId}/users/{userIdOrExternalId}/clients'.sub('{' + 'appId' + '}', CGI.escape(app_id.to_s)).sub('{' + 'userIdOrExternalId' + '}', CGI.escape(user_id_or_external_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(client_create)

  # return_type
  return_type = opts[:debug_return_type] || 'ClientResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth', 'bearerAuth']

  new_options = opts.merge(
    :operation => :"ClientsApi.create_client",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ClientsApi#create_client\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_clients(app_id, user_id_or_external_id, opts = {}) ⇒ ClientListResponse

List Clients Get all the clients for a particular user, including both linked clients and pending clients. This API is paginated through [cursor pagination](#section/Introduction/API-Pagination-and-Records-Limits). “‘shell /v2/apps/:appId/users/:userId/clients?page=5ebee0975ac5304b664a12fa “`

Parameters:

  • app_id (String) —

    Identifies the app.

  • user_id_or_external_id (String) —

    The user&#39;s id or externalId.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Page) —

    Contains parameters for applying cursor pagination.

Returns:



106
107
108
109
 
# File 'lib/sunshine-conversations-client/api/clients_api.rb', line 106

def list_clients(app_id, user_id_or_external_id, opts = {})
  data, _status_code, _headers = list_clients_with_http_info(app_id, user_id_or_external_id, opts)
  data
end

#list_clients_with_http_info(app_id, user_id_or_external_id, opts = {}) ⇒ Array<(ClientListResponse, Integer, Hash)>

List Clients Get all the clients for a particular user, including both linked clients and pending clients. This API is paginated through [cursor pagination](#section/Introduction/API-Pagination-and-Records-Limits). &#x60;&#x60;&#x60;shell /v2/apps/:appId/users/:userId/clients?page&#x3D;5ebee0975ac5304b664a12fa &#x60;&#x60;&#x60;

Parameters:

  • app_id (String) —

    Identifies the app.

  • user_id_or_external_id (String) —

    The user&#39;s id or externalId.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Page) —

    Contains parameters for applying cursor pagination.

Returns:

  • (Array<(ClientListResponse, Integer, Hash)>) —

    ClientListResponse data, response status code and response headers



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
165
166
167
168
169
 
# File 'lib/sunshine-conversations-client/api/clients_api.rb', line 118

def list_clients_with_http_info(app_id, user_id_or_external_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ClientsApi.list_clients ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling ClientsApi.list_clients"
  end
  # verify the required parameter 'user_id_or_external_id' is set
  if @api_client.config.client_side_validation && user_id_or_external_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id_or_external_id' when calling ClientsApi.list_clients"
  end
  # resource path
  local_var_path = '/v2/apps/{appId}/users/{userIdOrExternalId}/clients'.sub('{' + 'appId' + '}', CGI.escape(app_id.to_s)).sub('{' + 'userIdOrExternalId' + '}', CGI.escape(user_id_or_external_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ClientListResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth', 'bearerAuth']

  new_options = opts.merge(
    :operation => :"ClientsApi.list_clients",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ClientsApi#list_clients\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#remove_client(app_id, user_id_or_external_id, client_id, opts = {}) ⇒ Object

Remove Client Remove a particular client and unsubscribe it from all connected conversations.

Parameters:

  • app_id (String) —

    Identifies the app.

  • user_id_or_external_id (String) —

    The user&#39;s id or externalId.

  • client_id (String) —

    The client&#39;s id.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Object) 


178
179
180
181
 
# File 'lib/sunshine-conversations-client/api/clients_api.rb', line 178

def remove_client(app_id, user_id_or_external_id, client_id, opts = {})
  data, _status_code, _headers = remove_client_with_http_info(app_id, user_id_or_external_id, client_id, opts)
  data
end

#remove_client_with_http_info(app_id, user_id_or_external_id, client_id, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Remove Client Remove a particular client and unsubscribe it from all connected conversations.

Parameters:

  • app_id (String) —

    Identifies the app.

  • user_id_or_external_id (String) —

    The user&#39;s id or externalId.

  • client_id (String) —

    The client&#39;s id.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/sunshine-conversations-client/api/clients_api.rb', line 190

def remove_client_with_http_info(app_id, user_id_or_external_id, client_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ClientsApi.remove_client ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling ClientsApi.remove_client"
  end
  # verify the required parameter 'user_id_or_external_id' is set
  if @api_client.config.client_side_validation && user_id_or_external_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id_or_external_id' when calling ClientsApi.remove_client"
  end
  # verify the required parameter 'client_id' is set
  if @api_client.config.client_side_validation && client_id.nil?
    fail ArgumentError, "Missing the required parameter 'client_id' when calling ClientsApi.remove_client"
  end
  # resource path
  local_var_path = '/v2/apps/{appId}/users/{userIdOrExternalId}/clients/{clientId}'.sub('{' + 'appId' + '}', CGI.escape(app_id.to_s)).sub('{' + 'userIdOrExternalId' + '}', CGI.escape(user_id_or_external_id.to_s)).sub('{' + 'clientId' + '}', CGI.escape(client_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth', 'bearerAuth']

  new_options = opts.merge(
    :operation => :"ClientsApi.remove_client",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ClientsApi#remove_client\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end