{"id":19888851,"url":"https://github.com/paypal/paypal-typescript-server-sdk","last_synced_at":"2025-04-07T19:13:37.048Z","repository":{"id":256724943,"uuid":"847951591","full_name":"paypal/PayPal-TypeScript-Server-SDK","owner":"paypal","description":null,"archived":false,"fork":false,"pushed_at":"2025-03-24T19:07:08.000Z","size":800,"stargazers_count":24,"open_issues_count":11,"forks_count":17,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-03-31T18:18:23.234Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/paypal.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-08-26T21:23:49.000Z","updated_at":"2025-03-24T19:07:13.000Z","dependencies_parsed_at":"2024-11-21T18:37:50.712Z","dependency_job_id":null,"html_url":"https://github.com/paypal/PayPal-TypeScript-Server-SDK","commit_stats":null,"previous_names":["paypal/paypal-typescript-server-sdk"],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/paypal%2FPayPal-TypeScript-Server-SDK","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/paypal%2FPayPal-TypeScript-Server-SDK/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/paypal%2FPayPal-TypeScript-Server-SDK/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/paypal%2FPayPal-TypeScript-Server-SDK/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/paypal","download_url":"https://codeload.github.com/paypal/PayPal-TypeScript-Server-SDK/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247713258,"owners_count":20983683,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-12T18:08:26.698Z","updated_at":"2025-04-07T19:13:36.229Z","avatar_url":"https://github.com/paypal.png","language":"TypeScript","funding_links":["https://developer.paypal.com/docs/api/orders/v2/","https://developer.paypal.com/docs/api/payments/v2/","https://developer.paypal.com/docs/api/payment-tokens/v3/"],"categories":[],"sub_categories":[],"readme":"\n# Getting Started with PayPal Server SDK\n\n## Introduction\n\n### Important Notes\n\n- **Available Features:** This SDK currently contains only 3 of PayPal's API endpoints. Additional endpoints and functionality will be added in the future.\n- **API Changes:** Expect potential changes in APIs and features as we finalize the product.\n\n### Information\n\nThe PayPal Server SDK provides integration access to the PayPal REST APIs. The API endpoints are divided into distinct controllers:\n\n- Orders Controller: \u003ca href=\"https://developer.paypal.com/docs/api/orders/v2/\"\u003eOrders API v2\u003c/a\u003e\n- Payments Controller: \u003ca href=\"https://developer.paypal.com/docs/api/payments/v2/\"\u003ePayments API v2\u003c/a\u003e\n- Vault Controller: \u003ca href=\"https://developer.paypal.com/docs/api/payment-tokens/v3/\"\u003ePayment Method Tokens API v3\u003c/a\u003e *Available in the US only.*\n\nFind out more here: [https://developer.paypal.com/docs/api/orders/v2/](https://developer.paypal.com/docs/api/orders/v2/)\n\n## Install the Package\n\nRun the following command from your project directory to install the package from npm:\n\n```bash\nnpm install @paypal/paypal-server-sdk@1.0.0\n```\n\nFor additional package details, see the [Npm page for the @paypal/paypal-server-sdk@1.0.0 npm](https://www.npmjs.com/package/@paypal/paypal-server-sdk/v/1.0.0).\n\n## Initialize the API Client\n\n**_Note:_** Documentation for the client can be found [here.](https://www.github.com/paypal/PayPal-TypeScript-Server-SDK/tree/1.0.0/doc/client.md)\n\nThe following parameters are configurable for the API Client:\n\n| Parameter | Type | Description |\n|  --- | --- | --- |\n| `environment` | `Environment` | The API environment. \u003cbr\u003e **Default: `Environment.Sandbox`** |\n| `timeout` | `number` | Timeout for API calls.\u003cbr\u003e*Default*: `0` |\n| `httpClientOptions` | `Partial\u003cHttpClientOptions\u003e` | Stable configurable http client options. |\n| `unstableHttpClientOptions` | `any` | Unstable configurable http client options. |\n| `logging` | [`PartialLoggingOptions`](https://www.github.com/paypal/PayPal-TypeScript-Server-SDK/tree/1.0.0/doc/partial-logging-options.md) | Logging Configuration to enable logging |\n| `clientCredentialsAuthCredentials` | [`ClientCredentialsAuthCredentials`](https://www.github.com/paypal/PayPal-TypeScript-Server-SDK/tree/1.0.0/doc/auth/oauth-2-client-credentials-grant.md) | The credential object for clientCredentialsAuth |\n\n### HttpClientOptions\n\n| Parameter | Type | Description |\n|  --- | --- | --- |\n| `timeout` | `number` | Timeout in milliseconds. |\n| `httpAgent` | `any` | Custom http agent to be used when performing http requests. |\n| `httpsAgent` | `any` | Custom https agent to be used when performing http requests. |\n| `retryConfig` | `Partial\u003cRetryConfiguration\u003e` | Configurations to retry requests. |\n\n### RetryConfiguration\n\n| Parameter | Type | Description |\n|  --- | --- | --- |\n| `maxNumberOfRetries` | `number` | Maximum number of retries. \u003cbr\u003e *Default*: `0` |\n| `retryOnTimeout` | `boolean` | Whether to retry on request timeout. \u003cbr\u003e *Default*: `true` |\n| `retryInterval` | `number` | Interval before next retry. Used in calculation of wait time for next request in case of failure. \u003cbr\u003e *Default*: `1` |\n| `maximumRetryWaitTime` | `number` | Overall wait time for the requests getting retried. \u003cbr\u003e *Default*: `0` |\n| `backoffFactor` | `number` | Used in calculation of wait time for next request in case of failure. \u003cbr\u003e *Default*: `2` |\n| `httpStatusCodesToRetry` | `number[]` | Http status codes to retry against. \u003cbr\u003e *Default*: `[408, 413, 429, 500, 502, 503, 504, 521, 522, 524]` |\n| `httpMethodsToRetry` | `HttpMethod[]` | Http methods to retry against. \u003cbr\u003e *Default*: `['GET', 'PUT']` |\n\nThe API client can be initialized as follows:\n\n```ts\nconst client = new Client({\n  clientCredentialsAuthCredentials: {\n    oAuthClientId: 'OAuthClientId',\n    oAuthClientSecret: 'OAuthClientSecret'\n  },\n  timeout: 0,\n  environment: Environment.Sandbox,\n  logging: {\n    logLevel: LogLevel.Info,\n    logRequest: {\n      logBody: true\n    },\n    logResponse: {\n      logHeaders: true\n    }\n  },\n});\n```\n\n## Environments\n\nThe SDK can be configured to use a different environment for making API calls. Available environments are:\n\n### Fields\n\n| Name | Description |\n|  --- | --- |\n| Production | PayPal Live Environment |\n| Sandbox | **Default** PayPal Sandbox Environment |\n\n## Authorization\n\nThis API uses the following authentication schemes.\n\n* [`Oauth2 (OAuth 2 Client Credentials Grant)`](https://www.github.com/paypal/PayPal-TypeScript-Server-SDK/tree/1.0.0/doc/auth/oauth-2-client-credentials-grant.md)\n\n## List of APIs\n\n* [Orders](https://www.github.com/paypal/PayPal-TypeScript-Server-SDK/tree/1.0.0/doc/controllers/orders.md)\n* [Payments](https://www.github.com/paypal/PayPal-TypeScript-Server-SDK/tree/1.0.0/doc/controllers/payments.md)\n* [Vault](https://www.github.com/paypal/PayPal-TypeScript-Server-SDK/tree/1.0.0/doc/controllers/vault.md)\n\n## Classes Documentation\n\n* [ApiResponse](https://www.github.com/paypal/PayPal-TypeScript-Server-SDK/tree/1.0.0/doc/api-response.md)\n* [HttpRequest](https://www.github.com/paypal/PayPal-TypeScript-Server-SDK/tree/1.0.0/doc/http-request.md)\n* [ApiError](https://www.github.com/paypal/PayPal-TypeScript-Server-SDK/tree/1.0.0/doc/api-error.md)\n* [PartialLoggingOptions](https://www.github.com/paypal/PayPal-TypeScript-Server-SDK/tree/1.0.0/doc/partial-logging-options.md)\n* [PartialRequestLoggingOptions](https://www.github.com/paypal/PayPal-TypeScript-Server-SDK/tree/1.0.0/doc/partial-request-logging-options.md)\n* [PartialResponseLoggingOptions](https://www.github.com/paypal/PayPal-TypeScript-Server-SDK/tree/1.0.0/doc/partial-response-logging-options.md)\n* [LoggerInterface](https://www.github.com/paypal/PayPal-TypeScript-Server-SDK/tree/1.0.0/doc/logger-interface.md)\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpaypal%2Fpaypal-typescript-server-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpaypal%2Fpaypal-typescript-server-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpaypal%2Fpaypal-typescript-server-sdk/lists"}