Class: Readiness::Zendesk::GroupMemberships

Inherits:
Client
  • Object
show all
Defined in:
lib/support_readiness/zendesk/group_memberships.rb

Overview

Defines the class GroupMemberships within the module Readiness::Zendesk.

Author:

  • Jason Colyer

Since:

  • 1.0.0

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Client

auth_error, bad_request_error, convert_actions, convert_conditions, convert_standard_names_to_ids, convert_ticket_form_agent_conditions, convert_ticket_form_brands, convert_ticket_form_end_user_conditions, convert_ticket_form_names_to_ids, convert_view_names_to_ids, convert_view_restrictions, covert_ticket_form_field_ids, create_package!, erb_renderer, handle_request_error, not_found_error, not_processible_error, put_into_archive, recursively_deflate_directory, timestamp_filename, to_clean_json, to_clean_json_with_key, to_hash, to_nearly_clean_json, to_nearly_clean_json_with_key, to_param_string, write_entries

Constructor Details

#initialize(object = {}) ⇒ GroupMemberships

Creates a new Readiness::Zendesk::GroupMemberships instance

Examples:

require 'support_readiness'
Readiness::Zendesk::GroupMemberships.new

Parameters:

Author:

  • Jason Colyer

Since:

  • 1.0.0



24
25
26
27
28
29
 
# File 'lib/support_readiness/zendesk/group_memberships.rb', line 24

def initialize(object = {})
  @id = object['id']
  @default = object['default']
  @group_id = object['group_id']
  @user_id = object['user_id']
end

Instance Attribute Details

#default ⇒ Object

Since:

  • 1.0.0



13
14
15
 
# File 'lib/support_readiness/zendesk/group_memberships.rb', line 13

def default
  @default
end

#group_id ⇒ Object

Since:

  • 1.0.0



13
14
15
 
# File 'lib/support_readiness/zendesk/group_memberships.rb', line 13

def group_id
  @group_id
end

#id ⇒ Object

Since:

  • 1.0.0



13
14
15
 
# File 'lib/support_readiness/zendesk/group_memberships.rb', line 13

def id
  @id
end

#user_id ⇒ Object

Since:

  • 1.0.0



13
14
15
 
# File 'lib/support_readiness/zendesk/group_memberships.rb', line 13

def user_id
  @user_id
end

Class Method Details

.create!(client, membership) ⇒ Object

Creates an organization membership. Will exit if unsuccessful

Examples:

require 'support_readiness'
config = Readiness::Zendesk::Configuration.new
config.username = 'alice@example.com'
config.token = 'test123abc'
config.url = 'https://example.zendesk.com/api/v2'
client = Readiness::Zendesk::Client.new(config)
membership = Readiness::Zendesk::GroupMemberships.new
membership.user_id = 72
membership.group_id: 88
create = Readiness::Zendesk::GroupMemberships.create!(client, membership)
pp create.id
# => 461

Parameters:

Returns:

See Also:

Author:

  • Jason Colyer

Since:

  • 1.0.0



165
166
167
168
169
 
# File 'lib/support_readiness/zendesk/group_memberships.rb', line 165

def self.create!(client, membership)
  response = client.connection.post 'group_memberships', to_clean_json_with_key(membership, 'group_membership')
  handle_request_error(1, 'Zendesk', response.status, { action: 'Create group membership', message: Oj.load(response.body)}) unless response.status == 201
  GroupMemberships.new(Oj.load(response.body)['group_membership'])
end

.create_many!(client, memberships) ⇒ object

Creates multiple organization memberships via a batch job

Examples:

require 'support_readiness'
config = Readiness::Zendesk::Configuration.new
config.username = 'alice@example.com'
config.token = 'test123abc'
config.url = 'https://example.zendesk.com/api/v2'
client = Readiness::Zendesk::Client.new(config)
membership1 = Readiness::Zendesk::GroupMemberships.new
membership1.user_id = 72
membership1.group_id: 88
membership2 = Readiness::Zendesk::GroupMemberships.new
membership2.user_id = 27
membership2.group_id: 88
memberships = [membership1, membership2]
create = Readiness::Zendesk::GroupMemberships.create_many!(client, memberships)
pp create.id
# => "82de0b044094f0c67893ac9fe64f1a99"

