softonic/noodle_setup_api_sdk

This package is abandoned and no longer maintained. No replacement package was suggested.

1.14.0 2018-11-28 09:12 UTC

Requires

• php: >=5.5
• ext-curl: *
• ext-json: *
• ext-mbstring: *
• guzzlehttp/guzzle: ^6.2

Requires (Dev)

• friendsofphp/php-cs-fixer: ~1.12
• phpunit/phpunit: ^4.8
• squizlabs/php_codesniffer: ~2.6

proprietary

• Swagger and contributors

• php
• api
• sdk
• swagger

README

API that allows configure programs for Noodle

This PHP package is automatically generated by the Swagger Codegen project:

• API version: 1.0.0
• Package version: 1.14.0
• Build package: io.swagger.codegen.languages.PhpClientCodegen For more information, please visit http://corporate.softonic.com/contact-us

Requirements

PHP 5.5 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/softonic/noodle_setup_api_sdk.git"
    }
  ],
  "require": {
    "softonic/noodle_setup_api_sdk": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/NoodleSetup/vendor/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Softonic\NoodleSetupApiSdk\Api\ProgramsPlatformsLocalesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$id_program = "id_program_example"; // string | Program identifier
$id_platform = "id_platform_example"; // string | Platform identifier
$body = new \Softonic\NoodleSetupApiSdk\Client\Model\ProgramPlatformLocale(); // \Softonic\NoodleSetupApiSdk\Client\Model\ProgramPlatformLocale | 

try {
    $result = $apiInstance->createProgramPlatformLocale($id_program, $id_platform, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProgramsPlatformsLocalesApi->createProgramPlatformLocale: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to https://noodle-setup-v1.sftapi.com

Class	Method	HTTP request	Description
ProgramsPlatformsLocalesApi	createProgramPlatformLocale	POST /programs/{id_program}/platforms/{id_platform}/locales	Creates a program configuration for a specific platform and locale
ProgramsPlatformsLocalesApi	deleteProgramPlatformLocale	DELETE /programs/{id_program}/platforms/{id_platform}/locales/{id_locale}	Deletes a program configuration for a specific platform and locale
ProgramsPlatformsLocalesApi	findProgramPlatformLocale	GET /programs/{id_program}/platforms/{id_platform}/locales	Finds a program configuration for a specific platform for all locales
ProgramsPlatformsLocalesApi	readProgramPlatformLocale	GET /programs/{id_program}/platforms/{id_platform}/locales/{id_locale}	Reads a program configuration for a specific platform and locale
ProgramsPlatformsLocalesApi	replaceProgramPlatformLocale	PUT /programs/{id_program}/platforms/{id_platform}/locales/{id_locale}	Replaces a program configuration for a specific platform and locale
ProgramsPlatformsLocalesApi	updateProgramPlatformLocale	PATCH /programs/{id_program}/platforms/{id_platform}/locales/{id_locale}	Updates a program configuration for a specific platform and locale
SearchApi	search	POST /search	Search a list of filters and returns the result

Documentation For Models

• ProgramPlatformLocale
• SearchRequest

Documentation For Authorization

noodle_setup

• Type: OAuth
• Flow: application
• Authorization URL:
• Scopes:
• noodle_setup.find.program.platforms.locales: Finds a program configuration for a specific platform for all locales
• noodle_setup.read.program.platforms.locales: Reads a program configuration for a specific platform and locale
• noodle_setup.create.program.platforms.locales: Creates a program configuration for a specific platform and locale
• noodle_setup.replace.program.platforms.locales: Replaces a program configuration for a specific platform and locale
• noodle_setup.update.program.platforms.locales: Updates a program configuration for a specific platform and locale
• noodle_setup.delete.program.platforms.locales: Deletes a program configuration for a specific platform and locale

oauth2

• Type: OAuth
• Flow: application
• Authorization URL:
• Scopes:
• noodle_setup.find.programs.platforms.locales: Finds a program configuration for a specific platform for all locales
• noodle_setup.read.programs.platforms.locales: Reads a program configuration for a specific platform and locale
• noodle_setup.create.programs.platforms.locales: Creates a program configuration for a specific platform and local
• noodle_setup.replace.programs.platforms.locales: Replaces a program configuration for a specific platform and local
• noodle_setup.update.programs.platforms.locales: Updates a program configuration for a specific platform and local
• noodle_setup.delete.programs.platforms.locales: Deletes a program configuration for a specific platform and local
• noodle_setup.create.search: Search using a list of filters based in the identifiers.

Author

[e-mail]