OpenAPIClient

The V2 of WhatsAPI Go

This ObjC package is automatically generated by the OpenAPI Generator project:

API version: 2.0
Package version:
Build package: org.openapitools.codegen.languages.ObjcClientCodegen

Requirements

The SDK requires ARC (Automatic Reference Counting) to be enabled in the Xcode project.

Installation & Usage

Install from Github using CocoaPods

Add the following to the Podfile:

pod 'OpenAPIClient', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

To specify a particular branch, append , :branch => 'branch-name-here'

To specify a particular commit, append , :commit => '11aa22'

Install from local path using CocoaPods

Put the SDK under your project folder (e.g. /path/to/objc_project/Vendor/OpenAPIClient) and then add the following to the Podfile:

pod 'OpenAPIClient', :path => 'Vendor/OpenAPIClient'

Usage

Import the following:

#import <OpenAPIClient/OAIApiClient.h>
#import <OpenAPIClient/OAIDefaultConfiguration.h>
// load models
#import <OpenAPIClient/OAIAPIResponse.h>
#import <OpenAPIClient/OAIButtonMessagePayload.h>
#import <OpenAPIClient/OAIButtonMessageWithMediaPayload.h>
#import <OpenAPIClient/OAIContactMessagePayload.h>
#import <OpenAPIClient/OAIContactMessagePayloadVcard.h>
#import <OpenAPIClient/OAICreateInstancePayload.h>
#import <OpenAPIClient/OAIFileUpload.h>
#import <OpenAPIClient/OAIGroupCreatePayload.h>
#import <OpenAPIClient/OAIGroupInviteMessagePayload.h>
#import <OpenAPIClient/OAIGroupUpdateDescriptionPayload.h>
#import <OpenAPIClient/OAIGroupUpdateNamePayload.h>
#import <OpenAPIClient/OAIGroupUpdateParticipantsPayload.h>
#import <OpenAPIClient/OAIListItem.h>
#import <OpenAPIClient/OAIListMessagePayload.h>
#import <OpenAPIClient/OAIListSection.h>
#import <OpenAPIClient/OAILocationMessagePayload.h>
#import <OpenAPIClient/OAILocationMessagePayloadLocation.h>
#import <OpenAPIClient/OAIPaymentRequestPayload.h>
#import <OpenAPIClient/OAIPollMessagePayload.h>
#import <OpenAPIClient/OAIReplyButton.h>
#import <OpenAPIClient/OAISendAudioRequest.h>
#import <OpenAPIClient/OAISendDocumentRequest.h>
#import <OpenAPIClient/OAISendMediaPayload.h>
#import <OpenAPIClient/OAISendVideoRequest.h>
#import <OpenAPIClient/OAISetGroupPictureRequest.h>
#import <OpenAPIClient/OAITemplateButton.h>
#import <OpenAPIClient/OAITemplateButtonPayload.h>
#import <OpenAPIClient/OAITemplateButtonWithMediaPayload.h>
#import <OpenAPIClient/OAITextMessage.h>
#import <OpenAPIClient/OAIUpdateProfilePicRequest.h>
#import <OpenAPIClient/OAIUploadMediaRequest.h>
#import <OpenAPIClient/OAIUrlMediaUploadPayload.h>
#import <OpenAPIClient/OAIUserInfoPayload.h>
#import <OpenAPIClient/OAIWebhookPayload.h>
// load API classes for accessing endpoints
#import <OpenAPIClient/OAIBusinessManagementApi.h>
#import <OpenAPIClient/OAIGroupManagementApi.h>
#import <OpenAPIClient/OAIInstanceApi.h>
#import <OpenAPIClient/OAIMessageSendingApi.h>
#import <OpenAPIClient/OAIMiscellaneousApi.h>

Recommendation

It's recommended to create an instance of ApiClient per thread in a multi-threaded environment to avoid any potential issues.

Getting Started

Please follow the installation procedure and then run the following:

OAIDefaultConfiguration *apiConfig = [OAIDefaultConfiguration sharedConfig];

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


NSString* *instanceKey = @"instanceKey_example"; // Instance key

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