Parameters:

Returns:

See Also:

Author:

  • Jason Colyer

Since:

  • 1.0.0



197
198
199
200
201
202
 
# File 'lib/support_readiness/zendesk/group_memberships.rb', line 197

def self.create_many!(client, memberships)
  data = { group_memberships: memberships.map { |t| to_hash(t).compact } }.to_json
  response = client.connection.post('group_memberships/create_many', data)
  handle_request_error(1, 'Zendesk', response.status, { action: 'Create many group memberships', message: Oj.load(response.body)}) unless response.status == 200
  JobStatuses.new(Oj.load(response.body)['job_status'])
end

.delete!(client, membership) ⇒ Boolean

Deletes an group membership. Will exit if unsuccessful

Examples:

require 'support_readiness'
config = Readiness::Zendesk::Configuration.new
config.username = 'alice@example.com'
config.token = 'test123abc'
config.url = 'https://example.zendesk.com/api/v2'
client = Readiness::Zendesk::Client.new(config)
membership = Readiness::Zendesk::GroupMemberships.find!(client, 4)
delete = Readiness::Zendesk::GroupMemberships.delete!(client, membership)
pp delete
# => true

Parameters:

Returns:

  • (Boolean)

See Also:

Author:

  • Jason Colyer

Since:

  • 1.0.0



224
225
226
227
228
 
# File 'lib/support_readiness/zendesk/group_memberships.rb', line 224

def self.delete!(client, membership)
  response = client.connection.delete "group_memberships/#{membership.id}"
  handle_request_error(1, 'Zendesk', response.status, { action: 'Delete group membership', message: Oj.load(response.body)}) unless response.status == 204
  true
end

.delete_many!(client, mids) ⇒ object

Deletes multiple organization memberships via a batch job

Examples:

require 'support_readiness'
config = Readiness::Zendesk::Configuration.new
config.username = 'alice@example.com'
config.token = 'test123abc'
config.url = 'https://example.zendesk.com/api/v2'
client = Readiness::Zendesk::Client.new(config)
delete = Readiness::Zendesk::GroupMemberships.delete_many!(client, [1, 2, 3])
pp delete.id
# => "82de0b044094f0c67893ac9fe64f1a99"

Parameters:

  • client (Object) —

    An instance of Client

  • mids (Array) —

    An array of group memberships IDs

Returns:

See Also:

Author:

  • Jason Colyer

Since:

  • 1.0.0



249
250
251
252
253
 
# File 'lib/support_readiness/zendesk/group_memberships.rb', line 249

def self.delete_many!(client, mids)
  response = client.connection.delete("group_memberships/destroy_many?ids=#{mids.join(',')}")
  handle_request_error(1, 'Zendesk', response.status, { action: 'Delete many group memberships', message: Oj.load(response.body)}) unless response.status == 200
  JobStatuses.new(Oj.load(response.body)['job_status'])
end

.find(client, gid) ⇒ Hash

Locates a group membership within Zendesk. This will not exit on error (except Authentication errors)

Examples:

require 'support_readiness'
config = Readiness::Zendesk::Configuration.new
config.username = 'alice@example.com'
config.token = 'test123abc'
config.url = 'https://example.zendesk.com/api/v2'
client = Readiness::Zendesk::Client.new(config)
membership = Readiness::Zendesk::GroupMemberships.find(client, 4)
pp membership.user_id
# => 29

Parameters:

  • client (Object) —

    An instance of Client

  • gid (Integer) —

    The group membership ID to find

Returns:

  • (Hash)

See Also:

Author:

  • Jason Colyer

Since:

  • 1.0.0



