Skip to content

KSF-Media/persona-objc-client

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

116 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
 
 

Repository files navigation

OpenAPIClient

KSF Media unified login service

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

  • API version: 1.3.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/KSF-Media/persona-objc-client.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/OAIActiveDays.h>
#import <OpenAPIClient/OAIAddress.h>
#import <OpenAPIClient/OAIAdminNewUser.h>
#import <OpenAPIClient/OAICancelSubscriptionReason.h>
#import <OpenAPIClient/OAIDeleteTempAddressChangeDates.h>
#import <OpenAPIClient/OAIDeliveryAddress.h>
#import <OpenAPIClient/OAIDeliveryReclamation.h>
#import <OpenAPIClient/OAIEntitlementAccess.h>
#import <OpenAPIClient/OAIFaroUser.h>
#import <OpenAPIClient/OAIForgotPasswordData.h>
#import <OpenAPIClient/OAIFreePass.h>
#import <OpenAPIClient/OAIFreePassInput.h>
#import <OpenAPIClient/OAIGdprConsent.h>
#import <OpenAPIClient/OAIInlineResponse400.h>
#import <OpenAPIClient/OAIInlineResponse400InvalidRequestBody.h>
#import <OpenAPIClient/OAIInlineResponse403.h>
#import <OpenAPIClient/OAIInlineResponse4031.h>
#import <OpenAPIClient/OAIInlineResponse4031AccessTokenExpired.h>
#import <OpenAPIClient/OAIInlineResponse403InvalidCredentials.h>
#import <OpenAPIClient/OAIInlineResponse415.h>
#import <OpenAPIClient/OAIInlineResponse415UnsupportedMediaType.h>
#import <OpenAPIClient/OAIInlineResponse500.h>
#import <OpenAPIClient/OAIInlineResponse500InternalServerError.h>
#import <OpenAPIClient/OAIJanrainUser.h>
#import <OpenAPIClient/OAILegalConsent.h>
#import <OpenAPIClient/OAILoginData.h>
#import <OpenAPIClient/OAILoginDataSSO.h>
#import <OpenAPIClient/OAILoginResponse.h>
#import <OpenAPIClient/OAINewDeliveryReclamation.h>
#import <OpenAPIClient/OAINewTemporaryUser.h>
#import <OpenAPIClient/OAINewUser.h>
#import <OpenAPIClient/OAINewsletter.h>
#import <OpenAPIClient/OAINewsletterSubscription.h>
#import <OpenAPIClient/OAIPackage.h>
#import <OpenAPIClient/OAIPackageCampaign.h>
#import <OpenAPIClient/OAIPackageOffer.h>
#import <OpenAPIClient/OAIPaper.h>
#import <OpenAPIClient/OAIPastTemporaryAddress.h>
#import <OpenAPIClient/OAIPausedSubscription.h>
#import <OpenAPIClient/OAIPayment.h>
#import <OpenAPIClient/OAIPendingAddressChange.h>
#import <OpenAPIClient/OAIPersistedEntitlementAccess.h>
#import <OpenAPIClient/OAIProduct.h>
#import <OpenAPIClient/OAISearchQuery.h>
#import <OpenAPIClient/OAISearchResult.h>
#import <OpenAPIClient/OAISubscription.h>
#import <OpenAPIClient/OAISubscriptionDates.h>
#import <OpenAPIClient/OAISubscriptionPauseDates.h>
#import <OpenAPIClient/OAISubscriptionPauseEdit.h>
#import <OpenAPIClient/OAISubscriptionPayments.h>
#import <OpenAPIClient/OAITemporaryAddressChange.h>
#import <OpenAPIClient/OAITemporaryAddressChangeDates.h>
#import <OpenAPIClient/OAIUpdatePasswordData.h>
#import <OpenAPIClient/OAIUser.h>
#import <OpenAPIClient/OAIUserUpdate.h>
#import <OpenAPIClient/OAIUserUpdateAddress.h>
#import <OpenAPIClient/OAIUserUpdatePassword.h>
// load API classes for accessing endpoints
#import <OpenAPIClient/OAIAccountApi.h>
#import <OpenAPIClient/OAIAdminApi.h>
#import <OpenAPIClient/OAIEntitlementsApi.h>
#import <OpenAPIClient/OAIIdentificationApi.h>
#import <OpenAPIClient/OAILoginApi.h>
#import <OpenAPIClient/OAIUsersApi.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:

NSString* *body = @"body_example"; // 

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

