OAIGroupControllerApi

All URIs are relative to https://api.mailslurp.com

Method	HTTP request	Description
addContactsToGroup	PUT /groups/{groupId}/contacts	Add contacts to a group
createGroup	POST /groups	Create a group
deleteGroup	DELETE /groups/{groupId}	Delete group
getAllGroups	GET /groups/paginated	Get all Contact Groups in paginated format
getGroup	GET /groups/{groupId}	Get group
getGroupWithContacts	GET /groups/{groupId}/contacts	Get group and contacts belonging to it
getGroupWithContactsPaginated	GET /groups/{groupId}/contacts-paginated
getGroups	GET /groups	Get all groups
removeContactsFromGroup	DELETE /groups/{groupId}/contacts	Remove contacts from a group

-(NSURLSessionTask*) addContactsToGroupWithGroupId: (NSString*) groupId
    updateGroupContacts: (OAIUpdateGroupContacts*) updateGroupContacts
        completionHandler: (void (^)(OAIGroupContactsDto* output, NSError* error)) handler;

Add contacts to a group

Example

OAIDefaultConfiguration *apiConfig = [OAIDefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: API_KEY)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];


NSString* groupId = @"groupId_example"; // 
OAIUpdateGroupContacts* updateGroupContacts = [[OAIUpdateGroupContacts alloc] init]; // 

OAIGroupControllerApi*apiInstance = [[OAIGroupControllerApi alloc] init];

// Add contacts to a group
[apiInstance addContactsToGroupWithGroupId:groupId
              updateGroupContacts:updateGroupContacts
          completionHandler: ^(OAIGroupContactsDto* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling OAIGroupControllerApi->addContactsToGroup: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
groupId	NSString*
updateGroupContacts	OAIUpdateGroupContacts*

Return type

OAIGroupContactsDto*

Authorization

API_KEY

HTTP request headers

Content-Type: application/json
Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]

-(NSURLSessionTask*) createGroupWithCreateGroupOptions: (OAICreateGroupOptions*) createGroupOptions
        completionHandler: (void (^)(OAIGroupDto* output, NSError* error)) handler;

Create a group

Example

OAIDefaultConfiguration *apiConfig = [OAIDefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: API_KEY)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];


OAICreateGroupOptions* createGroupOptions = [[OAICreateGroupOptions alloc] init]; // 

OAIGroupControllerApi*apiInstance = [[OAIGroupControllerApi alloc] init];

// Create a group
[apiInstance createGroupWithCreateGroupOptions:createGroupOptions
          completionHandler: ^(OAIGroupDto* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling OAIGroupControllerApi->createGroup: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
createGroupOptions	OAICreateGroupOptions*

Return type

OAIGroupDto*

Authorization

API_KEY

HTTP request headers

Content-Type: application/json
Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]

-(NSURLSessionTask*) deleteGroupWithGroupId: (NSString*) groupId
        completionHandler: (void (^)(NSError* error)) handler;

Delete group

Example

OAIDefaultConfiguration *apiConfig = [OAIDefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: API_KEY)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];


NSString* groupId = @"groupId_example"; // 

OAIGroupControllerApi*apiInstance = [[OAIGroupControllerApi alloc] init];