110
111
112
113
114
115
116
 
# File 'lib/support_readiness/zendesk/group_memberships.rb', line 110

def self.find(client, gid)
  response = client.connection.get("group_memberships/#{gid}")
  handle_request_error(0, 'Zendesk', response.status,  { action: 'get', id: gid }) unless response.status == 200
  return GroupMemberships.new(Oj.load(response.body)['group_membership']) if response.status == 200

  Oj.load(response.body)
end

.find!(client, gid) ⇒ Hash

Locates a group membership within Zendesk. This will exit on error

Examples:

require 'support_readiness'
config = Readiness::Zendesk::Configuration.new
config.username = 'alice@example.com'
config.token = 'test123abc'
config.url = 'https://example.zendesk.com/api/v2'
client = Readiness::Zendesk::Client.new(config)
membership = Readiness::Zendesk::GroupMemberships.find!(client, 4)
pp membership.user_id
# => 29

Parameters:

  • client (Object) —

    An instance of Client

  • gid (Integer) —

    The group membership ID to find

Returns:

  • (Hash)

See Also:

Author:

  • Jason Colyer

Since:

  • 1.0.0



137
138
139
140
141
 
# File 'lib/support_readiness/zendesk/group_memberships.rb', line 137

def self.find!(client, gid)
  response = client.connection.get("group_memberships/#{gid}")
  handle_request_error(1, 'Zendesk', response.status, { action: 'Find group membership', id: gid }) unless response.status == 200
  GroupMemberships.new(Oj.load(response.body)['group_membership'])
end

.list(client) ⇒ Array

Lists the first 100 group memberships

Examples:

require 'support_readiness'
config = Readiness::Zendesk::Configuration.new
config.username = 'alice@example.com'
config.token = 'test123abc'
config.url = 'https://example.zendesk.com/api/v2'
client = Readiness::Zendesk::Client.new(config)
memberships = Readiness::Zendesk::GroupMemberships.list(client)
pp memberships.first.id
# => 4

Parameters:

  • client (Object) —

    An instance of Client

Returns:

  • (Array)

See Also:

Author:

  • Jason Colyer

Since:

  • 1.0.0



49
50
51
52
53
 
# File 'lib/support_readiness/zendesk/group_memberships.rb', line 49

def self.list(client)
  response = client.connection.get("group_memberships?page[size]=100")
  handle_request_error(0, 'Zendesk', response.status) unless response.status == 200
  Oj.load(response.body)['group_memberships'].map { |m| GroupMemberships.new(m) }
end

.list_many(client, limit = 0) ⇒ Array

Lists many group memberships. Does not stop until it ends or the page limit is hit. This method can take a long time to run depending on the parameters used.

Examples:

require 'support_readiness'
config = Readiness::Zendesk::Configuration.new
config.username = 'alice@example.com'
config.token = 'test123abc'
config.url = 'https://example.zendesk.com/api/v2'
client = Readiness::Zendesk::Client.new(config)
memberships = Readiness::Zendesk::GroupMemberships.list_many(client)
pp memberships.first.id
# => 4

Parameters:

  • client (Object) —

    An instance of Client

  • limit (Integer) (defaults to: 0) —

    The number of pages to stop at. Using 0 means to list all.

Returns:

  • (Array)

See Also:

Author:

  • Jason Colyer

Since:

  • 1.0.0



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/support_readiness/zendesk/group_memberships.rb', line 75

def self.list_many(client, limit = 0)
  array = []
  opts = "page[size]=100"
  loop do
    response = client.connection.get("group_memberships?#{opts}")
    handle_request_error(0, 'Zendesk', response.status) unless response.status == 200
    body = Oj.load(response.body)
    array += body['group_memberships'].map { |o| GroupMemberships.new(o) }
    break if limit != 0 && array.count >= (limit * 100)
    break unless body['meta']['has_more']

    opts = body['links'] ['next'].split('?').last
  end
  array
end