// Validate password reset token
[apiInstance accountPasswordCheckTokenPostWithBody:body
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

Documentation for API Endpoints

All URIs are relative to http://http:/v1

Class Method HTTP request Description
OAIAccountApi accountPasswordCheckTokenPost POST /account/password/check-token Validate password reset token
OAIAccountApi accountPasswordForgotPost POST /account/password/forgot Request password reset link
OAIAccountApi accountPasswordResetPost POST /account/password/reset Reset a forgotten password with a token
OAIAdminApi adminFreePassDelete DELETE /admin/free-pass Revokes an existing free pass
OAIAdminApi adminFreePassPut PUT /admin/free-pass Creates a free pass to an article
OAIAdminApi adminFreePassesGet GET /admin/free-passes Lists all free passes
OAIAdminApi adminSearchPost POST /admin/search Search for users
OAIAdminApi adminTransferPassiveSubscribersListidPost POST /admin/transfer-passive-subscribers/{listid} Transfers passive customers from Kayak to Mailchimp
OAIAdminApi adminUserPost POST /admin/user Create a new user with admin options.
OAIAdminApi adminUserUuidDelete DELETE /admin/user/{uuid} Delete user
OAIEntitlementsApi entitlementsAllowDelete DELETE /entitlements/allow Remove an entitlement
OAIEntitlementsApi entitlementsAllowGet GET /entitlements/allow Check if global entitlements are enabled
OAIEntitlementsApi entitlementsAllowPost POST /entitlements/allow Add an entitlement for all users
OAIEntitlementsApi entitlementsAllowUuidPost POST /entitlements/allow/{uuid} Grant product access to a customer
OAIEntitlementsApi entitlementsFreePassGet GET /entitlements/free-pass Verify given free pass hash
OAIEntitlementsApi entitlementsGet GET /entitlements List all entitlements
OAIEntitlementsApi entitlementsGlobalGet GET /entitlements/global Lists all past and future global entitlements
OAIIdentificationApi identificationLoginGet GET /identification/login Authenticate with OpenID Connect
OAIIdentificationApi identificationLoginMonitorGet GET /identification/login/monitor Get token for off band response login flow monitor
OAIIdentificationApi identificationLoginReturnGet GET /identification/login/return Redirect endpoint for OpenID Connect
OAIIdentificationApi identificationUserStampUuidPost POST /identification/user/stamp/{uuid} Query when the strong identification was last updated
OAILoginApi loginIpGet GET /login/ip Login with IP
OAILoginApi loginPost POST /login Login with email and password
OAILoginApi loginSsoPost POST /login/sso Disabled. Always returns 403.
OAILoginApi loginUuidDelete DELETE /login/{uuid} Logout
OAIUsersApi usersPost POST /users Create a new user.
OAIUsersApi usersTemporaryPost POST /users/temporary Create a new user with email.
OAIUsersApi usersUuidEntitlementGet GET /users/{uuid}/entitlement Get users entitlements.
OAIUsersApi usersUuidGdprPut PUT /users/{uuid}/gdpr Updates the GDPR consent settings for a given user.
OAIUsersApi usersUuidGet GET /users/{uuid} Get user by UUID.
OAIUsersApi usersUuidLegalPut PUT /users/{uuid}/legal Updates the legal consent settings for a given user.
OAIUsersApi usersUuidNewslettersGet GET /users/{uuid}/newsletters Get newsletter subscriptions
OAIUsersApi usersUuidNewslettersPut PUT /users/{uuid}/newsletters Update newsletter subscriptions
OAIUsersApi usersUuidPasswordPut PUT /users/{uuid}/password Set / Change user password
OAIUsersApi usersUuidPatch PATCH /users/{uuid} Update a user
OAIUsersApi usersUuidPaymentsGet GET /users/{uuid}/payments Get user's subscriptions and payment events
OAIUsersApi usersUuidScopeGet GET /users/{uuid}/scope Check if user has valid token for a scope
OAIUsersApi usersUuidSubscriptionsSubsnoAddressChangeDelete DELETE /users/{uuid}/subscriptions/{subsno}/addressChange Delete temporary address change for subscription
OAIUsersApi usersUuidSubscriptionsSubsnoAddressChangePatch PATCH /users/{uuid}/subscriptions/{subsno}/addressChange Edit temporary address change dates of a subscription
OAIUsersApi usersUuidSubscriptionsSubsnoAddressChangePost POST /users/{uuid}/subscriptions/{subsno}/addressChange Make a temporary address change for a subscription
OAIUsersApi usersUuidSubscriptionsSubsnoCancelPut PUT /users/{uuid}/subscriptions/{subsno}/cancel Cancels user subscription
OAIUsersApi usersUuidSubscriptionsSubsnoPausePatch PATCH /users/{uuid}/subscriptions/{subsno}/pause Edit pause duration
OAIUsersApi usersUuidSubscriptionsSubsnoPausePost POST /users/{uuid}/subscriptions/{subsno}/pause Pause users subscription
OAIUsersApi usersUuidSubscriptionsSubsnoReclamationPost POST /users/{uuid}/subscriptions/{subsno}/reclamation Create a new delivery reclamation for a subscription
OAIUsersApi usersUuidSubscriptionsSubsnoReclamationsReclaimnoGet GET /users/{uuid}/subscriptions/{subsno}/reclamations/{reclaimno} Get a delivery reclamation
OAIUsersApi usersUuidSubscriptionsSubsnoUnpausePost POST /users/{uuid}/subscriptions/{subsno}/unpause Unpause users subscription

Documentation For Models

Documentation For Authorization

All endpoints do not require authorization.

Author

About

Autogenerated ObjectiveC client for our login service

Resources

Readme
Activity
Custom properties

Stars

0 stars

Watchers

6 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •  

Languages