// Fetches the catlog.
[apiInstance fetchCatlogWithInstanceKey:instanceKey
              completionHandler: ^(OAIAPIResponse* output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

Documentation for API Endpoints

All URIs are relative to /api

Class	Method	HTTP request	Description
OAIBusinessManagementApi	fetchCatlog	GET /instances/{instance_key}/business/catalog	Fetches the catlog.
OAIBusinessManagementApi	sendPaymentRequest	POST /instances/{instance_key}/business/payment-request	Send a payment request.
OAIGroupManagementApi	addParticipant	POST /instances/{instance_key}/groups/{group_id}/participants/add	Add participant.
OAIGroupManagementApi	createGroup	POST /instances/{instance_key}/groups/create	Create group.
OAIGroupManagementApi	demoteParticipant	PUT /instances/{instance_key}/groups/{group_id}/participants/demote	Demote participant.
OAIGroupManagementApi	getAdminGroups	GET /instances/{instance_key}/groups/admin	Get admin groups.
OAIGroupManagementApi	getAllGroups	GET /instances/{instance_key}/groups/	Get all groups.
OAIGroupManagementApi	getAllParticipants	GET /instances/{instance_key}/groups/{group_id}/participants	Get all participants.
OAIGroupManagementApi	getGroup	GET /instances/{instance_key}/groups/{group_id}	Get group.
OAIGroupManagementApi	getGroupFromInviteLink	GET /instances/{instance_key}/groups/invite-info	Get group from invite link.
OAIGroupManagementApi	getGroupInviteCode	GET /instances/{instance_key}/groups/{group_id}/invite-code	Get group invite code.
OAIGroupManagementApi	joinGroupWithLink	GET /instances/{instance_key}/groups/join	Join group with invite code.
OAIGroupManagementApi	leaveGroup	DELETE /instances/{instance_key}/groups/{group_id}/	Leaves the group.
OAIGroupManagementApi	promoteParticipant	PUT /instances/{instance_key}/groups/{group_id}/participants/promote	Promote participant.
OAIGroupManagementApi	removeParticipant	DELETE /instances/{instance_key}/groups/{group_id}/participants/remove	Remove participant.
OAIGroupManagementApi	setGroupAnnounce	PUT /instances/{instance_key}/groups/{group_id}/announce	Set group announce.
OAIGroupManagementApi	setGroupDescription	PUT /instances/{instance_key}/groups/{group_id}/description	Set group description.
OAIGroupManagementApi	setGroupLocked	PUT /instances/{instance_key}/groups/{group_id}/lock	Set group locked.
OAIGroupManagementApi	setGroupName	PUT /instances/{instance_key}/groups/{group_id}/name	Set group name.
OAIGroupManagementApi	setGroupPicture	PUT /instances/{instance_key}/groups/{group_id}/profile-pic	Set group picture.
OAIInstanceApi	changeWebhookUrl	PUT /instances/{instance_key}/webhook	Change Webhook url.
OAIInstanceApi	createInstance	POST /instances/create	Creates a new instance key.
OAIInstanceApi	deleteInstance	DELETE /instances/{instance_key}/delete	Delete Instance.
OAIInstanceApi	getContacts	GET /instances/{instance_key}/contacts	Get contacts.
OAIInstanceApi	getInstance	GET /instances/{instance_key}/	Get Instance.
OAIInstanceApi	getQrCode	GET /instances/{instance_key}/qrcode	Get QrCode.
OAIInstanceApi	listInstances	GET /instances/list	Get all instances.
OAIInstanceApi	logoutInstance	DELETE /instances/{instance_key}/logout	Logout Instance.
OAIMessageSendingApi	sendAudio	POST /instances/{instance_key}/send/audio	Send raw audio.
OAIMessageSendingApi	sendButtonMessage	POST /instances/{instance_key}/send/buttons	Send a button message.
OAIMessageSendingApi	sendButtonWithMedia	POST /instances/{instance_key}/send/button-media	Send a button message with a media header.
OAIMessageSendingApi	sendContact	POST /instances/{instance_key}/send/contact	Send a contact message.
OAIMessageSendingApi	sendDocument	POST /instances/{instance_key}/send/document	Send raw document.
OAIMessageSendingApi	sendGroupInvite	POST /instances/{instance_key}/send/group-invite	Send a group invite message
OAIMessageSendingApi	sendImage	POST /instances/{instance_key}/send/image	Send raw image.
OAIMessageSendingApi	sendListMessage	POST /instances/{instance_key}/send/list	Send a List message.
OAIMessageSendingApi	sendLocation	POST /instances/{instance_key}/send/location	Send a location message.
OAIMessageSendingApi	sendMediaMessage	POST /instances/{instance_key}/send/media	Send a media message.
OAIMessageSendingApi	sendPollMessage	POST /instances/{instance_key}/send/poll	Send a Poll message.
OAIMessageSendingApi	sendTemplate	POST /instances/{instance_key}/send/template	Send a template message.
OAIMessageSendingApi	sendTemplateWithMedia	POST /instances/{instance_key}/send/template-media	Send a template message with media.
OAIMessageSendingApi	sendTextMessage	POST /instances/{instance_key}/send/text	Send a text message.
OAIMessageSendingApi	sendVideo	POST /instances/{instance_key}/send/video	Send raw video.
OAIMessageSendingApi	uploadMedia	POST /instances/{instance_key}/send/upload	Upload media.
OAIMessageSendingApi	uploadMediaFromUrl	POST /instances/{instance_key}/send/upload-url	Upload media from url.
OAIMiscellaneousApi	downloadMedia	POST /instances/{instance_key}/misc/download	Download media
OAIMiscellaneousApi	getProfilePic	GET /instances/{instance_key}/misc/profile-pic	Get profile pic.
OAIMiscellaneousApi	getUsersInfo	POST /instances/{instance_key}/misc/user-info	Fetches the users info.
OAIMiscellaneousApi	setChatPresence	POST /instances/{instance_key}/misc/chat-presence	Set chat presence
OAIMiscellaneousApi	updateProfilePic	PUT /instances/{instance_key}/misc/profile-pic	Update profile picture

Documentation For Models

Documentation For Authorization

ApiKeyAuth

Type: API key
API key parameter name: Authorization
Location: HTTP header

Author

manjit@sponsorbook.io

Name		Name	Last commit message	Last commit date
Latest commit History 7 Commits
.openapi-generator		.openapi-generator
OpenAPIClient		OpenAPIClient
docs		docs
.gitignore		.gitignore
.openapi-generator-ignore		.openapi-generator-ignore
OpenAPIClient.podspec		OpenAPIClient.podspec
README.md		README.md
git_push.sh		git_push.sh

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

OpenAPIClient

Requirements

Installation & Usage

Install from Github using CocoaPods

Install from local path using CocoaPods

Usage

Recommendation

Getting Started

Documentation for API Endpoints

Documentation For Models

Documentation For Authorization

ApiKeyAuth

Author

About

Uh oh!

Releases

Packages

Languages

WazapIO/client-objc

Folders and files

Latest commit

History

Repository files navigation

OpenAPIClient

Requirements

Installation & Usage

Install from Github using CocoaPods

Install from local path using CocoaPods

Usage

Recommendation

Getting Started

Documentation for API Endpoints

Documentation For Models

Documentation For Authorization

ApiKeyAuth

Author

About

Resources

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Languages

Packages