// Delete group
[apiInstance deleteGroupWithGroupId:groupId
          completionHandler: ^(NSError* error) {
                        if (error) {
                            NSLog(@"Error calling OAIGroupControllerApi->deleteGroup: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
groupId	NSString*

Return type

void (empty response body)

Authorization

API_KEY

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to ]

-(NSURLSessionTask*) getAllGroupsWithPage: (NSNumber*) page
    size: (NSNumber*) size
    sort: (NSString*) sort
    since: (NSDate*) since
    before: (NSDate*) before
        completionHandler: (void (^)(OAIPageGroupProjection* output, NSError* error)) handler;

Get all Contact Groups in paginated format

Example

OAIDefaultConfiguration *apiConfig = [OAIDefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: API_KEY)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];


NSNumber* page = @0; // Optional page  in list pagination (optional) (default to @0)
NSNumber* size = @20; // Optional page size in list pagination (optional) (default to @20)
NSString* sort = @"ASC"; // Optional createdAt sort direction ASC or DESC (optional) (default to @"ASC")
NSDate* since = @"2013-10-20T19:20:30+01:00"; // Filter by created at after the given timestamp (optional)
NSDate* before = @"2013-10-20T19:20:30+01:00"; // Filter by created at before the given timestamp (optional)

OAIGroupControllerApi*apiInstance = [[OAIGroupControllerApi alloc] init];

// Get all Contact Groups in paginated format
[apiInstance getAllGroupsWithPage:page
              size:size
              sort:sort
              since:since
              before:before
          completionHandler: ^(OAIPageGroupProjection* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling OAIGroupControllerApi->getAllGroups: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
page	NSNumber*	Optional page in list pagination	[optional] [default to @0]
size	NSNumber*	Optional page size in list pagination	[optional] [default to @20]
sort	NSString*	Optional createdAt sort direction ASC or DESC	[optional] [default to @"ASC"]
since	NSDate*	Filter by created at after the given timestamp	[optional]
before	NSDate*	Filter by created at before the given timestamp	[optional]

Return type

OAIPageGroupProjection*

Authorization

API_KEY

HTTP request headers

Content-Type: Not defined
Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]

-(NSURLSessionTask*) getGroupWithGroupId: (NSString*) groupId
        completionHandler: (void (^)(OAIGroupDto* output, NSError* error)) handler;

Get group

Example

OAIDefaultConfiguration *apiConfig = [OAIDefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: API_KEY)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];


NSString* groupId = @"groupId_example"; // 

OAIGroupControllerApi*apiInstance = [[OAIGroupControllerApi alloc] init];

// Get group
[apiInstance getGroupWithGroupId:groupId
          completionHandler: ^(OAIGroupDto* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling OAIGroupControllerApi->getGroup: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
groupId	NSString*

Return type

OAIGroupDto*

Authorization

API_KEY

HTTP request headers

Content-Type: Not defined
Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]

-(NSURLSessionTask*) getGroupWithContactsWithGroupId: (NSString*) groupId
        completionHandler: (void (^)(OAIGroupContactsDto* output, NSError* error)) handler;

Get group and contacts belonging to it

Example

OAIDefaultConfiguration *apiConfig = [OAIDefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: API_KEY)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];


NSString* groupId = @"groupId_example"; // 

OAIGroupControllerApi*apiInstance = [[OAIGroupControllerApi alloc] init];

// Get group and contacts belonging to it
[apiInstance getGroupWithContactsWithGroupId:groupId
          completionHandler: ^(OAIGroupContactsDto* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling OAIGroupControllerApi->getGroupWithContacts: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
groupId	NSString*

Return type

OAIGroupContactsDto*

Authorization

API_KEY

HTTP request headers

Content-Type: Not defined
Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]

-(NSURLSessionTask*) getGroupWithContactsPaginatedWithGroupId: (NSString*) groupId
    page: (NSNumber*) page
    size: (NSNumber*) size
    sort: (NSString*) sort
    since: (NSDate*) since
    before: (NSDate*) before
        completionHandler: (void (^)(OAIPageContactProjection* output, NSError* error)) handler;

Get group and paginated contacts belonging to it

Example

OAIDefaultConfiguration *apiConfig = [OAIDefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: API_KEY)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];


NSString* groupId = @"groupId_example"; // 
NSNumber* page = @0; // Optional page  in group contact pagination (optional) (default to @0)
NSNumber* size = @20; // Optional page size in group contact pagination (optional) (default to @20)
NSString* sort = @"ASC"; // Optional createdAt sort direction ASC or DESC (optional) (default to @"ASC")
NSDate* since = @"2013-10-20T19:20:30+01:00"; // Filter by created at after the given timestamp (optional)
NSDate* before = @"2013-10-20T19:20:30+01:00"; // Filter by created at before the given timestamp (optional)

OAIGroupControllerApi*apiInstance = [[OAIGroupControllerApi alloc] init];

[apiInstance getGroupWithContactsPaginatedWithGroupId:groupId
              page:page
              size:size
              sort:sort
              since:since
              before:before
          completionHandler: ^(OAIPageContactProjection* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling OAIGroupControllerApi->getGroupWithContactsPaginated: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
groupId	NSString*
page	NSNumber*	Optional page in group contact pagination	[optional] [default to @0]
size	NSNumber*	Optional page size in group contact pagination	[optional] [default to @20]
sort	NSString*	Optional createdAt sort direction ASC or DESC	[optional] [default to @"ASC"]
since	NSDate*	Filter by created at after the given timestamp	[optional]
before	NSDate*	Filter by created at before the given timestamp	[optional]

Return type

OAIPageContactProjection*

Authorization

API_KEY

HTTP request headers

Content-Type: Not defined
Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]

-(NSURLSessionTask*) getGroupsWithCompletionHandler: 
        (void (^)(NSArray<OAIGroupProjection>* output, NSError* error)) handler;

Get all groups

Example

OAIDefaultConfiguration *apiConfig = [OAIDefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: API_KEY)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];



OAIGroupControllerApi*apiInstance = [[OAIGroupControllerApi alloc] init];

// Get all groups
[apiInstance getGroupsWithCompletionHandler: 
          ^(NSArray<OAIGroupProjection>* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling OAIGroupControllerApi->getGroups: %@", error);
                        }
                    }];

Parameters

This endpoint does not need any parameter.

Return type

NSArray*

Authorization

API_KEY

HTTP request headers

Content-Type: Not defined
Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]

-(NSURLSessionTask*) removeContactsFromGroupWithGroupId: (NSString*) groupId
    updateGroupContacts: (OAIUpdateGroupContacts*) updateGroupContacts
        completionHandler: (void (^)(OAIGroupContactsDto* output, NSError* error)) handler;

Remove contacts from a group

Example

OAIDefaultConfiguration *apiConfig = [OAIDefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: API_KEY)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];


NSString* groupId = @"groupId_example"; // 
OAIUpdateGroupContacts* updateGroupContacts = [[OAIUpdateGroupContacts alloc] init]; // 

OAIGroupControllerApi*apiInstance = [[OAIGroupControllerApi alloc] init];

// Remove contacts from a group
[apiInstance removeContactsFromGroupWithGroupId:groupId
              updateGroupContacts:updateGroupContacts
          completionHandler: ^(OAIGroupContactsDto* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling OAIGroupControllerApi->removeContactsFromGroup: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
groupId	NSString*
updateGroupContacts	OAIUpdateGroupContacts*

Return type

OAIGroupContactsDto*

Authorization

API_KEY

HTTP request headers

Content-Type: application/json
Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]