@handsondigital/idplugger-promotion 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +267 -0
- package/.openapi-generator/VERSION +1 -0
- package/.openapi-generator-ignore +23 -0
- package/README.md +367 -0
- package/api.ts +14329 -0
- package/base.ts +98 -0
- package/common.ts +150 -0
- package/configuration.ts +115 -0
- package/dist/api.d.ts +10994 -0
- package/dist/api.js +7834 -0
- package/dist/base.d.ts +66 -0
- package/dist/base.js +99 -0
- package/dist/common.d.ts +65 -0
- package/dist/common.js +253 -0
- package/dist/configuration.d.ts +91 -0
- package/dist/configuration.js +57 -0
- package/dist/index.d.ts +13 -0
- package/dist/index.js +31 -0
- package/docs/AddLuckyNumberCustom.md +26 -0
- package/docs/Article.md +40 -0
- package/docs/ArticleCustomDataInner.md +28 -0
- package/docs/ArticlesApi.md +258 -0
- package/docs/ArticlesCreate200Response.md +26 -0
- package/docs/ArticlesCreate400Response.md +26 -0
- package/docs/ArticlesCreate401Response.md +26 -0
- package/docs/ArticlesDelete200Response.md +26 -0
- package/docs/ArticlesDelete400Response.md +26 -0
- package/docs/ArticlesDelete401Response.md +26 -0
- package/docs/ArticlesIndex200Response.md +28 -0
- package/docs/ArticlesIndex400Response.md +26 -0
- package/docs/ArticlesIndex401Response.md +26 -0
- package/docs/ArticlesUpdate200Response.md +26 -0
- package/docs/ArticlesUpdate400Response.md +26 -0
- package/docs/ArticlesUpdate401Response.md +26 -0
- package/docs/AuthApi.md +105 -0
- package/docs/Award.md +40 -0
- package/docs/Awarded.md +38 -0
- package/docs/AwardedsApi.md +184 -0
- package/docs/AwardedsSearch200Response.md +28 -0
- package/docs/AwardedsSearch400Response.md +26 -0
- package/docs/AwardedsSearch401Response.md +26 -0
- package/docs/AwardedsStates200Response.md +26 -0
- package/docs/AwardedsStates200ResponseContentInner.md +22 -0
- package/docs/AwardedsUpdate200Response.md +26 -0
- package/docs/AwardedsUpdate400Response.md +26 -0
- package/docs/AwardedsUpdate401Response.md +26 -0
- package/docs/AwardsApi.md +243 -0
- package/docs/AwardsCreate200Response.md +26 -0
- package/docs/AwardsCreate400Response.md +26 -0
- package/docs/AwardsCreate401Response.md +26 -0
- package/docs/AwardsDelete200Response.md +26 -0
- package/docs/AwardsDelete400Response.md +26 -0
- package/docs/AwardsDelete401Response.md +26 -0
- package/docs/AwardsIndex200Response.md +28 -0
- package/docs/AwardsIndex400Response.md +26 -0
- package/docs/AwardsIndex401Response.md +26 -0
- package/docs/AwardsUpdate200Response.md +26 -0
- package/docs/AwardsUpdate400Response.md +26 -0
- package/docs/AwardsUpdate401Response.md +26 -0
- package/docs/BlacklistCreate200Response.md +26 -0
- package/docs/BlacklistCreate200ResponseContentInner.md +24 -0
- package/docs/BlacklistCreate400Response.md +26 -0
- package/docs/BlacklistCreate401Response.md +26 -0
- package/docs/BlacklistCreateRequest.md +20 -0
- package/docs/BlacklistDelete200Response.md +26 -0
- package/docs/BlacklistDelete400Response.md +26 -0
- package/docs/BlacklistDelete401Response.md +26 -0
- package/docs/BlacklistIndex200Response.md +28 -0
- package/docs/BlacklistIndex200ResponseContentInner.md +24 -0
- package/docs/BlacklistIndex400Response.md +26 -0
- package/docs/BlockedUsersApi.md +179 -0
- package/docs/Branding.md +54 -0
- package/docs/BrandingApi.md +120 -0
- package/docs/BrandingIndex200Response.md +26 -0
- package/docs/BrandingIndex400Response.md +26 -0
- package/docs/BrandingIndex401Response.md +26 -0
- package/docs/BrandingMenuInner.md +24 -0
- package/docs/BrandingSocial.md +28 -0
- package/docs/BrandingUpdate200Response.md +26 -0
- package/docs/BrandingUpdate400Response.md +26 -0
- package/docs/BrandingUpdate401Response.md +26 -0
- package/docs/ConfigWebhook200Response.md +26 -0
- package/docs/ConfigWebhook400Response.md +26 -0
- package/docs/ConfigWebhook401Response.md +26 -0
- package/docs/ConfigWebhookRequest.md +22 -0
- package/docs/ConfigsIndex200Response.md +26 -0
- package/docs/ConfigsIndex400Response.md +26 -0
- package/docs/ConfigsIndex401Response.md +26 -0
- package/docs/Content.md +28 -0
- package/docs/ContentApi.md +129 -0
- package/docs/ContentCreate200Response.md +26 -0
- package/docs/ContentCreate400Response.md +26 -0
- package/docs/ContentCreate401Response.md +26 -0
- package/docs/ContentIndex200Response.md +26 -0
- package/docs/ContentIndex400Response.md +26 -0
- package/docs/ContentIndex401Response.md +26 -0
- package/docs/Coupon.md +36 -0
- package/docs/CouponProductsInner.md +26 -0
- package/docs/CouponWebhookError.md +26 -0
- package/docs/CouponWebhookErrorContent.md +38 -0
- package/docs/CouponWebhookErrorContentAllOfErrors.md +22 -0
- package/docs/CouponWebhookSuccess.md +26 -0
- package/docs/CouponsApi.md +311 -0
- package/docs/CouponsCreate200Response.md +26 -0
- package/docs/CouponsCreate401Response.md +26 -0
- package/docs/CouponsCreate409Response.md +26 -0
- package/docs/CouponsCreateRequest.md +20 -0
- package/docs/CouponsDelete200Response.md +26 -0
- package/docs/CouponsDelete400Response.md +26 -0
- package/docs/CouponsDelete401Response.md +26 -0
- package/docs/CouponsIndex200Response.md +28 -0
- package/docs/CouponsIndex200ResponseContentInner.md +38 -0
- package/docs/CouponsIndex400Response.md +26 -0
- package/docs/CouponsIndex401Response.md +26 -0
- package/docs/CouponsUpdate201Response.md +26 -0
- package/docs/CouponsUpdate401Response.md +26 -0
- package/docs/CouponsUpdate409Response.md +26 -0
- package/docs/CuponsWebhookRequest.md +26 -0
- package/docs/DocumentRulesApi.md +173 -0
- package/docs/DocumentRulesIndex200Response.md +26 -0
- package/docs/DocumentRulesIndex200ResponseContent.md +24 -0
- package/docs/DocumentRulesIndex200ResponseContentRegulationsInner.md +24 -0
- package/docs/DocumentRulesIndex400Response.md +26 -0
- package/docs/DocumentRulesIndex401Response.md +26 -0
- package/docs/DocumentRulesRegulationDelete200Response.md +24 -0
- package/docs/DocumentRulesRegulationDelete400Response.md +26 -0
- package/docs/DocumentRulesRegulationDelete401Response.md +26 -0
- package/docs/DocumentRulesUpdate200Response.md +26 -0
- package/docs/DocumentRulesUpdate400Response.md +26 -0
- package/docs/DocumentRulesUpdate401Response.md +26 -0
- package/docs/DocumentRulesUpdateRequest.md +24 -0
- package/docs/DocumentRulesUpdateRequestRegulationsInner.md +24 -0
- package/docs/FAQApi.md +236 -0
- package/docs/FaqCreate200Response.md +26 -0
- package/docs/FaqCreate400Response.md +26 -0
- package/docs/FaqCreate401Response.md +26 -0
- package/docs/FaqCreateRequestInner.md +22 -0
- package/docs/FaqDelete200Response.md +26 -0
- package/docs/FaqDelete400Response.md +26 -0
- package/docs/FaqDelete401Response.md +26 -0
- package/docs/FaqIndex200Response.md +28 -0
- package/docs/FaqIndex200ResponseContentInner.md +22 -0
- package/docs/FaqIndex400Response.md +26 -0
- package/docs/FaqIndex401Response.md +26 -0
- package/docs/FaqUpdate200Response.md +26 -0
- package/docs/FaqUpdate400Response.md +26 -0
- package/docs/FaqUpdate401Response.md +26 -0
- package/docs/FilesApi.md +56 -0
- package/docs/Login200Response.md +24 -0
- package/docs/Login401Response.md +20 -0
- package/docs/LoginRequest.md +22 -0
- package/docs/LuckyNumber.md +32 -0
- package/docs/LuckyNumbersAddCustom200Response.md +26 -0
- package/docs/LuckyNumbersAddCustom400Response.md +26 -0
- package/docs/LuckyNumbersAddCustom401Response.md +26 -0
- package/docs/LuckyNumbersApi.md +202 -0
- package/docs/LuckyNumbersRemove200Response.md +26 -0
- package/docs/LuckyNumbersRemove400Response.md +26 -0
- package/docs/LuckyNumbersRemove401Response.md +26 -0
- package/docs/LuckyNumbersRemoveRequest.md +20 -0
- package/docs/LuckyNumbersRemoveRequestLuckyNumbersInner.md +22 -0
- package/docs/LuckyNumbersSearch200Response.md +28 -0
- package/docs/LuckyNumbersSearch400Response.md +26 -0
- package/docs/LuckyNumbersSearch401Response.md +26 -0
- package/docs/Me200Response.md +28 -0
- package/docs/Me200ResponsePromotionsInner.md +22 -0
- package/docs/Metrics200Response.md +26 -0
- package/docs/Metrics200ResponseContent.md +40 -0
- package/docs/Metrics200ResponseContentUsersInner.md +22 -0
- package/docs/Metrics400Response.md +20 -0
- package/docs/MetricsApi.md +75 -0
- package/docs/Order.md +42 -0
- package/docs/OrderCustomDataInner.md +26 -0
- package/docs/OrdersApi.md +204 -0
- package/docs/OrdersCreate200Response.md +26 -0
- package/docs/OrdersCreate400Response.md +26 -0
- package/docs/OrdersCreate401Response.md +26 -0
- package/docs/OrdersCreateRequest.md +20 -0
- package/docs/OrdersIndex200Response.md +28 -0
- package/docs/OrdersIndex400Response.md +26 -0
- package/docs/OrdersIndex401Response.md +26 -0
- package/docs/OrdersUpdate200Response.md +26 -0
- package/docs/OrdersUpdate400Response.md +26 -0
- package/docs/OrdersUpdate401Response.md +26 -0
- package/docs/Pagination.md +42 -0
- package/docs/PaginationLinksInner.md +24 -0
- package/docs/Product.md +32 -0
- package/docs/ProductsApi.md +242 -0
- package/docs/ProductsCreate200Response.md +26 -0
- package/docs/ProductsCreate401Response.md +26 -0
- package/docs/ProductsCreate409Response.md +26 -0
- package/docs/ProductsCreateRequest.md +20 -0
- package/docs/ProductsDelete200Response.md +26 -0
- package/docs/ProductsDelete400Response.md +26 -0
- package/docs/ProductsDelete401Response.md +26 -0
- package/docs/ProductsIndex200Response.md +28 -0
- package/docs/ProductsIndex400Response.md +26 -0
- package/docs/ProductsIndex401Response.md +26 -0
- package/docs/ProductsUpdate201Response.md +26 -0
- package/docs/ProductsUpdate401Response.md +26 -0
- package/docs/ProductsUpdate409Response.md +26 -0
- package/docs/Promotion.md +34 -0
- package/docs/PromotionDataApi.md +60 -0
- package/docs/PromotionDatetime.md +28 -0
- package/docs/PromotionDatetimeActive.md +22 -0
- package/docs/PromotionDatetimeDelivery.md +20 -0
- package/docs/PromotionDatetimeParticipate.md +22 -0
- package/docs/PromotionDatetimeShowAwardeds.md +20 -0
- package/docs/Raffle.md +44 -0
- package/docs/RafflesApi.md +309 -0
- package/docs/RafflesCreate200Response.md +26 -0
- package/docs/RafflesCreate400Response.md +26 -0
- package/docs/RafflesCreate401Response.md +26 -0
- package/docs/RafflesCreateRequestInner.md +30 -0
- package/docs/RafflesDelete200Response.md +26 -0
- package/docs/RafflesDelete400Response.md +26 -0
- package/docs/RafflesDelete401Response.md +26 -0
- package/docs/RafflesIndex200Response.md +28 -0
- package/docs/RafflesIndex400Response.md +26 -0
- package/docs/RafflesIndex401Response.md +26 -0
- package/docs/RafflesReportRequest.md +20 -0
- package/docs/RafflesUpdate200Response.md +26 -0
- package/docs/RafflesUpdate400Response.md +26 -0
- package/docs/RafflesUpdate401Response.md +26 -0
- package/docs/RafflesUpdateRequestInner.md +32 -0
- package/docs/SerieNumber.md +24 -0
- package/docs/SettingsApi.md +65 -0
- package/docs/Store.md +38 -0
- package/docs/StoresApi.md +242 -0
- package/docs/StoresCreate200Response.md +26 -0
- package/docs/StoresCreate401Response.md +26 -0
- package/docs/StoresCreate409Response.md +26 -0
- package/docs/StoresCreateRequest.md +20 -0
- package/docs/StoresDelete200Response.md +26 -0
- package/docs/StoresDelete400Response.md +26 -0
- package/docs/StoresDelete401Response.md +26 -0
- package/docs/StoresIndex200Response.md +28 -0
- package/docs/StoresIndex400Response.md +26 -0
- package/docs/StoresIndex401Response.md +26 -0
- package/docs/StoresUpdate201Response.md +26 -0
- package/docs/StoresUpdate401Response.md +26 -0
- package/docs/StoresUpdate409Response.md +26 -0
- package/docs/Ticket.md +48 -0
- package/docs/TicketsApi.md +249 -0
- package/docs/TicketsCreate200Response.md +26 -0
- package/docs/TicketsCreate400Response.md +26 -0
- package/docs/TicketsCreate401Response.md +26 -0
- package/docs/TicketsDelete200Response.md +26 -0
- package/docs/TicketsDelete400Response.md +26 -0
- package/docs/TicketsDelete401Response.md +26 -0
- package/docs/TicketsIndex200Response.md +28 -0
- package/docs/TicketsIndex400Response.md +26 -0
- package/docs/TicketsIndex401Response.md +26 -0
- package/docs/TicketsUpdate200Response.md +26 -0
- package/docs/TicketsUpdate400Response.md +26 -0
- package/docs/User.md +56 -0
- package/docs/UserCustomData.md +24 -0
- package/docs/UserWebhookError.md +26 -0
- package/docs/UserWebhookErrorContent.md +58 -0
- package/docs/UserWebhookErrorContentAllOfErrors.md +22 -0
- package/docs/UserWebhookSuccess.md +26 -0
- package/docs/UsersApi.md +304 -0
- package/docs/UsersCreate201Response.md +26 -0
- package/docs/UsersCreate401Response.md +26 -0
- package/docs/UsersCreate409Response.md +26 -0
- package/docs/UsersCreateRequest.md +20 -0
- package/docs/UsersDelete200Response.md +26 -0
- package/docs/UsersDelete400Response.md +26 -0
- package/docs/UsersDelete401Response.md +26 -0
- package/docs/UsersIndex200Response.md +28 -0
- package/docs/UsersUpdate201Response.md +26 -0
- package/docs/UsersWebhook200Response.md +20 -0
- package/docs/UsersWebhookRequest.md +26 -0
- package/git_push.sh +57 -0
- package/index.ts +18 -0
- package/package.json +31 -0
- package/tsconfig.json +21 -0
package/dist/base.d.ts
ADDED
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Plataforma de Promoção - Documentação da API
|
|
3
|
+
* # Introdução Bem-vindo à documentação oficial da API da Plataforma de Promoção IdPlugger! Esta API foi desenvolvida para oferecer acesso seguro e eficiente aos recursos e serviços essenciais da Plataforma. # Sobre a API Esta API é baseada em REST, proporcionando uma arquitetura flexível e de fácil integração para desenvolvedores e empresas. Esta documentação foi elaborada com o intuito de fornecer uma referência abrangente e detalhada para desenvolvedores, parceiros e clientes que desejam utilizar a API da Plataforma de Promoção IdPlugger em seus próprios aplicativos, sistemas e plataformas. Aqui, você encontrará informações sobre os endpoints disponíveis, parâmetros de solicitação, respostas esperadas, autenticação, webhooks, exemplos de uso e muito mais. # Começando Para começar a explorar e utilizar a API da Plataforma de Promoção IdPlugger, recomendamos que você siga os seguintes passos: 1. **Autenticação**: Obtenha suas credenciais de autenticação (\'username\' e \'password\'), junto ao nosso time comercial, para acessar a API. 2. **Explorar Endpoints**: Navegue pela lista de endpoints disponíveis e suas respectivas funcionalidades. 3. **Experimentar**: Utilize os exemplos de solicitação fornecidos para testar os endpoints e compreender melhor seu funcionamento. 4. **Integrar**: Integre a API da Plataforma de Promoção IdPlugger em seus próprios projetos e sistemas para aproveitar ao máximo suas capacidades. # Autenticação Todos os endpoints requerem token de autenticação válido, que pode ser obtido através de requisição à API enviando as credenciais obtidas junto a equipe da Plataforma de Promoção. Este token é do tipo JWT e deve ser enviado no header da requisição no seguinte formato: | Header | Valor | | - | - | | Authorization | bearer `{token}` | Substitua `{token}` pelo token obtido na autenticação. IMPORTANTE: O token JWT tem um tempo de validade, o ideal é armazenar o token JWT e solicitar um novo token apenas quando o seu token expirar. A validade do token é enviada junto com o token na resposta do endpoint de autenticação. # Webhooks Ao cadastrar um usuário ou um cupom, a API irá armazenar os dados informados para processar em segundo plano. Por tanto, para obter a informação de cadastro com sucesso ou falha no cadastro de um usuário ou um cupom, é necessário ter um webhook cadastrado na API. Para cadastrar o webhook da promoção na API, utilize o endpoint <a href=\"#/Settings/config.webhook\">`/webhook`</a>. # Ambiente de testes Atualmente a Plataforma de Promoção IdPlugger não possui ambiente de homologação para testes de integração do cliente. Todos as validações devem ser realizadas em produção, **sem ônus à pessoa desenvolvedora**. Todos os dados de testes serão excluídos da Plataforma antes do início oficial da Promoção. Estamos empolgados por você ter escolhido a API de Promoção da IdPlugger para impulsionar suas iniciativas promocionais. Se surgirem dúvidas ou precisar de suporte, não hesite em contatar nossa equipe de suporte técnico. Vamos começar a promover o sucesso juntos! # Postman Collection [<img src=\"https://run.pstmn.io/button.svg\" alt=\"Run In \" style=\"width: 128px; height: 32px;\">](https://god.gw.postman.com/run-collection/13619232-20687020-3c58-488d-bd15-9f9d1a8164b1?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D13619232-20687020-3c58-488d-bd15-9f9d1a8164b1%26entityType%3Dcollection%26workspaceId%3Df86d7ea0-5224-4351-bf69-54ada2ca328d)
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 3.3.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { Configuration } from './configuration';
|
|
13
|
+
import type { AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
14
|
+
export declare const BASE_PATH: string;
|
|
15
|
+
/**
|
|
16
|
+
*
|
|
17
|
+
* @export
|
|
18
|
+
*/
|
|
19
|
+
export declare const COLLECTION_FORMATS: {
|
|
20
|
+
csv: string;
|
|
21
|
+
ssv: string;
|
|
22
|
+
tsv: string;
|
|
23
|
+
pipes: string;
|
|
24
|
+
};
|
|
25
|
+
/**
|
|
26
|
+
*
|
|
27
|
+
* @export
|
|
28
|
+
* @interface RequestArgs
|
|
29
|
+
*/
|
|
30
|
+
export interface RequestArgs {
|
|
31
|
+
url: string;
|
|
32
|
+
options: RawAxiosRequestConfig;
|
|
33
|
+
}
|
|
34
|
+
/**
|
|
35
|
+
*
|
|
36
|
+
* @export
|
|
37
|
+
* @class BaseAPI
|
|
38
|
+
*/
|
|
39
|
+
export declare class BaseAPI {
|
|
40
|
+
protected basePath: string;
|
|
41
|
+
protected axios: AxiosInstance;
|
|
42
|
+
protected configuration: Configuration | undefined;
|
|
43
|
+
constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
|
|
44
|
+
}
|
|
45
|
+
/**
|
|
46
|
+
*
|
|
47
|
+
* @export
|
|
48
|
+
* @class RequiredError
|
|
49
|
+
* @extends {Error}
|
|
50
|
+
*/
|
|
51
|
+
export declare class RequiredError extends Error {
|
|
52
|
+
field: string;
|
|
53
|
+
constructor(field: string, msg?: string);
|
|
54
|
+
}
|
|
55
|
+
interface ServerMap {
|
|
56
|
+
[key: string]: {
|
|
57
|
+
url: string;
|
|
58
|
+
description: string;
|
|
59
|
+
}[];
|
|
60
|
+
}
|
|
61
|
+
/**
|
|
62
|
+
*
|
|
63
|
+
* @export
|
|
64
|
+
*/
|
|
65
|
+
export declare const operationServerMap: ServerMap;
|
|
66
|
+
export {};
|
package/dist/base.js
ADDED
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Plataforma de Promoção - Documentação da API
|
|
6
|
+
* # Introdução Bem-vindo à documentação oficial da API da Plataforma de Promoção IdPlugger! Esta API foi desenvolvida para oferecer acesso seguro e eficiente aos recursos e serviços essenciais da Plataforma. # Sobre a API Esta API é baseada em REST, proporcionando uma arquitetura flexível e de fácil integração para desenvolvedores e empresas. Esta documentação foi elaborada com o intuito de fornecer uma referência abrangente e detalhada para desenvolvedores, parceiros e clientes que desejam utilizar a API da Plataforma de Promoção IdPlugger em seus próprios aplicativos, sistemas e plataformas. Aqui, você encontrará informações sobre os endpoints disponíveis, parâmetros de solicitação, respostas esperadas, autenticação, webhooks, exemplos de uso e muito mais. # Começando Para começar a explorar e utilizar a API da Plataforma de Promoção IdPlugger, recomendamos que você siga os seguintes passos: 1. **Autenticação**: Obtenha suas credenciais de autenticação (\'username\' e \'password\'), junto ao nosso time comercial, para acessar a API. 2. **Explorar Endpoints**: Navegue pela lista de endpoints disponíveis e suas respectivas funcionalidades. 3. **Experimentar**: Utilize os exemplos de solicitação fornecidos para testar os endpoints e compreender melhor seu funcionamento. 4. **Integrar**: Integre a API da Plataforma de Promoção IdPlugger em seus próprios projetos e sistemas para aproveitar ao máximo suas capacidades. # Autenticação Todos os endpoints requerem token de autenticação válido, que pode ser obtido através de requisição à API enviando as credenciais obtidas junto a equipe da Plataforma de Promoção. Este token é do tipo JWT e deve ser enviado no header da requisição no seguinte formato: | Header | Valor | | - | - | | Authorization | bearer `{token}` | Substitua `{token}` pelo token obtido na autenticação. IMPORTANTE: O token JWT tem um tempo de validade, o ideal é armazenar o token JWT e solicitar um novo token apenas quando o seu token expirar. A validade do token é enviada junto com o token na resposta do endpoint de autenticação. # Webhooks Ao cadastrar um usuário ou um cupom, a API irá armazenar os dados informados para processar em segundo plano. Por tanto, para obter a informação de cadastro com sucesso ou falha no cadastro de um usuário ou um cupom, é necessário ter um webhook cadastrado na API. Para cadastrar o webhook da promoção na API, utilize o endpoint <a href=\"#/Settings/config.webhook\">`/webhook`</a>. # Ambiente de testes Atualmente a Plataforma de Promoção IdPlugger não possui ambiente de homologação para testes de integração do cliente. Todos as validações devem ser realizadas em produção, **sem ônus à pessoa desenvolvedora**. Todos os dados de testes serão excluídos da Plataforma antes do início oficial da Promoção. Estamos empolgados por você ter escolhido a API de Promoção da IdPlugger para impulsionar suas iniciativas promocionais. Se surgirem dúvidas ou precisar de suporte, não hesite em contatar nossa equipe de suporte técnico. Vamos começar a promover o sucesso juntos! # Postman Collection [<img src=\"https://run.pstmn.io/button.svg\" alt=\"Run In \" style=\"width: 128px; height: 32px;\">](https://god.gw.postman.com/run-collection/13619232-20687020-3c58-488d-bd15-9f9d1a8164b1?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D13619232-20687020-3c58-488d-bd15-9f9d1a8164b1%26entityType%3Dcollection%26workspaceId%3Df86d7ea0-5224-4351-bf69-54ada2ca328d)
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 3.3.0
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
var __extends = (this && this.__extends) || (function () {
|
|
16
|
+
var extendStatics = function (d, b) {
|
|
17
|
+
extendStatics = Object.setPrototypeOf ||
|
|
18
|
+
({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
|
|
19
|
+
function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
|
|
20
|
+
return extendStatics(d, b);
|
|
21
|
+
};
|
|
22
|
+
return function (d, b) {
|
|
23
|
+
if (typeof b !== "function" && b !== null)
|
|
24
|
+
throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
|
|
25
|
+
extendStatics(d, b);
|
|
26
|
+
function __() { this.constructor = d; }
|
|
27
|
+
d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
|
|
28
|
+
};
|
|
29
|
+
})();
|
|
30
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
31
|
+
exports.operationServerMap = exports.RequiredError = exports.BaseAPI = exports.COLLECTION_FORMATS = exports.BASE_PATH = void 0;
|
|
32
|
+
var axios_1 = require("axios");
|
|
33
|
+
exports.BASE_PATH = "http://localhost".replace(/\/+$/, "");
|
|
34
|
+
/**
|
|
35
|
+
*
|
|
36
|
+
* @export
|
|
37
|
+
*/
|
|
38
|
+
exports.COLLECTION_FORMATS = {
|
|
39
|
+
csv: ",",
|
|
40
|
+
ssv: " ",
|
|
41
|
+
tsv: "\t",
|
|
42
|
+
pipes: "|",
|
|
43
|
+
};
|
|
44
|
+
/**
|
|
45
|
+
*
|
|
46
|
+
* @export
|
|
47
|
+
* @class BaseAPI
|
|
48
|
+
*/
|
|
49
|
+
var BaseAPI = /** @class */ (function () {
|
|
50
|
+
function BaseAPI(configuration, basePath, axios) {
|
|
51
|
+
if (basePath === void 0) { basePath = exports.BASE_PATH; }
|
|
52
|
+
if (axios === void 0) { axios = axios_1.default; }
|
|
53
|
+
var _a;
|
|
54
|
+
this.basePath = basePath;
|
|
55
|
+
this.axios = axios;
|
|
56
|
+
if (configuration) {
|
|
57
|
+
this.configuration = configuration;
|
|
58
|
+
this.basePath = (_a = configuration.basePath) !== null && _a !== void 0 ? _a : basePath;
|
|
59
|
+
}
|
|
60
|
+
}
|
|
61
|
+
return BaseAPI;
|
|
62
|
+
}());
|
|
63
|
+
exports.BaseAPI = BaseAPI;
|
|
64
|
+
;
|
|
65
|
+
/**
|
|
66
|
+
*
|
|
67
|
+
* @export
|
|
68
|
+
* @class RequiredError
|
|
69
|
+
* @extends {Error}
|
|
70
|
+
*/
|
|
71
|
+
var RequiredError = /** @class */ (function (_super) {
|
|
72
|
+
__extends(RequiredError, _super);
|
|
73
|
+
function RequiredError(field, msg) {
|
|
74
|
+
var _this = _super.call(this, msg) || this;
|
|
75
|
+
_this.field = field;
|
|
76
|
+
_this.name = "RequiredError";
|
|
77
|
+
return _this;
|
|
78
|
+
}
|
|
79
|
+
return RequiredError;
|
|
80
|
+
}(Error));
|
|
81
|
+
exports.RequiredError = RequiredError;
|
|
82
|
+
/**
|
|
83
|
+
*
|
|
84
|
+
* @export
|
|
85
|
+
*/
|
|
86
|
+
exports.operationServerMap = {
|
|
87
|
+
"CouponsApi.cuponsWebhook": [
|
|
88
|
+
{
|
|
89
|
+
url: "https://api.example.com/",
|
|
90
|
+
description: "URL do servidor do cliente",
|
|
91
|
+
}
|
|
92
|
+
],
|
|
93
|
+
"UsersApi.usersWebhook": [
|
|
94
|
+
{
|
|
95
|
+
url: "https://api.example.com/",
|
|
96
|
+
description: "URL do servidor do cliente",
|
|
97
|
+
}
|
|
98
|
+
],
|
|
99
|
+
};
|
package/dist/common.d.ts
ADDED
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Plataforma de Promoção - Documentação da API
|
|
3
|
+
* # Introdução Bem-vindo à documentação oficial da API da Plataforma de Promoção IdPlugger! Esta API foi desenvolvida para oferecer acesso seguro e eficiente aos recursos e serviços essenciais da Plataforma. # Sobre a API Esta API é baseada em REST, proporcionando uma arquitetura flexível e de fácil integração para desenvolvedores e empresas. Esta documentação foi elaborada com o intuito de fornecer uma referência abrangente e detalhada para desenvolvedores, parceiros e clientes que desejam utilizar a API da Plataforma de Promoção IdPlugger em seus próprios aplicativos, sistemas e plataformas. Aqui, você encontrará informações sobre os endpoints disponíveis, parâmetros de solicitação, respostas esperadas, autenticação, webhooks, exemplos de uso e muito mais. # Começando Para começar a explorar e utilizar a API da Plataforma de Promoção IdPlugger, recomendamos que você siga os seguintes passos: 1. **Autenticação**: Obtenha suas credenciais de autenticação (\'username\' e \'password\'), junto ao nosso time comercial, para acessar a API. 2. **Explorar Endpoints**: Navegue pela lista de endpoints disponíveis e suas respectivas funcionalidades. 3. **Experimentar**: Utilize os exemplos de solicitação fornecidos para testar os endpoints e compreender melhor seu funcionamento. 4. **Integrar**: Integre a API da Plataforma de Promoção IdPlugger em seus próprios projetos e sistemas para aproveitar ao máximo suas capacidades. # Autenticação Todos os endpoints requerem token de autenticação válido, que pode ser obtido através de requisição à API enviando as credenciais obtidas junto a equipe da Plataforma de Promoção. Este token é do tipo JWT e deve ser enviado no header da requisição no seguinte formato: | Header | Valor | | - | - | | Authorization | bearer `{token}` | Substitua `{token}` pelo token obtido na autenticação. IMPORTANTE: O token JWT tem um tempo de validade, o ideal é armazenar o token JWT e solicitar um novo token apenas quando o seu token expirar. A validade do token é enviada junto com o token na resposta do endpoint de autenticação. # Webhooks Ao cadastrar um usuário ou um cupom, a API irá armazenar os dados informados para processar em segundo plano. Por tanto, para obter a informação de cadastro com sucesso ou falha no cadastro de um usuário ou um cupom, é necessário ter um webhook cadastrado na API. Para cadastrar o webhook da promoção na API, utilize o endpoint <a href=\"#/Settings/config.webhook\">`/webhook`</a>. # Ambiente de testes Atualmente a Plataforma de Promoção IdPlugger não possui ambiente de homologação para testes de integração do cliente. Todos as validações devem ser realizadas em produção, **sem ônus à pessoa desenvolvedora**. Todos os dados de testes serão excluídos da Plataforma antes do início oficial da Promoção. Estamos empolgados por você ter escolhido a API de Promoção da IdPlugger para impulsionar suas iniciativas promocionais. Se surgirem dúvidas ou precisar de suporte, não hesite em contatar nossa equipe de suporte técnico. Vamos começar a promover o sucesso juntos! # Postman Collection [<img src=\"https://run.pstmn.io/button.svg\" alt=\"Run In \" style=\"width: 128px; height: 32px;\">](https://god.gw.postman.com/run-collection/13619232-20687020-3c58-488d-bd15-9f9d1a8164b1?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D13619232-20687020-3c58-488d-bd15-9f9d1a8164b1%26entityType%3Dcollection%26workspaceId%3Df86d7ea0-5224-4351-bf69-54ada2ca328d)
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 3.3.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { Configuration } from "./configuration";
|
|
13
|
+
import type { RequestArgs } from "./base";
|
|
14
|
+
import type { AxiosInstance, AxiosResponse } from 'axios';
|
|
15
|
+
/**
|
|
16
|
+
*
|
|
17
|
+
* @export
|
|
18
|
+
*/
|
|
19
|
+
export declare const DUMMY_BASE_URL = "https://example.com";
|
|
20
|
+
/**
|
|
21
|
+
*
|
|
22
|
+
* @throws {RequiredError}
|
|
23
|
+
* @export
|
|
24
|
+
*/
|
|
25
|
+
export declare const assertParamExists: (functionName: string, paramName: string, paramValue: unknown) => void;
|
|
26
|
+
/**
|
|
27
|
+
*
|
|
28
|
+
* @export
|
|
29
|
+
*/
|
|
30
|
+
export declare const setApiKeyToObject: (object: any, keyParamName: string, configuration?: Configuration) => Promise<void>;
|
|
31
|
+
/**
|
|
32
|
+
*
|
|
33
|
+
* @export
|
|
34
|
+
*/
|
|
35
|
+
export declare const setBasicAuthToObject: (object: any, configuration?: Configuration) => void;
|
|
36
|
+
/**
|
|
37
|
+
*
|
|
38
|
+
* @export
|
|
39
|
+
*/
|
|
40
|
+
export declare const setBearerAuthToObject: (object: any, configuration?: Configuration) => Promise<void>;
|
|
41
|
+
/**
|
|
42
|
+
*
|
|
43
|
+
* @export
|
|
44
|
+
*/
|
|
45
|
+
export declare const setOAuthToObject: (object: any, name: string, scopes: string[], configuration?: Configuration) => Promise<void>;
|
|
46
|
+
/**
|
|
47
|
+
*
|
|
48
|
+
* @export
|
|
49
|
+
*/
|
|
50
|
+
export declare const setSearchParams: (url: URL, ...objects: any[]) => void;
|
|
51
|
+
/**
|
|
52
|
+
*
|
|
53
|
+
* @export
|
|
54
|
+
*/
|
|
55
|
+
export declare const serializeDataIfNeeded: (value: any, requestOptions: any, configuration?: Configuration) => any;
|
|
56
|
+
/**
|
|
57
|
+
*
|
|
58
|
+
* @export
|
|
59
|
+
*/
|
|
60
|
+
export declare const toPathString: (url: URL) => string;
|
|
61
|
+
/**
|
|
62
|
+
*
|
|
63
|
+
* @export
|
|
64
|
+
*/
|
|
65
|
+
export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;
|
package/dist/common.js
ADDED
|
@@ -0,0 +1,253 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Plataforma de Promoção - Documentação da API
|
|
6
|
+
* # Introdução Bem-vindo à documentação oficial da API da Plataforma de Promoção IdPlugger! Esta API foi desenvolvida para oferecer acesso seguro e eficiente aos recursos e serviços essenciais da Plataforma. # Sobre a API Esta API é baseada em REST, proporcionando uma arquitetura flexível e de fácil integração para desenvolvedores e empresas. Esta documentação foi elaborada com o intuito de fornecer uma referência abrangente e detalhada para desenvolvedores, parceiros e clientes que desejam utilizar a API da Plataforma de Promoção IdPlugger em seus próprios aplicativos, sistemas e plataformas. Aqui, você encontrará informações sobre os endpoints disponíveis, parâmetros de solicitação, respostas esperadas, autenticação, webhooks, exemplos de uso e muito mais. # Começando Para começar a explorar e utilizar a API da Plataforma de Promoção IdPlugger, recomendamos que você siga os seguintes passos: 1. **Autenticação**: Obtenha suas credenciais de autenticação (\'username\' e \'password\'), junto ao nosso time comercial, para acessar a API. 2. **Explorar Endpoints**: Navegue pela lista de endpoints disponíveis e suas respectivas funcionalidades. 3. **Experimentar**: Utilize os exemplos de solicitação fornecidos para testar os endpoints e compreender melhor seu funcionamento. 4. **Integrar**: Integre a API da Plataforma de Promoção IdPlugger em seus próprios projetos e sistemas para aproveitar ao máximo suas capacidades. # Autenticação Todos os endpoints requerem token de autenticação válido, que pode ser obtido através de requisição à API enviando as credenciais obtidas junto a equipe da Plataforma de Promoção. Este token é do tipo JWT e deve ser enviado no header da requisição no seguinte formato: | Header | Valor | | - | - | | Authorization | bearer `{token}` | Substitua `{token}` pelo token obtido na autenticação. IMPORTANTE: O token JWT tem um tempo de validade, o ideal é armazenar o token JWT e solicitar um novo token apenas quando o seu token expirar. A validade do token é enviada junto com o token na resposta do endpoint de autenticação. # Webhooks Ao cadastrar um usuário ou um cupom, a API irá armazenar os dados informados para processar em segundo plano. Por tanto, para obter a informação de cadastro com sucesso ou falha no cadastro de um usuário ou um cupom, é necessário ter um webhook cadastrado na API. Para cadastrar o webhook da promoção na API, utilize o endpoint <a href=\"#/Settings/config.webhook\">`/webhook`</a>. # Ambiente de testes Atualmente a Plataforma de Promoção IdPlugger não possui ambiente de homologação para testes de integração do cliente. Todos as validações devem ser realizadas em produção, **sem ônus à pessoa desenvolvedora**. Todos os dados de testes serão excluídos da Plataforma antes do início oficial da Promoção. Estamos empolgados por você ter escolhido a API de Promoção da IdPlugger para impulsionar suas iniciativas promocionais. Se surgirem dúvidas ou precisar de suporte, não hesite em contatar nossa equipe de suporte técnico. Vamos começar a promover o sucesso juntos! # Postman Collection [<img src=\"https://run.pstmn.io/button.svg\" alt=\"Run In \" style=\"width: 128px; height: 32px;\">](https://god.gw.postman.com/run-collection/13619232-20687020-3c58-488d-bd15-9f9d1a8164b1?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D13619232-20687020-3c58-488d-bd15-9f9d1a8164b1%26entityType%3Dcollection%26workspaceId%3Df86d7ea0-5224-4351-bf69-54ada2ca328d)
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 3.3.0
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
var __assign = (this && this.__assign) || function () {
|
|
16
|
+
__assign = Object.assign || function(t) {
|
|
17
|
+
for (var s, i = 1, n = arguments.length; i < n; i++) {
|
|
18
|
+
s = arguments[i];
|
|
19
|
+
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
|
|
20
|
+
t[p] = s[p];
|
|
21
|
+
}
|
|
22
|
+
return t;
|
|
23
|
+
};
|
|
24
|
+
return __assign.apply(this, arguments);
|
|
25
|
+
};
|
|
26
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
27
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
28
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
29
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
30
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
31
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
32
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
33
|
+
});
|
|
34
|
+
};
|
|
35
|
+
var __generator = (this && this.__generator) || function (thisArg, body) {
|
|
36
|
+
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
|
|
37
|
+
return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
|
|
38
|
+
function verb(n) { return function (v) { return step([n, v]); }; }
|
|
39
|
+
function step(op) {
|
|
40
|
+
if (f) throw new TypeError("Generator is already executing.");
|
|
41
|
+
while (g && (g = 0, op[0] && (_ = 0)), _) try {
|
|
42
|
+
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
|
|
43
|
+
if (y = 0, t) op = [op[0] & 2, t.value];
|
|
44
|
+
switch (op[0]) {
|
|
45
|
+
case 0: case 1: t = op; break;
|
|
46
|
+
case 4: _.label++; return { value: op[1], done: false };
|
|
47
|
+
case 5: _.label++; y = op[1]; op = [0]; continue;
|
|
48
|
+
case 7: op = _.ops.pop(); _.trys.pop(); continue;
|
|
49
|
+
default:
|
|
50
|
+
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
|
|
51
|
+
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
|
|
52
|
+
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
|
|
53
|
+
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
|
|
54
|
+
if (t[2]) _.ops.pop();
|
|
55
|
+
_.trys.pop(); continue;
|
|
56
|
+
}
|
|
57
|
+
op = body.call(thisArg, _);
|
|
58
|
+
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
|
|
59
|
+
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
|
|
60
|
+
}
|
|
61
|
+
};
|
|
62
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
63
|
+
exports.createRequestFunction = exports.toPathString = exports.serializeDataIfNeeded = exports.setSearchParams = exports.setOAuthToObject = exports.setBearerAuthToObject = exports.setBasicAuthToObject = exports.setApiKeyToObject = exports.assertParamExists = exports.DUMMY_BASE_URL = void 0;
|
|
64
|
+
var base_1 = require("./base");
|
|
65
|
+
/**
|
|
66
|
+
*
|
|
67
|
+
* @export
|
|
68
|
+
*/
|
|
69
|
+
exports.DUMMY_BASE_URL = 'https://example.com';
|
|
70
|
+
/**
|
|
71
|
+
*
|
|
72
|
+
* @throws {RequiredError}
|
|
73
|
+
* @export
|
|
74
|
+
*/
|
|
75
|
+
var assertParamExists = function (functionName, paramName, paramValue) {
|
|
76
|
+
if (paramValue === null || paramValue === undefined) {
|
|
77
|
+
throw new base_1.RequiredError(paramName, "Required parameter ".concat(paramName, " was null or undefined when calling ").concat(functionName, "."));
|
|
78
|
+
}
|
|
79
|
+
};
|
|
80
|
+
exports.assertParamExists = assertParamExists;
|
|
81
|
+
/**
|
|
82
|
+
*
|
|
83
|
+
* @export
|
|
84
|
+
*/
|
|
85
|
+
var setApiKeyToObject = function (object, keyParamName, configuration) {
|
|
86
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
87
|
+
var localVarApiKeyValue, _a;
|
|
88
|
+
return __generator(this, function (_b) {
|
|
89
|
+
switch (_b.label) {
|
|
90
|
+
case 0:
|
|
91
|
+
if (!(configuration && configuration.apiKey)) return [3 /*break*/, 5];
|
|
92
|
+
if (!(typeof configuration.apiKey === 'function')) return [3 /*break*/, 2];
|
|
93
|
+
return [4 /*yield*/, configuration.apiKey(keyParamName)];
|
|
94
|
+
case 1:
|
|
95
|
+
_a = _b.sent();
|
|
96
|
+
return [3 /*break*/, 4];
|
|
97
|
+
case 2: return [4 /*yield*/, configuration.apiKey];
|
|
98
|
+
case 3:
|
|
99
|
+
_a = _b.sent();
|
|
100
|
+
_b.label = 4;
|
|
101
|
+
case 4:
|
|
102
|
+
localVarApiKeyValue = _a;
|
|
103
|
+
object[keyParamName] = localVarApiKeyValue;
|
|
104
|
+
_b.label = 5;
|
|
105
|
+
case 5: return [2 /*return*/];
|
|
106
|
+
}
|
|
107
|
+
});
|
|
108
|
+
});
|
|
109
|
+
};
|
|
110
|
+
exports.setApiKeyToObject = setApiKeyToObject;
|
|
111
|
+
/**
|
|
112
|
+
*
|
|
113
|
+
* @export
|
|
114
|
+
*/
|
|
115
|
+
var setBasicAuthToObject = function (object, configuration) {
|
|
116
|
+
if (configuration && (configuration.username || configuration.password)) {
|
|
117
|
+
object["auth"] = { username: configuration.username, password: configuration.password };
|
|
118
|
+
}
|
|
119
|
+
};
|
|
120
|
+
exports.setBasicAuthToObject = setBasicAuthToObject;
|
|
121
|
+
/**
|
|
122
|
+
*
|
|
123
|
+
* @export
|
|
124
|
+
*/
|
|
125
|
+
var setBearerAuthToObject = function (object, configuration) {
|
|
126
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
127
|
+
var accessToken, _a;
|
|
128
|
+
return __generator(this, function (_b) {
|
|
129
|
+
switch (_b.label) {
|
|
130
|
+
case 0:
|
|
131
|
+
if (!(configuration && configuration.accessToken)) return [3 /*break*/, 5];
|
|
132
|
+
if (!(typeof configuration.accessToken === 'function')) return [3 /*break*/, 2];
|
|
133
|
+
return [4 /*yield*/, configuration.accessToken()];
|
|
134
|
+
case 1:
|
|
135
|
+
_a = _b.sent();
|
|
136
|
+
return [3 /*break*/, 4];
|
|
137
|
+
case 2: return [4 /*yield*/, configuration.accessToken];
|
|
138
|
+
case 3:
|
|
139
|
+
_a = _b.sent();
|
|
140
|
+
_b.label = 4;
|
|
141
|
+
case 4:
|
|
142
|
+
accessToken = _a;
|
|
143
|
+
object["Authorization"] = "Bearer " + accessToken;
|
|
144
|
+
_b.label = 5;
|
|
145
|
+
case 5: return [2 /*return*/];
|
|
146
|
+
}
|
|
147
|
+
});
|
|
148
|
+
});
|
|
149
|
+
};
|
|
150
|
+
exports.setBearerAuthToObject = setBearerAuthToObject;
|
|
151
|
+
/**
|
|
152
|
+
*
|
|
153
|
+
* @export
|
|
154
|
+
*/
|
|
155
|
+
var setOAuthToObject = function (object, name, scopes, configuration) {
|
|
156
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
157
|
+
var localVarAccessTokenValue, _a;
|
|
158
|
+
return __generator(this, function (_b) {
|
|
159
|
+
switch (_b.label) {
|
|
160
|
+
case 0:
|
|
161
|
+
if (!(configuration && configuration.accessToken)) return [3 /*break*/, 5];
|
|
162
|
+
if (!(typeof configuration.accessToken === 'function')) return [3 /*break*/, 2];
|
|
163
|
+
return [4 /*yield*/, configuration.accessToken(name, scopes)];
|
|
164
|
+
case 1:
|
|
165
|
+
_a = _b.sent();
|
|
166
|
+
return [3 /*break*/, 4];
|
|
167
|
+
case 2: return [4 /*yield*/, configuration.accessToken];
|
|
168
|
+
case 3:
|
|
169
|
+
_a = _b.sent();
|
|
170
|
+
_b.label = 4;
|
|
171
|
+
case 4:
|
|
172
|
+
localVarAccessTokenValue = _a;
|
|
173
|
+
object["Authorization"] = "Bearer " + localVarAccessTokenValue;
|
|
174
|
+
_b.label = 5;
|
|
175
|
+
case 5: return [2 /*return*/];
|
|
176
|
+
}
|
|
177
|
+
});
|
|
178
|
+
});
|
|
179
|
+
};
|
|
180
|
+
exports.setOAuthToObject = setOAuthToObject;
|
|
181
|
+
function setFlattenedQueryParams(urlSearchParams, parameter, key) {
|
|
182
|
+
if (key === void 0) { key = ""; }
|
|
183
|
+
if (parameter == null)
|
|
184
|
+
return;
|
|
185
|
+
if (typeof parameter === "object") {
|
|
186
|
+
if (Array.isArray(parameter)) {
|
|
187
|
+
parameter.forEach(function (item) { return setFlattenedQueryParams(urlSearchParams, item, key); });
|
|
188
|
+
}
|
|
189
|
+
else {
|
|
190
|
+
Object.keys(parameter).forEach(function (currentKey) {
|
|
191
|
+
return setFlattenedQueryParams(urlSearchParams, parameter[currentKey], "".concat(key).concat(key !== '' ? '.' : '').concat(currentKey));
|
|
192
|
+
});
|
|
193
|
+
}
|
|
194
|
+
}
|
|
195
|
+
else {
|
|
196
|
+
if (urlSearchParams.has(key)) {
|
|
197
|
+
urlSearchParams.append(key, parameter);
|
|
198
|
+
}
|
|
199
|
+
else {
|
|
200
|
+
urlSearchParams.set(key, parameter);
|
|
201
|
+
}
|
|
202
|
+
}
|
|
203
|
+
}
|
|
204
|
+
/**
|
|
205
|
+
*
|
|
206
|
+
* @export
|
|
207
|
+
*/
|
|
208
|
+
var setSearchParams = function (url) {
|
|
209
|
+
var objects = [];
|
|
210
|
+
for (var _i = 1; _i < arguments.length; _i++) {
|
|
211
|
+
objects[_i - 1] = arguments[_i];
|
|
212
|
+
}
|
|
213
|
+
var searchParams = new URLSearchParams(url.search);
|
|
214
|
+
setFlattenedQueryParams(searchParams, objects);
|
|
215
|
+
url.search = searchParams.toString();
|
|
216
|
+
};
|
|
217
|
+
exports.setSearchParams = setSearchParams;
|
|
218
|
+
/**
|
|
219
|
+
*
|
|
220
|
+
* @export
|
|
221
|
+
*/
|
|
222
|
+
var serializeDataIfNeeded = function (value, requestOptions, configuration) {
|
|
223
|
+
var nonString = typeof value !== 'string';
|
|
224
|
+
var needsSerialization = nonString && configuration && configuration.isJsonMime
|
|
225
|
+
? configuration.isJsonMime(requestOptions.headers['Content-Type'])
|
|
226
|
+
: nonString;
|
|
227
|
+
return needsSerialization
|
|
228
|
+
? JSON.stringify(value !== undefined ? value : {})
|
|
229
|
+
: (value || "");
|
|
230
|
+
};
|
|
231
|
+
exports.serializeDataIfNeeded = serializeDataIfNeeded;
|
|
232
|
+
/**
|
|
233
|
+
*
|
|
234
|
+
* @export
|
|
235
|
+
*/
|
|
236
|
+
var toPathString = function (url) {
|
|
237
|
+
return url.pathname + url.search + url.hash;
|
|
238
|
+
};
|
|
239
|
+
exports.toPathString = toPathString;
|
|
240
|
+
/**
|
|
241
|
+
*
|
|
242
|
+
* @export
|
|
243
|
+
*/
|
|
244
|
+
var createRequestFunction = function (axiosArgs, globalAxios, BASE_PATH, configuration) {
|
|
245
|
+
return function (axios, basePath) {
|
|
246
|
+
var _a;
|
|
247
|
+
if (axios === void 0) { axios = globalAxios; }
|
|
248
|
+
if (basePath === void 0) { basePath = BASE_PATH; }
|
|
249
|
+
var axiosRequestArgs = __assign(__assign({}, axiosArgs.options), { url: (axios.defaults.baseURL ? '' : (_a = configuration === null || configuration === void 0 ? void 0 : configuration.basePath) !== null && _a !== void 0 ? _a : basePath) + axiosArgs.url });
|
|
250
|
+
return axios.request(axiosRequestArgs);
|
|
251
|
+
};
|
|
252
|
+
};
|
|
253
|
+
exports.createRequestFunction = createRequestFunction;
|
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Plataforma de Promoção - Documentação da API
|
|
3
|
+
* # Introdução Bem-vindo à documentação oficial da API da Plataforma de Promoção IdPlugger! Esta API foi desenvolvida para oferecer acesso seguro e eficiente aos recursos e serviços essenciais da Plataforma. # Sobre a API Esta API é baseada em REST, proporcionando uma arquitetura flexível e de fácil integração para desenvolvedores e empresas. Esta documentação foi elaborada com o intuito de fornecer uma referência abrangente e detalhada para desenvolvedores, parceiros e clientes que desejam utilizar a API da Plataforma de Promoção IdPlugger em seus próprios aplicativos, sistemas e plataformas. Aqui, você encontrará informações sobre os endpoints disponíveis, parâmetros de solicitação, respostas esperadas, autenticação, webhooks, exemplos de uso e muito mais. # Começando Para começar a explorar e utilizar a API da Plataforma de Promoção IdPlugger, recomendamos que você siga os seguintes passos: 1. **Autenticação**: Obtenha suas credenciais de autenticação (\'username\' e \'password\'), junto ao nosso time comercial, para acessar a API. 2. **Explorar Endpoints**: Navegue pela lista de endpoints disponíveis e suas respectivas funcionalidades. 3. **Experimentar**: Utilize os exemplos de solicitação fornecidos para testar os endpoints e compreender melhor seu funcionamento. 4. **Integrar**: Integre a API da Plataforma de Promoção IdPlugger em seus próprios projetos e sistemas para aproveitar ao máximo suas capacidades. # Autenticação Todos os endpoints requerem token de autenticação válido, que pode ser obtido através de requisição à API enviando as credenciais obtidas junto a equipe da Plataforma de Promoção. Este token é do tipo JWT e deve ser enviado no header da requisição no seguinte formato: | Header | Valor | | - | - | | Authorization | bearer `{token}` | Substitua `{token}` pelo token obtido na autenticação. IMPORTANTE: O token JWT tem um tempo de validade, o ideal é armazenar o token JWT e solicitar um novo token apenas quando o seu token expirar. A validade do token é enviada junto com o token na resposta do endpoint de autenticação. # Webhooks Ao cadastrar um usuário ou um cupom, a API irá armazenar os dados informados para processar em segundo plano. Por tanto, para obter a informação de cadastro com sucesso ou falha no cadastro de um usuário ou um cupom, é necessário ter um webhook cadastrado na API. Para cadastrar o webhook da promoção na API, utilize o endpoint <a href=\"#/Settings/config.webhook\">`/webhook`</a>. # Ambiente de testes Atualmente a Plataforma de Promoção IdPlugger não possui ambiente de homologação para testes de integração do cliente. Todos as validações devem ser realizadas em produção, **sem ônus à pessoa desenvolvedora**. Todos os dados de testes serão excluídos da Plataforma antes do início oficial da Promoção. Estamos empolgados por você ter escolhido a API de Promoção da IdPlugger para impulsionar suas iniciativas promocionais. Se surgirem dúvidas ou precisar de suporte, não hesite em contatar nossa equipe de suporte técnico. Vamos começar a promover o sucesso juntos! # Postman Collection [<img src=\"https://run.pstmn.io/button.svg\" alt=\"Run In \" style=\"width: 128px; height: 32px;\">](https://god.gw.postman.com/run-collection/13619232-20687020-3c58-488d-bd15-9f9d1a8164b1?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D13619232-20687020-3c58-488d-bd15-9f9d1a8164b1%26entityType%3Dcollection%26workspaceId%3Df86d7ea0-5224-4351-bf69-54ada2ca328d)
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 3.3.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
export interface ConfigurationParameters {
|
|
13
|
+
apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
|
|
14
|
+
username?: string;
|
|
15
|
+
password?: string;
|
|
16
|
+
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
|
|
17
|
+
basePath?: string;
|
|
18
|
+
serverIndex?: number;
|
|
19
|
+
baseOptions?: any;
|
|
20
|
+
formDataCtor?: new () => any;
|
|
21
|
+
}
|
|
22
|
+
export declare class Configuration {
|
|
23
|
+
/**
|
|
24
|
+
* parameter for apiKey security
|
|
25
|
+
* @param name security name
|
|
26
|
+
* @memberof Configuration
|
|
27
|
+
*/
|
|
28
|
+
apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
|
|
29
|
+
/**
|
|
30
|
+
* parameter for basic security
|
|
31
|
+
*
|
|
32
|
+
* @type {string}
|
|
33
|
+
* @memberof Configuration
|
|
34
|
+
*/
|
|
35
|
+
username?: string;
|
|
36
|
+
/**
|
|
37
|
+
* parameter for basic security
|
|
38
|
+
*
|
|
39
|
+
* @type {string}
|
|
40
|
+
* @memberof Configuration
|
|
41
|
+
*/
|
|
42
|
+
password?: string;
|
|
43
|
+
/**
|
|
44
|
+
* parameter for oauth2 security
|
|
45
|
+
* @param name security name
|
|
46
|
+
* @param scopes oauth2 scope
|
|
47
|
+
* @memberof Configuration
|
|
48
|
+
*/
|
|
49
|
+
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
|
|
50
|
+
/**
|
|
51
|
+
* override base path
|
|
52
|
+
*
|
|
53
|
+
* @type {string}
|
|
54
|
+
* @memberof Configuration
|
|
55
|
+
*/
|
|
56
|
+
basePath?: string;
|
|
57
|
+
/**
|
|
58
|
+
* override server index
|
|
59
|
+
*
|
|
60
|
+
* @type {number}
|
|
61
|
+
* @memberof Configuration
|
|
62
|
+
*/
|
|
63
|
+
serverIndex?: number;
|
|
64
|
+
/**
|
|
65
|
+
* base options for axios calls
|
|
66
|
+
*
|
|
67
|
+
* @type {any}
|
|
68
|
+
* @memberof Configuration
|
|
69
|
+
*/
|
|
70
|
+
baseOptions?: any;
|
|
71
|
+
/**
|
|
72
|
+
* The FormData constructor that will be used to create multipart form data
|
|
73
|
+
* requests. You can inject this here so that execution environments that
|
|
74
|
+
* do not support the FormData class can still run the generated client.
|
|
75
|
+
*
|
|
76
|
+
* @type {new () => FormData}
|
|
77
|
+
*/
|
|
78
|
+
formDataCtor?: new () => any;
|
|
79
|
+
constructor(param?: ConfigurationParameters);
|
|
80
|
+
/**
|
|
81
|
+
* Check if the given MIME is a JSON MIME.
|
|
82
|
+
* JSON MIME examples:
|
|
83
|
+
* application/json
|
|
84
|
+
* application/json; charset=UTF8
|
|
85
|
+
* APPLICATION/JSON
|
|
86
|
+
* application/vnd.company+json
|
|
87
|
+
* @param mime - MIME (Multipurpose Internet Mail Extensions)
|
|
88
|
+
* @return True if the given MIME is JSON, false otherwise.
|
|
89
|
+
*/
|
|
90
|
+
isJsonMime(mime: string): boolean;
|
|
91
|
+
}
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Plataforma de Promoção - Documentação da API
|
|
6
|
+
* # Introdução Bem-vindo à documentação oficial da API da Plataforma de Promoção IdPlugger! Esta API foi desenvolvida para oferecer acesso seguro e eficiente aos recursos e serviços essenciais da Plataforma. # Sobre a API Esta API é baseada em REST, proporcionando uma arquitetura flexível e de fácil integração para desenvolvedores e empresas. Esta documentação foi elaborada com o intuito de fornecer uma referência abrangente e detalhada para desenvolvedores, parceiros e clientes que desejam utilizar a API da Plataforma de Promoção IdPlugger em seus próprios aplicativos, sistemas e plataformas. Aqui, você encontrará informações sobre os endpoints disponíveis, parâmetros de solicitação, respostas esperadas, autenticação, webhooks, exemplos de uso e muito mais. # Começando Para começar a explorar e utilizar a API da Plataforma de Promoção IdPlugger, recomendamos que você siga os seguintes passos: 1. **Autenticação**: Obtenha suas credenciais de autenticação (\'username\' e \'password\'), junto ao nosso time comercial, para acessar a API. 2. **Explorar Endpoints**: Navegue pela lista de endpoints disponíveis e suas respectivas funcionalidades. 3. **Experimentar**: Utilize os exemplos de solicitação fornecidos para testar os endpoints e compreender melhor seu funcionamento. 4. **Integrar**: Integre a API da Plataforma de Promoção IdPlugger em seus próprios projetos e sistemas para aproveitar ao máximo suas capacidades. # Autenticação Todos os endpoints requerem token de autenticação válido, que pode ser obtido através de requisição à API enviando as credenciais obtidas junto a equipe da Plataforma de Promoção. Este token é do tipo JWT e deve ser enviado no header da requisição no seguinte formato: | Header | Valor | | - | - | | Authorization | bearer `{token}` | Substitua `{token}` pelo token obtido na autenticação. IMPORTANTE: O token JWT tem um tempo de validade, o ideal é armazenar o token JWT e solicitar um novo token apenas quando o seu token expirar. A validade do token é enviada junto com o token na resposta do endpoint de autenticação. # Webhooks Ao cadastrar um usuário ou um cupom, a API irá armazenar os dados informados para processar em segundo plano. Por tanto, para obter a informação de cadastro com sucesso ou falha no cadastro de um usuário ou um cupom, é necessário ter um webhook cadastrado na API. Para cadastrar o webhook da promoção na API, utilize o endpoint <a href=\"#/Settings/config.webhook\">`/webhook`</a>. # Ambiente de testes Atualmente a Plataforma de Promoção IdPlugger não possui ambiente de homologação para testes de integração do cliente. Todos as validações devem ser realizadas em produção, **sem ônus à pessoa desenvolvedora**. Todos os dados de testes serão excluídos da Plataforma antes do início oficial da Promoção. Estamos empolgados por você ter escolhido a API de Promoção da IdPlugger para impulsionar suas iniciativas promocionais. Se surgirem dúvidas ou precisar de suporte, não hesite em contatar nossa equipe de suporte técnico. Vamos começar a promover o sucesso juntos! # Postman Collection [<img src=\"https://run.pstmn.io/button.svg\" alt=\"Run In \" style=\"width: 128px; height: 32px;\">](https://god.gw.postman.com/run-collection/13619232-20687020-3c58-488d-bd15-9f9d1a8164b1?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D13619232-20687020-3c58-488d-bd15-9f9d1a8164b1%26entityType%3Dcollection%26workspaceId%3Df86d7ea0-5224-4351-bf69-54ada2ca328d)
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 3.3.0
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
var __assign = (this && this.__assign) || function () {
|
|
16
|
+
__assign = Object.assign || function(t) {
|
|
17
|
+
for (var s, i = 1, n = arguments.length; i < n; i++) {
|
|
18
|
+
s = arguments[i];
|
|
19
|
+
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
|
|
20
|
+
t[p] = s[p];
|
|
21
|
+
}
|
|
22
|
+
return t;
|
|
23
|
+
};
|
|
24
|
+
return __assign.apply(this, arguments);
|
|
25
|
+
};
|
|
26
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
27
|
+
exports.Configuration = void 0;
|
|
28
|
+
var Configuration = /** @class */ (function () {
|
|
29
|
+
function Configuration(param) {
|
|
30
|
+
if (param === void 0) { param = {}; }
|
|
31
|
+
var _a;
|
|
32
|
+
this.apiKey = param.apiKey;
|
|
33
|
+
this.username = param.username;
|
|
34
|
+
this.password = param.password;
|
|
35
|
+
this.accessToken = param.accessToken;
|
|
36
|
+
this.basePath = param.basePath;
|
|
37
|
+
this.serverIndex = param.serverIndex;
|
|
38
|
+
this.baseOptions = __assign(__assign({}, param.baseOptions), { headers: __assign({}, (_a = param.baseOptions) === null || _a === void 0 ? void 0 : _a.headers) });
|
|
39
|
+
this.formDataCtor = param.formDataCtor;
|
|
40
|
+
}
|
|
41
|
+
/**
|
|
42
|
+
* Check if the given MIME is a JSON MIME.
|
|
43
|
+
* JSON MIME examples:
|
|
44
|
+
* application/json
|
|
45
|
+
* application/json; charset=UTF8
|
|
46
|
+
* APPLICATION/JSON
|
|
47
|
+
* application/vnd.company+json
|
|
48
|
+
* @param mime - MIME (Multipurpose Internet Mail Extensions)
|
|
49
|
+
* @return True if the given MIME is JSON, false otherwise.
|
|
50
|
+
*/
|
|
51
|
+
Configuration.prototype.isJsonMime = function (mime) {
|
|
52
|
+
var jsonMime = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i');
|
|
53
|
+
return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json');
|
|
54
|
+
};
|
|
55
|
+
return Configuration;
|
|
56
|
+
}());
|
|
57
|
+
exports.Configuration = Configuration;
|